filestorage_base
in package
Définition de la classe 'filestorage_base'.
Table of Contents
- create_temporary() : mixed
- Créer un fichier temporaire sur le filesystem
- delete_temporary() : uid
- Créer un fichier temporaire sur le filesystem
- 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_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é.
- 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é.
- create() : null
- Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la sauvegarde d'un fichier contenant les données, ainsi que la sauvegarde de fichier contenant les métadonnées du fichier précédemment cité.
- delete() : mixed
- Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la suppression d'un fichier contenant les données, ainsi que de supprimer le fichier contenant les métadonnées du fichier précédemment cité.
- get() : mixed
- Cette fonction doit être implémente par des classes dérivées. 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 du fichier précédemment cité.
- 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.
- getFilename() : null
- Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le nom du fichier identifié par l'uid passe en paramétré.
- getInfo() : null
- Cette fonction doit être implémente par des classes dérivées. Son but est de retourner les metadonnees du fichier identifié par l'uid passe en paramétré.
- getMimetype() : null
- Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le mime type du fichier identifié par l'uid passe en paramétré.
- getPath() : null
- Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le path du fichier identifié par l'uid passe en paramétre.
- getSize() : null
- Cette fonction doit être implémente par des classes dérivées. Son but est de retourner la taille du fichier identifié par l'uid passe en paramétré.
- lock() : false
- Cette fonction doit être implémente par des classes dérivées. Son but est de permettre le lock d'un fichier.
- unlock() : mixed
- Cette fonction doit être implémente par des classes dérivées. Son but est de lâcher le lock sur un fichier.
- update() : string
- Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la modification d'un fichier contenant les données, ainsi que la modification du fichier contenant les métadonnées du fichier précédemment cité.
- update_metadata() : string
- Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la modification des métadonnées d'un fichier.
Methods
create_temporary()
Créer un fichier temporaire sur le filesystem
public
create_temporary(mixed $data, mixed $metadata, string $mode) : mixed
Parameters
- $data : mixed
- $metadata : mixed
- $mode : string
-
origine des données (content/temporary/path)
Return values
mixed —delete_temporary()
Créer un fichier temporaire sur le filesystem
public
delete_temporary(mixed $uid) : uid
Parameters
- $uid : mixed
Return values
uid —get_temporary()
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
public
get_temporary(mixed $uid) : null
Parameters
- $uid : mixed
Return values
null —getFilename_temporary()
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é.
public
getFilename_temporary(string $uid) : null
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
null —getPath_temporary()
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é.
public
getPath_temporary(string $uid) : null
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
null —create()
Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la sauvegarde d'un fichier contenant les données, ainsi que la sauvegarde de fichier contenant les métadonnées du fichier précédemment cité.
protected
create(string $file_content, mixed $metadata[, string $mode = "from_content" ]) : null
Parameters
- $file_content : string
-
Le contenu de fichier
- $metadata : mixed
-
Les métadonnées du fichier à sauvegarder
- $mode : string = "from_content"
-
origine des données (content/temporary/path)
Return values
null —delete()
Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la suppression d'un fichier contenant les données, ainsi que de supprimer le fichier contenant les métadonnées du fichier précédemment cité.
protected
delete(string $uid) : mixed
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
mixed —get()
Cette fonction doit être implémente par des classes dérivées. 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 du fichier précédemment cité.
protected
get(string $uid) : mixed
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
mixed —getContent()
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.
protected
getContent(string $data, string $mode) : mixed
Parameters
- $data : string
-
handle du fichier
- $mode : string
-
origine des données (content/temporary/path)
Return values
mixed —Contenu du fichier
getFilename()
Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le nom du fichier identifié par l'uid passe en paramétré.
protected
getFilename(string $uid) : null
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
null —getInfo()
Cette fonction doit être implémente par des classes dérivées. Son but est de retourner les metadonnees du fichier identifié par l'uid passe en paramétré.
protected
getInfo(string $uid) : null
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
null —getMimetype()
Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le mime type du fichier identifié par l'uid passe en paramétré.
protected
getMimetype(string $uid) : null
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
null —getPath()
Cette fonction doit être implémente par des classes dérivées. Son but est de retourner le path du fichier identifié par l'uid passe en paramétre.
protected
getPath(string $uid) : null
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
null —getSize()
Cette fonction doit être implémente par des classes dérivées. Son but est de retourner la taille du fichier identifié par l'uid passe en paramétré.
protected
getSize(string $uid) : null
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
null —lock()
Cette fonction doit être implémente par des classes dérivées. Son but est de permettre le lock d'un fichier.
protected
lock(string $uid) : false
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
false —unlock()
Cette fonction doit être implémente par des classes dérivées. Son but est de lâcher le lock sur un fichier.
protected
unlock(string $uid) : mixed
Parameters
- $uid : string
-
L'identifiant du fichier
Return values
mixed —update()
Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la modification d'un fichier contenant les données, ainsi que la modification du fichier contenant les métadonnées du fichier précédemment cité.
protected
update(string $uid, string $file_content, mixed $metadata[, string $mode = "from_content" ]) : string
Parameters
- $uid : string
-
L'identifiant du fichier
- $file_content : string
-
Le contenu de fichier
- $metadata : mixed
-
Les métadonnées du fichier à sauvegarder
- $mode : string = "from_content"
-
origine des données (content/temporary/path)
Return values
string —$uid L'identifiant du fichier
update_metadata()
Cette fonction doit être implémente par des classes dérivées. Son but est de permettre la modification des métadonnées d'un fichier.
protected
update_metadata(string $uid, array<string|int, mixed> $metadata) : string
Parameters
- $uid : string
-
Identifiant du fichier dans le filestorage.
- $metadata : array<string|int, mixed>
-
Liste des métadonnées à mettre à jour.
Return values
string —Identifiant du fichier.