Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe Tar
+ Graphe d'héritage de Tar:

Fonctions membres publiques

 __construct ($options=[])
 
 extract ($archive, $destination)
 

Fonctions membres publiques statiques

static isSupported ()
 

Fonctions membres protégées

 getTarInfo (&$data)
 

Attributs protégés

 $options = []
 

Fonctions membres privées

 isBelow ($destination, $path)
 

Attributs privés

const TYPES
 
 $data
 
 $metadata
 

Description détaillée

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

Michael Slusarz slusa.nosp@m.rz@h.nosp@m.orde..nosp@m.org Michael Cochrane mike@.nosp@m.graf.nosp@m.tonha.nosp@m.ll.c.nosp@m.o.nz

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = [])

Create a new Archive object.

Paramètres
array | \ArrayAccess$optionsAn array of options or an object that implements
Depuis
1.0
Exceptions

Références Tar\$options.

Documentation des fonctions membres

◆ extract()

extract (   $archive,
  $destination 
)

Extract a ZIP compressed file to a given path

Paramètres
string$archivePath to ZIP archive to extract
string$destinationPath to extract archive into
Renvoie
boolean True if successful
Depuis
1.0
Exceptions

Implémente ExtractableInterface.

Références $buffer, $i, $n, $path, $type, Path\clean(), Folder\create(), Tar\getTarInfo(), Tar\isBelow(), null, et File\write().

◆ getTarInfo()

getTarInfo ( $data)
protected

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

Array structure:

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
Paramètres
string$dataThe Tar archive buffer.
Renvoie
void
Depuis
1.0
Exceptions

Références Tar\$data, $info, $mode, $position, elseif, et null.

Référencé par Tar\extract().

◆ isBelow()

isBelow (   $destination,
  $path 
)
private

Check if a path is below a given destination path

Paramètres
string$destinationThe destination path
string$pathThe path to be checked
Renvoie
boolean
Depuis
2.0.1

Références $path, Path\clean(), et Path\resolve().

Référencé par Tar\extract().

◆ isSupported()

static isSupported ( )
static

Tests whether this adapter can unpack files on this computer.

Renvoie
boolean True if supported
Depuis
1.0

Implémente ExtractableInterface.

Documentation des champs

◆ $data

$data
private

Référencé par Tar\getTarInfo().

◆ $metadata

$metadata
private

◆ $options

$options = []
protected

Référencé par Tar\__construct().

◆ TYPES

const TYPES
private
Valeur initiale :
= [
0x0 => 'Unix file'

La documentation de cette classe a été générée à partir du fichier suivant :