\dbform

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.

Summary

Methods
Properties
Constants
__destruct()
constructeur()
get_class_custom()
ajouter()
setValFAjout()
setId()
verifierAjout()
modifier()
supprimer()
verifier()
cleSecondaire()
begin_treatment()
end_treatment()
checkUniqueKey()
isUnique()
checkRequired()
getLibFromField()
setvalF()
triggerajouter()
triggermodifier()
triggersupprimer()
triggerajouterapres()
triggermodifierapres()
triggersupprimerapres()
setParameters()
setParameter()
getParameter()
get_parameter_or_override()
compose_form_url()
getDataSubmit()
getDataSubmitSousForm()
getMetadata()
traitementFichierUploadAjoutModification()
traitementFichierUploadSuppression()
undoValidation()
formulaire()
cmp_class_actions()
is_portlet_action_defined()
is_action_available()
is_action_defined()
is_action_condition_satisfied()
is_action_permission_satisfied()
get_class_actions()
get_action_key_for_identifier()
init_class_actions()
get_action_param()
get_action_crud()
compose_portlet_actions()
form_specific_content_before_portlet_actions()
form_specific_content_after_portlet_actions()
sousform_specific_content_before_portlet_actions()
sousform_specific_content_after_portlet_actions()
formSpecificContent()
sousFormSpecificContent()
afterFormSpecificContent()
afterSousFormSpecificContent()
deverrouille()
verrouille()
testverrou()
is_back_link_redirect_activated()
redirect_to_back_link()
get_back_target()
get_back_link()
message()
retour()
bouton()
boutonsousformulaire()
setRequired()
setVal()
set_form_default_values()
setValFFromVal()
setType()
setLib()
setTaille()
setMax()
setSelect()
getSelectOldValue()
setOnchange()
setOnkeyup()
setOnclick()
setGroupe()
setRegroupe()
setBloc()
setFieldset()
setLayout()
set_form_specificity()
getFormTitle()
getSubFormTitle()
sousformulaire()
retoursousformulaire()
setValsousformulaire()
getCle()
addToMessage()
erreur_db()
addToErrors()
clearErrors()
rechercheTable()
init_select()
canAccess()
checkAccessibility()
getVal()
checkActionAvailability()
is_option_class_action_activated()
is_in_context_of_foreign_key()
form_resubmit_handle_valid_identifier()
form_resubmit_handle_new_identifier()
dateDB()
heureDB()
dateSystemeDB()
datePHP()
anneePHP()
moisPHP()
jourPHP()
dateDBToForm()
compute_pdf_output()
expose_pdf_output()
get_merge_fields_to_avoid()
get_merge_fields()
get_values_merge_fields()
get_labels_merge_fields()
get_substitution_vars()
get_values_substitution_vars()
get_labels_substitution_vars()
get_displayed_labels_substitution_vars()
post_treatment()
$db
$champs
$type
$longueurMax
$flags
$val
$valF
$msg
$correct
$selectioncol
$recherche
$form
$parameters
$actions_sup
$class_actions
$unique_key
$required_field
$_is_action_available
$metadata_global
$errors
$tmpFile
$sousform
$retourformulaire
$foreign_keys_extended
$merge_fields_to_avoid_core
$merge_fields_to_avoid_app
$merge_fields_to_avoid_obj
No constants found
init_om_application()
addToLog()
$f
N/A
undoFileTransaction()
No private properties found
N/A

Properties

$db

$db : null|\database

Instance de connexion à la base de données.

Type

null|\database

$champs

$champs : array

Informations DB nom de chaque champ

Type

array

$type

$type : array

Informations DB type de chaque champ

Type

array

$longueurMax

$longueurMax : array

Informations DB taille de chaque champ

Type

array

$flags

$flags : array

Informations DB flag de chaque champ ???

Type

array

$val

$val : array

Valeur des champs requete selection

Type

array

$valF

$valF : array

Valeur des champs retournes pour saisie et maj

Type

array

$msg

$msg : string

Message retourne au formulaire de saisie

Type

string

$correct

$correct : boolean

Flag pour validation des donnees

Type

boolean

$selectioncol

$selectioncol : string

Colonne choisie pour la sélection sur le tableau de la page précédente (tab.php?selectioncol=).

Type

string

$recherche

$recherche : string

Chaine recherchee (tab.php?recherche=).

