Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Archive

Fonctions membres publiques

 __construct ($options=array())
 
 extract ($archivename, $extractdir)
 
 setAdapter ($type, $class, $override=true)
 
 getAdapter ($type)
 

Champs de données

 $options = array()
 

Attributs protégés

 $adapters = array()
 

Description détaillée

An Archive handling class

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array())

Create a new Archive object.

Paramètres
array | \ArrayAccess$optionsAn array of options
Depuis
1.0
Exceptions

Références Archive\$options.

Documentation des fonctions membres

◆ extract()

extract (   $archivename,
  $extractdir 
)

Extract an archive file to a directory.

Paramètres
string$archivenameThe name of the archive file
string$extractdirDirectory to unpack into
Renvoie
boolean True for success
Depuis
1.0
Exceptions

Références $path, File\copy(), Folder\create(), Archive\getAdapter(), et null.

Référencé par InstallerHelper\unpack().

◆ getAdapter()

getAdapter (   $type)

Get a file compression adapter.

Paramètres
string$typeThe type of adapter (bzip2|gzip|tar|zip).
Renvoie
ExtractableInterface Adapter for the requested type
Depuis
1.0
Exceptions

Références $class, et $type.

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

◆ setAdapter()

setAdapter (   $type,
  $class,
  $override = true 
)

Method to override the provided adapter with your own implementation.

Paramètres
string$typeName of the adapter to set.
string$classFQCN of your class which implements ExtractableInterface.
boolean$overrideTrue to force override the adapter type.
Renvoie
Archive This object for chaining.
Depuis
1.0
Exceptions

Références $class, et $type.

Documentation des champs

◆ $adapters

$adapters = array()
protected

◆ $options

$options = array()

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


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