Documentation du code de SPIP et de ses plugins

Big Upload

CacheFichiers
in package
uses LogTrait

Gère le cache des fichiers dans tmp/bigupload

Tags
plugin

Bigup

copyright

2016

author

marcimat

licence

GNU/GPL

Table of Contents

Properties

$cache  : CacheRepertoire|null
$champ  : string|null
$identifier  : Identifier|null
Identification du formulaire

Methods

__construct()  : mixed
Constructeur
chemin_description()  : string
Retoune le chemin du fichier qui stocke les descriptions d'un fichier dans le cache.
creer_vignette()  : array<string|int, mixed>|false
Crée une vignette à partir d'un chemin et retourne un base64 de l'image générée.
debug()  : mixed
decrire_fichier()  : array<string|int, mixed>|false
Décrire un fichier (comme dans `$_FILES`)
decrire_fichier_description()  : array<string|int, mixed>|false
Décrire un fichier (comme dans `$_FILES`)
dir_champ()  : string
Retourne le chemin du cache pour ce champ du formulaire
dir_fichier()  : string
Retourne le chemin du répertoire cache pour cet identifiant de fichier et nom ce fichier du formulaire
dir_identifiant()  : string
Retourne le chemin du répertoire cache pour cet identifiant de fichier du formulaire
ecrire_description_fichier()  : bool
Sauvegarde la description du fichier
error()  : mixed
est_fichier_description()  : bool
Indique si ce nom de fichier est un fichier de description
hash_identifiant()  : string
Retourne le nom du répertoire / hash relatif à l'identifiant de fichier indiqué.
info()  : mixed
lire_description_fichier()  : array<string|int, mixed>|bool
Lit une description de fichier sauvegardée
log()  : mixed
Des logs
obtenir_description_fichier()  : array<string|int, mixed>|false
Retourne la description d'un fichier dont le chemin est indiqué
path_fichier()  : string
Retourne le chemin du fichier cache pour cet identifiant de fichier et nom ce fichier du formulaire

Properties

Methods

__construct()

Constructeur

public __construct(CacheRepertoire $cache, string $champ) : mixed
Parameters
$cache : CacheRepertoire

Cache des fichiers pour ce formulaire

$champ : string

Nom du champ (valeur de l'attribut name) pour ces fichiers

chemin_description()

Retoune le chemin du fichier qui stocke les descriptions d'un fichier dans le cache.

public static chemin_description(string $chemin) : string
Parameters
$chemin : string
Return values
string

creer_vignette()

Crée une vignette à partir d'un chemin et retourne un base64 de l'image générée.

public static creer_vignette(array<string|int, mixed>|string $desc, int $width, int $height) : array<string|int, mixed>|false
Parameters
$desc : array<string|int, mixed>|string

Description d'un fichier

$width : int
$height : int
Return values
array<string|int, mixed>|false

False si vignette non calculée, tableau avec clés : 'width', 'height', 'data'

debug()

public static debug(mixed $quoi) : mixed
Parameters
$quoi : mixed

decrire_fichier()

Décrire un fichier (comme dans `$_FILES`)

public decrire_fichier(string $identifiant, array<string|int, mixed> $infos) : array<string|int, mixed>|false
Parameters
$identifiant : string

Identifiant du fichier dans le cache

$infos : array<string|int, mixed>

Description du fichier tel que $_FILES le fournit. Tableau [ cle => valeur] avec pour clés : name, type, tmp_name, size, error

Tags
uses
decrire_fichier_chemin()
Return values
array<string|int, mixed>|false

Description du fichier, complétée. False si erreur.

decrire_fichier_description()

Décrire un fichier (comme dans `$_FILES`)

public static decrire_fichier_description(array<string|int, mixed> $infos, mixed $bigup) : array<string|int, mixed>|false
Parameters
$infos : array<string|int, mixed>

Description du fichier tel que $_FILES le fournit. Tableau [ cle => valeur] avec pour clés : name, type, tmp_name, size, error

$bigup : mixed
Return values
array<string|int, mixed>|false

Description du fichier, complétée. False si erreur.

dir_champ()

Retourne le chemin du cache pour ce champ du formulaire

public dir_champ() : string
Return values
string

dir_fichier()

Retourne le chemin du répertoire cache pour cet identifiant de fichier et nom ce fichier du formulaire

public dir_fichier(mixed $identifiant, mixed $fichier) : string
Parameters
$identifiant : mixed
$fichier : mixed
Return values
string

dir_identifiant()

Retourne le chemin du répertoire cache pour cet identifiant de fichier du formulaire

public dir_identifiant(mixed $identifiant) : string
Parameters
$identifiant : mixed
Return values
string

ecrire_description_fichier()

Sauvegarde la description du fichier

public static ecrire_description_fichier(string $chemin, array<string|int, mixed> $description) : bool
Parameters
$chemin : string
$description : array<string|int, mixed>
Return values
bool

error()

public static error(mixed $quoi) : mixed
Parameters
$quoi : mixed

est_fichier_description()

Indique si ce nom de fichier est un fichier de description

public static est_fichier_description(string $nom) : bool
Parameters
$nom : string
Return values
bool

true si c'en est un, false sinon.

hash_identifiant()

Retourne le nom du répertoire / hash relatif à l'identifiant de fichier indiqué.

public static hash_identifiant(string $identifiant) : string

Si l'identifiant transmis est déjà un hash, le retourne directement

Parameters
$identifiant : string
Return values
string

info()

public static info(mixed $quoi) : mixed
Parameters
$quoi : mixed

lire_description_fichier()

Lit une description de fichier sauvegardée

public static lire_description_fichier(string $chemin) : array<string|int, mixed>|bool
Parameters
$chemin : string
Return values
array<string|int, mixed>|bool

log()

Des logs

public static log(mixed $quoi[, int $gravite = _LOG_INFO_IMPORTANTE ]) : mixed
Parameters
$quoi : mixed
$gravite : int = _LOG_INFO_IMPORTANTE

obtenir_description_fichier()

Retourne la description d'un fichier dont le chemin est indiqué

public static obtenir_description_fichier(string $chemin) : array<string|int, mixed>|false

Cette description est sauvegardée à côté du fichier lors de son enregistrement dans le cache.

Parameters
$chemin : string

Chemin du fichier dans le cache de bigup.

Tags
uses
lire_description_fichier()
Return values
array<string|int, mixed>|false

Description si retrouvée, sinon false

path_fichier()

Retourne le chemin du fichier cache pour cet identifiant de fichier et nom ce fichier du formulaire

public path_fichier(string $identifiant, stiring $fichier) : string
Parameters
$identifiant : string
$fichier : stiring
Return values
string

        
On this page

Search results