Type

string

$form

$form : null|\formulaire

Objet formulaire

Type

null|\formulaire

$parameters

$parameters : array

Valeurs de tous les parametres

Type

array

$actions_sup

$actions_sup : array

Actions du portlet supplementaires provenant des fichiers .form.inc.php

Type

array

$class_actions

$class_actions : array

Actions par defaut dans openMairie

Type

array

$unique_key

$unique_key : array

Liste des champs uniques

Type

array

$required_field

$required_field : array

Liste des champs not null

Type

array

$_is_action_available

$_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.

Type

null|boolean

$metadata_global

$metadata_global : array

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

Type

array

$errors

$errors : array

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

Type

array — Valeurs de toutes les erreurs

$tmpFile

$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.

Type

array — au format retourné pas le storage

$sousform

$sousform : boolean

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

Type

boolean

$retourformulaire

$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

Type

mixed

$foreign_keys_extended

$foreign_keys_extended : mixed

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

$foreign_keys_extended = array( "" => array("", ), "" => array("", ), );

Type

mixed

$merge_fields_to_avoid_core

$merge_fields_to_avoid_core : array

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

Type

array

$merge_fields_to_avoid_app

$merge_fields_to_avoid_app : array

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

Type

array

$merge_fields_to_avoid_obj

$merge_fields_to_avoid_obj : array

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

Type

array

$f

$f : null|\application

Instance de la classe 'application'.

Type

null|\application

Methods

__destruct()

__destruct() 

Destructeur.

constructeur()

constructeur(string  $id,   $dnu1 = null, null  $dnu2 = null) 

Constructeur.

Parameters

string $id

Identifiant de l'objet.

$dnu1
null $dnu2

@deprecated Ne pas utiliser.

get_class_custom()

get_class_custom() : string

Remplace get_class($this) en enlevant custom

Returns

string

ajouter()

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.

Parameters

array $val

Tableau des valeurs brutes.

$dnu1
null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

setValFAjout()

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]

Parameters

array $val

Tableau des valeurs brutes.

setId()

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

Parameters

$dnu1

verifierAjout()

verifierAjout(array  $val = array(),   $dnu1 = null) : void

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

Parameters

array $val

Tableau des valeurs brutes.

$dnu1

modifier()

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.

Parameters

array $val

Tableau des valeurs brutes.

$dnu1
null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

supprimer()

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.

Parameters

array $val

Tableau des valeurs brutes.

$dnu1
null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

verifier()

verifier(array  $val = array(),   $dnu1 = null, null  $dnu2 = null) : void

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

Parameters

array $val

Tableau des valeurs brutes.

$dnu1
null $dnu2

@deprecated Ne pas utiliser.

cleSecondaire()

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.

Parameters

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()

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.

Parameters

string $method_name

Nom de la méthode appelante.

array $extras

Paramètres supplémentaires.

end_treatment()

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.

Parameters

string $method_name

Nom de la méthode appelante.

boolean $ret

Valeur de retour.

array $extras

Paramètres supplémentaires.

Returns

mixed

checkUniqueKey()

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.

isUnique()

isUnique(string  $champ, string  $value) 

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

Parameters

string $champ

nom du champ unique

string $value

valeur à inserer dans la colonne

checkRequired()

checkRequired() 

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

getLibFromField()

getLibFromField(string  $champ) : string

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

Parameters

string $champ

nom du champ

Returns

string —

libellé

setvalF()

setvalF(array  $val = array()) : void

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

Parameters

array $val

Tableau des valeurs brutes.

triggerajouter()

triggerajouter(string  $id,   $dnu1 = null, array  $val = array(), null  $dnu2 = null) : boolean

TRIGGER - triggerajouter.

Parameters

string $id
$dnu1
array $val

Tableau des valeurs brutes.

null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

triggermodifier()

triggermodifier(string  $id,   $dnu1 = null, array  $val = array(), null  $dnu2 = null) : boolean

TRIGGER - triggermodifier.

Parameters

string $id
$dnu1
array $val

Tableau des valeurs brutes.

null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

triggersupprimer()

triggersupprimer(string  $id,   $dnu1 = null, array  $val = array(), null  $dnu2 = null) 

TRIGGER - triggersupprimer.

Parameters

string $id
$dnu1
array $val

Tableau des valeurs brutes.

null $dnu2

