Framework openMairie - version 4.10

filestorage_filesystem extends filestorage_base
in package

framework

openmairie

Définition de la classe 'filestorage_filesystem'.

Cette classe est une classe de stockage spécifique aussi appelée plugin de stockage pour le système d'abstraction de stockage des fichiers. Le principe de ce plugin est de stocker tous les fichiers en renommant le fichier avec un UUID (identifiant unique) et en créant une arborescence à deux niveaux. Le premier est composé des deux premiers caractères de l'UUID du fichier et le second niveau des quatre premiers caractères de l'UUID du fichier. Un fichier avec l'extension .info permet de stocker les informations de base du fichier ainsi que des métadonnées.

$FILE_HANDLE_ERR : string: Message à destination des logs.
$ILLEGAL_CHANGE : string: Message à destination des logs.
$LOCK_FAILURE : string: Message à destination des logs.
$METADATA_MISSING : string: Message à destination des logs.
$METADATA_WRITE_ERR : string: Message à destination des logs.
$MKDIR_ERR : string: Message à destination des logs.
$NO_CHANGE : string: Message à destination des logs.
$NO_FILE : string: Message à destination des logs.
$NO_FILEDATA : string: Message à destination des logs.
$NO_METADATA : string: Message à destination des logs.
$NO_ROOT_DIR : string: Message à destination des logs.
$NO_UID : string: Message à destination des logs.
$NO_WRITE_RIGHT : string: Message à destination des logs.
$RAW_DATA_WRITE_ERR : string: Message à destination des logs.
$SIZE_MISMATCH : string: Message à destination des logs.
$SUCCESS : string: Message à destination des logs.
__construct() : void: Constructeur.
create() : string: Cette fonction permet de sauvegarder le fichier contenant les donnees, ainsi que le fichier contenant les métadonnées du fichier precedement cité.
create_temporary() : mixed: Créer un fichier temporaire sur le filesystem
delete() : string: Cette fonction permet de supprimer un ficher sauvegardé sur le filesystem.
delete_temporary() : uid: Créer un fichier temporaire sur le filesystem
get() : En: Cette fonction permet de récupérer les données d'un fichier (données brutes et métadonnées).
get_temporary() : null: Son but est de permettre l'extraction d'un fichier contenant les données, ainsi que l'extraction de contenu du fichier contenant les métadonnées
getFilename() : Le: Cette fonction retourne le nom de fichier qui est stocké sous l'uid passé en paramètre.
getFilename_temporary() : null: Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le nom du fichier temporaire identifié par l'uid passe en paramétré.
getInfo() : La: Cette fonction retourne un tableau associatif qui contient le nom, le mime type et la taille de fichier qui est stocké sous l'uid passé en paramètre.
getMimetype() : Le: Cette fonction retourne le mime type de fichier qui est stocké sous l'uid passé en paramètre.
getPath() : Le: Cette fonction retourne le path du fichier
getPath_temporary() : null: Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le path du fichier temporaire identifié par l'uid passe en paramétré.
getSize() : La: Cette fonction retourne la taille de fichier qui est stocké sous l'uid passé en paramètre.
lock() : string: Cette fonction permet de faire un lock sur un fichier. On peut créer le lock seulement si il n'y a aucun lock existant.
unlock() : mixed: Cette fonction permet de lâcher le lock sur un fichier.
update() : En: Cette fonction permet de modifier les données d'un fichier (données brutes et métadonnées).
update_metadata() : mixed: Cette fonction permet de modifier les métadonnées d'un fichier.
getContent() : mixed: Permet de recupérer le contenu et les métadonnées d'un fichier en fonction du mode passé en paramètre qui définira le type de la donnée.
addToLog() : mixed: Cette fonction ajoute dans le log.
arraysEqual() : Si: Cette fonction compare deux tableaux pour vérifier s'ils contenait les données identiques
generate_uuid() : mixed: Cette fonction génère l'identifiant unique utilisé dans la sauvegarde d'un fichier.
getDirPathForUid() : Le: Cette fonction retourne le répertoire qui stocke le fichier avec les données brutes, et le fichier avec les métadonnées. Quand un fichier qui sert comme lock est créé il est placé dans ce même répertoire
getMetadata() : mixed|null: Cette fonction extraire les métadonnées d'un fichier sauvegarde.
getMetadataStr() : La: Cette fonction retourne les metadonees représentées dans le format d'une chaîne des caractères.
rmdirLevel() : mixed: Cette fonction supprime les repertoires donne le numero des niveaux a supprimer.
writeFile() : mixed: Cette fonction permet d'ecrire un fichier.