\UserGroupAssoc

Gère l'association Utilisateur/Groupe d'utilisateur

Summary

Methods
Properties
Constants
__construct()
__callStatic()
checkTbl()
tbl()
tblJoin()
tblMods()
checkTblId()
tblId()
getClass()
build()
current()
currentChange()
curValue()
isSame()
preKey()
langKey()
langKeyDecline()
initVars()
getVals()
getPublicVals()
getPrivateVals()
debug()
modTrad()
get()
trad()
split()
splitTrad()
hscTrad()
getKeys()
getMultiLingualKeys()
getVarOptions()
getVarForm()
getVarFormType()
getVar()
getId()
hsc()
getLabel()
cleanVars()
arrayToObjects()
dbInit()
dbAdd()
dbUpdate()
dbSave()
dbRemove()
dbPref()
dbPrefRemove()
dbPrefSearchModule()
dbGenerateFilter()
dbGenerateOrderByField()
dbGenerateOrder()
dbGenerateLimit()
dbGenerateGroupBy()
dbGenerateSelect()
dbGenerateFrom()
dbSelList()
dbList()
dbListMods()
dbExecuteRemove()
dbCount()
dbJoinedList()
dbJoinedCount()
convJoinedFilter()
dbInitSearch()
dbNextId()
cacheTimeKey()
getCacheTime()
updateCacheTime()
genUrlKey()
getUrlKey()
regenImagesKey()
regenAll()
exeUploadKey()
getVarsByType()
getVarsFiles()
getVarsImages()
getUploadVars()
postConfigure()
postSuccess()
postAdd()
postUpdate()
postRemove()
getUserAccess()
getACL()
getACLKeys()
postACL()
setPermission()
getPermissions()
getPostDo()
getGetDo()
getValsDo()
getUserPermission()
checkLabel()
exePost()
exePostProcess()
treatAjax()
restGet()
restList()
sessionMake()
getConfig()
setConfig()
cloneConfig()
addToConfig()
hasConfig()
initForm()
adminNav()
extendAdminNav()
getAdminCurNav()
getAdminTitle()
getAdminTitleAttr()
getIconLink()
buildAdminOnglets()
getStandardOnglets()
getOnglets()
getDefaultDo()
getDisableAction()
getDialogDo()
getDialogMessage()
getStandardActionPrint()
getStandardActionUpdate()
getStandardActionDelete()
checkActionTabCondition()
getStandardActionTab()
printAdminActionTab()
getAdminTh()
getAdminTd()
getAdminTr()
getAssoc()
sortByKey()
printAdminTab()
isSelectedOnglet()
printAdminOnglets()
printAdminBody()
exeAdminController()
addAdminOnglets()
printAdminInterface()
callFunction()
getAdminListOptions()
printAdminList()
printAdminListBody()
printAdminListHeadBtn()
genAdminListHeadFilter()
genAdminListHead()
genAdminListLine()
genAdminListAction()
genAdminListFormat()
genAdminListLineCustomClass()
genAdminListContent()
getAdminTpl()
getAdminListMods()
getAdminListCombo()
getAdminListGroupBy()
getAdminListLd()
getAdminListParams()
printAdminListInfo()
printAdminConfigure()
printAdminConfigureCSV()
printAdminAdd()
printAdminUpdate()
printAdminFormStart()
printAdminFormStop()
printAdminFormSubmit()
printAdminForm()
printAdminFlags()
printAdminElt()
printAdminSearch()
printFormToggle()
printFormQuickChange()
exportCSV()
getPrintedAssoc()
getPrinted()
synchronize()
No public properties found
TBL_NAME
TBL_PRIMARY
getControlledKeys()
checkVals()
checkKey()
removeGet()
printAdminAddForm()
printAdminUpdateForm()
$vars
$config
$private_keys
N/A
No private methods found
No private properties found
N/A

Constants

TBL_NAME

TBL_NAME

TBL_PRIMARY

TBL_PRIMARY

Properties

$vars

$vars : object

Type

object — les différents champs sous forme d'AcidVar

$config

$config : array

Type

array — tableau de configuration du module

$private_keys

$private_keys : array

Type

array — liste des clés considérées comme privées

Methods

__construct()

__construct(mixed  $init_id = null) 

Constructeur

Parameters

mixed $init_id

__callStatic()

__callStatic(\unknown_type  $chrMethod, \unknown_type  $arrArguments) : mixed

Appel static

Parameters

\unknown_type $chrMethod
\unknown_type $arrArguments

Returns

mixed

checkTbl()

checkTbl() : boolean|string

Verifie que le module dispose bien d'une constante TBL_NAME et retourne le nom de la table SQL dont il fait référence

Returns

boolean|string

tbl()

tbl() : string

Retourne le nom de la table SQL associé au module.

Returns

string

tblJoin()

tblJoin() : string

Retourne le nom de la table SQL associé au module pour les jointures.

Méthode prévue pour override

Returns

string

tblMods()

tblMods(  $module) : string

Retourne le nom de la table SQL associé au module pour le dbListMods.

Méthode prévue pour override

Parameters

$module

Returns

string

checkTblId()

checkTblId() : string

Contrôle puis retourne le nom de la table SQL associé au module sans préfixe.

Returns

string

tblId()

tblId() : string

Retourne le nom du champs identifiant en base de données.

Returns

string

getClass()

getClass() : string

Retourne la classe courante.

Returns

string

build()

build(mixed  $elts = null) : string

Retourne un nouvel objet module

Parameters

mixed $elts

initialisateur de module

Returns

string

current()

current() : string

Retourne le module en session

Returns

string

currentChange()

currentChange(  $values = array()) : string

Sauvegarde le module en session

Parameters

$values

tableau contenant les nouvelles valeurs du module

Returns

string

curValue()

curValue(string  $key, string  $def = null) : mixed

Retourne une valeur du module en session

Parameters

string $key

identifiant de la variable

string $def

valeur à retourner en cas d'échec

Returns

mixed

isSame()

isSame(integer  $id) : string

Compare l'id soumis avec celui en session

Parameters

integer $id

Returns

string

preKey()

preKey(string  $next = '') : string

Retourne le nom de la table en base de données.

Parameters

string $next

suffixe à intégrer à la valeur de retour

Returns

string

langKey()

langKey(string  $key, string  $lang = null) : string

Retourne le nom d'un champ avec le suffixe de langue s'il existe

Parameters

string $key

la clé

string $lang

la langue à utiliser

Returns

string

langKeyDecline()

langKeyDecline(string  $key, string  $langs = null) : string

Retourne le nom d'un champ avec le suffixe de langue s'il existe

Parameters

string $key

la clé

string $langs

les langues à utiliser

Returns

string

initVars()

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.

Parameters

array $tab

([paramètre] => [valeurs])

boolean $eraseIfUndefined
boolean $allow_tbl_pref

Returns

array —

([paramètre])

getVals()

getVals(array  $filter = null) : array

Retourne un tableau accueillant les paramètres de l'objet associés à leurs valeurs.

Parameters

array $filter

liste des clés autorisées à la sortie

Returns

array —

([paramètre] => [valeurs])

getPublicVals()

getPublicVals() : array

Retourne un tableau accueillant les paramètres considérés publiques de l'objet associés à leurs valeurs.

Returns

array

getPrivateVals()

getPrivateVals() : array

Retourne un tableau accueillant les paramètres considérés privés de l'objet associés à leurs valeurs.

Returns

array

debug()

debug() : string

Liste les paramètres de l'objet ainsi que leurs valeurs sous forme d'une chaîne de caractères mise en forme.

Returns

string

modTrad()

modTrad(string  $val) : mixed

Retourne la traduction dans la langue courante de la clé renseignée en entrée.

Parameters

string $val

Nom du paramétre.

Returns

mixed

get()

get(string  $key) : mixed

Retourne la valeur du paramétre renseigné en entrée.

Parameters

string $key

Nom du paramétre.

Returns

mixed

trad()

trad(string  $key) : mixed

Retourne la valeur associée à la clé renségnée et relative à la langue courante.

Parameters

string $key

Nom du paramétre.

Returns

mixed

split()

split(string  $key,   $length = 100,   $end = '...', boolean  $trad = false) : string

Retourne la valeur associée à la clé en entrée tronquée

Parameters

string $key

Nom du paramétre.

$length
$end
boolean $trad

si true, alors split la valeur traduite

Returns

string

splitTrad()

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

Parameters

string $key

Nom du paramétre.

string $length

Longueur max de la chaîne.

string $end

Fin de la chaîne.

Returns

\Ambigous —

<string, string, mixed>

hscTrad()

hscTrad(string  $key) : mixed

Alias : htmlspecialchars de la fonction getTrad($key)

Parameters

string $key

Nom du paramétre.

Returns

mixed

getKeys()

getKeys(boolean  $add_tbl = false) : array

Retourne un tableau accueillant le nom de chaque paramétre de l'objet.

Parameters

boolean $add_tbl

si true, les champs seront prefixés par le nom de table SQL du module

Returns

array —

[paramètre]

getMultiLingualKeys()

getMultiLingualKeys() : \multitype:unknown

Retourne un tableau de clés reconnues comme clés de traduction

Returns

\multitype:unknown

getVarOptions()

getVarOptions(string  $key) : mixed

Retourne un tableau accueillant les différentes valeurs du paramétre multi-valeurs (select, radio) renseigné en entrée.

Parameters

string $key

Nom du paramétre.

Returns

mixed

getVarForm()

getVarForm(string  $key, boolean  $print = true, array  $attr = array(), string  $start = '', string  $stop = '') : mixed

Retourne le formulaire associé à la clé en entrée.

Parameters

string $key

Nom du paramétre.

boolean $print

si false, utilise la valeur par défaut

array $attr

attributs

string $start

préfixe

string $stop

suffixe

Returns

mixed

getVarFormType()

getVarFormType(string  $key) : string

Retourne le type de form associé à la clé en entrée.

Parameters

string $key

Nom du paramétre.

Returns

string

getVar()

getVar(string  $key) : string

Retourne l'AcidVar associé à la clé en entrée.

Parameters

string $key

Nom du paramétre.

Returns

string

getId()

getId() : array

Retourne la valeur de l'identifiant de l'objet.

Returns

array

hsc()

hsc(string  $key) : string

Retourne la valeur du paramétre renseigné en entrée, aprés l'avoir soumise à la fonction htmlspecialchars.

Parameters

string $key

Returns

string

getLabel()

getLabel(string  $key) : string

Retourne l'étiquette du paramétre renseigné en entrée.

Parameters

string $key

Returns

string

cleanVars()

cleanVars() 

Attribue leur valeur par défaut à tous les paramètres de l'objet.

arrayToObjects()

arrayToObjects(  $tab) 

Transforme un tableau de valeur en tableau d'object

Parameters

$tab

dbInit()

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.

Parameters

mixed $id

Valeur de l'identifiant.

Returns

boolean

dbAdd()

dbAdd() : integer

Enregistre l'objet dans la table SQL qui lui est associée Renvoie la valeur de son identifiant en cas de réussite, renvoie false sinon.

Returns

integer —

| bool

dbUpdate()

dbUpdate(  $updates) : boolean

Met à jour la base de données avec les valeurs de l'objet 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

Parameters

$updates

Returns

boolean

dbSave()

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

Parameters

$updates

Returns

boolean

dbRemove()

dbRemove(mixed  $id = null) 

Supprime l'enregistrement de l'objet d'identifiant $id de la base de données.

Parameters

mixed $id

dbPref()

dbPref(string  $value, string  $prefix = null) : string|\unknown

Retourne le champ SQL entré prefixé du nom de table associé au module

Parameters

string $value
string $prefix

si défini, la valeur sera utilisée comme préfixe

Returns

string|\unknown

dbPrefRemove()

dbPrefRemove(string  $key) : string|\unknown

Supprime le nom de table du nom de champs SQL saisi en entré

Parameters

string $key

nom du champs SQL

Returns

string|\unknown

dbPrefSearchModule()

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é

Parameters

string $key

nom du champs

array $mods

liste des modules à inspecter

Returns

string|\Ambigous —

<boolean, unknown>

dbGenerateFilter()

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

Parameters

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

Returns

string

dbGenerateOrderByField()

dbGenerateOrderByField(array  $tab, string  $way = 'ASC', boolean  $add_quote = true) 

Génère un tableau d'ordre en fonction du tableau

Parameters

array $tab
string $way
boolean $add_quote

dbGenerateOrder()

dbGenerateOrder(mixed  $order,   $add_aquote = true) : string

Génère une portion de code SQL (portion ORDER BY) en fonction des paramêtres en entrée

Parameters

mixed $order

[SQL CODE | array('field1'=>'ASC|DESC','field2'=>'ASC|DESC')]

$add_aquote

Returns

string

dbGenerateLimit()

dbGenerateLimit(string  $limit) : string

Génère une portion de code SQL (portion LIMIT ) en fonction des paramêtres en entrée

Parameters

string $limit

la limite

Returns

string

dbGenerateGroupBy()

dbGenerateGroupBy(array  $fields = array()) : string

Génère une portion de code SQL (portion GROUP BY ) en fonction des paramêtres en entrée

Parameters

array $fields

liste des champss

Returns

string

dbGenerateSelect()

dbGenerateSelect(mixed  $select = '') : string

Génère une portion de code SQL (portion SELECT ) en fonction des paramêtres en entrée

Parameters

mixed $select

[SQL Code | array(array(key,func,pref,as),array(key2,func2,pref2,as2))]

Returns

string

dbGenerateFrom()

dbGenerateFrom(\{array}  $tables = array(), string  $join = 'LEFT JOIN', string  $first_as = '') : array

Generère un filtre FROM

Parameters

\{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

Returns

array —

| int

dbSelList()

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.

Parameters

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

Returns

array —

| int

dbList()

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.

Parameters

$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

Returns

array —

| int

dbListMods()

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.

Parameters

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

Returns

array —

| int

dbExecuteRemove()

dbExecuteRemove(mixed  $filter = '', mixed  $combo = 'AND') : \number

Generère une portion de code SQL (DELETE FROM) en fonction des paramètres en entrée

Parameters

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'

Returns

\number

dbCount()

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.

Parameters

$filter
string $combo

Opérateur logique associant les éléments de $filter Valeur par défaut 'AND'

Returns

integer

dbJoinedList()

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.

Parameters

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 )

Returns

array —

| int

dbJoinedCount()

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

Parameters

\unknown_type $mods
\unknown_type $join
\unknown_type $filter
\unknown_type $combo

Returns

\Ambigous —

<multitype:, mixed>

convJoinedFilter()

convJoinedFilter(array  $filter) : array

Simplifie le tableau en entrée

Parameters

array $filter

Returns

array

dbInitSearch()

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.

Parameters

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

Returns

boolean

dbNextId()

dbNextId() : string

Recupére la valeur du prochain identifiant de la table SQL associé à l'objet.

Returns

string

cacheTimeKey()

cacheTimeKey() 

Retourne le nom de la variable correspondant au cache time

getCacheTime()

getCacheTime(string  $force = null) 

Retourne un timestamp de référence pour le cache

Parameters

string $force

force une valeur à time() si aucune configuration

updateCacheTime()

updateCacheTime(string  $value = null) 

Met à jour la variable cache time

Parameters

string $value

si non définie, retroune time()

genUrlKey()

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

Parameters

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

Returns

string

getUrlKey()

getUrlKey(string  $key, string  $format = null) 

Retourne l'url associé à l'AcidVar de la clé saisi en entrée

Parameters

string $key
string $format

regenImagesKey()

regenImagesKey(string  $key, array  $format_filter = null) : boolean

Regénère les images associées à l'AcidVar de la clé saisi en entrée

Parameters

string $key

nom du paramètre

array $format_filter

liste des formats à traiter

Returns

boolean

regenAll()

regenAll(array  $keys = null) : \multitype:unknown

Regénère toutes les images associées au module

Parameters

array $keys

liste des paramètres à traiter

Returns

\multitype:unknown

exeUploadKey()

exeUploadKey(string  $key, string  $val, string  $name = null) 

Lance le processus d'upload pour la clé en entrée

Parameters

string $key

clé du fichier

string $val

chemin vers le fichier

string $name

nom du fichier

getVarsByType()

getVarsByType(array  $types) : \multitype:unknown

Retourne la liste des clés du modules étant du type saisi en entrée

Parameters

array $types

liste des types acceptés

Returns

\multitype:unknown

getVarsFiles()

getVarsFiles() : \Ambigous

Retourne la liste des clés "fichier" du modules

Returns

\Ambigous —

<multitype:unknown, multitype:unknown >

getVarsImages()

getVarsImages() : \Ambigous

Retourne la liste des clés "images" du modules

Returns

\Ambigous —

<multitype:unknown, multitype:unknown >

getUploadVars()

getUploadVars() : \Ambigous

Retourne la liste des clés "nécéssitant un upload" du modules

Returns

\Ambigous —

<multitype:unknown, multitype:unknown >

postConfigure()

postConfigure(array  $vals = array(), string  $do = null, array  $config = null) 

Préparation du module pour le processus POST

Parameters

array $vals

les valeurs à traiter

string $do

le type d'action effectué

array $config

postSuccess()

postSuccess(array  $vals = array(), string  $do = null) : boolean

Traitement lors du succès d'un processus POST

Parameters

array $vals

les valeurs à traiter

string $do

le type d'action effectué

Returns

boolean

postAdd()

postAdd(array  $vals, mixed  $dialog = null) : object

Traite la procédure d'ajout d'élément depuis un formulaire.

Parameters

array $vals
mixed $dialog

Returns

object —

| bool

postUpdate()

postUpdate(array  $vals, mixed  $dialog = null) : object

Traite la procédure de mise à jour d'un élément depuis un formulaire.

Parameters

array $vals
mixed $dialog

Returns

object —

| bool

postRemove()

postRemove(mixed  $id = null, mixed  $dialog = null) : boolean

Traite la procédure de suppression d'un élément depuis un formulaire.

Parameters

mixed $id

Identifiant de l'élément

mixed $dialog

Returns

boolean

getUserAccess()

getUserAccess(string  $do = null) : integer

Retourne le niveau d'accès à l'action en entrée

Parameters

string $do

Returns

integer

getACL()

getACL(string  $do = null) : integer

Retourne le niveau d'accès à l'action en entrée

Parameters

string $do

Returns

integer

getACLKeys()

getACLKeys(string  $do = null) : integer

Retourne le tableau associatif clé=>niveau correspondant à l'action en entrée

Parameters

string $do

Returns

integer

postACL()

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.

Parameters

string $do
array $vals

Returns

array|boolean

setPermission()

setPermission(string  $do, integer  $id, string  $type = 'id_user') : string

Définit une permission pour le module

Parameters

string $do

l'action associée; default : tous

integer $id

identifiant

string $type

type de permission (id_group, id_user, level)

Returns

string

getPermissions()

getPermissions(string  $do = null, string  $type = null) : string

Recupère les permissions du module

Parameters

string $do

l'action associée; default : tous

string $type

type de permission (id_group, id_user, level)

Returns

string

getPostDo()

getPostDo() : \La

Permet de récupérer un $do de ce module qui aurait été transmis en $_POST.

Ex : Pour le module News, vérifie la présence de "news_do"

Returns

\La —

valeur du $do en question s'il existe, FALSE sinon.

getGetDo()

getGetDo() : \La

Permet de récupérer un $do de ce module qui aurait été transmis en $_GET.

Ex : Pour le module News, recupère la valeur de "news_do"

Returns

\La —

valeur du $do en question s'il existe, FALSE sinon.

getValsDo()

getValsDo(array  $vals) : \La

Permet de récupérer un $do de ce module qui aurait été transmis en $vals.

Ex : Pour le module News, récupère le contenu de "news_do"

Parameters

array $vals

tableau à inspecter

Returns

\La —

valeur du $do en question s'il existe, FALSE sinon.

getUserPermission()

getUserPermission(string  $do = null, string  $type = null, integer  $id_user = null) : string

Recupère les permissions de l'utilisateur sur le module

Parameters

string $do

l'action associée; default : tous

string $type

type de permission (id_group, id_user, level)

integer $id_user

identifiant utilisateur

Returns

string

checkLabel()

checkLabel(string  $key) : string

Définit le nom des clés contrôlées

Parameters

string $key

Returns

string

exePost()

