\filestorage

Définition de la classe 'filestorage'.

Cette classe est une classe d'abstraction de stockage de fichiers. C'est cette classe qui est instanciée et utilisée par d'autres scripts pour gérer la création, récupération, suppression de fichiers et ce peu importe le stockage utilisé. Son objectif est d'instancier la classe de stockage spécifique aussi appelée plugin de stockage correspondant au paramétrage sélectionné. Cette classe de stockage spécifique hérite de la classe 'base_storage' qui lui sert de modèle.

Summary

Methods
Properties
Constants
__construct()
__destruct()
getPath()
create()
update()
update_metadata()
delete()
get()
create_temporary()
delete_temporary()
get_temporary()
getFilename_temporary()
getPath_temporary()
getFilename()
getMimetype()
getSize()
getInfo()
$type_storage
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$type_storage

$type_storage : null|string

Cet attribut permet de stocker le type de stockage cette valeur doit être remplie en fonction du paramétrage présent dans le fichier dyn/filestorage.inc.php

Type

null|string

Methods

__construct()

__construct(array  $conf = array()) 

Le constructeur instancie la classe de connecteur envoyée par le paramétrage lors de l'instanciation et lui transmettre le paramétrage en question.

Parameters

array $conf

Tableau de configuration.

__destruct()

__destruct() 

Le destructeur permet de détruire la ressource instanciée dans le constructeur.

getPath()

getPath(string  $uid) : \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

Parameters

string $uid

L'identifiant du fichier

Returns

\Le —

répertoire qui contient les fichiers. Si le chemin de racine de sauvegarde des fichiers n'est pas set, on retourne null.

create()

create(string  $file_content, mixed  $metadata, string  $mode = "from_content") : string

Cette fonction appelle la fonction de mémé nom de la ressource de stockage pour sauvegarder un fichier

Parameters

string $file_content

Le contenu de fichier

mixed $metadata

Les metadata du fichier à sauvegarder

string $mode

origine des données (content/temporary/path)

Returns

string —

Le résultat de création retourné par la ressource de stockage. Si la classe de sauvegarde n'était pas instanciée, on retourne OP_FAILURE.

update()

update(string  $uid, string  $file_content, mixed  $metadata, string  $mode = "from_content") : string

Cette fonction appelle la fonction de mémé nom de la ressource de stockage pour modifier un fichier, ou des metadata d'un fichier.

Parameters

string $uid

L'identifiant de fichier

string $file_content

Le contenu de fichier

mixed $metadata

Les metadata du fichier à sauvegarder

string $mode

origine des données (content/temporary/path)

Returns

string —

Le résultat de modification retourné par la ressource de stockage. Si la classe de sauvegarde n'était pas instanciée, on retourne OP_FAILURE.

update_metadata()

update_metadata(string  $uid, array  $metadata) : mixed

Cette fonction appelle la fonction de même nom de la ressource de stockage pour modifier les métadonnées d'un fichier.

Parameters

string $uid

Identifiant du fichier dans le filestorage.

array $metadata

Liste des métadonnées à mettre à jour.

Returns

mixed —

Identifiant du fichier ou OP_FAILURE.

delete()

delete(string  $uid) : string

Cette fonction appelle la fonction de même nom de la ressource de stockage pour supprimer un fichier

Parameters

string $uid

L'identifiant de fichier

Returns

string —

Le résultat de suppression retourné par la ressource de stockage. Si la classe de sauvegarde n'était pas instanciée, on retourne OP_FAILURE.

get()

get(string  $uid) : string

Cette fonction appelle la fonction de même nom de la ressource de stockage pour retourner les données d'un fichier, ce qui inclure le fichier lui même, et le metadata.

Parameters

string $uid

L'identifiant de fichier

Returns

string —

Le résultat de extraction retourné par la ressource de stockage. Si la classe de sauvegarde n'était pas instanciée, on retourne OP_FAILURE.

create_temporary()

create_temporary(string  $data, mixed  $metadata, string  $mode = "from_content") : string

Cette fonction appelle la fonction de même nom de la ressource de stockage pour sauvegarder un fichier temporaire

Parameters

string $data

Le contenu de fichier

mixed $metadata

Les metadata du fichier à sauvegarder

string $mode

origine des données (content/temporary/path)

Returns

string —

Le résultat de création retourné par la ressource de stockage. Si la classe de sauvegarde n'était pas instanciée, on retourne OP_FAILURE.

delete_temporary()

delete_temporary(string  $uid) : string

Cette fonction appelle la fonction de même nom de la ressource de stockage pour supprimer un fichier temporaire

Parameters

string $uid

L'identifiant de fichier

Returns

string —

Le résultat de suppression retourné par la ressource de stockage. Si la classe de sauvegarde n'était pas instanciée, on retourne OP_FAILURE.

get_temporary()

get_temporary(string  $uid) : string

Cette fonction appelle la fonction de même nom de la ressource de stockage pour retourner les données d'un fichier temporaire, ce qui inclure le fichier lui même, et le metadata.

Parameters

string $uid

L'identifiant de fichier

Returns

string —

Le résultat de extraction retourné par la ressource de stockage. Si la classe de sauvegarde n'était pas instanciée, on retourne OP_FAILURE.

getFilename_temporary()

getFilename_temporary(string  $uid) : \Le

Cette fonction retourne le nom de fichier temporaire qui est stocké sous l'uid passé en paramètre.

Parameters

string $uid

L'identifiant de fichier

Returns

\Le —

nom de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée

getPath_temporary()

getPath_temporary(string  $uid) : \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

Parameters

string $uid

L'identifiant du fichier

Returns

\Le —

répertoire qui contient les fichiers. Si le chemin de racine de sauvegarde des fichiers n'est pas set, on retourne null.

getFilename()

getFilename(string  $uid) : \Le

Cette fonction retourne le nom de fichier qui est stocké sous l'uid passé en paramètre.

Parameters

string $uid

L'identifiant de fichier

Returns

\Le —

nom de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée

getMimetype()

getMimetype(string  $uid) : \Le

Cette fonction retourne le mime type de fichier qui est stocké sous l'uid passé en paramètre.

Parameters

string $uid

L'identifiant de fichier

Returns

\Le —

mime type de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée

getSize()

getSize(string  $uid) : \La

Cette fonction retourne la taille de fichier qui est stocké sous l'uid passé en paramètre.

Parameters

string $uid

L'identifiant de fichier

Returns

\La —

taille de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée

getInfo()

getInfo(string  $uid) : \Le

Cette fonction retourne le résultat d'appel à la fonction qui retourne les métadonnées du fichier stocké sous l'uid passé en paramètre.

Parameters

string $uid

L'identifiant de fichier

Returns

\Le —

résultat d'appel à la fonction de la classe utilisée pour le stockage des fichiers. On retourne OP_FAILURE si la classe de sauvegarde n'était pas instanciée