Actions

API17

Difference between revisions of "JArchive::extract"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by one user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JArchive::extract|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JArchive::extract|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JArchive::extract ($archivename, $extractdir)
+
public static function extract (
 +
        $archivename
 +
        $extractdir
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True for success
boolean True for success
+
* '''Defined''' on line 32 of libraries/joomla/filesystem/archive.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/archive.php
+
* '''Referenced by'''
===Referenced by===
+
** [[JInstallerHelper::unpack/11.1|JInstallerHelper::unpack]]
* [[JInstallerHelper/unpack/11.1|JInstallerHelper::unpack]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JArchive::extract source code''' on [[jplatform:filesystem/archive.php#cl-24|BitBucket]]
 +
* {{JVer|11.1}} Class [[JArchive/11.1|JArchive]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
 +
* [[JArchive::extract|Other versions of JArchive::extract]]
 +
{{SeeAlso:JArchive::extract}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JArchive::extract|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JArchive::extract|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JArchive/11.1|JArchive]]
+
===User contributed notes===
* [[JArchive::extract|Other versions of this method]]
+
{{SeeAlso:JArchive::extract}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 53: Line 54:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JArchive]][[Category:JArchive::extract]]</noinclude>
 
<noinclude>[[Category:JArchive]][[Category:JArchive::extract]]</noinclude>

Revision as of 20:09, 27 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JArchive::extract

Description

Extract an archive file to a directory.

Description:JArchive::extract [Edit Descripton]

public static function extract (
        $archivename
        $extractdir
)
Parameter Type Default Description
$archivename string The name of the archive file
$extractdir string Directory to unpack into
  • Returns boolean True for success
  • Defined on line 32 of libraries/joomla/filesystem/archive.php
  • Since Joomla 11.1
  • Referenced by

See also

SeeAlso:JArchive::extract [Edit See Also]

User contributed notes

<CodeExamplesForm />