API Documentation
\
Helper

\AcidVarList

Variante Liste d'AcidVar

Summary

Methods
Properties
Constants
__construct()
valIsEmpty()
upper()
lower()
treatVal()
getVal()
setVal()
setDef()
getDef()
setLabel()
getLabel()
setuppercase()
setlowercase()
setfunction()
setConfig()
setElts()
getElts()
validEntry()
setNullable()
isNullable()
getFormValOf()
getSqlValOf()
getForm()
setForm()
getEnumInstruction()
getVals()
No public properties found
No constants found
No protected methods found
$sql
$form
$config
$elts
$limiter
$use_index
$int_index
N/A
No private methods found
$_val
$_def
$_regex
$_label
$_is_nullable
N/A

Properties

$sql

$sql : array

Type

array — paramêtres SQL

$form

$form : array

Type

array — paramêtre formulaire

$config

$config : array

Type

array — configuration

$elts

$elts : array

Type

array — tableau représentatif des éléments de la liste

$limiter

$limiter : \strinf

Type

\strinf — délimiteur

$use_index

$use_index : \booelan

Type

\booelan — true si la valeur associée est une chaine

$int_index

$int_index : boolean|null|true

Type

boolean|null|true — true si l'index est un entier

$_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 = 'AcidVarList', array  $elts = array(), string  $def = '', boolean|false  $multiple = false, boolean|true  $use_index = true, integer  $size = 1, boolean|true  $int_index = true)

Constructeur AcidVarList

Parameters

string $label

Etiquette de la variable.
array $elts

Liste des éléments.
string $def

Valeur par défaut.
boolean|false $multiple

True si on autorise plusieurs valeurs sélectionnées en formulaire.
boolean|true $use_index

On utilise l'asso
integer $size

Taille du select dans le formulaire.
boolean|true $int_index

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

setVal()

setVal(mixed  $val) : boolean

Assigne un élément à la variable

Parameters

mixed $val

Returns

boolean

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

setConfig()

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

Attribue une nouvelle configuration à la variable.

Parameters

array $config
boolean $erase_before

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

getForm()

getForm(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

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

getEnumInstruction()

getEnumInstruction(array  $elts) : string

Retourne l'ensemble des valeurs du tableau en entrée sous forme de chaîne de caractères.

Parameters

array $elts

Returns

string

getVals()

getVals() : array

Retourne les valeurs de la liste sous forme d'un tableau

Returns

array