API Documentation
\
Helper

\AcidMediatheque

Outil de Mediatheque publique

Summary

Methods
Properties
Constants
__construct()
buildUrl()
setJs()
setPlugin()
getPlugin()
exePost()
setCurPath()
getExtType()
printPath()
printChangeNameForm()
printNewDirHiddenForm()
printUploadForm()
printRemoveForm()
printZipForm()
printEltDir()
printEltLink()
thumbs()
thumbsRemove()
printEltFile()
printDir()
$thumbs_width
$thumbs_height
UNAUTHORIZED_PATH
UNAUTHORIZED_NAME
recursiveRemoveDir()
fsAdd()
fsRename()
fsRemove()
fsZip()
postMultiAdd()
postAdd()
postUpdate()
postRemove()
getContent()
getDirElements()
fileExtAllowed()
getNameBasedOn()
createNewDir()
$base_path
$files_path
$cur_path
$img
$key
$router_key
$use_router
$acl
$plugin
$js
N/A
No private methods found
No private properties found
N/A

Constants

UNAUTHORIZED_PATH

UNAUTHORIZED_PATH

UNAUTHORIZED_NAME

UNAUTHORIZED_NAME

Properties

$thumbs_width

$thumbs_width : integer

Type

integer — largeur des miniatures en pixels

$thumbs_height

$thumbs_height : integer

Type

integer — hauteur des miniatures en pixels

$base_path

$base_path : \unknown_type

Racine de la mediathèque

Type

\unknown_type

$files_path

$files_path : \unknown_type

Chemin vers le dossier des ressources fichier

Type

\unknown_type

$cur_path

$cur_path : \unknown_type

Chemin du dossier courant

Type

\unknown_type

$img

$img : \unknown_type

Chemin vers le dossier des ressources images

Type

\unknown_type

$key

$key : \unknown_type

Identifiant de la mediathèque

Type

\unknown_type

$router_key

$router_key : \unknown_type

Identifiant router de la mediathèque

Type

\unknown_type

$use_router

$use_router : \unknown_type

Utiliser le router pour naviguer

Type

\unknown_type

$acl

$acl : \unknown_type

Droits de la médiathèque

Type

\unknown_type

$plugin

$plugin : \unknown_type

Gestion de plugin

Type

\unknown_type

$js

$js : \unknown_type

Js courant

Type

\unknown_type

Methods

__construct()

__construct(  $path, boolean|false  $absolute = false, null  $acl = null, null  $plugin = null, string  $router_key = 'medias', string  $tpl_path = 'tools/medias/', boolean|true  $use_router = true)

Constructeur AcidMediatheque

Parameters

$path

Chemin associé au navigateur.
boolean|false $absolute

True si le chemin est absolu. - Défaut : false
null $acl

acl personnalisé
null $plugin

plugin associé
string $router_key

clé de la route
string $tpl_path

chemin vers le dossier tpl
boolean|true $use_router

si true, utilise les routeurs

buildUrl()

buildUrl(string|null  $path = null,   $without = array()) : string

Retourne l'url de la mediatheque publique

Parameters

string|null $path
$without

Returns

string

setJs()

setJs(string  $content = null)

Définit la valeur du JS

Parameters

string $content

setPlugin()

setPlugin(string  $name)

Définit la valeur du plugin

Parameters

string $name

getPlugin()

getPlugin()

Récupère la valeur du plugin

exePost()

exePost()

Controlleur d'execution depuis un formulaire.

setCurPath()

setCurPath(string  $path) : boolean

Définit le répertoire courant du navigateur, et retourne true en case de succès, false sinon.

Parameters

string $path

Returns

boolean

getExtType()

getExtType(string  $ext) : boolean

Retourne le type d'élément associé à l'extension en entrée Retourne false si non reconnu.

Parameters

string $ext

Returns

boolean —

| string

printPath()

printPath() : string

Retourne le chemin vers le repertoire courant du navigateur.

Returns

string

printChangeNameForm()

printChangeNameForm() : string

Retourne un formulaire de renommage.

Returns

string

printNewDirHiddenForm()

printNewDirHiddenForm() : string

Retourne un formulaire caché

Returns

string

printUploadForm()

