API17:JArchiveZip::extract
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Updated to r1448:247ba8d88526) |
||
| (One intermediate revision by one user not shown) | |||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JArchiveZip::extract|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JArchiveZip::extract|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function extract ( |
| + | $archive | ||
| + | $destination | ||
| + | $options=array | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 37: | Line 38: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' boolean True if successful | |
| − | boolean True if successful | + | * '''Defined''' on line 119 of libraries/joomla/filesystem/archive/zip.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/filesystem/archive/zip.php | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JArchiveZip::extract source code''' on [[jplatform:filesystem/archive/zip.php#cl-111|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JArchiveZip/11.1|JArchiveZip]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]] | ||
| + | * [[JArchiveZip::extract|Other versions of JArchiveZip::extract]] | ||
| + | {{SeeAlso:JArchiveZip::extract}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JArchiveZip::extract|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JArchiveZip::extract|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 57: | Line 58: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JArchiveZip]][[Category:JArchiveZip::extract]]</noinclude> | <noinclude>[[Category:JArchiveZip]][[Category:JArchiveZip::extract]]</noinclude> | ||
Revision as of 20:10, 27 April 2011
JArchiveZip::extract
Description
Extract a ZIP compressed file to a given path.
Description:JArchiveZip::extract [Edit Descripton]
public function extract ( $archive $destination $options=array )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $archive | string | Path to ZIP archive to extract | |
| $destination | string | Path to extract archive into | |
| $options | array | array() | Extraction options [unused] |
- Returns boolean True if successful
- Defined on line 119 of libraries/joomla/filesystem/archive/zip.php
- Since
See also
- JArchiveZip::extract source code on BitBucket
- Class JArchiveZip
- Subpackage Filesystem
- Other versions of JArchiveZip::extract
SeeAlso:JArchiveZip::extract [Edit See Also]
User contributed notes
<CodeExamplesForm />
