Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe Archive

Fonctions membres publiques

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

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
UnknownArchiveExceptionif the archive type is not supported

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

◆ 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 | object$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
UnsupportedArchiveExceptionif the adapter type is not supported

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 :