table extends om_base
in package

framework

openmairie

Définition de la classe 'table'.

Cette classe permet de 'tabler' les champs suivant une requete.

$_advs_id : mixed: Attribut contenant un identifiant unique de recherche avancee
$_etatRechercheAv : bool: Etat de la recherche avancee : true -> activee, false -> desactivee
$_global_actions : array<string|int, mixed>: Liste des actions globales.
$_om_validite : bool: Permet de savoir si le tableau actuel est un tableau d'objets a date de validite.
$_rechercheAvanceeFaite : bool: Permet de savoir si une recherche avancee a ete effectuee.
$absolute_object : string: Nom de la classe métier pour la recherche avancée.
$actions : mixed: Liste des actions accessible par l'utilisateurs.
$actions_number_c : mixed: Nombre d'actions affichables en coin.
$actions_number_l : mixed: Nombre d'actions affichables a gauche.
$actions_order_c : mixed: Ordre des actions en coin.
$actions_order_l : mixed: Ordre des actions de gauche.
$advs_default_form : string: Permet de definir quel formulaire de recherche avancee est ouvert par defaut
$aff : string: Nom de l'objet metier
$champAffiche : array<string|int, mixed>: Tableau des champs a afficher
$champRecherche : array<string|int, mixed>: Tableau des champs sur lesquels la recherche est effectuee
$db : null|database: Instance de connexion à la base de données.
$dbChampRechercheAv : array<string|int, mixed>: Liste des champs configures pour le formulaire de recherche avancee.
$export : mixed: Tableau des type d'export possible pour le resultat de la recherche avancee
$htmlChampRechercheAv : array<string|int, mixed>: Liste des attributs 'name' des champs HTML composant le formulaire de recherche avancee.
$max_actions_number : mixed: Nombre maximum d'actions affichees.
$options : array<string|int, mixed>: Liste des options
$paramChampRechercheAv : array<string|int, mixed>: Tableau de parametres permettant de construire le formulaire de recherche avancee et d'interroger les bonnes tables et colonnes de la base de donnees.
$selection : string: Clause de selection dans la requete
$serie : int: Nombre d'enregistrement(s) par page
$sql : string: Requete
$sqlC : string: Requete qui compte le nombre d'enregistrement
$table : string: Critere from de la requete
$tri : string: Critere de tri de la requete
$wildcard : array<string|int, mixed>: Configuration du wildcard des recherches.
$f : null|application: Instance de la classe 'application'.
__construct() : void: Constructeur.
__destruct() : mixed: Destructeur.
composeAdvancedSearch() : mixed: Méthode de composition de la recherche avancée.
composeChamp() : string: Méthode de composition de la liste des champs du SELECT
composeExportUrl() : string: Compose une URL pour l'export.
composeQuery() : void: Methode de construction de la requete
composeSearchTab() : void: Gestion de la recherche.
composeSearchValue() : string: Méthode permettant de retraiter la chaîne recherchée en intégrant les valeurs multiples séparées par une ',' ainsi que l'échappement des caractères interdits
composeSimpleSearch() : void: Composition et stockage de la requête dans le cas d'une recherche simple.
composeTri() : string: Méthode de composition du tri
composeURL() : string: Compose une URL.
countActions() : int: Retourne le nombre d'actions affichables pour une liste donnee.
createSQLW() : string: Création de la requête
display() : void: Affichage principal.
displayGlobalContainerEnd() : void: Layout.
displayGlobalContainerStart() : void: Layout.
displayHeader() : void: Calcule et affiche la ligne d'entête du tableau.
displayPagination() : void: Calcule et affiche le bloc de pagination.
displaySearch() : void: Methode permettant l'affichage de la recherche
displaySearchContainerEnd() : void: Layout.
displaySearchContainerStart() : void: Layout.
displayTableContainerEnd() : void: Layout.
displayTableContainerStart() : void: Layout.
displayTableHeadLineEnd() : void: Layout.
displayTableHeadLineStart() : void: Layout.
displayTableStart() : void: Layout.
displayToolbarContainerEnd() : void: Layout.
displayToolbarContainerStart() : void: Layout.
getColumnsName() : array<string|int, mixed>: Retourne la liste des colonnes de la ressource de base de données (résultat de requête) passée en paramètre.
getKeyForColumnName() : string: Retourne la clé numérique correspondante au nom de colonne ou au label dans la propriété 'champAffiche'.
getParam() : string: Accesseur pour la propriété 'params'.
isAdvancedSearchEnabled() : bool: Retourne true si la recherche avancee est activee, false sinon.
normalizeFieldValue() : string: Méthode permettant de normaliser les valeurs des champs de recherche en vue de les comparer aux valeurs recherchées
normalizeSearchValue() : string: Méthode permettant de faire les traitements d'échappements et de normalisation sur une chaîne destinée à la recherche
saveActionsNumber() : void: Compte le nombre d'actions affichables: - en coin - a gauche
saveUserActions() : mixed: Initialise le tableau $this->actions avec un tableau donne.
serialize_criterions() : void: Stocke en variable de session les critères de la recherche avancée.
setParam() : void: Mutateur pour la propriété 'params'.
setParams() : void: Mutateur pour la propriété 'params'.
unserialize_criterions() : array<string|int, mixed>: Retour les critères de la recherche avancée.
_del_substr() : string: Supprime la chaine $substr de $str si $substr existe.
add_action_to_global_actions() : void: Mutateur pour la propriété '_global_actions'.
add_aggregate_filters() : string: Cree une chaine en ajoutant les criteres de recherche avancee utilisant des fonctions d'aggregation les uns a la suite des autres.
addToLog() : void: Ajout d'un message au système de logs.
display_global_actions() : void: Affiche les actions globales.
displayAdvancedSearch() : void: Affiche le formulaire de recherche avancée.
getPostedChampRechercheAv() : array<string|int, mixed>: Retourne la liste des champs de recherche avancee qui ont ete envoyes par POST et dont la valeur n'est pas vide.
init_om_application() : bool: Initialisation de la classe 'application'.
initHtmlChampRechercheAv() : array<string|int, mixed>: Permet d'initialiser la liste des champs HTML a afficher par le formulaire de recherche avancee.
process_global_action_edition() : void: Gère l'action globale 'edition pdf'.
process_global_action_export() : void: Ajoute les boutons d'export globaux.
process_global_action_validity() : void: Gère l'action globale 'om_validite'.
gen_advs_id() : string: Retourne un identifiant unique pour ka recherche avancée.

$_advs_id

Attribut contenant un identifiant unique de recherche avancee


    public
        mixed
    $_advs_id

$_etatRechercheAv

Etat de la recherche avancee : true -> activee, false -> desactivee


    public
        bool
    $_etatRechercheAv
     = \NULL

Activer la recherche avancee

Pour activer la recherche avancee sur un objet particulier, rendez-vous dans le fichier sql/[...]/objet.inc.php de l'objet et ajoutez le tableau suivant aux tableaux d'options:

EX: $options[] = (1) array('type' => 'search', (2) 'display' => true, (3) 'advanced' => $champs, (4) 'default_form' => 'advanced', (5) 'absolute_object' => 'om_utilisateur');

(1) 'type' : OBLIGATOIRE Permet de definir le type de l'option. Pour une recherche il faut saisir 'search'.

(2) 'display' : OBLIGATOIRE Permet d'afficher ou non la recherche, tout en conservant sa configuration Supporte les valeurs 'true' et 'false'.

(3) 'advanced' : OBLIGATOIRE Permet de preciser que le formulaire de recherche est un formulaire de recherche avancee. Cette cle doit contenir le tableau des champs configures pour la recherche (voir plus bas pour la configuration).

(4) 'default_form' : optionnel Permet de choisir quel formulaire de recherche est ouvert par defaut. La valeur 'advanced' permet d'afficher le formulaire de recherche multi-criteres. Les autres valeurs ou si 'default_form' n'est pas configure, affichent le formulaire de recherche mono-critere.

(5) 'absolute_object' : OBLIGATOIRE Permet de specifier le nom de la table en base de donnees de l'objet recherche.

$_global_actions

Liste des actions globales.


    public
        array<string|int, mixed>
    $_global_actions
     = array()

$_om_validite

Permet de savoir si le tableau actuel est un tableau d'objets a date de validite.


    public
        bool
    $_om_validite

$_rechercheAvanceeFaite

Permet de savoir si une recherche avancee a ete effectuee.


    public
        bool
    $_rechercheAvanceeFaite
     = \false

Ce parametre est false:

par defaut
lorsque la recherche avancee n'est pas activee
lorsque la recherche avancee est activee et que les champs soumis par le formulaire de rechreche avancee sont tous vide

$absolute_object

Nom de la classe métier pour la recherche avancée.


    public
        string
    $absolute_object
     = ''

$actions

Liste des actions accessible par l'utilisateurs.


    public
        mixed
    $actions
     = array()

$actions_number_c

Nombre d'actions affichables en coin.


    public
        mixed
    $actions_number_c

$actions_number_l

Nombre d'actions affichables a gauche.


    public
        mixed
    $actions_number_l

$actions_order_c

Ordre des actions en coin.


    public
        mixed
    $actions_order_c
     = array()

$actions_order_l

Ordre des actions de gauche.


    public
        mixed
    $actions_order_l
     = array()

$advs_default_form

Permet de definir quel formulaire de recherche avancee est ouvert par defaut


    public
        string
    $advs_default_form
     = "simple"

'simple' -> mono-critere 'avanced' -> multi-critere

Dans tous les autres cas, la recherche mono-critere est affichee

$aff

Nom de l'objet metier


    public
        string
    $aff

$champAffiche

Tableau des champs a afficher


    public
        array<string|int, mixed>
    $champAffiche

$champRecherche

Tableau des champs sur lesquels la recherche est effectuee


    public
        array<string|int, mixed>
    $champRecherche

$db

Instance de connexion à la base de données.


    public
        null|database
    $db
     = \null

$dbChampRechercheAv

Liste des champs configures pour le formulaire de recherche avancee.


    public
        array<string|int, mixed>
    $dbChampRechercheAv
     = array()

Cette liste sera initialisee seulement si la recherche avancee est activee.

$export

Tableau des type d'export possible pour le resultat de la recherche avancee


    public
        mixed
    $export
     = \NULL

$htmlChampRechercheAv

Liste des attributs 'name' des champs HTML composant le formulaire de recherche avancee.


    public
        array<string|int, mixed>
    $htmlChampRechercheAv
     = array()

Ces valeurs sont les cles du tableau $_POST contenant les valeurs a rechercher.

Cette liste sera initialisee seulement si la recherche avancee est activee.

$max_actions_number

Nombre maximum d'actions affichees.


    public
        mixed
    $max_actions_number
     = 0

$options

Liste des options


    public
        array<string|int, mixed>
    $options

$paramChampRechercheAv

Tableau de parametres permettant de construire le formulaire de recherche avancee et d'interroger les bonnes tables et colonnes de la base de donnees.


    public
        array<string|int, mixed>
    $paramChampRechercheAv
     = array()

Les cles de ce tableau sont les noms des champs du formulaire de recherche.

Les valeurs sont des tableaux associatif contenant la configuration du champ a savoir : la colonne et la table dans laquel s'effectuera la recherche de sa valeur, son type, sa taille, etc.

I - Configuration simple

EX: array('dentifiant_utilisateur' (1) =>

         (2)    array('colonne' => 'om_utilisateur',
         (3)          'table'   => 'om_utilisateur',
         (4)          'type'    => 'text',
         (5)          'libelle' => __('Identifiant'),
         (6)          'taille'  => 10,
         (7)          'max'     => 8));

