API Documentation
\
Helper

\Acid

Acidfarm

Summary

Methods
Properties
Constants
load()
loadMod()
mod()
tool()
log()
tradExists()
trad()
outPath()
themePath()
themeUrl()
themeFolder()
tplPath()
tpl()
executeTpl()
hash()
parse()
parseArray()
get()
set()
add()
setMany()
kill()
exists()
exist()
isEmpty()
save()
rollback()
getRollback()
setRollback()
sessGet()
sessSet()
sessAdd()
sessExist()
sessEmpty()
sessKill()
timerStart()
timerStop()
timerSum()
counter()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

load()

load(string  $path) : boolean

Permet de charger fichier. (DEPRECATED)

Parameters

string $path

repertoire pointant vers le fichier en question

Returns

boolean

loadMod()

loadMod(string  $path, string  $mod) : boolean

Permet de charger un module interne a un fichier.

Parameters

string $path

repertoire pointant vers le fichier
string $mod

nom de la classeà charger

Returns

boolean

mod()

mod(string  $mod) : object

Méthode abrégée de chargement de module Acidfarm.

Parameters

string $mod

nom de la classe à charger

Returns

object

tool()

tool(mixed  $tool)

DEPRECATED

Parameters

mixed $tool

log()

log(string  $level, string  $message, string  $path = null)

Signal un rapport d'erreur dans le registre prévu à cet effet.

Parameters

string $level

niveau de gravité
string $message
string $path

chemin vers le fichier de destination

tradExists()

tradExists(string  $val) : boolean

Retourne vrai si une traduction existe

Parameters

string $val

Returns

boolean

trad()

trad(string  $val, array  $replace = array()) : string

Traduit la clé en entrée

Parameters

string $val
array $replace

Returns

string

outPath()

outPath(string  $file = null) : string

Retourne le chemin vers le fichier template désigné en entrée.

Si le fichier n'existe pas dans le template courant, on retourne le chemin vers le fichier par défaut.

Parameters

string $file

Returns

string

themePath()

themePath(string  $file,   $sources = null, boolean|false  $relative = false, boolean|false  $dir = false) : mixed|null|string

Retourne le chemin vers le fichier theme désigné en entrée.

Si le fichier n'existe pas dans le theme courant, on retourne le chemin vers le fichier par défaut.

Parameters

string $file
$sources
boolean|false $relative

si false, chemin complet vers le fichier
boolean|false $dir

si true, on recherche un dossier au lieu d'un fichier

Returns

mixed|null|string

themeUrl()

themeUrl(string  $file, array  $sources = null, boolean|false  $dir = false) : mixed|null|string

Retourne le chemin relatif vers le fichier theme désigné en entrée.

Parameters

string $file
array $sources
boolean|false $dir

si true, on recherche un dossier au lieu d'un fichier

Returns

mixed|null|string

themeFolder()

themeFolder(string  $file, array  $sources = null) : \Ambigous

Retourne le chemin relatif vers le dossier theme désigné en entrée.

Parameters

string $file
array $sources

Returns

\Ambigous —

<string, NULL>

tplPath()

tplPath(string  $file) : string

Retourne le chemin vers le fichier template désigné en entrée.

Si le fichier n'existe pas dans le template courant, on retourne le chemin vers le fichier par défaut.

Parameters

string $file

Returns

string

tpl()

tpl(string  $file, array  $v = array(), object  $o = null) : string

Appel le fichier template désigné en entrée.

Procède à un include. Dans un tpl on peut utiliser $v pour le tableau d'arguments en entrée, $o pour l'objet en entrée, et $g pour $GLOBALS

Parameters

string $file

chemin vers le fichier tpl depuis le dossier de templates
array $v

les arguments à importer dans le tpl
object $o

l'objet à importer dans le tpl

Returns

string

executeTpl()

executeTpl(string  $path, array  $v = array(), object  $o = null) : string

Execute le fichier désigné en entrée et retourne son interpretation.

Procède à un include. Dans un tpl on peut utiliser $v pour le tableau d'arguments en entrée, $o pour l'objet en entrée, et $g pour $GLOBALS

Parameters

string $path

chemin vers le fichier tpl
array $v

les arguments à importer dans le tpl
object $o

l'objet à importer dans le tpl

Returns

string

hash()

hash(string  $string) : string

Génère la valeur de hachage d'une chaîne de carractère.

Parameters

string $string

Returns

string

parse()

parse(array  $array_path, array  $array) : mixed

Parcourt un tableau en fonction du tableau chemin en entrée

Parameters

array $array_path

Chemin
array $array

Returns

mixed

parseArray()

parseArray(string  $key) : mixed

Récupère le tableau de parcours en fonction de la clé en entrée

Parameters

string $key

Returns

mixed

get()

get(string  $key, string  $array = null) : mixed

Récupère une variable de configuration

Parameters

string $key
string $array

nom de la variable globale qui sera parcourue en tant que tableau

Returns

mixed

set()

set(array  $key, mixed  $value, string  $array = null)

Définit une variable de configuration

Parameters

array $key
mixed $value
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

add()

add(array  $key, mixed  $value, string  $array = null)

Ajoute un élément dans une variable de configuration

Parameters

array $key
mixed $value
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

setMany()

setMany(array  $key, array  $values, string  $array = null)

Ajoute plusieurs éléments dans une variable de configuration

Parameters

array $key
array $values
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

kill()

kill(string  $key, string  $array = null)

Efface une variable de configuration

Parameters

string $key
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

exists()

exists(string  $key, string  $array = null) : boolean

Test l'existence d'une variable de configuration

Parameters

string $key
string $array

nom de la variable globale qui sera parcourue en tant que tableau

Returns

boolean

exist()

exist(  $key, null  $array = null) : boolean

DEPRECATED

Parameters

$key
null $array

Returns

boolean

isEmpty()

isEmpty(string  $key, string  $array = null) : boolean

Test si une variable de configuration est vide

Parameters

string $key
string $array

nom de la variable globale qui sera parcourue en tant que tableau

Returns

boolean

save()

save(array  $key, string  $array = null)

Définit une variable de configuration en créant un historique

Parameters

array $key
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

rollback()

rollback(array  $key = null, string  $array = null)

Remonte l'historique des configurations

Parameters

array $key
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

getRollback()

getRollback(array  $key, string  $array = null) : array

Retourn l'historique des configurations

Parameters

array $key
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

Returns

array

setRollback()

setRollback(array  $key, mixed  $value, string  $array = null)

Enregistre l'historique des configurations

Parameters

array $key
mixed $value
string $array

nom de la variable globale qui sera utilisée/altérée en tant que tableau

sessGet()

sessGet(string  $key) : mixed

Récupère une variable de configuration

Parameters

string $key

Returns

mixed

sessSet()

sessSet(array  $key, mixed  $value)

Définit une variable de configuration

Parameters

array $key
mixed $value

sessAdd()

sessAdd(array  $key, mixed  $value)

Ajoute un élement dans une variable de configuration

Parameters

array $key
mixed $value

sessExist()

sessExist(string  $key) : boolean

Test l'existence d'une variable de session

Parameters

string $key

Returns

boolean

sessEmpty()

sessEmpty(string  $key) : boolean

Test si une variable de session est vide

Parameters

string $key

Returns

boolean

sessKill()

sessKill(string  $key) : boolean

Supprime une variable de session

Parameters

string $key

Returns

boolean

timerStart()

timerStart(string  $key)

Active un timer

Parameters

string $key

timerStop()

timerStop(string  $key)

Desactive un Timer

Parameters

string $key

timerSum()

timerSum(string  $key, boolean  $convert = true) : \number

Retourne le resultat du Timer

Parameters

string $key

identifiant du timer
boolean $convert

si true, retourne une valeur en ms

Returns

\number

counter()

counter(string  $key)

Retourne le Compteur

Parameters

string $key