Difference between revisions of "JArchiveZip::extract"
From Joomla! Documentation
(Layout updates) |
m (→See also: moving preparation) |
||
| (3 intermediate revisions by 2 users 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 [[API17:JArchiveZip|JArchiveZip]] | ||
| + | * {{JVer|11.1}} Subpackage [[API17:Subpackage_Filesystem|Filesystem]] | ||
| + | * [[API17: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 58: | Line 58: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category: | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Revision as of 19:44, 11 May 2013
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JArchiveZip::extract[edit]
Description[edit]
Extract a ZIP compressed file to a given path.
Template: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[edit]
- JArchiveZip::extract source code on BitBucket
- Class JArchiveZip
- Subpackage Filesystem
- Other versions of JArchiveZip::extract
Template:SeeAlso:JArchiveZip::extract [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />