TBL_NAME
TBL_NAME
Classe de configuration du site
initVars(array $tab, boolean $eraseIfUndefined = false, boolean $allow_tbl_pref = true) : array
Attribut une valeur aux paramètre de l'objet s'ils sont renseignés dans le tableau en entrée Retourne un tableau reccueillant les paramètres réellement modifiés lors de la procédure Si $eraseIfUndefined est à true, alors les champs non renseignés dans le tableau en entrée seront initialisés à leur valeur par défaut.
| array | $tab | ([paramètre] => [valeurs]) |
| boolean | $eraseIfUndefined | |
| boolean | $allow_tbl_pref |
([paramètre])
splitTrad(string $key, string $length = 100, string $end = '...') : \Ambigous
Retourne la valeur traduite dans la langue courante associée à la clé en entrée tronquée
| string | $key | Nom du paramétre. |
| string | $length | Longueur max de la chaîne. |
| string | $end | Fin de la chaîne. |
<string, string, mixed>
getVarForm(string $key, boolean $print = true, array $attr = array(), string $start = '', string $stop = '') : mixed
Retourne le formulaire associé à la clé en entrée.
| string | $key | Nom du paramétre. |
| boolean | si false, utilise la valeur par défaut |
|
| array | $attr | attributs |
| string | $start | préfixe |
| string | $stop | suffixe |
dbInit(mixed $id) : boolean
Initialise la valeur des paramètre de l'objet en fonction des valeurs stockées en base de données Renvoie true en cas de réussite Si $id n'est pas trouvé en base de données, alors l'objet est initialisé avec ses valeurs par défaut, on renvoie alors false.
| mixed | $id | Valeur de l'identifiant. |
dbSave( $updates = 'all') : boolean
Met à jour la base de données avec les valeurs de l'objet Si pas encore présent en base, on ajoute l'élément sinon on le met à jour Si $updates est la chaîne de carractères "all", met à jour tous les champs Sinon, met à jour uniquement les champs renseignés par le tableau $updates
| $updates |
dbPrefSearchModule(string $key, array $mods = null) : string|\Ambigous
Retourne le module associé au nom de champs SQL saisi en entré si un résultat est trouvé
| string | $key | nom du champs |
| array | $mods | liste des modules à inspecter |
<boolean, unknown>
dbGenerateFilter(mixed $filter, string $combo = 'AND', boolean $add_aquote = true) : string
Génère une portion de code SQL (portion WHERE) en fonction des paramêtres en entrée
| mixed | $filter | [ code SQL | array(array('field1','operator','value'),array('field2','operator2','value2'),'codeSQL3') ] |
| string | $combo | opérateur à utiliser pour lier les différents filtres |
| boolean | $add_aquote | si true, ajoute les antiquote au nom des champs |
dbGenerateFrom(\{array} $tables = array(), string $join = 'LEFT JOIN', string $first_as = '') : array
Generère un filtre FROM
| \{array} | $tables | array( array('Table1',array('clé commune')) , array('Table2',array(array('clé tbl1','clé tbl2'))) ) |
| string | $join | Méthode de jointure |
| string | $first_as | Prefixe pour la table principale |
| int
dbSelList(mixed $select = '', $filter = '', $order = '', $limit = '', boolean $count = false, string $combo = 'AND', mixed $group_by = '') : array
Retourne tous les éléments de la table SQL associée à l'objet en fonction de la configuration renseignée par les paramètress en entrée Si $count a la valeur true, retourne seulement le nombre d'élements.
| mixed | $select | Commandes SQL de selection, array(array([Champs],[Fonction],[Prefixe],[Alias])) |
| $filter | ||
| $order | ||
| $limit | ||
| boolean | $count | Valeur par défaut : false ( ASC ) |
| string | $combo | Opérateur logique associant les éléments de $filter Valeur par défaut 'AND' |
| mixed | $group_by | Commandes SQL de group by |
| int
dbList( $filter = '', $order = '', $limit = '', boolean $count = false, string $combo = 'AND', mixed $group_by = '') : array
Retourne tous les éléments de la table SQL associée à l'objet en fonction de la configuration renseignée par les paramètress en entrée Si $count a la valeur true, retourne seulement le nombre d'élements.
| $filter | ||
| $order | ||
| $limit | ||
| boolean | $count | Valeur par défaut : false ( ASC ) |
| string | $combo | Opérateur logique associant les éléments de $filter Valeur par défaut 'AND' |
| mixed | $group_by | Commandes SQL de group by |
| int
dbListMods(array $mods = array(), $filter = '', $order = '', $limit = '', boolean $count = false, string $combo = 'AND', mixed $group_by = '') : array
Retourne tous les éléments de la table SQL associée à l'objet en fonction de la configuration renseignée par les paramètress en entrée Si $count a la valeur true, retourne seulement le nombre d'élements.
| array | $mods | array('Module1'=>array('key1'),'Module2'=>array(array('keymod','keymod2')),'Module3'=>'str') |
| $filter | ||
| $order | ||
| $limit | ||
| boolean | $count | Valeur par défaut : false ( ASC ) |
| string | $combo | Opérateur logique associant les éléments de $filter Valeur par défaut 'AND' |
| mixed | $group_by | Commandes SQL de group by |
| int
dbExecuteRemove(mixed $filter = '', mixed $combo = 'AND') : \number
Generère une portion de code SQL (DELETE FROM) en fonction des paramètres en entrée
| mixed | $filter | Commandes SQL de filtrage, array(arrays([Champs],[Opérateurs],[Valeurs])) |
| mixed | $combo | Opérateur logique associant les éléments de $filter Valeur par défaut 'AND' |
dbCount( $filter = '', string $combo = 'AND') : integer
Retourne le nombre d'élements de la table SQL associée à l'objet en fonction de la configuration renseignée par les paramètress en entrée.
| $filter | ||
| string | $combo | Opérateur logique associant les éléments de $filter Valeur par défaut 'AND' |
dbJoinedList(array $mod_elts, array $mod_rel, $filter = '', $order = '', $limit = '', string $combo = "AND", boolean $count = false) : array
Joint plusieures tables Retourne tous les éléments de la table SQL associée à l'objet en fonction de la configuration renseignée par les paramètresss en entrée Si $count a la valeur true, retourne seulement le nombre d'élements.
| array | $mod_elts | Liste des champs prélevés array( string{ [nom table] | [nom table/alias] } => string|array [champs prélevés] ) |
| array | $mod_rel | Liste des relations array( string [alias table] => array( [alias1]=>[champ1],[alias2]=>[champs2] ) ) |
| $filter | ||
| $order | ||
| $limit | ||
| string | $combo | Opérateur logique associant les éléments de $filter Valeur par défaut 'AND' |
| boolean | $count | Valeur par défaut : false ( ASC ) |
| int
dbJoinedCount(\unknown_type $mods, \unknown_type $join, \unknown_type $filter = '', \unknown_type $combo = 'AND') : \Ambigous
Joint plusieures tables Retourne le nombre d'éléments de la table SQL associée à l'objet en fonction de la configuration renseignée par les paramètress en entrée
| \unknown_type | $mods | |
| \unknown_type | $join | |
| \unknown_type | $filter | |
| \unknown_type | $combo |
<multitype:, mixed>
dbInitSearch(array $tab, boolean $limit = false, array $order = array()) : boolean
Initialise l'objet unique correspondant aux contraintes renseignées par le tableau en entrée Renvoi true en cas de succés, false sinon.
| array | $tab | |
| boolean | $limit | si vrai, retourne le premier élément parmis ceux trouvés, sinon retourne une valeur que si cette dernière est unique |
| array | $order |
genUrlKey(string $key, string $url = null, string $format = null, null $cache_time = null) : string
Formate l'url en fonction de l'AcidVar de la clé saisi en entrée
| string | $key | nom du paramètre |
| string | $url | pour forcer l'url |
| string | $format | format à appliquer à l'url |
| null | $cache_time | cachetime à ajouter en paramètre |
postACL(string $do, array $vals) : array|boolean
Définit les droits d'accés de l'utilisateur sur les éléments renseignés en entrée Retourne un tableau avec uniquement les éléments dont l'accés est autorisé, ou false si l'utilisateur n'a aucun droit.
| string | $do | |
| array | $vals |
getUserPermission(string $do = null, string $type = null, integer $id_user = null) : string
Recupère les permissions de l'utilisateur sur le module
| string | $do | l'action associée; default : tous |
| string | $type | type de permission (id_group, id_user, level) |
| integer | $id_user | identifiant utilisateur |
getIconLink(string $link = null, string $image = null, string $title = 'bouton', string $click = null, string $tpl = null) : string
Retourne une portion HTML correspondant aux boutons de modération de l'administration d'AcidFarm
| string | $link | Url du bouton. |
| string | $image | Url de l'icone. |
| string | $title | Titre / Alt de l'image. |
| string | $click | Evènment Onclick. |
| string | $tpl | Chemin vers le fichier tpl. |
buildAdminOnglets(array $name, array $builder = array(), array $excluder = array(), string $key = null, string $src = null) : array
Retourne un tableau représentant un onglet
| array | $name | Intitulé de l'onglet |
| array | $builder | Composantes qui définissent l'url |
| array | $excluder | Clés exclues de l'url |
| string | $key | Clés associée à l'onglet |
| string | $src | Url source |
getStandardActionTab(mixed $elt, array $config = array('print', 'update', 'delete')) : string
Retourne un tableau de configuration "standard" des boutons de modérations de l'administration AcidFarm
| mixed | $elt | L'élement à contrôler |
| array | $config | Tableau de filtrage / rangement des boutons de modérations |
getAssoc(string $key_val = null, string $key_index = null, string $hsc_if_value = true, string $order = array(), string $filter = array()) : array
Renvoie un tableau associatif des données en basse poru ce module avec pour couple clé => valeur, le nom de champs du module passé en argument. Si les deux champs sont vides, cette méthode ira voir la présence de config['assoc:index'] && config['assoc:value'] qui devront être renseigné dans le module correspondant.
| string | $key_val | Le nom du champ du module qui doit servir de valeur pour le tableau associatif (ex: title) |
| string | $key_index | Le nom du champ du module qui doit servir de clé pour le tableau associatif (ex: id_module) |
| string | $hsc_if_value | |
| string | $order | |
| string | $filter |
Le tableau associatif
sortByKey(array $tab, string $key_index = null, string $key_value = null, boolean $force_unique = true, boolean $hsc_if_value = true) : \Ambigous
Tri un tableau associatif des données avec pour clé la valeur en entrée
| array | $tab | tableau |
| string | $key_index | Le nom du champ du module qui doit servir de clé pour le tableau associatif (ex: id_module) |
| string | $key_value | Le nom du champ du module qui doit servir de valeur pour le tableau associatif (ex: title) |
| boolean | $force_unique | |
| boolean | $hsc_if_value |
<multitype:multitype: unknown , unknown, string>
printAdminBody(string $content, array $onglets = array(), string $title = null, array $title_attr = null) : string
Retourne une portion HTML representant le corps de l'administration AcidFarm
| string | $content | Le contenu à insérer |
| array | $onglets | La configuration des onglets |
| string | $title | Le titre |
| array | $title_attr | La configuration du titre |
callFunction(mixed $cuf, array $cup = array()) : array
Execute une fonction prédéfinie par l'utilisateur avec la gestion des methodes de $this
| mixed | $cuf | Paramètre 1 de la function call_user_func_array de PHP Il est possible de lui renseigner $=>'true' en troisieme paramètre pour utiliser ${$cuf[0]} en entête de fonction |
| array | $cup | Paramètre 2 de la function call_user_func_array de PHP |
printAdminListBody(\unknown_type $content, \unknown_type $infos, \unknown_type $nav, \unknown_type $conf = array()) : string
Génère le corps du listing d'administration du module sous forme d'une chaîne de caractères.
| \unknown_type | $content | Contenu |
| \unknown_type | $infos | Les ibfos |
| \unknown_type | $nav | La nav |
| \unknown_type | $conf | Configuration |
getAdminListParams(integer $nb_elts, array $conf = array()) : array
Retourne les paramètrages du listing
| integer | $nb_elts | le nombre d'éléments trouvés par lors de l'execution de la recherche |
| array | $conf | Configuration |
list( nombre maxi d'éléments par page , limite d'affichage, page courante, pagination )
printAdminListInfo(integer $nb_elts, integer $page, integer $ll, boolean $hide_filter_ind, array $conf = array()) : array
Retourne une portion HTML mettant en forme des indications relatives au listing
| integer | $nb_elts | le nombre d'éléments trouvés par lors de l'execution de la recherche |
| integer | $page | page courante |
| integer | $ll | nombre maxi d'éléments par page |
| boolean | $hide_filter_ind | true si on affiche la gestion des filtres |
| array | $conf | Configuration |
list( nombre maxi d'éléments par page , limite d'affichage, page courante, pagination )
exportCSV(mixed $filter = '', array $fields = array(), array $config = null, boolean $label = false, boolean $printed = true) : \AcidCSV
Retourne un AcidCSV correspondant au module
| mixed | $filter | filtre à appliquer sue le dbList |
| array | $fields | les champs à mettre dans le CSV |
| array | $config | la configuration array(delimiter,enclosure,espace) |
| boolean | $label | utilise getLabel pour le nom des colonnes |
| boolean | $printed | utilise getPrined pour l'affichage des valeurs (attention, printAdminConfigureCSV ré-initialise $this->config) |
checkKey( $key, $tab, string $do = '', null $error_msg = null) : boolean|null
Validation de champs
| $key | ||
| $tab | ||
| string | $do | |
| null | $error_msg | alimente $error_msg avec un message d'erreur personnalisé si besoin |
retourne null si la clé est manquante, false si c'est une mauvaise valeur, true si ok