$table
$table : null|string
Nom de la table.
Définition de la classe *om_dbform*.
Cette classe permet de gérer une interface entre un objet métier et sa représentation dans la base de données.
$f : null|\om_application
Instance de la classe *om_application*.
load_var_from_sql_forminc() : void
Récupère les variables définies dans un script form.inc.
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__
init_record_data(mixed $id) : void
Initialise l'enregistrement à partir d'une requête de sélection.
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é.
| mixed | $id | Identifiant de l'enregistrement à initialiser. |
get_var_sql_forminc__sql(string $sql = "") : string
GETTER_FORMINC - sql.
Accesseur pour récuperer les variables $sql_* depuis la configuration form.inc.
Deux niveaux de récupérations :
dbform::load_var_from_sql_forminc() et c'est elle qui est renvoyéedbform::get_var_sql_forminc__sql_<NOM_DE_LA_VARIABLE>()
est définie sur la classe et c'estson retour qui est renvoyée| string | $sql | Nom de la variable à récupérer dans le préfixe 'sql_'. |
Valeur de la variable récupérée ou chaîne vide
get_absolute_class_name() : string
Cette méthode permet de renvoyer le nom de l'objet métier absolu.
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 '
ajouter(array $val = array(), $dnu1 = null, null $dnu2 = null) : boolean
TREATMENT - ajouter.
Cette méthode permet d'exécuter l'ajout (mode CREATE) de l'objet dans la base de données.
| array | $val | Tableau des valeurs brutes. |
| $dnu1 | ||
| null | $dnu2 | @deprecated Ne pas utiliser. |
setValFAjout(array $val = array()) : void
SETTER_TREATMENT - setValFAjout (setValF).
Mutateur pour la propriéré 'valF' en mode CREATE.
initialisation valF pour la cle primaire (si pas de cle automatique) [value primary key to database - not automatic primary key]
| array | $val | Tableau des valeurs brutes. |
setId( $dnu1 = null) : void
SETTER_TREATMENT - setId (setValF).
Mutateur pour la propriété 'valF' en mode CREATE.
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
| $dnu1 |
modifier(array $val = array(), $dnu1 = null, null $dnu2 = null) : boolean
TREATMENT - modifier.
Cette méthode permet d'exécuter la modification (mode UPDATE) de l'objet dans la base de données.
| array | $val | Tableau des valeurs brutes. |
| $dnu1 | ||
| null | $dnu2 | @deprecated Ne pas utiliser. |
supprimer(array $val = array(), $dnu1 = null, null $dnu2 = null) : boolean
TREATMENT - supprimer.
Cette méthode permet d'exécuter le traitement de suppression (mode DELETE) de l'objet dans la base de données.
| array | $val | Tableau des valeurs brutes. |
| $dnu1 | ||
| null | $dnu2 | @deprecated Ne pas utiliser. |
cleSecondaire(string $id, $dnu1 = null, array $val = array(), null $dnu2 = null) : void
CHECK_TREATMENT - 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.
| string | $id | Identifiant (cle primaire) de l'objet dans la base |
| $dnu1 | ||
| array | $val | Tableau associatif representant les valeurs du formulaire |
| null | $dnu2 | @deprecated Ne pas utiliser. |
begin_treatment(string $method_name, array $extras = array()) : void
Cette méthode permet d'exécuter une routine en début des méthodes dites de TREATMENT. Doit être appelée une seule fois avant l'appel des méthodes dites de CHECK_TREATMENT.
| string | $method_name | Nom de la méthode appelante. |
| array | $extras | Paramètres supplémentaires. |
end_treatment(string $method_name, boolean $ret, array $extras = array()) : mixed
Cette méthode permet de logger les informations de retour depuis les méthodes dites de TREATMENT.
| string | $method_name | Nom de la méthode appelante. |
| boolean | $ret | Valeur de retour. |
| array | $extras | Paramètres supplémentaires. |
get_parameter_or_override(string $parameter = "", mixed $override = array()) : mixed
Permet de récupérer la valeur d'un paramètre ou de sa surcharge.
| string | $parameter | Clé du paramètre. |
| mixed | $override | Tableau de paramètre permettant de surcharger certaines valeurs récupérées de manière standard si ce n'est pas le cas. |
compose_form_url(string $case = "form", mixed $override = array()) : string
Permet de composer l'url vers les script 'formulaire' standards.
| string | $case | Mode dans lequel l'url doit être construite. |
| mixed | $override | Tableau de paramètre permettant de surcharger certaines valeurs récupérées de manière standard si ce n'est pas le cas. |
getDataSubmit() : string
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.
Attribut action du form
getDataSubmitSousForm() : string
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.
Attribut action du form
traitementFichierUploadAjoutModification() : \string/boolean
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.
retourne true ou un message d'erreur
get_action_key_for_identifier(string $identifier) : integer
Permet de renvoyer la clé de l'action à partir de son identifiant texte.
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.
| string | $identifier | Identifiant textuel de l'action. |
compose_portlet_actions() : void
Permet de composer un tableau des actions composant le portlet.
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 :
form_specific_content_before_portlet_actions(integer $maj) : void
Point d'entrée dans la VIEW formulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques avant le portlet d'actions.
| integer | $maj | Identifant numérique de l'action. |
form_specific_content_after_portlet_actions(integer $maj) : void
Point d'entrée dans la VIEW formulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques après le portlet d'actions.
| integer | $maj | Identifant numérique de l'action. |
sousform_specific_content_before_portlet_actions(integer $maj) : void
Point d'entrée dans la VIEW sousformulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques avant le portlet d'actions.
| integer | $maj | Identifant numérique de l'action. |
sousform_specific_content_after_portlet_actions(integer $maj) : void
Point d'entrée dans la VIEW sousformulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques après le portlet d'actions.
| integer | $maj | Identifant numérique de l'action. |
retour(null $dnu1 = null, null $dnu2 = null, null $dnu3 = null) : void
Affiche le lien retour (VIEW formulaire).
Cette méthode permet de composer le lien retour et de l'afficher.
| null | $dnu1 | @deprecated Ne pas utiliser. |
| null | $dnu2 | @deprecated Ne pas utiliser. |
| null | $dnu3 | @deprecated Ne pas utiliser. |
setVal(\formulaire $form, integer $maj, integer $validation, $dnu1 = null, null $dnu2 = null) : void
SETTER_FORM - setVal.
Configuration du formulaire (VIEW formulaire).
| \formulaire | $form | Instance formulaire. |
| integer | $maj | Identifant numérique de l'action. |
| integer | $validation | Marqueur de validation du formulaire. |
| $dnu1 | ||
| null | $dnu2 | @deprecated Ne pas utiliser. |
set_form_default_values(\formulaire $form, integer $maj, integer $validation) : void
SETTER_FORM - set_form_default_values (setVal).
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
| \formulaire | $form | Instance formulaire. |
| integer | $maj | Identifant numérique de l'action. |
| integer | $validation | Marqueur de validation du formulaire. |
setSelect(\formulaire $form, integer $maj, $dnu1 = null, null $dnu2 = null) : void
SETTER_FORM - setSelect.
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
| \formulaire | $form | Instance formulaire. |
| integer | $maj | Identifant numérique de l'action. |
| $dnu1 | ||
| null | $dnu2 | @deprecated Ne pas utiliser. |
getSelectOldValue(\formulaire $form, integer $maj, $dnu1 = null, array $contenu, string $sql_by_id, string $table, null|array $val = null) : void
Met à jour la varaiable '$contenu' pour gérer d'éventuelles valeurs non valides (om_validite).
| \formulaire | $form | Instance formulaire. |
| integer | $maj | Identifant numérique de l'action. |
| $dnu1 | ||
| array | $contenu | |
| string | $sql_by_id | |
| string | $table | |
| null|array | $val |
set_form_specificity(\formulaire $form, integer $maj) : void
SETTER_FORM - set_form_specificity.
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
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.
| \formulaire | $form | Instance formulaire. |
| integer | $maj | Identifant numérique de l'action. |
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
Affiche le lien retour dans la VIEW formulaire.
Cette méthode permet de composer le lien retour et de l'afficher.
| null | $dnu1 | @deprecated Ne pas utiliser. |
| null | $dnu2 | @deprecated Ne pas utiliser. |
| null | $dnu3 | @deprecated Ne pas utiliser. |
| null | $dnu4 | @deprecated Ne pas utiliser. |
| null | $dnu5 | @deprecated Ne pas utiliser. |
| null | $dnu6 | @deprecated Ne pas utiliser. |
| null | $dnu7 | @deprecated Ne pas utiliser. |
| null | $dnu8 | @deprecated Ne pas utiliser. |
| null | $dnu9 | @deprecated Ne pas utiliser. |
| null | $dnu10 | @deprecated Ne pas utiliser. |
setValsousformulaire(\formulaire $form, integer $maj, integer $validation, string $idxformulaire, string $retourformulaire, string $typeformulaire, $dnu1 = null, null $dnu2 = null) : void
SETTER_FORM - setValsousformulaire (setVal).
Configuration du formulaire (VIEW sousformulaire).
| \formulaire | $form | Instance formulaire. |
| integer | $maj | Identifant numérique de l'action. |
| integer | $validation | Marqueur de validation du formulaire. |
| string | $idxformulaire | Identifiant de l'objet du formulaire parent (form.php?idx=). |
| string | $retourformulaire | Objet du formulaire parent (form.php?obj=). |
| string | $typeformulaire | @deprecated ??? |
| $dnu1 | ||
| null | $dnu2 | @deprecated Ne pas utiliser. |
erreur_db(string $debuginfo, string $messageDB, string $table) : void
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()'.
| string | $debuginfo | Message 1. |
| string | $messageDB | Message 2. |
| string | $table | Inutilisé. |
rechercheTable( $dnu1 = null, string $table, string $field, string $id, null $dnu2 = null, string $selection = "") : void
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.
Cette methode est principalement destinee a etre appellee depuis la methode cleSecondaire.
| $dnu1 | ||
| string | $table | |
| string | $field | |
| string | $id | |
| null | $dnu2 | @deprecated Ne pas utiliser. |
| string | $selection |
init_select(\formulaire $form = null, $dnu1 = null, integer $maj, null $dnu2 = null, string $field, string $sql, string $sql_by_id = "", string $om_validite = false, string $multiple = false) : void
Initialisation des valeurs des champs HTML <select>
| \formulaire | $form | Instance formulaire. |
| $dnu1 | ||
| integer | $maj | Identifant numérique de l'action. |
| null | $dnu2 | @deprecated Ne pas utiliser. |
| string | $field | nom du champ |
| string | $sql | requete de selection des valeurs du |
| string | $sql_by_id | requete de selection valeur par identifiant |
| string | $om_validite | permet de définir si l'objet lié est affecté par une date de validité |
| string | $multiple | permet d'utiliser cette méthode pour configurer l'affichage de select_multiple (widget) |
getVal(string $field) : mixed
Accesseur de l'attribut `val`.
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.
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"); ""
echo $this->getVal("libelle"); "Titre"
| string | $field | Nom du champ de l'objet. |
La valeur du champ de l'objet ou une chaine vide.
checkActionAvailability() : boolean
Vérification de la disponibilité de l'action sur l'objet.
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.
is_in_context_of_foreign_key(string $foreign_key = "", string $context = "") : boolean
Indique si on se trouve dans le contexte d'une clé étrangère.
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.
| string | $foreign_key | Table de la clé étrangère. |
| string | $context | Valeur du contexte (retourformulaire) qui doit être vérifiée. |
form_resubmit_handle_valid_identifier() : boolean
Gère et retourne la validité de la soumission du formulaire.
Cette permet permet de vérifier :
form_resubmit_handle_new_identifier() : void
Gère et affiche le champ de validité de la soumission du formulaire.
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.
dateDB(string $val) : string
DateDB met la date au format de la base de données.
Transforme les dates provenant du formulaire en date pour base de données. Aujourd'hui les formats acceptés en entrée sont :
| string | $val | Date à vérifier et à formater. |
heureDB(string $val) : void|string
Vérifie/transforme la valeur passée en paramètre au format heure attendu par la base de données.
Exemples :
| string | $val | Valeur à vérifier/transformer. |
compute_pdf_output(string $type, string $obj, null|string $collectivite = null, null|string $idx = null, null|array $params = null) : array
Retourne l'édition PDF.
| string | $type | Type d'édition : 'lettretype' ou 'etat'. |
| string | $obj | |
| null|string | $collectivite | |
| null|string | $idx | |
| null|array | $params |
get_substitution_vars(string $type, null|string $om_collectivite_idx = null) : array
Récupération des variables de remplacement pour l'édition ou l'aide à la saisie.
| string | $type | 'values' ou 'labels' |
| null|string | $om_collectivite_idx | Identiant de la collectivité. |
post_treatment(null|integer $maj = null) : void|boolean
Traite les valeurs postées du formulaire
| null|integer | $maj | Identifant numérique de l'action. |
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.