Framework openMairie - version 4.10

dbform extends om_base
in package

framework

openmairie

Définition de la classe 'dbform'.

Cette classe permet de gérer une interface entre un objet métier et sa représentation dans la base de données.

$_is_action_available

Marqueur permettant de déterminer si l'action sur laquelle on se trouve est disponible sur l'objet instancié et dans le contexte.


    public
        null|bool
    $_is_action_available
     = \null

$actions_sup

Actions du portlet supplementaires provenant d'un script form.inc


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

$champs

Informations DB nom de chaque champ


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

$class_actions

Actions par defaut dans openMairie


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

$correct

Flag pour validation des donnees


    public
        bool
    $correct

$db

Instance de connexion à la base de données.


    public
        null|database
    $db
     = \null

$errors

Ce tableau récupère les messages d'erreurs


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

Valeurs de toutes les erreurs

$flags

Informations DB flag de chaque champ ???


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

$foreign_keys_extended

Liste des clés étrangères avec la liste des éventuelles surcharges de leur classe.


    public
        mixed
    $foreign_keys_extended
     = array()

$foreign_keys_extended = array( "<foreign_key1_table1>" => array("<classe_surcharge_1_de_table1>", ), "<foreign_key2_table2>" => array("<classe_surcharge_1_de_table2>", ), );

$form

Objet formulaire


    public
        null|formulaire
    $form
     = \null

$longueurMax

Informations DB taille de chaque champ


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

$merge_fields_to_avoid_app

Liste des champs à ne pas proposer dans les champs de fusion (niveau app).


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

$merge_fields_to_avoid_core

Liste des champs à ne pas proposer dans les champs de fusion (niveau core).


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

$merge_fields_to_avoid_obj

Liste des champs à ne pas proposer dans les champs de fusion (niveau obj).


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

$metadata_global

Liste des métadonnées communes à l'ensemble des fichiers de l'application


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

$msg

Message retourne au formulaire de saisie


    public
        string
    $msg
     = ""

$parameters

Valeurs de tous les parametres


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

$required_field

Liste des champs not null


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

$retourformulaire

Attribut permettant de stocker le paramètre du retourformulaire (objet lié du formulaire principal appelé également contexte) uniquement valable dans le cas d'un sous formulaire


    public
        mixed
    $retourformulaire

$sousform

Flag permettant de définir si on setrouve en sousformulaire.


    public
        bool
    $sousform

$tmpFile

Tableau permettant de stocker les fichiers en cours de modification dans le cas ou la suite de la transaction ne se déroule pas bien.


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

au format retourné pas le storage

$type

Informations DB type de chaque champ


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

$unique_key

Liste des champs uniques


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

$val

Valeur des champs requete selection


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

$valF

Valeur des champs retournes pour saisie et maj


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

$f

Instance de la classe 'application'.


    protected
        null|application
    $f
     = \null

__construct()

Constructeur.


    public
                    __construct(string $id[, null &$dnu1 = null ][, null $dnu2 = null ]) : mixed

Parameters

$id : string: Identifiant de l'objet.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

mixed —

__destruct()

Destructeur.


    public
                    __destruct() : mixed

Return values

mixed —

addToErrors()

Cette methode remplace erreur_db, et permet de remplir le tableau d'erreur


    public
                    addToErrors(string $debuginfo, string $messageDB, string $msg) : void

Parameters

$debuginfo : string: Message 1.
$messageDB : string: Message 2.
$msg : string: Message 3.

Return values

void —

addToMessage()

Cette methode permet de faire les verifications necessaires lors de l'ajout de messages, et d'obtenir une coherence dans l'attribut message de l'objet pour l'affichage.


    public
                    addToMessage([string $message = "" ]) : mixed

Parameters

$message : string = ""

Return values

mixed —

afterFormSpecificContent()

Point d'entrée dans la VIEW formulaire.


    public
                    afterFormSpecificContent() : void

Cette méthode à surcharger permet d'afficher des informations spécifiques après le formulaire.

Return values

void —

afterSousFormSpecificContent()

Point d'entrée dans la VIEW sousformulaire.


    public
                    afterSousFormSpecificContent() : void

Cette méthode à surcharger permet d'afficher des informations spécifiques après le sousformulaire.

Return values

void —

ajouter()

TREATMENT - ajouter.


    public
                    ajouter([array<string|int, mixed> $val = array() ][, null &$dnu1 = null ][, null $dnu2 = null ]) : bool

Cette méthode permet d'exécuter l'ajout (mode CREATE) de l'objet dans la base de données.

Parameters

$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

anneePHP()

Cette methode permet de verifier la validite d'une date et d'en retourner l'annee


    public
                    anneePHP(string $val) : mixed

Parameters

$val : string: Date saisie au format 'JJ/MM/AAAA'

Return values

mixed —

begin_treatment()

Cette méthode permet d'exécuter une routine en début des méthodes dites de TREATMENT.


    public
                    begin_treatment(string $method_name[, array<string|int, mixed> $extras = array() ]) : void

Parameters

$method_name : string: Nom de la méthode appelante.
$extras : array<string|int, mixed> = array(): Paramètres supplémentaires.

Return values

void —

bouton()

Affiche le bouton (VIEW formulaire).


    public
                    bouton(int $maj) : void

Parameters

$maj : int: Identifant numérique de l'action.

Return values

void —

boutonsousformulaire()

Affiche le bouton (VIEW sousformulaire).


    public
                    boutonsousformulaire(null $datasubmit, int $maj[, null $val = null ]) : void

Parameters

$datasubmit : null: @deprecated Non utilisé.
$maj : int: Identifant numérique de l'action.
$val : null = null: @deprecated Non utilisé.

Return values

void —

canAccess()

Cette methode est à surcharger elle permet de tester dans chaque classe des droits des droits spécifiques en fonction des données.


    public
                    canAccess() : bool

Return values

bool —

checkAccessibility()

Appelle la méthode canAccess() et affiche ou non une erreur.


    public
                    checkAccessibility() : void

Return values

void —

checkActionAvailability()

Vérification de la disponibilité de l'action sur l'objet.


    public
                    checkActionAvailability() : bool

Le postulat est que les actions ajouter, modifier, supprimer et consulter sont disponibles sur tous les objets. La disponibilité des autres actions est vérifiée si la valeur de l'action existe comme clé dans l'attribut actions de l'objet.

Return values

bool —

checkRequired()

Methode de verification des contraintes not null, affiche une erreur si nul.


    public
                    checkRequired() : mixed

Return values

mixed —

checkUniqueKey()

Methode de verification de l'unicite d'une valeur pour chaque elements du tableau unique_key, ainsi que l'unicite de la cle multiple unique_multiple_key.


    public
                    checkUniqueKey() : mixed

Return values

mixed —

clearErrors()

Cette methode vide les valeurs des erreurs du tableau errors.


    public
                    clearErrors() : void

Return values

void —

cleSecondaire()

Cette methode est appelee lors de la suppression d'un objet, elle permet d'effectuer des tests pour verifier si l'objet supprime n'est pas cle secondaire dans une autre table pour en empecher la suppression.


    public
                    cleSecondaire(string $id[, null &$dnu1 = null ][, array<string|int, mixed> $val = array() ][, null $dnu2 = null ]) : void

Parameters

$id : string: Identifiant (cle primaire) de l'objet dans la base
$dnu1 : null = null: @deprecated Ne pas utiliser.
$val : array<string|int, mixed> = array(): Tableau associatif representant les valeurs du formulaire
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

void —

cmp_class_actions()

Méthode de comparaison pour réorganisation du tableau des actions.


    public
                    cmp_class_actions(array<string|int, mixed> $a, array<string|int, mixed> $b) : int

Parameters

$a : array<string|int, mixed>: Élément à comparer n°1
$b : array<string|int, mixed>: Élément à comparer n°2

Return values

int —

1 ou -1 selon si a.order est > ou < à b.order

compose_form_url()

Permet de composer l'url vers les script 'formulaire' standards.


    public
                    compose_form_url([string $case = "form" ][, mixed $override = array() ]) : string

Parameters

$case : string = "form": Mode dans lequel l'url doit être construite.
$override : mixed = array(): Tableau de paramètre permettant de surcharger certaines valeurs récupérées de manière standard si ce n'est pas le cas.

Return values

string —

compose_portlet_actions()

Permet de composer un tableau des actions composant le portlet.


    public
                    compose_portlet_actions() : void

Ce tableau sera directement interprété par la méthode d'affichage du portlet (formulaire::afficher_portlet). Une action est composée des éléments suivant :

href,
target,
class,
onclick,
id,
libelle.

Return values

void —

compute_pdf_output()

Retourne l'édition PDF.


    public
                    compute_pdf_output(string $type, string $obj[, null|string $collectivite = null ][, null|string $idx = null ][, null|array<string|int, mixed> $params = null ]) : array<string|int, mixed>

Parameters

$type : string: Type d'édition : 'lettretype' ou 'etat'.
$obj : string
$collectivite : null|string = null
$idx : null|string = null
$params : null|array<string|int, mixed> = null

Return values

array<string|int, mixed> —

constructeur()

Constructeur.


    public
                    constructeur(string $id[, null &$dnu1 = null ][, null $dnu2 = null ]) : mixed

Parameters

$id : string: Identifiant de l'objet.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

mixed —

dateDB()

DateDB met la date au format de la base de données.


    public
                    dateDB(string $val) : string

Transforme les dates provenant du formulaire en date pour base de données. Aujourd'hui les formats acceptés en entrée sont :

J/M/AAAA
JJ/M/AAAA
J/MM/AAAA
JJ/MM/AAAA
J-M-AAAA
JJ-M-AAAA
J-MM-AAAA
JJ-MM-AAAA
AAAA-M-J
AAAA-M-JJ
AAAA-MM-J
AAAA-MM-JJ et en sortie :
JJ/MM/AAAA
AAAA-MM-JJ

Parameters

$val : string: Date à vérifier et à formater.

Return values

string —

dateDBToForm()

Méthode pour convertir une date Y-m-d en d/m/Y


    public
                    dateDBToForm(string $date) : string

Parameters

$date : string: Date au format 'YYYY-MM-DD'.

Return values

string —

datePHP()

Cette methode permet de verifier la validite d'une date et de la retourner sous le format 'AAAA-MM-JJ'


    public
                    datePHP(string $val) : mixed

Parameters

$val : string: Date saisie au format 'JJ/MM/AAAA'

Return values

mixed —

dateSystemeDB()

Retourne la date du jour au format de la base de données.


    public
                    dateSystemeDB() : string

Return values

string —

deverrouille()

Cette méthode est inutilisée depuis la version 4.5.0 du framework.


    public
                    deverrouille([null $validation = null ]) : void

Elle est conservée ici dans un souci de rétro-compatibilité. Elle sera supprimée dans la version 4.6.0 du framework.

Parameters

$validation : null = null: @deprecated

Return values

void —

end_treatment()

Cette méthode permet de logger les informations de retour depuis les méthodes dites de TREATMENT.


    public
                    end_treatment(string $method_name, bool $ret[, array<string|int, mixed> $extras = array() ]) : mixed

Parameters

$method_name : string: Nom de la méthode appelante.
$ret : bool: Valeur de retour.
$extras : array<string|int, mixed> = array(): Paramètres supplémentaires.

Return values

mixed —

erreur_db()

Cette méthode ne doit plus être appelée, c'est '$this->f->isDatabaseError($res)' qui s'occupe d'afficher le message d'erreur et de faire le 'die()'.


    public
                    erreur_db(string $debuginfo, string $messageDB, string $table) : void

Parameters

$debuginfo : string: Message 1.
$messageDB : string: Message 2.
$table : string: Inutilisé.

Return values

void —

exists()

CONDITION - exists.


    public
                    exists() : bool

Est-ce que l'enregistrement instancié existe en base de données ?

Return values

bool —

expose_pdf_output()

Expose le fichier PDF à l'utilisateur.


    public
                    expose_pdf_output(string $pdf_output, string $filename) : void

Parameters

$pdf_output : string: PDF sous forme de chaîne de caractères.
$filename : string: Nom du fichier.

Return values

void —

form_resubmit_handle_new_identifier()

Gère et affiche le champ de validité de la soumission du formulaire.


    public
                    form_resubmit_handle_new_identifier() : void

A chaque affichage de formulaire (via les méthodes formulaire et sousformulaire), lorsqu'un bouton est affiché alors on insère un champ caché (input de type hidden) qui contient comme valeur un identifiant généré et supposé unique, puis on stocke cet identifiant dans une liste dédiée dans la variable de session afin qu'il puisse être vérifié pour valider ou non la soumission du formulaire.

Return values

void —

form_resubmit_handle_valid_identifier()

Gère et retourne la validité de la soumission du formulaire.


    public
                    form_resubmit_handle_valid_identifier() : bool

Cette permet permet de vérifier :

si un identifiant est posté, si ce n'est pas le cas, on part du principe que la soumission est valide (notamment pour action-direct).
si sa valeur est bien présente dans la liste dédiée dans la variable de session, si c'est le cas on enlève la valeur de cette liste et on valide la soumission du formulaire et on va pouvoir exécuter le traitement rattaché (géré dans les vues formulaire).
Si ce n'est pas le cas, cela signifie que le formulaire a déjà été soumis au préalable donc on ne valide pas la soumission et on va pouvoir afficher une erreur à l'utilisateur (géré dans les vues formulaire).

Return values

bool —

form_specific_content_after_portlet_actions()

Point d'entrée dans la VIEW formulaire.


    public
                    form_specific_content_after_portlet_actions(int $maj) : void

Cette méthode à surcharger permet d'afficher des informations spécifiques après le portlet d'actions.

Parameters

$maj : int: Identifant numérique de l'action.

Return values

void —

form_specific_content_before_portlet_actions()

Point d'entrée dans la VIEW formulaire.


    public
                    form_specific_content_before_portlet_actions(int $maj) : void

Cette méthode à surcharger permet d'afficher des informations spécifiques avant le portlet d'actions.

Parameters

$maj : int: Identifant numérique de l'action.

Return values

void —

formSpecificContent()

Point d'entrée dans la VIEW formulaire.


    public
                    formSpecificContent(int $maj) : void

Cette méthode à surcharger permet d'afficher des informations spécifiques en fin de formulaire.

Parameters

$maj : int: Identifant numérique de l'action.

Return values

void —

formulaire()

VIEW - formulaire.


    public
                    formulaire() : void

Return values

void —

get_absolute_class_name()

Cette méthode permet de renvoyer le nom de l'objet métier absolu.


    public
                    get_absolute_class_name() : string

C'est-à-dire que la fonctionnalité custom et les cascades obj/core/gen et les surcharges permettent d'avoir noms de classe comme <OBJ>_custom ou <OBJ>_core ou <OBJ>_gen ou '<OBJ>_archive', nous avons besoin de quel objet métier est réellement pour gérer les permissions, les clés étrangères, ...

Return values

string —

get_action_crud()

Retourne le mode de l'action passée en paramètre ou null si aucun n'a été défini.


    public
                    get_action_crud([mixed $maj = null ]) : mixed

Parameters

$maj : mixed = null

Return values

mixed —

get_action_key_for_identifier()

Permet de renvoyer la clé de l'action à partir de son identifiant texte.


    public
                    get_action_key_for_identifier(string $identifier) : int

L'identifiant texte correspond à l'attribut "identifier" de l'action, il est sensé être unique et doit avoir une signification fonctionnelle en opposition à la clé qui est un entier qui n'a aucune signification fonctionnelle.

Parameters

$identifier : string: Identifiant textuel de l'action.

Return values

int —

get_action_param()

Méthode permettant de récupérer une valeur de l'action passée en paramètre.


    public
                    get_action_param(int $action, string $param) : string

Parameters

$action : int: Identifant numérique de l'action.
$param : string: paramètre à récupérer

Return values

string —

valeur du paramètre

get_back_link()

Retourne le lien de retour (VIEW formulaire et VIEW sousformulaire).


    public
                    get_back_link([string $view = "formulaire" ]) : string

Parameters

$view : string = "formulaire": Appel dans le contexte de la vue 'formulaire' ou de la vue 'sousformulaire'.

Return values

string —

get_back_target()

Retourne la cible de retour (VIEW formulaire et VIEW sousformulaire).


    public
                    get_back_target() : string

La cible de retour peut être 'form' ou 'tab'. L'ergonomie permet donc de renvoyer soit sur la vue de l'élément (form) soir sur le listing (tab).

Return values

string —

get_class_actions()

Méthode permettant de récupérer le tableau complet des actions.


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

Return values

array<string|int, mixed> —

get_default_libelle()

Retourne le libellé par défaut d'un enregistrement.


    public
                    get_default_libelle() : string

Principalement utilisé pour le titre de la page. C'est le dernier élément du titre : Rubrique > Catégorie > Libellé par défaut.

Return values

string —

get_displayed_labels_substitution_vars()

Retourne l'affichage de l'aide à la saisie des variables de remplacement.


    public
                    get_displayed_labels_substitution_vars() : string

Return values

string —

get_labels_merge_fields()

Récupération des libellés des champs de fusion


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

Return values

array<string|int, mixed> —

tableau associatif

get_labels_substitution_vars()

Récupération des libellés des champs de fusion


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

Parameters

$om_collectivite_idx : null|string = null: Identiant de la collectivité.

Return values

array<string|int, mixed> —

tableau associatif

get_merge_fields()

Récupération des champs de fusion pour l'édition ou l'aide à la saisie


    public
                    get_merge_fields(string $type) : array<string|int, mixed>

Parameters

$type : string: 'values' ou 'labels'

Return values

array<string|int, mixed> —

get_merge_fields_to_avoid()

Retourne la liste des champs à ne pas proposer dans les champs de fusion.


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

Return values

array<string|int, mixed> —

get_parameter_or_override()

Permet de récupérer la valeur d'un paramètre ou de sa surcharge.


    public
                    get_parameter_or_override([string $parameter = "" ][, mixed $override = array() ]) : mixed

Parameters

$parameter : string = "": Clé du paramètre.
$override : mixed = array(): Tableau de paramètre permettant de surcharger certaines valeurs récupérées de manière standard si ce n'est pas le cas.

Return values

mixed —

get_substitution_vars()

Récupération des variables de remplacement pour l'édition ou l'aide à la saisie.


    public
                    get_substitution_vars(string $type[, null|string $om_collectivite_idx = null ]) : array<string|int, mixed>

Parameters

$type : string: 'values' ou 'labels'
$om_collectivite_idx : null|string = null: Identiant de la collectivité.

Return values

array<string|int, mixed> —

get_values_merge_fields()

Récupération des valeurs des champs de fusion


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

Return values

array<string|int, mixed> —

tableau associatif

get_values_substitution_vars()

Récupération des valeurs des champs de fusion


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

Parameters

$om_collectivite_idx : null|string = null: Identiant de la collectivité.

Return values

array<string|int, mixed> —

tableau associatif

get_var_sql_forminc__champs()

Clause select pour la requête de sélection des données de l'enregistrement.


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

Return values

array<string|int, mixed> —

get_var_sql_forminc__selection()

Clause where pour la requête de sélection des données de l'enregistrement.


    public
                    get_var_sql_forminc__selection() : string

Return values

string —

get_var_sql_forminc__sql()

Accesseur pour récuperer les variables $sql_* depuis la configuration form.inc.


    public
                    get_var_sql_forminc__sql([string $sql = "" ]) : string

Deux niveaux de récupérations :

soit la variable $sql_<NOM_DE_LA_VARIABLE> est définie dans le script form.inc et a été affectée à un atribut de la classe nommé "var_from_sql_forminc__sql<NOM_DE_LA_VARIABLE>" par la méthode dbform::load_var_from_sql_forminc() et c'est elle qui est renvoyée
soit la méthode dbform::get_var_sql_forminc__sql_<NOM_DE_LA_VARIABLE>() est définie sur la classe et c'estson retour qui est renvoyée

Parameters

$sql : string = "": Nom de la variable à récupérer dans le préfixe 'sql_'.

Return values

string —

Valeur de la variable récupérée ou chaîne vide

get_var_sql_forminc__tableSelect()

Clause from pour la requête de sélection des données de l'enregistrement.


    public
                    get_var_sql_forminc__tableSelect() : string

Return values

string —

get_widget_config()

Accesseur pour la récupération des configurations de widget de formulaire.


    public
                    get_widget_config(string $field, string $widget) : array<string|int, mixed>|null

Parameters

$field : string
$widget : string

Return values

array<string|int, mixed>|null —

getCle()

Cette methode permet d'obtenir une chaine representant la clause where pour une requete de selection sur la cle primaire.


    public
                    getCle([string $id = "" ]) : string

Parameters

$id : string = "": Valeur de la cle primaire

Return values

string —

Clause where

getDataSubmit()

Methode permettant aux objets metiers de surcharger facilement la methode formulaire et de passer facilement des variables supplementaires en parametre. Cette methode retourne une chaine representant l'attribut action du formulaire.


    public
                    getDataSubmit() : string

Return values

string —

Attribut action du form

getDataSubmitSousForm()

Methode permettant aux objets metiers de surcharger facilement la methode sousformulaire et de passer facilement des variables supplementaires en parametre. Cette methode retourne une chaine representant l'attribut action du formulaire.


    public
                    getDataSubmitSousForm() : string

Return values

string —

Attribut action du form

getFormTitle()

Permet de modifier le fil d'Ariane depuis l'objet pour un formulaire


    public
                    getFormTitle(string $ent) : Fil

Parameters

$ent : string: Fil d'Ariane récupéréré

Return values

Fil —

d'Ariane

getLibFromField()

Méthode permettant de retourner le nom d'un champ que le formulaire soit instancié ou non


    public
                    getLibFromField(string $champ) : string

Parameters

$champ : string: nom du champ

Return values

string —

libellé

getMetadata()

Méthode permettant de calculer les métadonnées autres que celle définies lors de l'upload


    public
                    getMetadata(string $champ) : array<string|int, mixed>

Parameters

$champ : string: champ sur lequel on récupère les métadonnées

Return values

array<string|int, mixed> —

tableau contenant les métadonnées

getParameter()

Accesseur pour la propriété 'parameters'.


    public
                    getParameter([string $parameter = "" ]) : null|string

Parameters

$parameter : string = ""

Return values

null|string —

getSelectOldValue()

Met à jour la varaiable '$contenu' pour gérer d'éventuelles valeurs non valides (om_validite).


    public
                    getSelectOldValue(formulaire &$form, int $maj[, null &$dnu1 = null ][, array<string|int, mixed> &$contenu = array() ][, string $sql_by_id = "" ][, string $table = "" ][, null|array<string|int, mixed> $val = null ]) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$contenu : array<string|int, mixed> = array()
$sql_by_id : string = ""
$table : string = ""
$val : null|array<string|int, mixed> = null

Return values

void —

getSubFormTitle()

Permet de modifier le fil d'Ariane depuis l'objet pour un sous-formulaire


    public
                    getSubFormTitle(string $ent) : Fil

Parameters

$ent : string: Fil d'Ariane récupéréré

Return values

Fil —

d'Ariane

getVal()

Accesseur de l'attribut `val`.


    public
                    getVal(string $field) : mixed

Permet de récupérer la valeur d'un élément de l'attribut val via le nom du champ correspondant à cette valeur.

L'attribut val est un tableau représentant les valeurs de l'enregistrement de l'objet. Chacune des valeurs est associée au nom du champ correspondant dans l'attribut champs. C'est la clé numérique de l'élément dans chacun des tableaux qui assure la correspondance.

Exemple

Pour les trois cas, l'attribut champs est définit comme suit : $this->champs = array("id", "libelle", "description");

Cas n°1 : Aucun champ correspondant au nom transmis, on retourne une chaine vide. $this->val = array(123, "Titre", "Une description courte");

echo $this->getVal("date"); ""
Cas n°2 : Aucune valeur pour l'enregistrement, on retourne une chaine vide. $this->val = array();

echo $this->getVal("libelle"); ""
Cas n°3 : Le champ et la valeur ont une correspondance, on retourne la valeur. $this->val = array(123, "Titre", "Une description courte");

echo $this->getVal("libelle"); "Titre"

Parameters

$field : string: Nom du champ de l'objet.

Return values

mixed —

La valeur du champ de l'objet ou une chaine vide.

heureDB()

Vérifie/transforme la valeur passée en paramètre au format heure attendu par la base de données.


    public
                    heureDB(string $val) : void|string

Exemples :

"01" => "01:00:00"
"01:01" => "01:01:00"
"01H01" => "01:01:00"
"01h01" => "01:01:00"
"01:01:01" => "01:01:01"

Parameters

$val : string: Valeur à vérifier/transformer.

Return values

void|string —

init_class_actions()

Définition des actions disponibles sur la classe.


    public
                    init_class_actions() : void

Return values

void —

init_record_data()

Initialise l'enregistrement à partir d'une requête de sélection.


    public
                    init_record_data(mixed $id) : void

La requête de sélection est composée à partir des variables sql from.inc 'champs', tableSelect' et 'selection'. Grâce aux éléments de cette requête, cette méthode initialise les attributs 'champs', 'longueurMax', 'type', 'flags' et 'val' de la classe pour l'enregistrement donné.

Parameters

$id : mixed: Identifiant de l'enregistrement à initialiser.

Return values

void —

init_select()

Initialisation des valeurs des champs HTML <select>


    public
                    init_select([formulaire &$form = null ][, null &$dnu1 = null ][, int $maj = null ][, null $dnu2 = null ][, string $field = "" ][, string $sql = "" ][, string $sql_by_id = "" ][, string $om_validite = false ][, string $multiple = false ]) : void

Parameters

$form : formulaire = null: Instance formulaire.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$maj : int = null: Identifant numérique de l'action.
$dnu2 : null = null: @deprecated Ne pas utiliser.
$field : string = "": nom du champ
$sql_by_id : string = "": requete de selection valeur par identifiant
$om_validite : string = false: permet de définir si l'objet lié est affecté par une date de validité
$multiple : string = false: permet d'utiliser cette méthode pour configurer l'affichage de select_multiple (widget)

Return values

void —

is_action_available()

Permet de vérifier que l'action est disponible pour l'utilisateur.


    public
                    is_action_available(int $action) : bool

Vérification des conditions et des permissions.

Parameters

$action : int: Identifant numérique de l'action.

Return values

bool —

is_action_condition_satisfied()

Indique si les conditions d'une action sont vérifiées.


    public
                    is_action_condition_satisfied(int $action) : bool

Parameters

$action : int: Identifant numérique de l'action.

Return values

bool —

is_action_defined()

Indique si une action est définie.


    public
                    is_action_defined(int $action) : bool

Parameters

$action : int: Identifant numérique de l'action.

Return values

bool —

is_action_permission_satisfied()

Permet de vérifier que l'utilisateur a bien la permission d'accéder à l'action.


    public
                    is_action_permission_satisfied(int $action) : bool

Parameters

$action : int: Identifant numérique de l'action.

Return values

bool —

is_back_link_redirect_activated()

Indique si la redirection vers le lien de retour est activée ou non.


    public
                    is_back_link_redirect_activated() : bool

L'objectif de cette méthode est de permettre d'activer ou de désactiver la redirection dans certains contextes.

Return values

bool —

is_in_context_of_foreign_key()

Indique si on se trouve dans le contexte d'une clé étrangère.


    public
                    is_in_context_of_foreign_key([string $foreign_key = "" ][, string $context = "" ]) : bool

Lorsque l'on se trouve dans un sous formulaire, les champs qui sont liés à l'objet du formulaire principal (clé étrangère) doivent avoir un comportement spécifique. La classe du formulaire principal peut facilement être surchargée, il est donc nécessaire de modifier tous ces comportements spécifiques pour y ajouter le nom de la classe qui surcharge l'objet principal. Cette méthode permet de faciliter la vérification.

Parameters

$foreign_key : string = "": Table de la clé étrangère.
$context : string = "": Valeur du contexte (retourformulaire) qui doit être vérifiée.

Return values

bool —

is_option_class_action_activated()

Indique si les actions (nouvelles) sont activée sur la classe.


    public
                    is_option_class_action_activated() : bool

Return values

bool —

is_portlet_action_defined()

Méthode permettant de vérifier l'existance d'une action de portlet dans une action.


    public
                    is_portlet_action_defined(int $action) : bool

Parameters

$action : int: Identifant numérique de l'action.

Return values

bool —

true si le portlet est défini

isUnique()

Methode permettant de requeter la base afin de definir la validite du champ unique


    public
                    isUnique(string $champ, string $value) : mixed

Parameters

$champ : string: nom du champ unique
$value : string: valeur à inserer dans la colonne

Return values

mixed —

jourPHP()

Cette methode permet de verifier la validite d'une date et d'en retourner le jour


    public
                    jourPHP(string $val) : mixed

Parameters

$val : string: Date saisie au format 'JJ/MM/AAAA'

Return values

mixed —

load_var_from_sql_forminc()

Récupère les variables définies dans un script form.inc.


    public
                    load_var_from_sql_forminc() : void

Cette méthode permet de charger toutes les variables définies dans un éventuel script form.inc ou custom. Elle permet d'affecter chacune de ces variables dans un attribut de la classe. Le nom de cet attribut est composé comme suit : "var_from_sql_forminc_<NOM_DE_LA_VARIABLE>".

Return values

void —

message()

Affiche le bloc message.


    public
                    message() : void

Return values

void —

modifier()

TREATMENT - modifier.


    public
                    modifier([array<string|int, mixed> $val = array() ][, null &$dnu1 = null ][, null $dnu2 = null ]) : bool

Cette méthode permet d'exécuter la modification (mode UPDATE) de l'objet dans la base de données.

Parameters

$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

moisPHP()

Cette methode permet de verifier la validite d'une date et d'en retourner le mois


    public
                    moisPHP(string $val) : mixed

Parameters

$val : string: Date saisie au format 'JJ/MM/AAAA'

Return values

mixed —

post_treatment()

Traite les valeurs postées du formulaire


    public
                    post_treatment([null|int $maj = null ]) : void|bool

Parameters

$maj : null|int = null: Identifant numérique de l'action.

Return values

void|bool —

Dans le cas des anciennes actions, on ne retourne aucune valeur. Dans le cas des nouvelles actions, on retourne 'true' si la méthode de traitement s'est bien passée et 'false' sinon.

rechercheTable()

Cette methode permet de rechercher le nombre d'enregistrements ayant le champ 'field' correspondant a la valeur 'id' dans la table 'table'. Si il y a des enregistrements, alors l'attribut 'correct' de l'objet est passe a la valeur false et un message supplementaire est ajoute a l'attribut msg de l'objet.


    public
                    rechercheTable([null &$dnu1 = null ][, string $table = "" ][, string $field = "" ][, string $id = null ][, null $dnu2 = null ][, string $selection = "" ]) : void

Cette methode est principalement destinee a etre appellee depuis la methode cleSecondaire.

Parameters

$dnu1 : null = null: @deprecated Ne pas utiliser.
$table : string = ""
$field : string = ""
$id : string = null
$dnu2 : null = null: @deprecated Ne pas utiliser.
$selection : string = ""

Return values

void —

redirect_to_back_link()

Stocke le message en session et fais une redirection vers le lien de retour.


    public
                    redirect_to_back_link([string $view = "formulaire" ]) : void

Parameters

$view : string = "formulaire": Appel dans le contexte de la vue 'formulaire' ou de la vue 'sousformulaire'.

Return values

void —

retour()

Affiche le lien retour (VIEW formulaire).


    public
                    retour([null $dnu1 = null ][, null $dnu2 = null ][, null $dnu3 = null ]) : void

Cette méthode permet de composer le lien retour et de l'afficher.

Parameters

$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.
$dnu3 : null = null: @deprecated Ne pas utiliser.

Return values

void —

retoursousformulaire()

Affiche le lien retour dans la VIEW formulaire.


    public
                    retoursousformulaire([null $dnu1 = null ][, null $dnu2 = null ][, null $dnu3 = null ][, null $dnu4 = null ][, null $dnu5 = null ][, null $dnu6 = null ][, null $dnu7 = null ][, null $dnu8 = null ][, null $dnu9 = null ][, null $dnu10 = null ]) : void

Cette méthode permet de composer le lien retour et de l'afficher.

Parameters

$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.
$dnu3 : null = null: @deprecated Ne pas utiliser.
$dnu4 : null = null: @deprecated Ne pas utiliser.
$dnu5 : null = null: @deprecated Ne pas utiliser.
$dnu6 : null = null: @deprecated Ne pas utiliser.
$dnu7 : null = null: @deprecated Ne pas utiliser.
$dnu8 : null = null: @deprecated Ne pas utiliser.
$dnu9 : null = null: @deprecated Ne pas utiliser.
$dnu10 : null = null: @deprecated Ne pas utiliser.

Return values

void —

set_form_default_values()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    set_form_default_values(formulaire &$form, int $maj, int $validation) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.
$validation : int: Marqueur de validation du formulaire.

Return values

void —

set_form_specificity()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    set_form_specificity(formulaire &$form, int $maj) : void

Permet d'effectuer des appels aux mutateurs spécifiques sur le formulaire de manière fonctionnelle et non en fonction du mutateur. Exemple : au lieu de gérer le champ service dans les méthodes setType, setSelect, le setLib, ... Nous allons les gérer dans cette méthode et appeler tous les mutateurs à la suite.

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setBloc()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setBloc(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setFieldset()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setFieldset(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setGroupe()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setGroupe(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setId()

Mutateur pour la propriété 'valF' en mode CREATE.


    public
                    setId([null &$dnu1 = null ]) : void

initialisation valF pour la cle primaire (si cle automatique) [value primary key to database - automatic primary key] id automatique method nextid automatic id with dbpear method nextid

Parameters

$dnu1 : null = null: @deprecated Ne pas utiliser.

Return values

void —

setLayout()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setLayout(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setLib()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setLib(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setMax()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setMax(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setOnchange()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setOnchange(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setOnclick()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setOnclick(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setOnkeyup()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setOnkeyup(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setParameter()

Mutateur pour la propriété 'parameters'.


    public
                    setParameter([string $parameter = "" ][, string $value = "" ]) : void

Parameters

$parameter : string = ""
$value : string = ""

Return values

void —

setParameters()

Mutateur pour la propriété 'parameters'.


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

Parameters

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

Return values

void —

setRegroupe()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setRegroupe(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setRequired()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setRequired(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setSelect()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setSelect(formulaire &$form, int $maj[, null &$dnu1 = null ][, null $dnu2 = null ]) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

void —

setTaille()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setTaille(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setType()

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).


    public
                    setType(formulaire &$form, int $maj) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.

Return values

void —

setVal()

Configuration du formulaire (VIEW formulaire).


    public
                    setVal(formulaire &$form, int $maj, int $validation[, null &$dnu1 = null ][, null $dnu2 = null ]) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.
$validation : int: Marqueur de validation du formulaire.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

void —

setvalF()

Mutateur pour la propriété 'valF' en mode CREATE & UPDATE.


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

Parameters

$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.

Return values

void —

setValFAjout()

Mutateur pour la propriéré 'valF' en mode CREATE.


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

initialisation valF pour la cle primaire (si pas de cle automatique) [value primary key to database - not automatic primary key]

Parameters

$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.

Return values

void —

setValFFromVal()

Méthode permettant de remplir valF avant validation du formulaire


    public
                    setValFFromVal() : void

Return values

void —

setValsousformulaire()

Configuration du formulaire (VIEW sousformulaire).


    public
                    setValsousformulaire(formulaire &$form, int $maj, int $validation, string $idxformulaire, string $retourformulaire, string $typeformulaire[, null &$dnu1 = null ][, null $dnu2 = null ]) : void

Parameters

$form : formulaire: Instance formulaire.
$maj : int: Identifant numérique de l'action.
$validation : int: Marqueur de validation du formulaire.
$idxformulaire : string: Identifiant de l'objet du formulaire parent (form.php?idx=).
$retourformulaire : string: Objet du formulaire parent (form.php?obj=).
$typeformulaire : string: @deprecated ???
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

void —

sousform_specific_content_after_portlet_actions()

Point d'entrée dans la VIEW sousformulaire.


    public
                    sousform_specific_content_after_portlet_actions(int $maj) : void

Cette méthode à surcharger permet d'afficher des informations spécifiques après le portlet d'actions.

Parameters

$maj : int: Identifant numérique de l'action.

Return values

void —

sousform_specific_content_before_portlet_actions()

Point d'entrée dans la VIEW sousformulaire.


    public
                    sousform_specific_content_before_portlet_actions(int $maj) : void

Cette méthode à surcharger permet d'afficher des informations spécifiques avant le portlet d'actions.

Parameters

$maj : int: Identifant numérique de l'action.

Return values

void —

sousFormSpecificContent()

Point d'entrée dans la VIEW sousformulaire.


    public
                    sousFormSpecificContent(int $maj) : void

Cette méthode à surcharger permet d'afficher des informations spécifiques en fin de sousformulaire.

Parameters

$maj : int: Identifant numérique de l'action.

Return values

void —

sousformulaire()

VIEW - sousformulaire.


    public
                    sousformulaire() : void

Return values

void —

supprimer()

TREATMENT - supprimer.


    public
                    supprimer([array<string|int, mixed> $val = array() ][, null &$dnu1 = null ][, null $dnu2 = null ]) : bool

Cette méthode permet d'exécuter le traitement de suppression (mode DELETE) de l'objet dans la base de données.

Parameters

$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

testverrou()

Cette méthode est inutilisée depuis la version 4.5.0 du framework.


    public
                    testverrou() : void

Elle est conservée ici dans un souci de rétro-compatibilité. Elle sera supprimée dans la version 4.6.0 du framework.

Return values

void —

traitementFichierUploadAjoutModification()

Méthode de traitement de fichier uploadé : récupération du fichier temporaire, pour l'ajout et la modification, la suppression se fait dans un 2nd temps.


    public
                    traitementFichierUploadAjoutModification() : mixed

Return values

mixed —

traitementFichierUploadSuppression()

Méthode de traitement de fichier uploadé : récupération du fichier temporaire, pour la suppression.


    public
                    traitementFichierUploadSuppression() : mixed

Return values

mixed —

triggerajouter()

TRIGGER - triggerajouter.


    public
                    triggerajouter(string $id[, null &$dnu1 = null ][, array<string|int, mixed> $val = array() ][, null $dnu2 = null ]) : bool

Parameters

$id : string
$dnu1 : null = null: @deprecated Ne pas utiliser.
$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

triggerajouterapres()

TRIGGER - triggerajouterapres.


    public
                    triggerajouterapres(string $id[, null &$dnu1 = null ][, array<string|int, mixed> $val = array() ][, null $dnu2 = null ]) : bool

Parameters

$id : string
$dnu1 : null = null: @deprecated Ne pas utiliser.
$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

triggermodifier()

TRIGGER - triggermodifier.


    public
                    triggermodifier(string $id[, null &$dnu1 = null ][, array<string|int, mixed> $val = array() ][, null $dnu2 = null ]) : bool

Parameters

$id : string
$dnu1 : null = null: @deprecated Ne pas utiliser.
$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

triggermodifierapres()

TRIGGER - triggermodifierapres.


    public
                    triggermodifierapres(string $id[, null &$dnu1 = null ][, array<string|int, mixed> $val = array() ][, null $dnu2 = null ]) : bool

Parameters

$id : string
$dnu1 : null = null: @deprecated Ne pas utiliser.
$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

triggersupprimer()

TRIGGER - triggersupprimer.


    public
                    triggersupprimer(string $id[, null &$dnu1 = null ][, array<string|int, mixed> $val = array() ][, null $dnu2 = null ]) : mixed

Parameters

$id : string
$dnu1 : null = null: @deprecated Ne pas utiliser.
$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

mixed —

triggersupprimerapres()

TRIGGER - triggersupprimerapres.


    public
                    triggersupprimerapres(string $id[, null &$dnu1 = null ][, array<string|int, mixed> $val = array() ][, null $dnu2 = null ]) : bool

Parameters

$id : string
$dnu1 : null = null: @deprecated Ne pas utiliser.
$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

bool —

undoValidation()

Permet d'annuler toutes modifications effectuées sur le formulaire


    public
                    undoValidation() : mixed

Return values

mixed —

verifier()

Vérifie la validité des valeurs en mode CREATE & UPDATE.


    public
                    verifier([array<string|int, mixed> $val = array() ][, null &$dnu1 = null ][, null $dnu2 = null ]) : void

Parameters

$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu1 : null = null: @deprecated Ne pas utiliser.
$dnu2 : null = null: @deprecated Ne pas utiliser.

Return values

void —

verifierAjout()

Vérifie la validité des valeurs en mode CREATE.


    public
                    verifierAjout([array<string|int, mixed> $val = array() ][, null &$dnu1 = null ]) : void

Parameters

$val : array<string|int, mixed> = array(): Tableau des valeurs brutes.
$dnu1 : null = null: @deprecated Ne pas utiliser.

Return values

void —

verrouille()

Cette méthode est inutilisée depuis la version 4.5.0 du framework.


    public
                    verrouille() : void

Elle est conservée ici dans un souci de rétro-compatibilité. Elle sera supprimée dans la version 4.6.0 du framework.

Return values

void —

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 —

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 —

undoFileTransaction()

Permet d'annuler le traitement effectué sur les fichiers du formulaire si une erreur lors de l'enregistrement survient.


    private
                    undoFileTransaction() : void

Return values

void —

dbform extends om_base in package framework openmairie

Tags

Table of Contents

Properties

$_is_action_available

$actions_sup

$champs

$class_actions

$correct

$db

Tags

$errors

$flags

$foreign_keys_extended

$form

$longueurMax

$merge_fields_to_avoid_app

$merge_fields_to_avoid_core

$merge_fields_to_avoid_obj

$metadata_global

$msg

$parameters

$required_field

$retourformulaire

$sousform

$tmpFile

$type

$unique_key

$val

$valF

$f

Methods

__construct()

Parameters

Return values

__destruct()

Return values

addToErrors()

Parameters

Return values

addToMessage()

Parameters

Return values

afterFormSpecificContent()

Return values

afterSousFormSpecificContent()

Return values

ajouter()

Parameters

Return values

anneePHP()

Parameters

Return values

begin_treatment()

Parameters

Return values

bouton()

Parameters

Return values

boutonsousformulaire()

Parameters

Return values

canAccess()

Return values

checkAccessibility()

Return values

checkActionAvailability()

Return values

checkRequired()

Return values

checkUniqueKey()

Return values

clearErrors()

Return values

cleSecondaire()

Parameters

Return values

cmp_class_actions()

Parameters

Return values

dbform extends om_base
in package

framework

openmairie