PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of Tar.php

Part of the Joomla Framework Archive Package

Copyright:	Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
License:	GNU General Public License version 2 or later; see LICENSE
File Size:	268 lines (7 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Tar:: (5 methods):
  __construct()
  extract()
  isSupported()
  getTarInfo()
  isBelow()

Class: Tar - X-Ref

Tar format adapter for the Archive package

This class is inspired from and draws heavily in code and concept from the Compress package of
The Horde Project <http://www.horde.org>

__construct($options = []) X-Ref

Create a new Archive object.

param: array|\ArrayAccess $options An array of options or an object that implements \ArrayAccess

extract($archive, $destination) X-Ref

Extract a ZIP compressed file to a given path

param: string $archive Path to ZIP archive to extract
param: string $destination Path to extract archive into
return: boolean True if successful

isSupported() X-Ref

Tests whether this adapter can unpack files on this computer.

return: boolean True if supported

getTarInfo(&$data) X-Ref

Get the list of files/data from a Tar archive buffer and builds a metadata array.

Array structure:
<pre>
KEY: Position in the array
VALUES: 'attr'  --  File attributes
'data'  --  Raw file contents
'date'  --  File modification time
'name'  --  Filename
'size'  --  Original file size
'type'  --  File type
</pre>

param: string  $data  The Tar archive buffer.
return: void

isBelow($destination, $path) X-Ref

Check if a path is below a given destination path

param: string $destination The destination path
param: string $path The path to be checked
return: boolean

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/vendor/joomla/archive/src/ -> Tar.php (summary)

Defines 1 class