$db
$db :null|\database
Instance de connexion à la base de données.
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.
$db :null|\database
Instance de connexion à la base de données.
$selectioncol :string
Colonne choisie pour la sélection sur le tableau de la page précédente (tab.php?selectioncol=).
None found |
None found |
$form :null|\formulaire
Objet formulaire
None found |
$actions_sup :array
Actions du portlet supplementaires provenant d'un script form.inc
None found |
$_is_action_available :null|boolean
Marqueur permettant de déterminer si l'action sur laquelle on se trouve est disponible sur l'objet instancié et dans le contexte.
None found |
$metadata_global :array
Liste des métadonnées communes à l'ensemble des fichiers de l'application
None found |
$errors :array
Ce tableau récupère les messages d'erreurs
None found |
$tmpFile :array
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.
None found |
$sousform :boolean
Flag permettant de définir si on setrouve en sousformulaire.
None found |
$retourformulaire :mixed
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
None found |
$foreign_keys_extended :mixed
Liste des clés étrangères avec la liste des éventuelles surcharges de leur classe.
$foreign_keys_extended = array(
"
None found |
$merge_fields_to_avoid_core :array
Liste des champs à ne pas proposer dans les champs de fusion (niveau core).
None found |
$merge_fields_to_avoid_app :array
Liste des champs à ne pas proposer dans les champs de fusion (niveau app).
None found |
$merge_fields_to_avoid_obj :array
Liste des champs à ne pas proposer dans les champs de fusion (niveau obj).
None found |
$f :null|\application
Instance de la classe 'application'.
None found |
None found |
__construct(string $id, $dnu1 = null,null $dnu2 = null)
Constructeur.
string | $id | Identifiant de l'objet. |
$dnu1 | ||
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
constructeur(string $id, $dnu1 = null,null $dnu2 = null)
Constructeur.
string | $id | Identifiant de l'objet. |
$dnu1 | ||
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
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__
None found |
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. |
None found |
get_var_sql_forminc__champs(): array
Clause select pour la requête de sélection des données de l'enregistrement.
None found |
get_var_sql_forminc__tableSelect(): string
Clause from pour la requête de sélection des données de l'enregistrement.
None found |
get_var_sql_forminc__selection(): string
Clause where pour la requête de sélection des données de l'enregistrement.
None found |
get_var_sql_forminc__sql(string $sql = ""): string
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éestring | $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
None found |
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 '
None found |
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. |
None found |
setValFAjout(array $val = array()): void
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. |
None found |
setId( $dnu1 = null): void
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 |
None found |
verifierAjout(array $val = array(), $dnu1 = null): void
Vérifie la validité des valeurs en mode CREATE.
array | $val | Tableau des valeurs brutes. |
$dnu1 |
None found |
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. |
None found |
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. |
None found |
verifier(array $val = array(), $dnu1 = null,null $dnu2 = null): void
Vérifie la validité des valeurs en mode CREATE & UPDATE.
array | $val | Tableau des valeurs brutes. |
$dnu1 | ||
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
cleSecondaire(string $id, $dnu1 = null,array $val = array(),null $dnu2 = null): void
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. |
None found |
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.
string | $method_name | Nom de la méthode appelante. |
array | $extras | Paramètres supplémentaires. |
None found |
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. |
None found |
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.
None found |
isUnique(string $champ,string $value)
Methode permettant de requeter la base afin de definir la validite du champ unique
string | $champ | nom du champ unique |
string | $value | valeur à inserer dans la colonne |
None found |
checkRequired()
Methode de verification des contraintes not null, affiche une erreur si nul.
None found |
getLibFromField(string $champ): string
Méthode permettant de retourner le nom d'un champ que le formulaire soit instancié ou non
string | $champ | nom du champ |
libellé
None found |
setvalF(array $val = array()): void
Mutateur pour la propriété 'valF' en mode CREATE & UPDATE.
array | $val | Tableau des valeurs brutes. |
None found |
triggerajouter(string $id, $dnu1 = null,array $val = array(),null $dnu2 = null): boolean
TRIGGER - triggerajouter.
string | $id | |
$dnu1 | ||
array | $val | Tableau des valeurs brutes. |
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
triggermodifier(string $id, $dnu1 = null,array $val = array(),null $dnu2 = null): boolean
TRIGGER - triggermodifier.
string | $id | |
$dnu1 | ||
array | $val | Tableau des valeurs brutes. |
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
triggersupprimer(string $id, $dnu1 = null,array $val = array(),null $dnu2 = null)
TRIGGER - triggersupprimer.
string | $id | |
$dnu1 | ||
array | $val | Tableau des valeurs brutes. |
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
triggerajouterapres(string $id, $dnu1 = null,array $val = array(),null $dnu2 = null): boolean
TRIGGER - triggerajouterapres.
string | $id | |
$dnu1 | ||
array | $val | Tableau des valeurs brutes. |
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
triggermodifierapres(string $id, $dnu1 = null,array $val = array(),null $dnu2 = null): boolean
TRIGGER - triggermodifierapres.
string | $id | |
$dnu1 | ||
array | $val | Tableau des valeurs brutes. |
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
triggersupprimerapres(string $id, $dnu1 = null,array $val = array(),null $dnu2 = null): boolean
TRIGGER - triggersupprimerapres.
string | $id | |
$dnu1 | ||
array | $val | Tableau des valeurs brutes. |
null | $dnu2 | @deprecated Ne pas utiliser. |
None found |
setParameters(array $parameters = array()): void
Mutateur pour la propriété 'parameters'.
array | $parameters |
None found |
setParameter(string $parameter = "",string $value = ""): void
Mutateur pour la propriété 'parameters'.
string | $parameter | |
string | $value |
None found |
getParameter(string $parameter = ""): null|string
Accesseur pour la propriété 'parameters'.
string | $parameter |
None found |
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. |
None found |
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. |
None found |
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
None found |
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
None found |
getMetadata(string $champ): array
Méthode permettant de calculer les métadonnées autres que celle définies lors de l'upload
string | $champ | champ sur lequel on récupère les métadonnées |
tableau contenant les métadonnées
None found |
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
None found |
traitementFichierUploadSuppression(): \string/boolean
Méthode de traitement de fichier uploadé : récupération du fichier temporaire, pour la suppression.
retourne true ou un message d'erreur
None found |
undoValidation()
Permet d'annuler toutes modifications effectuées sur le formulaire
None found |
todo | Changer l'attribut name du formulaire pour optimiser la gestion des formulaires |
---|
get_widget_config(string $field,string $widget): array|null
Accesseur pour la récupération des configurations de widget de formulaire.
string | $field | |
string | $widget |
None found |
cmp_class_actions(array $a,array $b): integer
Méthode de comparaison pour réorganisation du tableau des actions.
array | $a | Élément à comparer n°1 |
array | $b | Élément à comparer n°2 |
1 ou -1 selon si a.order est > ou < à b.order
None found |
is_portlet_action_defined(integer $action): boolean
Méthode permettant de vérifier l'existance d'une action de portlet dans une action.
integer | $action | Identifant numérique de l'action. |
true si le portlet est défini
None found |
is_action_available(integer $action): boolean
Permet de vérifier que l'action est disponible pour l'utilisateur.
Vérification des conditions et des permissions.
integer | $action | Identifant numérique de l'action. |
None found |
is_action_defined(integer $action): boolean
Indique si une action est définie.
integer | $action | Identifant numérique de l'action. |
None found |
is_action_condition_satisfied(integer $action): boolean
Indique si les conditions d'une action sont vérifiées.
integer | $action | Identifant numérique de l'action. |
None found |
is_action_permission_satisfied(integer $action): boolean
Permet de vérifier que l'utilisateur a bien la permission d'accéder à l'action.
integer | $action | Identifant numérique de l'action. |
None found |
get_class_actions(): array
Méthode permettant de récupérer le tableau complet des actions.
None found |
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. |
None found |
None found |
get_action_param(integer $action,string $param): string
Méthode permettant de récupérer une valeur de l'action passée en paramètre.
integer | $action | Identifant numérique de l'action. |
string | $param | paramètre à récupérer |
valeur du paramètre
None found |
get_action_crud(\[integer] $maj = null): \[string]
Retourne le mode de l'action passée en paramètre ou null si aucun n'a été défini.
\[integer] | $maj | clé de l'action, optionnelle |
mode de l'action ou null si aucun spécifié
None found |
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 :
None found |
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. |
None found |
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. |
None found |
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. |
None found |
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. |
None found |
formSpecificContent(integer $maj): void
Point d'entrée dans la VIEW formulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques en fin de formulaire.
integer | $maj | Identifant numérique de l'action. |
None found |
sousFormSpecificContent(integer $maj): void
Point d'entrée dans la VIEW sousformulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques en fin de sousformulaire.
integer | $maj | Identifant numérique de l'action. |
None found |
afterFormSpecificContent(): void
Point d'entrée dans la VIEW formulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques après le formulaire.
None found |
afterSousFormSpecificContent(): void
Point d'entrée dans la VIEW sousformulaire.
Cette méthode à surcharger permet d'afficher des informations spécifiques après le sousformulaire.
None found |
deverrouille(null $validation = null): void
Cette méthode est inutilisée depuis la version 4.5.0 du framework.
Elle est conservée ici dans un souci de rétro-compatibilité. Elle sera supprimée dans la version 4.6.0 du framework.
null | $validation | @deprecated |
None found |
verrouille(): void
Cette méthode est inutilisée depuis la version 4.5.0 du framework.
Elle est conservée ici dans un souci de rétro-compatibilité. Elle sera supprimée dans la version 4.6.0 du framework.
None found |
testverrou(): void
Cette méthode est inutilisée depuis la version 4.5.0 du framework.
Elle est conservée ici dans un souci de rétro-compatibilité. Elle sera supprimée dans la version 4.6.0 du framework.
None found |
is_back_link_redirect_activated(): boolean
Indique si la redirection vers le lien de retour est activée ou non.
L'objectif de cette méthode est de permettre d'activer ou de désactiver la redirection dans certains contextes.
None found |
redirect_to_back_link(string $view = "formulaire"): void
Stocke le message en session et fais une redirection vers le lien de retour.
string | $view | Appel dans le contexte de la vue 'formulaire' ou de la vue 'sousformulaire'. |
None found |
get_back_target(): string
Retourne la cible de retour (VIEW formulaire et VIEW sousformulaire).
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).
None found |
get_back_link(string $view = "formulaire"): string
Retourne le lien de retour (VIEW formulaire et VIEW sousformulaire).
string | $view | Appel dans le contexte de la vue 'formulaire' ou de la vue 'sousformulaire'. |
None found |
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. |
None found |
bouton(integer $maj): void
Affiche le bouton (VIEW formulaire).
integer | $maj | Identifant numérique de l'action. |
None found |
boutonsousformulaire(null $datasubmit,integer $maj,null $val = null): void
Affiche le bouton (VIEW sousformulaire).
null | $datasubmit | @deprecated Non utilisé. |
integer | $maj | Identifant numérique de l'action. |
null | $val | @deprecated Non utilisé. |
None found |
setRequired(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setVal(\formulaire $form,integer $maj,integer $validation, $dnu1 = null,null $dnu2 = null): void
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. |
None found |
set_form_default_values(\formulaire $form,integer $maj,integer $validation): void
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. |
None found |
setValFFromVal(): void
Méthode permettant de remplir valF avant validation du formulaire
None found |
setType(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setLib(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setTaille(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setMax(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setSelect(\formulaire $form,integer $maj, $dnu1 = null,null $dnu2 = null): void
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. |
None found |
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 |
None found |
setOnchange(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setOnkeyup(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setOnclick(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setGroupe(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setRegroupe(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setBloc(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setFieldset(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
setLayout(\formulaire $form,integer $maj): void
Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).
\formulaire | $form | Instance formulaire. |
integer | $maj | Identifant numérique de l'action. |
None found |
set_form_specificity(\formulaire $form,integer $maj): void
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. |
None found |
getFormTitle(string $ent): \Fil
Permet de modifier le fil d'Ariane depuis l'objet pour un formulaire
string | $ent | Fil d'Ariane récupéréré |
d'Ariane
None found |
getSubFormTitle(string $subEnt): \Fil
Permet de modifier le fil d'Ariane depuis l'objet pour un sous-formulaire
string | $subEnt | Fil d'Ariane récupéréré |
d'Ariane
None found |
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. |
None found |
setValsousformulaire(\formulaire $form,integer $maj,integer $validation,string $idxformulaire,string $retourformulaire,string $typeformulaire, $dnu1 = null,null $dnu2 = null): void
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. |
None found |
getCle(string $id = ""): string
Cette methode permet d'obtenir une chaine representant la clause where pour une requete de selection sur la cle primaire.
string | $id | Valeur de la cle primaire |
Clause where
None found |
addToMessage(string $message = "")
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.
string | $message |
None found |
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é. |
None found |
addToErrors(string $debuginfo,string $messageDB,string $msg): void
Cette methode remplace erreur_db, et permet de remplir le tableau d'erreur
string | $debuginfo | Message 1. |
string | $messageDB | Message 2. |
string | $msg | Message 3. |
None found |
None found |
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 |
None found |
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) |
None found |
canAccess(): boolean
Cette methode est à surcharger elle permet de tester dans chaque classe des droits des droits spécifiques en fonction des données.
None found |
checkAccessibility(): void
Appelle la méthode canAccess() et affiche ou non une erreur.
None found |
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.
None found |
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.
None found |
is_option_class_action_activated(): boolean
Indique si les actions (nouvelles) sont activée sur la classe.
None found |
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. |
None found |
form_resubmit_handle_valid_identifier(): boolean
Gère et retourne la validité de la soumission du formulaire.
Cette permet permet de vérifier :
None found |
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.
None found |
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. |
None found |
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. |
None found |
dateSystemeDB(): string
Retourne la date du jour au format de la base de données.
None found |
datePHP(string $val): mixed
Cette methode permet de verifier la validite d'une date et de la retourner sous le format 'AAAA-MM-JJ'
string | $val | Date saisie au format 'JJ/MM/AAAA' |
None found |
anneePHP(string $val): mixed
Cette methode permet de verifier la validite d'une date et d'en retourner l'annee
string | $val | Date saisie au format 'JJ/MM/AAAA' |
None found |
moisPHP(string $val): mixed
Cette methode permet de verifier la validite d'une date et d'en retourner le mois
string | $val | Date saisie au format 'JJ/MM/AAAA' |
None found |
jourPHP(string $val): mixed
Cette methode permet de verifier la validite d'une date et d'en retourner le jour
string | $val | Date saisie au format 'JJ/MM/AAAA' |
None found |
dateDBToForm(string $date): string
Méthode pour convertir une date Y-m-d en d/m/Y
string | $date | Date au format 'YYYY-MM-DD'. |
None found |
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 |
None found |
expose_pdf_output(string $pdf_output,string $filename): void
Expose le fichier PDF à l'utilisateur.
string | $pdf_output | PDF sous forme de chaîne de caractères. |
string | $filename | Nom du fichier. |
None found |
get_merge_fields_to_avoid(): array
Retourne la liste des champs à ne pas proposer dans les champs de fusion.
None found |
get_merge_fields(string $type): array
Récupération des champs de fusion pour l'édition ou l'aide à la saisie
string | $type | 'values' ou 'labels' |
None found |
get_values_merge_fields(): array
Récupération des valeurs des champs de fusion
tableau associatif
None found |
get_labels_merge_fields(): array
Récupération des libellés des champs de fusion
tableau associatif
None found |
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é. |
None found |
get_values_substitution_vars(null|string $om_collectivite_idx = null): array
Récupération des valeurs des champs de fusion
null|string | $om_collectivite_idx | Identiant de la collectivité. |
tableau associatif
None found |
get_labels_substitution_vars(null|string $om_collectivite_idx = null): array
Récupération des libellés des champs de fusion
null|string | $om_collectivite_idx | Identiant de la collectivité. |
tableau associatif
None found |
get_displayed_labels_substitution_vars(): string
Retourne l'affichage de l'aide à la saisie des variables de remplacement.
None found |
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.
None found |
init_om_application(): boolean
Initialisation de la classe 'application'.
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.
None found |
addToLog(string $message,integer $type = DEBUG_MODE): void
Ajout d'un message au système de logs.
Cette méthode permet de logger un message.
string | $message | Message à logger. |
integer | $type | Niveau de log du message. |
None found |