printUploadForm(string  $dst_dir) : string

Retourne un formulaire d'upload ves le repertoire $dst_dir.

Parameters

string $dst_dir

Returns

string

printRemoveForm()

printRemoveForm() : string

Retourne un formulaire de suppression d'élement.

Returns

string

printZipForm()

printZipForm() : string

Retourne un formulaire de téléchargement.

Returns

string

printEltDir()

printEltDir(array  $attrs) : string

Retourne un bloc Dossier mis en forme pour le navigateur en fonction des attributs en entrée.

Parameters

array $attrs

Returns

string

printEltLink()

printEltLink(array  $attrs) : string

Retourne un bloc Raccourci mis en forme pour le navigateur en fonction des attributs en entrée.

Parameters

array $attrs

Returns

string

thumbs()

thumbs(string  $path) : string

Retourne le chemin vers la miniature et la créer si nécéssaire

Parameters

string $path

Returns

string

thumbsRemove()

thumbsRemove(string  $path) : string

Retourne le chemin vers la miniature et la créer si nécéssaire

Parameters

string $path

Returns

string

printEltFile()

printEltFile(array  $attrs) : string

Retourne un bloc Fichier mis en forme pour le navigateur en fonction des attributs en entrée.

Parameters

array $attrs

Returns

string

printDir()

printDir(string  $path) : string

Retourne le contenu du repertoire $path depuis le navigateur.

Parameters

string $path

Chemin vers le répertoire à afficher.

Returns

string

recursiveRemoveDir()

recursiveRemoveDir(string  $directory) : boolean

Supprime un dossier et son contenu, et retourne true en cas de succès, false sinon.

Parameters

string $directory

Chemin vers le dossier.

Returns

boolean

fsAdd()

fsAdd(string  $tmp_path, string  $final_path) : boolean

Deplace un fichier uploadé en $tmp_path vers $final_path.

Parameters

string $tmp_path

Chemin de la source.
string $final_path

Chemin de destination.

Returns

boolean

fsRename()

fsRename(array  $attrs)

Renomme un fichier ou un dossier.

Parameters

array $attrs

Attributs de la cible.

fsRemove()

fsRemove(string  $path)

Supprime un fichier ou un dossier du navigateur.

Parameters

string $path

Chemin de l'élément.

fsZip()

fsZip(string  $path)

Génère une archive d'un dossier du navigateur.

Parameters

string $path

Chemin de l'élément.

postMultiAdd()

postMultiAdd(array  $attrs)

Gère l'ajout delayés de fichiers.

Parameters

array $attrs

Attributs du fichier.

postAdd()

postAdd(array  $attrs)

Gère l'ajout d'un fichier depuis un formulaire.

Parameters

array $attrs

Attributs du fichier.

postUpdate()

postUpdate(array  $attrs)

Traitement de mise à jour

Parameters

array $attrs

postRemove()

postRemove(string  $path)

Traitement de suppression

Parameters

string $path

getContent()

getContent(string  $path) : array

Retourne le contenu d'un dossier sous forme d'un tableau.

Parameters

string $path

Chemin du dossier.

Returns

array

getDirElements()

getDirElements() : array

Retourne les éléments du repertoire courant du navigateur.

Returns

array —

(array : dir , array : link , array : file)

fileExtAllowed()

fileExtAllowed(string  $file_name) : boolean

Retourne true si l'extension est reconnue par le navigateur, false sinon.

Parameters

string $file_name

Nom du fichier.

Returns

boolean

getNameBasedOn()

getNameBasedOn(string  $name, string  $dir, string  $type = 'file', string  $i, string  $ext = '')

Retourne un nom d'élément basé sur les paramètres en entrée ainsi que le contenu du dossier référant.

Parameters

string $name

Nom de base.
string $dir

Dossier référent.
string $type

Type de fichier. - Défaut : 'file'
string $i

Numéro d'indexation. (si 0, non affiché) - Défaut : 0
string $ext

Extension Forcée. (si définie)

createNewDir()

createNewDir(array  $attrs) : boolean

Créer un nouveau dossier dans le répertoire courant du navigateur, et retourne true en cas de succès, false sinon.

Parameters

array $attrs

Attributs du dossier.

Returns

boolean