(1) 'identifiant_utilisateur' : OBLIGATOIRE Nom unique du champ HTML (attribut name du champ).

(2) 'colonne' : OBLIGATOIRE Nom de la colonne de la base de donnees qui sera interrogee si $_POST contient la cle 'identifiant_utilisateur'.

(3) 'table' : OBLIGATOIRE Nom de la table de la base de donnees qui sera interrogee si $_POST contient la cle 'identifiant_utilisateur'.

(4) 'type' : OBLIGATOIRE Type du champ HTML a afficher. Cela peut-etre date, text, select, ou tout autre type supporte par la classe formulaire. Pour les champs de type select, le nom du champ HTML (1) doit etre le meme que le nom de la colonne (2). A corriger.

(5) 'libelle' : OBLIGATOIRE Le label qui sera affiche a cote du champ dans le formulaire de recherche.

(6) 'taille' : optionnel La taille du champ HTML (attribut size).

(7) 'max' : optionnel La longueur maximale de la valeur du champ (attribut maxlength).

II - Configuration avancee

- Creer un intervalle de date

EX: Recherche des utilisateurs crees entre telle et telle date

 $champs['date_de_creation'] =

         array('colonne' => 'creation_date',
               'table'   => 'user',
               'libelle' => __('Date de creation'),
               'type'    => 'date',
               'where'   => 'intervaldate');

Cette configuration permet de creer deux champs HTML datepicker: - date_de_creation_min : permet de saisir une date minimale - date_de_creation_max : permet de saisir une date maximale

Ces champs permettent de rechercher les uilisateurs dont la date de de creations est incluse dans l'intervalle saisi, bornes comprises. Il est possible de ne saisir qu'une seule date afin de rechercher les utilisateurs ayant ete crees avant ou apres une date particuliere.

- Creer un champ de recherche avec menu deroulant personnalise

EX: Recherche des utilisateurs administrateurs

L'information se trouve directement dans la table utilisateur.

 $champs['administrator'] =

         array('colonne'   => 'is_admin',
               'table'     => 'user',
               'libelle'   => __('Administrateur'),
               'type'      => 'select',
               'subtype'   => 'manualselect',
               'args'      => $args);

 $args[0] = array('', 'true', 'false');
 $args[1] = array(__('Tous'), __('Oui'), __('Non'));

Cette configuration permet de creer un champ HTML de type select avec trois choix: - Tous (valeur '') - Oui (valeur 'true') - Non (valeur 'false')

Le tableau $args[0] contient les valeurs associes aux choix. Elles seront recherchees telles quelles dans la base de donnees.

En selectionnant 'Oui', la requete sera construite comme suit:

 WHERE user.is_admin::varchar like 'true'

Il est possible de saisir n'importe quelle chaine de caracteres dans $args[0] et pas seulement des valeurs booleenes.

Attention cette recherche n'est pas sensible a la casse. Plusieurs fonction de formatage sont appelees sur 'user.is_admin' avant de tester l'egalite.

- Tester si une donnee est presente ou non dans un groupe de donnee

EX: Recherche des utilisateurs administrateurs

L'information se trouve non pas dans la table utilisateur mais dans la table administrateur disposant d'une colonne user_id (cle etrangere). Il faut utiliser une sous-requete pour recuperer l'ensemble des identifiants de le table administrateur afin de tester si un identifiant utilisateur est present dans cette liste.

 $champs['administrator'] =

         array('colonne'  => 'id',
               'table'    => 'user',
               'libelle'  => __('Type d'utilisateur'),
               'type'     => 'select',
               'subtype'  => 'manualselect',
               'where'    => 'insubquery',
               'args'     => $args,
               'subquery' => $subquery);

 $args[0] = array('', 'true', 'false');
 $args[1] = array(__('Tous'),
                  __('Administrateurs'),
                  __('Utilisateurs simples'));

 $subquery = 'SELECT user_id FROM admin';

Cette configuration permet de creer un champ HTML de type select avec trois choix: - Tous (valeur '') - Administrateurs (valeur 'true') - Utilisateurs simples (valeur 'false')

Le tableau $args[0] contient les valeurs associes aux choix. La valeur 'true' indique que les identifiants des utilisateurs doivent se trouver dans la sous-requete, la valeur 'false' indique qu'ils ne doivent pas se trouver dans la sous-requete. Contrairement a l'exemple 2, elles ne seront pas recherchees telles quelles dans la base de donnees et ne doivent surtout pas etre modifiees.

En selectionnant 'Administrateurs', la requete sera construite comme suit:

 WHERE user.id IN (SELECT user_id FROM admin)

$selection

Clause de selection dans la requete


    public
        string
    $selection

$serie

Nombre d'enregistrement(s) par page


    public
        int
    $serie

$sql

Requete


    public
        string
    $sql

$sqlC

Requete qui compte le nombre d'enregistrement


    public
        string
    $sqlC

$table

Critere from de la requete


    public
        string
    $table

$tri

Critere de tri de la requete


    public
        string
    $tri

$wildcard

Configuration du wildcard des recherches.


    public
        array<string|int, mixed>
    $wildcard
     = array('left' => '%', 'right' => '%')

$f

Instance de la classe 'application'.


    protected
        null|application
    $f
     = \null

__construct()

Constructeur.


    public
                    __construct(string $aff, string $table, int $serie, array<string|int, mixed> $champAffiche, array<string|int, mixed> $champRecherche, string $tri, string $selection[, string $edition = "" ][, array<string|int, mixed> $options = array() ][, null|string $advs_id = null ][, bool $om_validite = false ]) : void

Cette methode permet d'affecter tous les parametres aux attributs de la classe auxquels ils correspondent

Parameters

$aff : string: Nom de l'objet metier
$table : string: Critere from de la requete
$serie : int: Nombre d'enregistrement(s) par page
$champAffiche : array<string|int, mixed>: Tableau des champs a afficher
$champRecherche : array<string|int, mixed>: Tableau des champs sur lesquels la recherche est effectuee
$tri : string: Critere de tri de la requete
$selection : string: Clause de selection dans la requete
$edition : string = "": Lien vers edition pdf
$options : array<string|int, mixed> = array()
$advs_id : null|string = null
$om_validite : bool = false

Return values

void —

__destruct()

Destructeur.


    public
                    __destruct() : mixed

Return values

mixed —

composeAdvancedSearch()

Méthode de composition de la recherche avancée.


    public
                    composeAdvancedSearch(mixed $champ, mixed $tri) : mixed

Parameters

$champ : mixed
$tri : mixed

Return values

mixed —

composeChamp()

Méthode de composition de la liste des champs du SELECT


    public
                    composeChamp() : string

Return values

string —

composeExportUrl()

Compose une URL pour l'export.


    public
                    composeExportUrl([array<string|int, mixed> $params = array() ]) : string

Le principe est d'utiliser la propriété 'params' pour tous les paramètres de l'URL sauf si ils ont une valeur dans le paramètre passé.

Parameters

$params : array<string|int, mixed> = array(): Tableau de valeurs à surcharger.

Return values

string —

composeQuery()

Methode de construction de la requete


    public
                    composeQuery() : void

Cette methode permet de construire les deux requetes sql sqlC en concatenant les differents parametres

Return values

void —

composeSearchTab()

Gestion de la recherche.


    public
                    composeSearchTab() : void

Return values

void —

composeSearchValue()

Méthode permettant de retraiter la chaîne recherchée en intégrant les valeurs multiples séparées par une ',' ainsi que l'échappement des caractères interdits


    public
                    composeSearchValue(string $value) : string

Parameters

$value : string: Chaîne recherchée.

Return values

string —

composeSimpleSearch()

Composition et stockage de la requête dans le cas d'une recherche simple.


    public
                    composeSimpleSearch(string $champ, string $tri) : void

Parameters

$champ : string: Critère SELECT de la requête.
$tri : string: Critère TRI de la requête.

Return values

void —

composeTri()

Méthode de composition du tri


    public
                    composeTri() : string

Return values

string —

composeURL()

Compose une URL.


    public
                    composeURL([array<string|int, mixed> $params = array() ]) : string

Le principe est d'utiliser la propriété 'params' pour tous les paramètres de l'URL sauf si ils ont une valeur dans le paramètre passé.

Parameters

$params : array<string|int, mixed> = array(): Tableau de valeurs à surcharger.

Return values

string —

countActions()

Retourne le nombre d'actions affichables pour une liste donnee.


    public
                    countActions(array<string|int, mixed> $actions) : int

Parameters

$actions : array<string|int, mixed>: Tableau d'actions.

Return values

int —

createSQLW()

Création de la requête


    public
                    createSQLW(string $searchField, string $searchValue, string $opp) : string

Parameters

$searchField : string
$searchValue : string
$opp : string

Return values

string —

display()

Affichage principal.


    public
                    display([array<string|int, mixed> $params = array() ][, array<string|int, mixed> $actions = array() ][, mixed $db = NULL ][, string $class = "tab" ][, bool $onglet = false ]) : void

Parameters

$params : array<string|int, mixed> = array()
$actions : array<string|int, mixed> = array()
$db : mixed = NULL
$class : string = "tab": Prefixe de la classe CSS a utiliser
$onglet : bool = false

Return values

void —

displayGlobalContainerEnd()

Layout.


    public
                    displayGlobalContainerEnd() : void

Return values

void —

displayGlobalContainerStart()

Layout.


    public
                    displayGlobalContainerStart() : void

Return values

void —

displayHeader()

Calcule et affiche la ligne d'entête du tableau.


    public
                    displayHeader(array<string|int, mixed> $info[, string $class = "tab" ][, bool $onglet = false ]) : void

Parameters

$info : array<string|int, mixed>
$class : string = "tab": Prefixe de la classe CSS a utiliser
$onglet : bool = false

Return values

void —

displayPagination()

Calcule et affiche le bloc de pagination.


    public
                    displayPagination(int $nbligne[, string $style = "tab" ][, bool $onglet = false ]) : void

Parameters

$nbligne : int
$style : string = "tab": Prefixe de la classe CSS a utiliser
$onglet : bool = false

Return values

void —

displaySearch()

Methode permettant l'affichage de la recherche


    public
                    displaySearch([string $style = "tab" ]) : void

Cette methode permet d'afficher le formulaire de recherche

Parameters

$style : string = "tab": Prefixe de la classe CSS a utiliser

Return values

void —

displaySearchContainerEnd()

Layout.


    public
                    displaySearchContainerEnd() : void

Return values

void —

displaySearchContainerStart()

Layout.


    public
                    displaySearchContainerStart() : void

Return values

void —

displayTableContainerEnd()

Layout.


    public
                    displayTableContainerEnd() : void

Return values

void —

displayTableContainerStart()

Layout.


    public
                    displayTableContainerStart() : void

Return values

void —

displayTableHeadLineEnd()

Layout.


    public
                    displayTableHeadLineEnd() : void

Return values

void —

displayTableHeadLineStart()

Layout.


    public
                    displayTableHeadLineStart([string $style = "tab" ]) : void

Parameters

$style : string = "tab": Classe CSS.

Return values

void —

displayTableStart()

Layout.


    public
                    displayTableStart([string $class = "" ]) : void

Parameters

$class : string = "": Classe CSS.

Return values

void —

displayToolbarContainerEnd()

Layout.


    public
                    displayToolbarContainerEnd() : void

Return values

void —

displayToolbarContainerStart()

Layout.


    public
                    displayToolbarContainerStart() : void

Return values

void —

getColumnsName()

Retourne la liste des colonnes de la ressource de base de données (résultat de requête) passée en paramètre.


    public
                    getColumnsName([resource $resource = null ]) : array<string|int, mixed>

Parameters

$resource : resource = null: Ressource de base de données (résultat de requête).

Return values

array<string|int, mixed> —

getKeyForColumnName()

Retourne la clé numérique correspondante au nom de colonne ou au label dans la propriété 'champAffiche'.


    public
                    getKeyForColumnName([string $columnname = "" ]) : string

Parameters

$columnname : string = "": Nom de colonne ou label.

Return values

string —

getParam()

Accesseur pour la propriété 'params'.


    public
                    getParam([null|string $param = NULL ]) : string

Parameters

$param : null|string = NULL

Return values

string —

isAdvancedSearchEnabled()

Retourne true si la recherche avancee est activee, false sinon.


    public
                    isAdvancedSearchEnabled() : bool

Configure la recherche au premier appel si celle ci est activee.

Return values

bool —

etat de la recherche avancee: activee/desactivee

normalizeFieldValue()

Méthode permettant de normaliser les valeurs des champs de recherche en vue de les comparer aux valeurs recherchées


    public
                    normalizeFieldValue(string $searchField) : string

Parameters

$searchField : string: Champ de recherche à normaliser.

Return values

string —

normalizeSearchValue()

Méthode permettant de faire les traitements d'échappements et de normalisation sur une chaîne destinée à la recherche


    public
                    normalizeSearchValue(string $value) : string

Parameters

$value : string: Chaîne recherchée à normaliser.

Return values

string —

saveActionsNumber()

Compte le nombre d'actions affichables: - en coin - a gauche


    public
                    saveActionsNumber() : void

Une action affichable est une action ayant un lien non vide et != '#'.

Return values

void —

saveUserActions()

Initialise le tableau $this->actions avec un tableau donne.


    public
                    saveUserActions(mixed $actions) : mixed

$this->actions est le tableau des actions que l'utilisateur a le droit d'effectuer.

Parameters

$actions : mixed: liste des actions

Return values

mixed —

serialize_criterions()

Stocke en variable de session les critères de la recherche avancée.


    public
                    serialize_criterions(array<string|int, mixed> $post) : void

Parameters

$post : array<string|int, mixed>: Critères de la recherche avancée.

Return values

void —

setParam()

Mutateur pour la propriété 'params'.


    public
                    setParam([null|string $param = null ][, null|string $value = null ]) : void

Parameters

$param : null|string = null
$value : null|string = null

Return values

void —

setParams()

Mutateur pour la propriété 'params'.


    public
                    setParams([array<string|int, mixed> $params = array() ]) : void

Parameters

$params : array<string|int, mixed> = array()

Return values

void —

unserialize_criterions()

Retour les critères de la recherche avancée.


    public
                    unserialize_criterions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

_del_substr()

Supprime la chaine $substr de $str si $substr existe.


    protected
                    _del_substr(string $str, string $substr[, string $rep = "" ]) : string

Methode insensible à la casse

Parameters

$str : string: ...
$substr : string: ...
$rep : string = "": optionnel, $rep peut remplacer $substr

Return values

string —

le parametre $str traite

add_action_to_global_actions()

Mutateur pour la propriété '_global_actions'.


    protected
                    add_action_to_global_actions([array<string|int, mixed> $action = array() ]) : void

Parameters

$action : array<string|int, mixed> = array(): Tableau de configuration d'une action

Return values

void —

add_aggregate_filters()

Cree une chaine en ajoutant les criteres de recherche avancee utilisant des fonctions d'aggregation les uns a la suite des autres.


    protected
                    add_aggregate_filters(array<string|int, mixed> $filters, string $opp) : string

Cela permet de construire l'expression SQL devant se placer apres la clause HAVING.

Parameters

$filters : array<string|int, mixed>: liste des crietes de recherche
$opp : string: operateur binaire 'AND' ou 'OR'

Return values

string —

l'expression se placant apres le HAVING

addToLog()

Ajout d'un message au système de logs.


    protected
                    addToLog(string $message[, int $type = DEBUG_MODE ]) : void

Cette méthode permet de logger un message.

Parameters

$message : string: Message à logger.
$type : int = DEBUG_MODE: Niveau de log du message.

Return values

void —

display_global_actions()

Affiche les actions globales.


    protected
                    display_global_actions() : void

Return values

void —

displayAdvancedSearch()

Affiche le formulaire de recherche avancée.


    protected
                    displayAdvancedSearch() : void

Return values

void —

getPostedChampRechercheAv()

Retourne la liste des champs de recherche avancee qui ont ete envoyes par POST et dont la valeur n'est pas vide.


    protected
                    getPostedChampRechercheAv([bool $with_table_prefix = false ]) : array<string|int, mixed>

Cela permet d'utiliser dans la clause SQL WHERE uniquement les champs sollicites.

De plus, si la requete SQL contient des alias de table comme utilisateur as u le parametre $with_table_prefix permet de retourner la liste des champs. (A condition que le parametre table_prefix existe).

Parameters

$with_table_prefix : bool = false: ...

Return values

array<string|int, mixed> —

init_om_application()

Initialisation de la classe 'application'.


    protected
                    init_om_application() : bool

Cette méthode permet de vérifier que l'attribut f de la classe contient bien la ressource utils du framework et si ce n'est pas le cas de la récupérer.

Return values

bool —

initHtmlChampRechercheAv()

Permet d'initialiser la liste des champs HTML a afficher par le formulaire de recherche avancee.


    protected
                    initHtmlChampRechercheAv() : array<string|int, mixed>

Return values

array<string|int, mixed> —

liste des attributs "name" des champs

process_global_action_edition()

Gère l'action globale 'edition pdf'.


    protected
                    process_global_action_edition() : void

Return values

void —

process_global_action_export()

Ajoute les boutons d'export globaux.


    protected
                    process_global_action_export() : void

Si l'export est paramétré dans le tableau $options du fichier .inc.php d'un objet, cette méthode va afficher le bouton au dessus du listing.

Return values

void —

process_global_action_validity()

Gère l'action globale 'om_validite'.


    protected
                    process_global_action_validity() : void

Return values

void —

gen_advs_id()

Retourne un identifiant unique pour ka recherche avancée.


    private
                    gen_advs_id() : string

Return values

string —

table extends om_base in package framework openmairie

Table of Contents

Properties

$_advs_id

$_etatRechercheAv

Activer la recherche avancee

$_global_actions

$_om_validite

$_rechercheAvanceeFaite

$absolute_object

$actions

$actions_number_c

$actions_number_l

$actions_order_c

$actions_order_l

$advs_default_form

$aff

$champAffiche

$champRecherche

$db

Tags

$dbChampRechercheAv

$export

$htmlChampRechercheAv

$max_actions_number

$options

$paramChampRechercheAv

I - Configuration simple

II - Configuration avancee

$selection

$serie

$sql

$sqlC

$table

$tri

$wildcard

$f

Methods

__construct()

Parameters

Return values

__destruct()

Return values

composeAdvancedSearch()

Parameters

Return values

composeChamp()

Return values

composeExportUrl()

Parameters

Return values

composeQuery()

Return values

composeSearchTab()

Return values

composeSearchValue()

Parameters

Return values

composeSimpleSearch()

Parameters

Return values

composeTri()

Return values

composeURL()

Parameters

Return values

countActions()

Parameters

Return values

createSQLW()

Parameters

Return values

display()

Parameters

Return values

displayGlobalContainerEnd()

Return values

displayGlobalContainerStart()

Return values

displayHeader()

table extends om_base
in package

framework

openmairie