Difference between revisions of "JArchiveZip"
From Joomla! Documentation
m (→User contributed notes: moving preparation) |
m (moving preparation) |
||
Line 14: | Line 14: | ||
|- | |- | ||
|public | |public | ||
− | |[[JArchiveZip::checkZipData | + | |[[API17:JArchiveZip::checkZipData|checkZipData]] |
|Checks to see if the data is a valid ZIP file. | |Checks to see if the data is a valid ZIP file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JArchiveZip::create | + | |[[API17:JArchiveZip::create|create]] |
|Create a ZIP compressed file from an array of file data. | |Create a ZIP compressed file from an array of file data. | ||
|- | |- | ||
|public | |public | ||
− | |[[JArchiveZip::extract | + | |[[API17:JArchiveZip::extract|extract]] |
|Extract a ZIP compressed file to a given path. | |Extract a ZIP compressed file to a given path. | ||
|- | |- | ||
|public | |public | ||
− | |[[JArchiveZip::hasNativeSupport | + | |[[API17:JArchiveZip::hasNativeSupport|hasNativeSupport]] |
|Method to determine if the server has native zip support for faster handling. | |Method to determine if the server has native zip support for faster handling. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JArchiveZip::_addToZIPFile | + | |[[API17:JArchiveZip::_addToZIPFile|_addToZIPFile]] |
|Adds a "file" to the ZIP archive. | |Adds a "file" to the ZIP archive. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JArchiveZip::_createZIPFile | + | |[[API17:JArchiveZip::_createZIPFile|_createZIPFile]] |
|Creates the ZIP file. | |Creates the ZIP file. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JArchiveZip::_extract | + | |[[API17:JArchiveZip::_extract|_extract]] |
|Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support. | |Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JArchiveZip::_extractNative | + | |[[API17:JArchiveZip::_extractNative|_extractNative]] |
|Extract a ZIP compressed file to a given path using native php api calls for speed. | |Extract a ZIP compressed file to a given path using native php api calls for speed. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JArchiveZip::_getFileData | + | |[[API17:JArchiveZip::_getFileData|_getFileData]] |
|Returns the file data for a file by offsest in the ZIP archive. | |Returns the file data for a file by offsest in the ZIP archive. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JArchiveZip::_getZipInfo | + | |[[API17:JArchiveZip::_getZipInfo|_getZipInfo]] |
|Get the list of files/data from a ZIP archive buffer. | |Get the list of files/data from a ZIP archive buffer. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JArchiveZip::_unix2DOSTime | + | |[[API17:JArchiveZip::_unix2DOSTime|_unix2DOSTime]] |
|Converts a UNIX timestamp to a 4-byte DOS date and time format (date in high 2-bytes, time in low 2-bytes allowing magnitude comparison). | |Converts a UNIX timestamp to a 4-byte DOS date and time format (date in high 2-bytes, time in low 2-bytes allowing magnitude comparison). | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/filesystem/archive/zip.php | * '''Defined in''' libraries/joomla/filesystem/archive/zip.php | ||
− | * '''Extends''' [[JObject | + | * '''Extends''' [[API17:JObject|JObject]] |
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.filesystem.archive.zip' );</source> | <source lang="php">jimport( 'joomla.filesystem.archive.zip' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JArchiveZip source code''' on [[jplatform:filesystem/archive/zip.php|BitBucket]] | * {{JVer|11.1}} '''JArchiveZip source code''' on [[jplatform:filesystem/archive/zip.php|BitBucket]] | ||
− | * {{JVer|11.1}} Subpackage [[Subpackage Filesystem | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Filesystem|Filesystem]] |
− | * [[JArchiveZip|Other versions of JArchiveZip]] | + | * [[API17:JArchiveZip|Other versions of JArchiveZip]] |
{{SeeAlso:JArchiveZip}} | {{SeeAlso:JArchiveZip}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> |
Revision as of 19:43, 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[edit]
Description[edit]
Template:Description:JArchiveZip [Edit Descripton]
Methods[edit]
Visibility | Method name | Description |
---|---|---|
public | checkZipData | Checks to see if the data is a valid ZIP file. |
public | create | Create a ZIP compressed file from an array of file data. |
public | extract | Extract a ZIP compressed file to a given path. |
public | hasNativeSupport | Method to determine if the server has native zip support for faster handling. |
protected | _addToZIPFile | Adds a "file" to the ZIP archive. |
protected | _createZIPFile | Creates the ZIP file. |
protected | _extract | Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support. |
protected | _extractNative | Extract a ZIP compressed file to a given path using native php api calls for speed. |
protected | _getFileData | Returns the file data for a file by offsest in the ZIP archive. |
protected | _getZipInfo | Get the list of files/data from a ZIP archive buffer. |
protected | _unix2DOSTime | Converts a UNIX timestamp to a 4-byte DOS date and time format (date in high 2-bytes, time in low 2-bytes allowing magnitude comparison). |
- Defined in libraries/joomla/filesystem/archive/zip.php
- Extends JObject
Importing[edit]
jimport( 'joomla.filesystem.archive.zip' );
See also[edit]
- JArchiveZip source code on BitBucket
- Subpackage Filesystem
- Other versions of JArchiveZip
Template:SeeAlso:JArchiveZip [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />