API Documentation
\
Helper

\AcidZip

ACIDZIP

Summary

Methods
Properties
Constants
__construct()
init()
mkdir()
setName()
getPath()
setfilter()
addDir()
addFile()
removeFile()
readZip()
generateZip()
debug()
$name
No constants found
callError()
saveZip()
cleanFileName()
cleanPath()
isValideFile()
cloneElt()
$path
$tree
$logs
$filter
$filter_mode
$zip
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Type

string — nom du fichier

$path

$path : string

Type

string — chemin vers le fichier

$tree

$tree : array

Type

array — arborescence du zip

$logs

$logs : array

Type

array — les logs

$filter

$filter : array

Type

array — les fichiers à exclure lors des différents traitements

$filter_mode

$filter_mode : string

Type

string — type de filtre à effectuer

$zip

$zip : object

Type

object — objet ZIP

Methods

__construct()

__construct(string  $path = null)

Constructeur

Parameters

string $path

chemin vers le ZIP

init()

init(string  $path) : boolean

Initialiser le ZIP

Parameters

string $path

Returns

boolean

mkdir()

mkdir(string  $t_path) : boolean

Créer un dossier dans le zip

Parameters

string $t_path

chemin du dossier

Returns

boolean

setName()

setName(string  $name)

Définit le nom du zip

Parameters

string $name

getPath()

getPath() : string

Retourne le chemin vers le zip

Returns

string

setfilter()

setfilter(array  $filter, boolean  $erase = false, string  $mode = null)

Configure le filtrage du zip

Parameters

array $filter

les filtres
boolean $erase

si true, éfface la configuration précédente
string $mode

mode de filtrage

addDir()

addDir(string  $path, string  $t_path = null) : boolean

Ajoute un dossier au zip

Parameters

string $path

chemin vers le dossier
string $t_path

racine

Returns

boolean

addFile()

addFile(string  $path, \unknown_type  $t_path = null) : boolean

Ajoute un fichier au zip

Parameters

string $path

chemin vers le fichier
\unknown_type $t_path

racine

Returns

boolean

removeFile()

removeFile(string  $t_path) : boolean

Supprime un fichier du zip

Parameters

string $t_path

chemin vers le fichier

Returns

boolean

readZip()

readZip(boolean  $close = true)

Lit le fichier zip

Parameters

boolean $close

si true, conclut la méthode avec un exit();

generateZip()

generateZip(string  $folder, string  $name = null, string  $tmp_path = null, array  $filter = array(), string  $filter_mode = null)

Génère un zip à partir du repertoire $folder

Parameters

string $folder

chemin vers le repertoire à zipper
string $name

nom du fichier
string $tmp_path

repertoire de destination du zip
array $filter

filtre à utiliser lors de la generation du zip
string $filter_mode

type de filtrage

debug()

debug() : string

Retourne les logs de debug

Returns

string

callError()

callError(string  $error, string  $caller = null, boolean  $warning = true)

Génère une erreur

Parameters

string $error
string $caller
boolean $warning

saveZip()

saveZip(string  $path) : boolean

Sauvegarde le zip vers le chemin $path

Parameters

string $path

Returns

boolean

cleanFileName()

cleanFileName(string  $name) : mixed

Nettoie le nom de fichier designé par $name

Parameters

string $name

Returns

mixed

cleanPath()

cleanPath(string  $str_path) : string

Nettoie le chemin désigné par $str_path

Parameters

string $str_path

Returns

string

isValideFile()

isValideFile(string  $file, string  $path = null) : boolean

Retourne vrai si le fichier soumis est traitable

Parameters

string $file

chemin vers le fichier
string $path

repertoire racine

Returns

boolean

cloneElt()

cloneElt(string  $path_a, string  $path_b) : boolean

Copie le contenu du dossier $path_a dans le repertoire $path_b du zip

Parameters

string $path_a
string $path_b

Returns

boolean