ArchiverInterface
in
Représenter les fonctions de gestion liées aux fichiers d'archive.
Table of Contents
Methods
- commenter() : bool
- Associer un commentaire à l'archive.
- deballer() : bool
- Extraire tout ou partie des fichiers de l'archive vers une destination.
- emballer() : bool
- Créer ou modifier des fichiers dans le fichier d'archive.
- erreur() : int
- Renvoyer le dernier code d'erreur.
- getLectureSeule() : bool
- Indiquer si l'archive est accessible en ecriture ou pas.
- informer() : array<string|int, mixed>
- Indiquer le détail du contenu de l'archive.
- message() : string
- Renvoyer le dernier message d'erreur.
- retirer() : bool
- Retirer une liste de fichiers dans le fichier d'archive.
Methods
commenter()
Associer un commentaire à l'archive.
public
commenter([string $texte = '' ]) : bool
Parameters
- $texte : string = ''
-
Texte du commentaire à associer à l'archive
Return values
bool —Succès de l'opération
deballer()
Extraire tout ou partie des fichiers de l'archive vers une destination.
public
deballer([string $destination = '' ][, array<string|int, mixed> $fichiers = [] ]) : bool
Parameters
- $destination : string = ''
-
Chemin du répertoire d'extraction
- $fichiers : array<string|int, mixed> = []
-
Liste des fichiers à extraire
Return values
bool —Succès de l'opération
emballer()
Créer ou modifier des fichiers dans le fichier d'archive.
public
emballer([array<string|int, string>|array<string, string> $fichiers = [] ][, string|null $racine = null ]) : bool
Parameters
- $fichiers : array<string|int, string>|array<string, string> = []
-
Liste des fichiers à ajouter ou modifier
- $racine : string|null = null
-
Repertoire racine des fichiers a retirer du chemin lorsqu'on emballe
Tags
Return values
bool —Succès de l'opération
erreur()
Renvoyer le dernier code d'erreur.
public
erreur() : int
Return values
int —Dernier code d'erreur
getLectureSeule()
Indiquer si l'archive est accessible en ecriture ou pas.
public
getLectureSeule() : bool
Return values
bool —true si l'archive est en lecture seule
informer()
Indiquer le détail du contenu de l'archive.
public
informer() : array<string|int, mixed>
Return values
array<string|int, mixed> —détail du contenu de l'archive
message()
Renvoyer le dernier message d'erreur.
public
message() : string
Return values
string —Dernier message d'erreur
retirer()
Retirer une liste de fichiers dans le fichier d'archive.
public
retirer([array<string|int, mixed> $fichiers = [] ]) : bool
Parameters
- $fichiers : array<string|int, mixed> = []
-
Liste des fichiers à retirer
Return values
bool —Succès de l'opération