filestorage
in package
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.
Table of Contents
- $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
- __construct() : mixed
- 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.
- __destruct() : mixed
- Le destructeur permet de détruire la ressource instanciée dans le constructeur.
- create() : string
- Cette fonction appelle la fonction de mémé nom de la ressource de stockage pour sauvegarder un fichier
- create_temporary() : string
- Cette fonction appelle la fonction de même nom de la ressource de stockage pour sauvegarder un fichier temporaire
- delete() : string
- Cette fonction appelle la fonction de même nom de la ressource de stockage pour supprimer un fichier
- delete_temporary() : string
- Cette fonction appelle la fonction de même nom de la ressource de stockage pour supprimer un fichier temporaire
- get() : 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.
- get_temporary() : 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.
- getFilename() : Le
- Cette fonction retourne le nom de fichier qui est stocké sous l'uid passé en paramètre.
- getFilename_temporary() : Le
- Cette fonction retourne le nom de fichier temporaire qui est stocké sous l'uid passé en paramètre.
- getInfo() : 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.
- 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 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
- getPath_temporary() : 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
- getSize() : La
- Cette fonction retourne la taille de fichier qui est stocké sous l'uid passé en paramètre.
- update() : 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.
- update_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.
Properties
$type_storage
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
public
null|string
$type_storage
= \null
Methods
__construct()
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.
public
__construct([array<string|int, mixed> $conf = array() ]) : mixed
Parameters
- $conf : array<string|int, mixed> = array()
-
Tableau de configuration.
Return values
mixed —__destruct()
Le destructeur permet de détruire la ressource instanciée dans le constructeur.
public
__destruct() : mixed
Return values
mixed —create()
Cette fonction appelle la fonction de mémé nom de la ressource de stockage pour sauvegarder un fichier
public
create(string $file_content, mixed $metadata[, string $mode = "from_content" ]) : string
Parameters
- $file_content : string
-
Le contenu de fichier
- $metadata : mixed
-
Les metadata du fichier à sauvegarder
- $mode : string = "from_content"
-
origine des données (content/temporary/path)
Return values
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.
create_temporary()
Cette fonction appelle la fonction de même nom de la ressource de stockage pour sauvegarder un fichier temporaire
public
create_temporary(string $data, mixed $metadata[, string $mode = "from_content" ]) : string
Parameters
- $data : string
-
Le contenu de fichier
- $metadata : mixed
-
Les metadata du fichier à sauvegarder
- $mode : string = "from_content"
-
origine des données (content/temporary/path)
Return values
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()
Cette fonction appelle la fonction de même nom de la ressource de stockage pour supprimer un fichier
public
delete(string $uid) : string
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
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.
delete_temporary()
Cette fonction appelle la fonction de même nom de la ressource de stockage pour supprimer un fichier temporaire
public
delete_temporary(string $uid) : string
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
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()
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.
public
get(string $uid) : string
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
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.
get_temporary()
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.
public
get_temporary(string $uid) : string
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
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()
Cette fonction retourne le nom de fichier qui est stocké sous l'uid passé en paramètre.
public
getFilename(string $uid) : Le
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
Le —nom de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée
getFilename_temporary()
Cette fonction retourne le nom de fichier temporaire qui est stocké sous l'uid passé en paramètre.
public
getFilename_temporary(string $uid) : Le
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
Le —nom de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée
getInfo()
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.
public
getInfo(string $uid) : Le
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
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
getMimetype()
Cette fonction retourne le mime type de fichier qui est stocké sous l'uid passé en paramètre.
public
getMimetype(string $uid) : Le
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
Le —mime type de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée
getPath()
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
public
getPath(string $uid) : Le
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
Le —répertoire qui contient les fichiers. Si le chemin de racine de sauvegarde des fichiers n'est pas set, on retourne null.
getPath_temporary()
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
public
getPath_temporary(string $uid) : Le
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
Le —répertoire qui contient les fichiers. Si le chemin de racine de sauvegarde des fichiers n'est pas set, on retourne null.
getSize()
Cette fonction retourne la taille de fichier qui est stocké sous l'uid passé en paramètre.
public
getSize(string $uid) : La
Parameters
- $uid : string
-
L'identifiant de fichier
Return values
La —taille de fichier, si le fichier est trouvé, ou OP_FAILURE si la classe de sauvegarde n'était pas instanciée
update()
Cette fonction appelle la fonction de mémé nom de la ressource de stockage pour modifier un fichier, ou des metadata d'un fichier.
public
update(string $uid, string $file_content, mixed $metadata[, string $mode = "from_content" ]) : string
Parameters
- $uid : string
-
L'identifiant de fichier
- $file_content : string
-
Le contenu de fichier
- $metadata : mixed
-
Les metadata du fichier à sauvegarder
- $mode : string = "from_content"
-
origine des données (content/temporary/path)
Return values
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()
Cette fonction appelle la fonction de même nom de la ressource de stockage pour modifier les métadonnées d'un fichier.
public
update_metadata(string $uid, array<string|int, mixed> $metadata) : mixed
Parameters
- $uid : string
-
Identifiant du fichier dans le filestorage.
- $metadata : array<string|int, mixed>
-
Liste des métadonnées à mettre à jour.
Return values
mixed —Identifiant du fichier ou OP_FAILURE.