Documentation du code de SPIP et de ses plugins

Archiviste

ArchiveInterface

Représenter un fichier d'archive.

Table of Contents

Methods

close()  : bool
Fermer la resource du fichier d'archive.
compress()  : bool
Créer un fichier d'archive à partir d'une liste de fichiers.
extractTo()  : bool
Extraire tout ou partie des fichiers d'une archive.
getComment()  : string
Lire le commentaire associé à l'archive si il existe.
list()  : array<int, mixed>
Indiquer les fichiers d'une archive.
open()  : int
Ouvrir le fichier d'archive.
remove()  : bool
Supprimer des fichiers de l'archive.
setComment()  : bool
Associer un commentaire à l'archive.

Methods

compress()

Créer un fichier d'archive à partir d'une liste de fichiers.

public compress([string $source = '' ][, array<string, string> $files = [] ]) : bool
Parameters
$source : string = ''
$files : array<string, string> = []

Tableau des fichiers à ajouter à l'archive

Tags
since
3.0

Le paramètre $source est obsolète.

since
3.0

Le paramètre $files est un tableau associatif du type ['source' => 'destination']

Return values
bool

extractTo()

Extraire tout ou partie des fichiers d'une archive.

public extractTo([string $target = '' ][, array<string|int, string> $files = [] ]) : bool
Parameters
$target : string = ''

Répertoire cible

$files : array<string|int, string> = []

Tout les fichier si le tableau est vide

Return values
bool

getComment()

Lire le commentaire associé à l'archive si il existe.

public getComment() : string
Return values
string

list()

Indiquer les fichiers d'une archive.

public list() : array<int, mixed>
Return values
array<int, mixed>

open()

Ouvrir le fichier d'archive.

public open(string $filename, string $mode) : int
Parameters
$filename : string

Chemin vers le fichier d'archive

$mode : string

Mode d'accès au fichier

Return values
int

Code d'erreur

remove()

Supprimer des fichiers de l'archive.

public remove([array<string|int, string> $files = [] ]) : bool
Parameters
$files : array<string|int, string> = []
Return values
bool

setComment()

Associer un commentaire à l'archive.

public setComment(string $comment) : bool
Parameters
$comment : string
Return values
bool

        
On this page

Search results