@deprecated Ne pas utiliser.

triggerajouterapres()

triggerajouterapres(string  $id,   $dnu1 = null, array  $val = array(), null  $dnu2 = null) : boolean

TRIGGER - triggerajouterapres.

Parameters

string $id
$dnu1
array $val

Tableau des valeurs brutes.

null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

triggermodifierapres()

triggermodifierapres(string  $id,   $dnu1 = null, array  $val = array(), null  $dnu2 = null) : boolean

TRIGGER - triggermodifierapres.

Parameters

string $id
$dnu1
array $val

Tableau des valeurs brutes.

null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

triggersupprimerapres()

triggersupprimerapres(string  $id,   $dnu1 = null, array  $val = array(), null  $dnu2 = null) : boolean

TRIGGER - triggersupprimerapres.

Parameters

string $id
$dnu1
array $val

Tableau des valeurs brutes.

null $dnu2

@deprecated Ne pas utiliser.

Returns

boolean

setParameters()

setParameters(array  $parameters = array()) : void

Mutateur pour la propriété 'parameters'.

Parameters

array $parameters

setParameter()

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

Mutateur pour la propriété 'parameters'.

Parameters

string $parameter
string $value

getParameter()

getParameter(string  $parameter = "") : null|string

Accesseur pour la propriété 'parameters'.

Parameters

string $parameter

Returns

null|string

get_parameter_or_override()

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.

Parameters

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.

Returns

mixed

compose_form_url()

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

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

Parameters

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.

Returns

string

getDataSubmit()

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.

Returns

string —

Attribut action du form

getDataSubmitSousForm()

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.

Returns

string —

Attribut action du form

getMetadata()

getMetadata(string  $champ) : array

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

Parameters

string $champ

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

Returns

array —

tableau contenant les métadonnées

traitementFichierUploadAjoutModification()

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.

Returns

\string/boolean —

retourne true ou un message d'erreur

traitementFichierUploadSuppression()

traitementFichierUploadSuppression() : \string/boolean

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

Returns

\string/boolean —

retourne true ou un message d'erreur

undoValidation()

undoValidation() 

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

formulaire()

formulaire() : void

VIEW - formulaire.

cmp_class_actions()

cmp_class_actions(array  $a, array  $b) : integer

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

Parameters

array $a

Élément à comparer n°1

array $b

Élément à comparer n°2

Returns

integer —

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

is_portlet_action_defined()

is_portlet_action_defined(integer  $action) : boolean

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

Parameters

integer $action

Identifant numérique de l'action.

Returns

boolean —

true si le portlet est défini

is_action_available()

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.

Parameters

integer $action

Identifant numérique de l'action.

Returns

boolean

is_action_defined()

is_action_defined(integer  $action) : boolean

Indique si une action est définie.

Parameters

integer $action

Identifant numérique de l'action.

Returns

boolean

is_action_condition_satisfied()

is_action_condition_satisfied(integer  $action) : boolean

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

Parameters

integer $action

Identifant numérique de l'action.

Returns

boolean

is_action_permission_satisfied()

is_action_permission_satisfied(integer  $action) : boolean

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

Parameters

integer $action

Identifant numérique de l'action.

Returns

boolean

get_class_actions()

get_class_actions() : array

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

Returns

array

get_action_key_for_identifier()

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.

Parameters

string $identifier

Identifiant textuel de l'action.

Returns

integer

init_class_actions()

init_class_actions() : void

Définition des actions disponibles sur la classe.

get_action_param()

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.

Parameters

integer $action

Identifant numérique de l'action.

string $param

paramètre à récupérer

Returns

string —

valeur du paramètre

get_action_crud()

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.

Parameters

\[integer] $maj

clé de l'action, optionnelle

Returns

\[string] —

mode de l'action ou null si aucun spécifié

compose_portlet_actions()

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 :

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

form_specific_content_before_portlet_actions()

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.

Parameters

integer $maj

Identifant numérique de l'action.

form_specific_content_after_portlet_actions()

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.

Parameters

integer $maj

Identifant numérique de l'action.

sousform_specific_content_before_portlet_actions()

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.

Parameters

integer $maj

Identifant numérique de l'action.

sousform_specific_content_after_portlet_actions()

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.

Parameters

integer $maj

Identifant numérique de l'action.

formSpecificContent()

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.

Parameters

integer $maj

Identifant numérique de l'action.

sousFormSpecificContent()

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.

Parameters

integer $maj

Identifant numérique de l'action.

afterFormSpecificContent()

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.

afterSousFormSpecificContent()

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.

deverrouille()

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.

Parameters

null $validation

@deprecated

verrouille()

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.

testverrou()

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.

is_back_link_redirect_activated()

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.

Returns

boolean

redirect_to_back_link()

redirect_to_back_link(string  $view = "formulaire") : void

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

Parameters

string $view

Appel dans le contexte de la vue 'formulaire' ou de la vue 'sousformulaire'.

get_back_target()

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).

Returns

string

get_back_link()

get_back_link(string  $view = "formulaire") : string

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

Parameters

string $view

Appel dans le contexte de la vue 'formulaire' ou de la vue 'sousformulaire'.

Returns

string

message()

message() : void

Affiche le bloc message.

retour()

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.

Parameters

null $dnu1

@deprecated Ne pas utiliser.

null $dnu2

@deprecated Ne pas utiliser.

null $dnu3

@deprecated Ne pas utiliser.

bouton()

bouton(integer  $maj) : void

Affiche le bouton (VIEW formulaire).

Parameters

integer $maj

Identifant numérique de l'action.

boutonsousformulaire()

boutonsousformulaire(null  $datasubmit, integer  $maj, null  $val = null) : void

Affiche le bouton (VIEW sousformulaire).

Parameters

null $datasubmit

@deprecated Non utilisé.

integer $maj

Identifant numérique de l'action.

null $val

@deprecated Non utilisé.

setRequired()

setRequired(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setVal()

setVal(\formulaire  $form, integer  $maj, integer  $validation,   $dnu1 = null, null  $dnu2 = null) : void

Configuration du formulaire (VIEW formulaire).

Parameters

\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()

set_form_default_values(\formulaire  $form, integer  $maj, integer  $validation) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

integer $validation

Marqueur de validation du formulaire.

setValFFromVal()

setValFFromVal() : void

Méthode permettant de remplir valF avant validation du formulaire

setType()

setType(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setLib()

setLib(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setTaille()

setTaille(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setMax()

setMax(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setSelect()

setSelect(\formulaire  $form, integer  $maj,   $dnu1 = null, null  $dnu2 = null) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

$dnu1
null $dnu2

@deprecated Ne pas utiliser.

getSelectOldValue()

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).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

$dnu1
array $contenu
string $sql_by_id
string $table
null|array $val

setOnchange()

setOnchange(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setOnkeyup()

setOnkeyup(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setOnclick()

setOnclick(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setGroupe()

setGroupe(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setRegroupe()

setRegroupe(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setBloc()

setBloc(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setFieldset()

setFieldset(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

setLayout()

setLayout(\formulaire  $form, integer  $maj) : void

Configuration du formulaire (VIEW formulaire et VIEW sousformulaire).

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

set_form_specificity()

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.

Parameters

\formulaire $form

Instance formulaire.

integer $maj

Identifant numérique de l'action.

getFormTitle()

getFormTitle(string  $ent) : \Fil

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

Parameters

string $ent

Fil d'Ariane récupéréré

Returns

\Fil —

d'Ariane

getSubFormTitle()

getSubFormTitle(string  $subEnt) : \Fil

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

Parameters

string $subEnt

Fil d'Ariane récupéréré

Returns

\Fil —

d'Ariane

sousformulaire()

sousformulaire() : void

VIEW - sousformulaire.

retoursousformulaire()

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.

Parameters

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()

setValsousformulaire(\formulaire  $form, integer  $maj, integer  $validation, string  $idxformulaire, string  $retourformulaire, string  $typeformulaire,   $dnu1 = null, null  $dnu2 = null) : void

Configuration du formulaire (VIEW sousformulaire).

Parameters

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

getCle()

getCle(string  $id = "") : string

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

Parameters

string $id

Valeur de la cle primaire

Returns

string —

Clause where

addToMessage()

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.

Parameters

string $message

erreur_db()

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()'.

Parameters

string $debuginfo

Message 1.

string $messageDB

Message 2.

string $table

Inutilisé.

addToErrors()

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

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

Parameters

string $debuginfo

Message 1.

string $messageDB

Message 2.

string $msg

Message 3.

clearErrors()

clearErrors() : void

Cette methode vide les valeurs des erreurs du tableau errors.

rechercheTable()

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.

Parameters

$dnu1
string $table
string $field
string $id
null $dnu2

@deprecated Ne pas utiliser.

string $selection

init_select()

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>

Parameters

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

canAccess()

canAccess() : boolean

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

Returns

boolean

checkAccessibility()

checkAccessibility() : void

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

getVal()

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.

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

string $field

Nom du champ de l'objet.

Returns

mixed —

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

checkActionAvailability()

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.

Returns

boolean

is_option_class_action_activated()

is_option_class_action_activated() : boolean

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

Returns

boolean

is_in_context_of_foreign_key()

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.

Parameters

string $foreign_key

Table de la clé étrangère.

string $context

Valeur du contexte (retourformulaire) qui doit être vérifiée.

Returns

boolean

form_resubmit_handle_valid_identifier()

form_resubmit_handle_valid_identifier() : boolean

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

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).

Returns

boolean

form_resubmit_handle_new_identifier()

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()

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 :

  • 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

string $val

Date à vérifier et à formater.

Returns

string

heureDB()

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 :

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

Parameters

string $val

Valeur à vérifier/transformer.

Returns

void|string

dateSystemeDB()

dateSystemeDB() : string

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

Returns

string

datePHP()

datePHP(string  $val) : mixed

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

Parameters

string $val

Date saisie au format 'JJ/MM/AAAA'

Returns

mixed

anneePHP()

anneePHP(string  $val) : mixed

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

Parameters

string $val

Date saisie au format 'JJ/MM/AAAA'

Returns

mixed

moisPHP()

moisPHP(string  $val) : mixed

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

Parameters

string $val

Date saisie au format 'JJ/MM/AAAA'

Returns

mixed

jourPHP()

jourPHP(string  $val) : mixed

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

Parameters

string $val

Date saisie au format 'JJ/MM/AAAA'

Returns

mixed

dateDBToForm()

dateDBToForm(string  $date) : string

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

Parameters

string $date

Date au format 'YYYY-MM-DD'.

Returns

string

compute_pdf_output()

compute_pdf_output(string  $type, string  $obj, null|string  $collectivite = null, null|string  $idx = null, null|array  $params = null) : array

Retourne l'édition PDF.

Parameters

string $type

Type d'édition : 'lettretype' ou 'etat'.

string $obj
null|string $collectivite
null|string $idx
null|array $params

Returns

array

expose_pdf_output()

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

Expose le fichier PDF à l'utilisateur.

Parameters

string $pdf_output

PDF sous forme de chaîne de caractères.

string $filename

Nom du fichier.

get_merge_fields_to_avoid()

get_merge_fields_to_avoid() : array

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

Returns

array

get_merge_fields()

get_merge_fields(string  $type) : array

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

Parameters

string $type

'values' ou 'labels'

Returns

array

get_values_merge_fields()

get_values_merge_fields() : array

Récupération des valeurs des champs de fusion

Returns

array —

tableau associatif

get_labels_merge_fields()

get_labels_merge_fields() : array

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

Returns

array —

tableau associatif

get_substitution_vars()

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.

Parameters

string $type

'values' ou 'labels'

null|string $om_collectivite_idx

Identiant de la collectivité.

Returns

array

get_values_substitution_vars()

get_values_substitution_vars(null|string  $om_collectivite_idx = null) : array

Récupération des valeurs des champs de fusion

Parameters

null|string $om_collectivite_idx

Identiant de la collectivité.

Returns

array —

tableau associatif

get_labels_substitution_vars()

get_labels_substitution_vars(null|string  $om_collectivite_idx = null) : array

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

Parameters

null|string $om_collectivite_idx

Identiant de la collectivité.

Returns

array —

tableau associatif

get_displayed_labels_substitution_vars()

get_displayed_labels_substitution_vars() : string

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

Returns

string

post_treatment()

post_treatment(null|integer  $maj = null) : void|boolean

Traite les valeurs postées du formulaire

Parameters

null|integer $maj

Identifant numérique de l'action.

Returns

void|boolean —

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.

init_om_application()

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.

Returns

boolean

addToLog()

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.

Parameters

string $message

Message à logger.

integer $type

Niveau de log du message.

undoFileTransaction()

undoFileTransaction() : void

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