exePost() : \{object,

Controlleur d'execution d'un formulaire.

Returns

\{object, —

bool}

exePostProcess()

exePostProcess() : \{object,

Execution d'un formulaire.

Returns

\{object, —

bool}

treatAjax()

treatAjax(mixed  $res, array  $vals = null, array  $config = array()) : \{object,

Gestion Ajax d'un formulaire.

Parameters

mixed $res
array $vals
array $config

Returns

\{object, —

bool}

restGet()

restGet(array  $config = array()) 

Listing à retourner lors d'un GET REST

Parameters

array $config

restList()

restList(array  $config = array()) 

Listing à retourner lors d'un GET REST

Parameters

array $config

sessionMake()

sessionMake(mixed  $id = null) 

Définit une session relative à la table SQL associée à l'objet Si $id est renseigné, définit une session propre à l'identifiant correspondant

Parameters

mixed $id

getConfig()

getConfig(string  $key = null) : mixed

Retourne la valeur de configuration de l'objet qui renseignée en entrée lorsque celle-ci existe, renvoie null sinon.

Parameters

string $key

Nom de la configuration.

Returns

mixed

setConfig()

setConfig(string  $key, mixed  $value) : mixed

Attribut une valeur de configuration de l'objet

Parameters

string $key

Nom/Chemin de la configuration.

mixed $value

Valeur de la configuration.

Returns

mixed

cloneConfig()

cloneConfig(object  $obj) 

Attribut la même configuration de l'objet à l'objet en entrée

Parameters

object $obj

addToConfig()

addToConfig(string  $key, mixed  $value) : mixed

Modifie une valeur de configuration de l'objet

Parameters

string $key

Nom/Chemin de la configuration.

mixed $value

Valeur de la configuration.

Returns

mixed

hasConfig()

hasConfig(string  $key, boolean  $check_if_empty = false) : mixed

Regarde si une configuration existe

Parameters

string $key

Nom/Chemin de la configuration.

boolean $check_if_empty

Returns

mixed

initForm()

initForm(string  $prefix = '', boolean  $print_vals = true) : object

Instancit un formulaire ( post ) AcidForm propre à l'objet.

Parameters

string $prefix

Prefixe pour le nom des éléments.

boolean $print_vals

Returns

object

adminNav()

adminNav() : void

Gére l'URL de l'administration.

extendAdminNav()

extendAdminNav(string  $mods = null) 

Etend le champ d'action de AdminNav avec le dbPref des champs issus des modules en entrée

Parameters

string $mods

getAdminCurNav()

getAdminCurNav() : string

Retourne l'url courante, gérée par acidfarm, de l'adminsitration.

Returns

string

getAdminTitle()

getAdminTitle(array  $do = 'default') : array

Retourne le titre de l'administration

Parameters

array $do

Returns

array

getAdminTitleAttr()

getAdminTitleAttr(array  $do = 'default') : array

Retourne les attributs du titre de l'administration

Parameters

array $do

Returns

array

getIconLink()

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

Parameters

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.

Returns

string

buildAdminOnglets()

buildAdminOnglets(array  $name, array  $builder = array(), array  $excluder = array(), string  $key = null, string  $src = null) : array

Retourne un tableau représentant un onglet

Parameters

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

Returns

array

getStandardOnglets()

getStandardOnglets(array  $config = array('list', 'add', 'search')) : array

Retourne un tableau d'onglets "standard" de l'administration d'AcidFarm

Parameters

array $config

Tableau de filtrage / rangement des onglets

Returns

array

getOnglets()

getOnglets(array  $do = 'default') : array

Retourne un tableau d'onglets personnalisés

Parameters

array $do

Returns

array

getDefaultDo()

getDefaultDo() : array

Retourne le controller par défaut

Returns

array

getDisableAction()

getDisableAction() : boolean

Retourne si la colonne d'action estactivée ou non dans l'AdminList

Returns

boolean

getDialogDo()

getDialogDo(array  $do) : array

Retourne le controller dialog par défaut

Parameters

array $do

Returns

array

getDialogMessage()

getDialogMessage(array  $do, mixed  $dialog = null) : array

Retourne le texte dialog par défaut

Parameters

array $do
mixed $dialog

texte à afficher en case de succès si défini

Returns

array

getStandardActionPrint()

getStandardActionPrint(mixed  $elt) : array

Retourne un tableau de configuration "standard" du bouton d'affichage

Parameters

mixed $elt

Tableau representatif de l'élement

Returns

array

getStandardActionUpdate()

getStandardActionUpdate(mixed  $elt) : array

Retourne un tableau de configuration "standard" du bouton de mise à jour

Parameters

mixed $elt

Tableau representatif de l'élement

Returns

array

getStandardActionDelete()

getStandardActionDelete(mixed  $elt) : array

Retourne un tableau de configuration "standard" du bouton de suppression

Parameters

mixed $elt

Tableau representatif de l'élement

Returns

array

checkActionTabCondition()

checkActionTabCondition(string  $do, array  $elt) : boolean

Retourne le resultat de la fonction conditionnelle d'affichage du bouton, si inexistante, retourne true

Parameters

string $do

L'action associée

array $elt

L'élement à contrôler

Returns

boolean

getStandardActionTab()

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

Parameters

mixed $elt

L'élement à contrôler

array $config

Tableau de filtrage / rangement des boutons de modérations

Returns

string

printAdminActionTab()

printAdminActionTab(array  $links = array(), array  $forms = array(), array  $elt = array(), array  $conf = array()) : string

Retourne une portion HTML representant des boutons de modérations

Parameters

array $links
array $forms
array $elt
array $conf

Returns

string

getAdminTh()

getAdminTh(string  $cont, array  $attr = array(), array  $conf = array()) : string

Retourne une portion HTML representant un Th du tableau de l'administration AcidFarm

Parameters

string $cont
array $attr
array $conf

Returns

string

getAdminTd()

getAdminTd(string  $cont, array  $attr = array(), array  $conf = array()) : string

Retourne une portion HTML representant un Td du tableau de l'administration AcidFarm

Parameters

string $cont
array $attr
array $conf

Returns

string

getAdminTr()

getAdminTr(integer  $line, string  $class = null, array  $attr = array(), array  $conf = array()) : string

Retourne une portion HTML representant un Tr du tableau de l'administration AcidFarm

Parameters

integer $line
string $class
array $attr
array $conf

Returns

string

getAssoc()

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.

Parameters

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

Returns

array —

Le tableau associatif

sortByKey()

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

Parameters

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

Returns

\Ambigous —

<multitype:multitype: unknown , unknown, string>

printAdminTab()

printAdminTab(array  $cols = array(), array  $rows = null, array  $conf = array()) : string

Retourne une portion HTML representant un tableau de l'administration AcidFarm

Parameters

array $cols

les entêtes

array $rows

les lignes

array $conf

configuration

Returns

string

isSelectedOnglet()

isSelectedOnglet(array  $check) : string

Retourne true si l'onglet designé par $check correspond à l'url en cours

Parameters

array $check

Composantes de l'onglet

Returns

string

printAdminOnglets()

printAdminOnglets(array  $onglets = array(), array  $config = array()) : string

Retourne une portion HTML representant les onglets de l'administration AcidFarm

Parameters

array $onglets

Les onglets

array $config

Tableau de configuration pour les onglets

Returns

string

printAdminBody()

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

Parameters

string $content

Le contenu à insérer

array $onglets

La configuration des onglets

string $title

Le titre

array $title_attr

La configuration du titre

Returns

string

exeAdminController()

exeAdminController(string  $do, array  $config = array()) : string

Exécute les méthodes standards d'administration en fonction du paramètre d'entrée $do

Parameters

string $do

L'identifiant de la methode à effectuer

array $config

Configuration

Returns

string

addAdminOnglets()

addAdminOnglets(string  $do) 

Ajoute un onglet à l'administration

Parameters

string $do

alias de l'onglet

printAdminInterface()

printAdminInterface(array  $config = array()) : string

Controlleur de l'interface d'administration.

Parameters

array $config

Configuration

Returns

string

callFunction()

callFunction(mixed  $cuf, array  $cup = array()) : array

Execute une fonction prédéfinie par l'utilisateur avec la gestion des methodes de $this

Parameters

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

Returns

array

getAdminListOptions()

getAdminListOptions(mixed  $mods = false) : array

Retourne les paramètres de filtrage pour l'administration du module sous forme d'un couple ([filtres],[paramètre d'indexation])

Parameters

mixed $mods

un tableau contenant les modules associés à l'objet

Returns

array

printAdminList()

printAdminList(array  $conf = array()) : string

Retourne le listing d'administration du module sous forme d'une chaîne de caractères mise en forme.

Parameters

array $conf

Configuration (filter, order, mods, tpl modules )

Returns

string

printAdminListBody()

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.

Parameters

\unknown_type $content

Contenu

\unknown_type $infos

Les ibfos

\unknown_type $nav

La nav

\unknown_type $conf

Configuration

Returns

string

printAdminListHeadBtn()

printAdminListHeadBtn(array  $conf = array()) : string

Génère des boutons raccourcis en entete du listing d'administration

Parameters

array $conf

Returns

string

genAdminListHeadFilter()

genAdminListHeadFilter(array  $conf = array()) : string

Retourne des listes de filtrages dans le listing d'administration

Parameters

array $conf

Returns

string

genAdminListHead()

genAdminListHead(array  $conf = array()) : array

Retourne la tête du listing d'administration du module sous forme de tableau.

Parameters

array $conf

Configuration

Returns

array

genAdminListLine()

genAdminListLine(array  $fields, array  $elt, array  $conf = array()) : array

Génère une ligne du listing d'administration du module sous forme de tableau.

Parameters

array $fields

Champs à traiter

array $elt

Element à traiter

array $conf

Configuration

Returns

array

genAdminListAction()

genAdminListAction(array  $elt, array  $conf = array()) : string

Génère une cellule d'action du listing d'administration du module sous forme d'une chaîne de caractère.

Parameters

array $elt

Element à traiter

array $conf

Configuration

Returns

string

genAdminListFormat()

genAdminListFormat(array  $elts, array  $conf = array()) : string

Traites le tableau d'éléments en entrée

Parameters

array $elts

Element à traiter

array $conf

Configuration

Returns

string

genAdminListLineCustomClass()

genAdminListLineCustomClass(array  $elt, array  $conf = array()) : string

Retourne la classe css personnalisée de la ligne du tableau

Parameters

array $elt

Element à traiter

array $conf

Configuration

Returns

string

genAdminListContent()

genAdminListContent(array  $elts, array  $conf = array()) : array

Formate pour le listing d'administration du module les éléments en entrée sous forme d'une chaîne de caractères mise en forme.

Parameters

array $elts

Eléments à traiter

array $conf

Configuration

Returns

array

getAdminTpl()

getAdminTpl(string  $do) : array

Retourne le tableau des fichiers templates personnalisés

Parameters

string $do

l'action affectuée

Returns

array

getAdminListMods()

getAdminListMods() : array

Retourne la liaison de modules associée à l'objet

Returns

array

getAdminListCombo()

getAdminListCombo() : array

Retourne le combo ORM associé à l'objet

Returns

array

getAdminListGroupBy()

getAdminListGroupBy() : array

Retourne le group by ORM associé à l'objet

Returns

array

getAdminListLd()

getAdminListLd(string  $key) : array

Retourne le paramètre de tri ascendant / descendant pour la clé en entrée

Parameters

string $key

le paramètre de tri par type

Returns

array

getAdminListParams()

getAdminListParams(integer  $nb_elts, array  $conf = array()) : array

Retourne les paramètrages du listing

Parameters

integer $nb_elts

le nombre d'éléments trouvés par lors de l'execution de la recherche

array $conf

Configuration

Returns

array —

list( nombre maxi d'éléments par page , limite d'affichage, page courante, pagination )

printAdminListInfo()

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

Parameters

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

Returns

array —

list( nombre maxi d'éléments par page , limite d'affichage, page courante, pagination )

printAdminConfigure()

printAdminConfigure(string  $do = 'default', array  $conf = array()) 

Préparation du module pour les différents affichage/formulaires

Parameters

string $do

Vue en cours

array $conf

Configuration

printAdminConfigureCSV()

printAdminConfigureCSV() 

Préparation du module pour le retour CSV

printAdminAdd()

printAdminAdd() : string

Retourne le formulaire d\'ajout de l'objet après initialisation

Returns

string

printAdminUpdate()

printAdminUpdate() : string

Retourne l'interface de modification d'un élément du module sous forme d'une chaîne de caractères mise en forme.

Returns

string

printAdminFormStart()

printAdminFormStart(object  $form, string  $do) : string

Assigne aux formulaires des éléments au debut

Parameters

object $form

objet AcidForm

string $do

la vue demandée

Returns

string

printAdminFormStop()

printAdminFormStop(object  $form, string  $do) : string

Assigne aux formulaires des éléments à la fin

Parameters

object $form

objet AcidForm

string $do

la vue demandée

Returns

string

printAdminFormSubmit()

printAdminFormSubmit(object  $form, string  $do) : string

Assigne le bouton submit au formulaire d'administration de la vue en entrée

Parameters

object $form

objet AcidForm

string $do

la vue demandée

Returns

string

printAdminForm()

printAdminForm(string  $do) : string

Retourne le formulaire d'administration du module pour la vue demandée

Parameters

string $do

la vue demandée

Returns

string

printAdminFlags()

printAdminFlags(string  $do = 'default', array  $keys = null) 

Retourne une gestion multilingue en javascript des formulaires d'administrations

Parameters

string $do

la vue demandée

array $keys

les clés

printAdminElt()

printAdminElt() : string

Retourne les éléments de l'objet sous forme d'une chaîne de caractères mise en forme.

Returns

string

printAdminSearch()

printAdminSearch() : string

Retourne l'interface de recherche d'un élément du module sous forme d'une chaîne de caractères mise en forme.

Returns

string

printFormToggle()

printFormToggle(string  $key, object  $obj = null, boolean  $ajax = false) : string

Affiche un formulaire de switch on/off

Parameters

string $key

Nom du paramètre

object $obj

L'objet

boolean $ajax

Le formulaire sera traité en ajax

Returns

string

printFormQuickChange()

printFormQuickChange(  $key, null  $obj = null, boolean|false  $ajax = false, array  $params = array()) : string

Affiche un formulaire de "quick change"

Parameters

$key
null $obj
boolean|false $ajax

Le formulaire sera traité en ajax

array $params

Returns

string

exportCSV()

exportCSV(mixed  $filter = '', array  $fields = array(), array  $config = null, boolean  $label = false, boolean  $printed = true) : \AcidCSV

Retourne un AcidCSV correspondant au module

Parameters

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)

Returns

\AcidCSV

getPrintedAssoc()

getPrintedAssoc(string  $key = "") : mixed

Retourne la pré-configuration d'affichage associée à la clé en entrée

Parameters

string $key

nom du paramètre

Returns

mixed

getPrinted()

getPrinted(string  $key, array  $elt = null, array  $conf = array()) : mixed

Retourne une valeur de l'objet mise en forme pour l'interface d'adminsitration.

Parameters

string $key

Nom du paramètre

array $elt

Tableau representatif de l'objet

array $conf

Configuration

Returns

mixed

synchronize()

synchronize(array  $groups, integer  $id_user) 

Applique l'association de $id_user aux groupes $groups Les associations précédentes seront supprimées

Parameters

array $groups
integer $id_user

getControlledKeys()

getControlledKeys(string  $do) : \array()

Retourne un tableau contenant les clés à contrôler Si on a array( k1, array(k2, k3) ), k1 doit être défini ainsi que k2 ou k3.

Parameters

string $do

Returns

\array()

checkVals()

checkVals(string  $tab, string  $do) : \array()

Retourne un tableau contenant les clés à contrôler

Parameters

string $tab

tableau à controller

string $do

action effectuée

Returns

\array()

checkKey()

checkKey(  $key,   $tab, string  $do = '', null  $error_msg = null) : boolean|null

Validation de champs

Parameters

$key
$tab
string $do
null $error_msg

alimente $error_msg avec un message d'erreur personnalisé si besoin

Returns

boolean|null —

retourne null si la clé est manquante, false si c'est une mauvaise valeur, true si ok

removeGet()

removeGet(string  $name) : boolean

Stocke l'élément renseigné en entrée puis la retire de la variable PHP $_GET.

Parameters

string $name

Returns

boolean

printAdminAddForm()

printAdminAddForm() : string

Retourne le formulaire d\'ajout de l'objet

Returns

string

printAdminUpdateForm()

printAdminUpdateForm() : string

Retourne le formulaire de mise à jour de l'objet

Returns

string