API Documentation
\
Helper

\AcidVarImage

Variante Image d'AcidVar

Summary

Methods
Properties
Constants
__construct()
getPath()
getValPath()
getFileName()
getUrl()
buildUrl()
generateUrl()
initVal()
isAValidFile()
isAValidExt()
setExt()
fsRemove()
uploadProcess()
getParentForm()
getForm()
getConfig()
setConfig()
getDirPath()
setDirPath()
setVal()
bbcode()
stripbbcode()
split()
entityTranslator()
valIsEmpty()
upper()
lower()
treatVal()
getVal()
setDef()
getDef()
setLabel()
getLabel()
setuppercase()
setlowercase()
setfunction()
setElts()
getElts()
validEntry()
setNullable()
isNullable()
getFormValOf()
getSqlValOf()
setForm()
applySuffix()
getSuffix()
imgResize()
regen()
effectProcess()
$dir_path
No constants found
setUrl()
fsAdd()
formatProcess()
$config
$sql
$form
$elts
N/A
No private methods found
$_val
$_def
$_regex
$_label
$_is_nullable
N/A

Properties

$dir_path

$dir_path : string

Type

string — chemin vers le repertoire de stockage du fichier

$config

$config : array

Type

array — configuration

$sql

$sql : array

Type

array — paramêtres SQL

$form

$form : array

Type

array — paramêtre formulaire

$elts

$elts : array

Type

array — éléments associés

$_val

$_val : mixed

Type

mixed — valeur

$_def

$_def : mixed

Type

mixed — valeur par défaut

$_regex

$_regex : string

Type

string — expression régulière de validation

$_label

$_label : string

Type

string — étiquette

$_is_nullable

$_is_nullable : boolean

Type

boolean — is_nullable

Methods

__construct()

__construct(string  $label = 'AcidVarImage', string  $folder = null, array  $config = array(), string  $name = '')

Constructeur AcidVarImage

Parameters

string $label

étiquette
string $folder

chemin vers le repertoire de stockage du fichier
array $config

configuration
string $name

nom du fichier (variables magiques : NAME, ID )

getPath()

getPath(string  $format = 'src') : string

Retourne le chemin d'accès au fichier.

Parameters

string $format

Dérivé du fichier cible. Valeur par Défaut : NULL

Returns

string

getValPath()

getValPath(string  $format = 'src') : string

Retourne le chemin d'accès au fichier.

Parameters

string $format

Dérivé du fichier cible. Valeur par Défaut : NULL

Returns

string

getFileName()

getFileName() : string

Retourne le chemin d'accès au fichier.

Returns

string

getUrl()

getUrl(string  $format = 'src') : string

Retourne l'url d'une image du module ou de son derivé.

Parameters

string $format

Derivé de l'image. Valeur par défaut : NULL

Returns

string

buildUrl()

buildUrl(string  $id, string  $ext, string  $filename = null)

Génère l'URL du fichier.

Parameters

string $id
string $ext
string $filename

generateUrl()

generateUrl(string  $id, string  $ext, string  $filename = null)

Retourne l'URL du fichier.

Parameters

string $id
string $ext
string $filename

initVal()

initVal(integer  $id, string  $ext, string  $filename = null)

Initialise l'url du fichier

Parameters

integer $id
string $ext
string $filename

isAValidFile()

isAValidFile(string  $file_path) : boolean

Retourne true si le fichier renseigné en entrée est interprété comme valide, retourne false sinon.

Parameters

string $file_path

Returns

boolean

isAValidExt()

isAValidExt(string  $ext, array  $t_exts = null) : boolean

Retourne true si l'exention renseignée en entrée est interprétée comme valide, retourne false sinon.

Parameters

string $ext
array $t_exts

tableau d'extensions, par défaut $this->config['ext'], si false alors on accepte tout

Returns

boolean

setExt()

setExt(\unknown_type  $exts)

Mets à jour les extensions autorisées

Parameters

\unknown_type $exts

fsRemove()

fsRemove() : boolean

Supprime le fichier associé au module.

Returns

boolean

uploadProcess()

uploadProcess(integer  $id, string  $key, string  $filename = null, array  $tfiles = null, array  $tpost = null) : boolean

Traite la procédure de chargement d'un fichier.

Parameters

integer $id

identifiant
string $key

paramêtre
string $filename

variable de récupération du nom de fichier
array $tfiles

Equivalent $_FILES
array $tpost

$_POST

Returns

boolean

getParentForm()

getParentForm(object  $form, string  $key, boolean  $print = true, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Rajoute la variable au formulaire en entrée.

Parameters

object $form

AcidForm
string $key

Nom du paramétre.
boolean $print

si false, utilise la valeur par défaut
array $params

attributs
string $start

préfixe
string $stop

suffixe
array $body_attrs

attributs à appliquer au cadre

getForm()

getForm(object  $form, string  $key, boolean  $print = true, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array()) : string

Rajoute la variable au formulaire en entrée.

Parameters

object $form

AcidForm
string $key

Nom du paramétre.
boolean $print

si false, utilise la valeur par défaut
array $params

attributs
string $start

préfixe
string $stop

suffixe
array $body_attrs

attributs à appliquer au cadre

Returns

string

getConfig()

getConfig(string  $key = null) : mixed

Recupère la configuration de l'objet

Parameters

string $key

Returns

mixed

setConfig()

setConfig(array  $config, boolean  $erase_before = false)

Attribue une nouvelle configuration à la variable.

Parameters

array $config
boolean $erase_before

getDirPath()

getDirPath() : mixed

Recupère le dir_path de l'objet

Returns

mixed

setDirPath()

setDirPath(string  $path) : mixed

Modifie la dir_path de l'objet

Parameters

string $path

Returns

mixed

setVal()

setVal(mixed  $val) : boolean

Assigne une valeur à la variable.

Parameters

mixed $val

Returns

boolean

bbcode()

bbcode(string  $text) : string

Convertit une chaîne de caractères typée bbcode au format html.

Parameters

string $text

Returns

string

stripbbcode()

stripbbcode(string  $text) : string

Convertit une chaîne de caractères typée bbcode au format texte.

Parameters

string $text

Returns

string

split()

split(string  $string, integer  $length, string  $end = ' ...') : string

Abrège une chaîne de caractères.

Parameters

string $string

Chaîne en entrée.
integer $length

Longueur de la chaîne en sortie sans son suffixe.
string $end

Suffixe de la chaîne en sortie.

Returns

string

entityTranslator()

entityTranslator() : \array()

Retourne un tableau de conversion de caractères spéciaux

Returns

\array()

valIsEmpty()

valIsEmpty(  $val) : boolean

Retourne true si la valeur est considérée vide pour ce type de variable

Parameters

$val

Returns

boolean

upper()

upper(string  $val, string  $encode = 'UTF-8') : string

Force en Majuscule les valeurs en entrée

Parameters

string $val
string $encode

Returns

string

lower()

lower(string  $val, string  $encode = 'UTF-8') : string

Force en Minuscule les valeurs en entrée

Parameters

string $val
string $encode

Returns

string

treatVal()

treatVal(mixed  $val, mixed  $way = null) : mixed

Traite les valeurs en entrée selon la configuration de l'objet

Parameters

mixed $val
mixed $way

Returns

mixed

getVal()

getVal()

Retourne la valeur de la variable.

return mixed

setDef()

setDef()

Attribue sa valeur par défaut à la variable.

getDef()

getDef() : mixed

Retourne la valeur par défaut de la variable.

Returns

mixed

setLabel()

setLabel(string  $label)

Assigne une étiquette à la variable.

Parameters

string $label

getLabel()

getLabel() : string

Retourne l'étiquette de la variable.

Returns

string

setuppercase()

setuppercase(boolean  $value = true)

Assigne le paramêtre uppercase de la variable

Parameters

boolean $value

setlowercase()

setlowercase(boolean  $value = true)

Assigne le paramêtre uppercase de la variable

Parameters

boolean $value

setfunction()

setfunction(boolean  $value = false)

Assigne le paramêtre fonction de la variable

Parameters

boolean $value

setElts()

setElts(array  $elts, boolean  $erase_before = true)

Attribue de nouveaux éléments à la variable.

Parameters

array $elts
boolean $erase_before

getElts()

getElts()

Retourne les éléments de la variable.

validEntry()

validEntry(mixed  $val) : boolean

Teste l'éligibilité d'une valeur par la variable.

Parameters

mixed $val

Returns

boolean

setNullable()

setNullable(boolean  $bool)

Définit si la variable est à l'état NULL ou non.

Parameters

boolean $bool

isNullable()

isNullable()

retourne si la variable est nullable.

getFormValOf()

getFormValOf(  $key) : mixed

Retourne le paramètre de "configuration Formulaire" de la variable qui est renseigné en entrée.

Parameters

$key

Returns

mixed

getSqlValOf()

getSqlValOf(  $key) : boolean

Retourne le paramètre de "configuration SQL" de la variable qui est renseigné en entrée S'il n'est pas défini, renvoie false

Parameters

$key

Returns

boolean —

| mixed

setForm()

setForm(string  $type, array  $config = array())

Change le type de formulaire associé à la variable

Parameters

string $type

(hidden,text,password,textarea,file,select,radio,checkbox,free,...)
array $config

configuration

applySuffix()

applySuffix(string  $str, string  $suffix) : string

Retourne le nom de fichier en entrée après lui avoir appliqué le suffixe

Parameters

string $str

le fichier
string $suffix

le suffixe

Returns

string

getSuffix()

getSuffix(string  $format = 'src')

Retourne le suffixe à intégrer aux images en fonction du format en entrée

Parameters

string $format

Derivé de l'image. Valeur par défaut : NULL

imgResize()

imgResize(string  $format)

Génère un dérivé $format de l'image du module renseignée par $img.

Parameters

string $format

regen()

regen(array  $format_filter = null)

regénère les formats donnés

Parameters

array $format_filter

effectProcess()

effectProcess(string  $effect, string  $format)

Applique un effet choisi sur la format renseigné en entrée

Parameters

string $effect
string $format

setUrl()

setUrl(integer  $id, string  $ext, string  $filename = null)

Attribue son URL au fichier.

Parameters

integer $id
string $ext
string $filename

fsAdd()

fsAdd(string  $tmp_path, string  $final_path, boolean  $uploaded_file = true) : boolean

Déplace le fichier en $tmp_path vers le $final_path et configure ses droits d'accès.

Parameters

string $tmp_path
string $final_path
boolean $uploaded_file

Returns

boolean

formatProcess()

formatProcess(array  $format_filter = null)

Traite le processus de création/mise à jour des différents formats.

Parameters

array $format_filter