API17

Difference between revisions of "JArchiveZip:: extract"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (→‎See also: moving preparation)
(4 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>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
protected JArchiveZip->_extract ($archive, $destination, $options)
+
protected function _extract (
 +
        $archive
 +
        $destination
 +
        $options
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 37: Line 38:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True if successful
boolean True if successful
+
* '''Defined''' on line 174 of libraries/joomla/filesystem/archive/zip.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/archive/zip.php
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JArchiveZip::_extract source code''' on [[jplatform:filesystem/archive/zip.php#cl-166|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>
* [[JArchiveZip/11.1|JArchiveZip]]
+
===User contributed notes===
* [[JArchiveZip::_extract|Other versions of this method]]
 
{{SeeAlso:JArchiveZip::_extract}}
 
===Examples===
 
 
<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: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.

Joomla 11.1 JArchiveZip::_extract[edit]

Description[edit]

Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support.

Template:Description:JArchiveZip:: extract [Edit Descripton]

protected function _extract (
        $archive
        $destination
        $options
)
Parameter Type Default Description
$archive string Path to ZIP archive to extract.
$destination string Path to extract archive into.
$options array Extraction options [unused].
  • Returns boolean True if successful
  • Defined on line 174 of libraries/joomla/filesystem/archive/zip.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JArchiveZip:: extract [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />