\filestorage_base

Définition de la classe 'filestorage_base'.

Summary

Methods
Properties
Constants
create_temporary()
delete_temporary()
get_temporary()
getFilename_temporary()
getPath_temporary()
No public properties found
No constants found
create()
delete()
update()
update_metadata()
get()
getContent()
lock()
unlock()
getFilename()
getMimetype()
getPath()
getSize()
getInfo()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

create_temporary()

create_temporary(\[string]  $data, \[mixed]  $metadata, string  $mode) : \[string]

Créer un fichier temporaire sur le filesystem

Parameters

\[string] $data

contenu du fichier

\[mixed] $metadata

[tableau de méta données]

string $mode

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

Returns

\[string] —

uid

delete_temporary()

delete_temporary(\[string]  $uid) : \uid

Créer un fichier temporaire sur le filesystem

Parameters

\[string] $uid

uid du fichier

Returns

\uid

get_temporary()

get_temporary(\[string]  $uid) : 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

Parameters

\[string] $uid

uid du fichier

Returns

null

getFilename_temporary()

getFilename_temporary(string  $uid) : 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é.

Parameters

string $uid

L'identifiant du fichier

Returns

null

getPath_temporary()

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

Parameters

string $uid

L'identifiant du fichier

Returns

null

create()

create(string  $file_content, mixed  $metadata, string  $mode = "from_content") : 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é.

Parameters

string $file_content

Le contenu de fichier

mixed $metadata

Les métadonnées du fichier à sauvegarder

string $mode

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

Returns

null

delete()

delete(string  $uid) : \L'identifiant

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é.

Parameters

string $uid

L'identifiant du fichier

Returns

\L'identifiant —

du fichier

update()

update(string  $uid, string  $file_content, mixed  $metadata, string  $mode = "from_content") : 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é.

Parameters

string $uid

L'identifiant du fichier

string $file_content

Le contenu de fichier

mixed $metadata

Les métadonnées du fichier à sauvegarder

string $mode

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

Returns

string —

$uid L'identifiant du fichier

update_metadata()

update_metadata(string  $uid, array  $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.

Parameters

string $uid

Identifiant du fichier dans le filestorage.

array $metadata

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

Returns

string —

Identifiant du fichier.

get()

get(string  $uid) 

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é.

Parameters

string $uid

L'identifiant du fichier

getContent()

getContent(string  $data, string  $mode) : 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.

Parameters

string $data

handle du fichier

string $mode

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

Returns

mixed —

Contenu du fichier

lock()

lock(string  $uid) : false

Cette fonction doit être implémente par des classes dérivées. Son but est de permettre le lock d'un fichier.

Parameters

string $uid

L'identifiant du fichier

Returns

false

unlock()

unlock(string  $uid) 

Cette fonction doit être implémente par des classes dérivées. Son but est de lâcher le lock sur un fichier.

Parameters

string $uid

L'identifiant du fichier

getFilename()

getFilename(string  $uid) : 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é.

Parameters

string $uid

L'identifiant du fichier

Returns

null

getMimetype()

getMimetype(string  $uid) : 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é.

Parameters

string $uid

L'identifiant du fichier

Returns

null

getPath()

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

Parameters

string $uid

L'identifiant du fichier

Returns

null

getSize()

getSize(string  $uid) : 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é.

Parameters

string $uid

L'identifiant du fichier

Returns

null

getInfo()

getInfo(string  $uid) : 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é.

Parameters

string $uid

L'identifiant du fichier

Returns

null