$database
$database : array
Cette variable est un tableau associatif. Ce tableau permet de stocker toutes les configurations de bases de donnees presentes dans le fichier de configuration. Chaque connexion est representee par une cle de ce tableau.
Définition de la classe *om_application*.
Cette classe est la classe principale du framework openMairie.
$db : null|\database
Instance de connexion à la base de données.
$storage : null|\filestorage
Instance de l'abstracteur de stockage de fichiers.
$layout : null|\layout
Instance de l'abstracteur d'affichage.
$special_flags : array
Cette variable permet de définir la liste des marqueurs spéciaux.
Ces marqueurs spéciaux correspondent à des actions spécifiques liées à l'authentification des utilisateurs :
$html_head_js : array
$html_head_css : array
elapsedtime() : string
Retourne le temps écoulé depuis l'instanciation de la classe.
L'objectif est d'afficher cette information dans les logs destinés au développeur pour identifier facilement les traitements et les requêtes avec un temps d'exécution excessif.
Temps en secondes écoulé depuis l'instanciation de la classe. Exemple: '0.123'.
setParamsFromFiles() : void
Permet de récupérer les différents fichiers de configuration.
Cette méthode inclut les différents fichiers de configuration présents dans le répertoire dyn/ de l'application pour charger le contenu de la configuration dans des attributs de la classe et pouvoir les utiliser à tout moment dans les différentes méthodes de la classe.
isAuthorized(null|string|array $obj = null, string $operator = "AND") : void|boolean
Cette méthode permet de vérifier si l'utilisateur est autorisé ou non à accéder à un élément et permet d'agir en conséquence
| null|string|array | $obj | Permissions à vérifier. |
| string | $operator | Si plusieurs permissisions sont données dans le premier paramètre alors on indique si on veut que l'utilisateur en possède au moins une 'OR' ou les possède toutes 'AND' (défaut). |
isAccredited(null|string|array $obj = null, string $operator = "AND") : boolean
Cette méthode permet de vérifier si l'utilisateur est autorisé ou non à accéder à un élément
| null|string|array | $obj | Permissions à vérifier. |
| string | $operator | Si plusieurs permissisions sont données dans le premier paramètre alors on indique si on veut que l'utilisateur en possède au moins une 'OR' ou les possède toutes 'AND' (défaut). |
getCollectivite(integer|null $om_collectivite_idx = null) : array
Retourne et/ou stocke les paramètres de la collectivité.
Cette méthode permet de retourner la liste des paramètres de la collectivité :
| integer|null | $om_collectivite_idx | Identifiant de la collectivité. |
setDirectoryConfig() : boolean
Vérifie les paramètres de la configuration 'directory', si les vérifications sont correctes stocke cette configuration dans la propriété 'directory_config' et retourne true. Si les vérifications ne sont pas correctes, retourne false.
isDatabaseError(null|resource $dbobj = null, boolean $return = false) : void|boolean
Vérifie si une erreur de base de données s'est produite.
Cette méthode permet de vérifier si une erreur de base de données est survenue sur la ressource passée en paramètre. Si c'est le cas :
| null|resource | $dbobj | Ressource de base de données sur laquelle vérifier l'erreur. |
| boolean | $return | Marqueur indiquant un retour booléen ou non. |
connectDirectory(string $login = "", string $password = "") : boolean
Initialisation de la connexion au serveur LDAP.
Se connecte à l'annuaire et essaye de s'authentifier. Retourne true en cas de succès ou false en cas d'erreur.
| string | $login | Identifiant. |
| string | $password | Mot de passe. |
initSynchronization() : array
Renvoie la liste des utilisateurs de l'annuaire LDAP à ajouter, et la la liste des utilisateurs de la base de données à supprimer.
tabeau retourne un tableau associatif contenant les utilisateurs à ajouter (clef 'userToAdd') et les utilisateurs à supprimer (clef 'userToDelete')
getValFUserToAdd(array $user) : array
Retourne les données de l'utilisateur à insérer en base de données.
Les données sont composées à partir des informations de l'annuaire et des données de l'application. Les données retournées sont formatées pour une requête 'insert' en base de données dans la table des utilisateurs.
| array | $user | Informations de l'utilisateur. |
getValFUserToUpdate(array $user) : array
Retourne les données de l'utilisateur à insérer en base de données.
Les données sont composées à partir des informations de l'annuaire et des données de l'application. Les données retournées sont formatées pour une requête 'update' en base de données dans la table des utilisateurs.
| array | $user | Informations de l'utilisateur. |
processDatabaseAuthentication(string $login, string $password) : boolean
Traitement de l'authentification pour un utilisateur en base de donnees
| string | $login | Identifiant de l'utilisateur |
| string | $password | Mot de passe de l'utilisateur |
Etat de l'authentification de l'utilisateur
processDirectoryAuthentication(string $login, string $password) : boolean
Traitement de l'authentification pour un utilisateur en annuaire
| string | $login | Identifiant de l'utilisateur |
| string | $password | Mot de passe de l'utilisateur |
Etat de l'authentification de l'utilisateur
handle_links_to_display(string $zone) : array
Compose la liste des liens à afficher.
Cette méthode retourne la liste des liens disponibles pour l'utilisateur connecté dans le contexte actuel pour la section passée en paramètre.
| string | $zone | Section dont on souhaite récupérer les liens. |
getParameter(null|string $param = null) : mixed
Cette méthode permet de renvoyer la valeur d'un paramètre de l'application, on utilise cette méthode car les paramètres peuvent provenir de différentes sources : - le fichier dyn/config.inc.php - la table om_parametre En regroupant la récupération des paramètres dans une seule méthode : - on évite les erreurs - on peut se permettre de gérer des comportements complexes comme : si le paramètre n'est pas disponible pour la collectivité alors on va chercher dans la collectivité de niveau supérieur.
Si on ne trouve pas de paramètre correspondant alors on retourne null
| null|string | $param |
get_submitted_post_value(string $param = null) : null
Cette méthode permet de renvoyer la valeur soumise par post.
Si on ne trouve pas de paramètre correspondant alors on retourne chaîne vide
| string | $param | clé de la valeur dans le tableau |
ou la valeur
get_submitted_get_value(string $param = null) : null
Cette méthode permet de renvoyer la valeur soumise par get.
Si on ne trouve pas de paramètre correspondant alors on retourne chaîne vide
| string | $param | clé de la valeur dans le tableau |
ou la valeur
handle_if_no_localisation()
Permet d'empêcher l'accès aux scripts dédiés à la localisation.
Cette méthode vérifie si la valeur de l'option de localisation est différente de 'sig_interne' et si c'est le cas d'afficher un message d'erreur puis d'arrêter l'exécution du script. Exemple d'utilisation : <?php require_once "om_application.class.php"; $f = new om_application("nohtml"); $f->handle_if_no_localisation();
get_application_name() : mixed
Gestion du nom de l'application.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_package_name() : mixed
Gestion du nom du package.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_session_name() : mixed
Gestion du nom de la session.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_config__permission_by_hierarchical_profile() : mixed
Gestion du mode de gestion des permissions.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_config__dashboard_nb_column() : mixed
Gestion du nombre de colonnes du tableau de bord.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_config__menu() : mixed
Gestion des liens du menu.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_config__actions() : mixed
Gestion des liens des actions.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_config__shortlinks() : mixed
Gestion des liens shortlinks.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_config__footer() : mixed
Gestion des liens du footer.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
addHTMLHeadJs(mixed $js = array(), mixed $order = null) : void
Permet d'ajouter un script JS au registre des scripts JS.
Le layout est en charge du registre des scripts JS de base, cette méthode permet d'ajouter l'appel à un script JS pour un script PHP spécifique par exemple. Utilisation :
| mixed | $js | Tableau (array) représentant une liste de chemin vers les scripts JS à ajouter au registre ou chemin (string) vers le script JS à ajouter au registre. |
| mixed | $order | Catégorie (integer) représentant l'odre dans le registre dans lequel on souhaite ajouter le script. Les anciennes catégories (string) : "begin", "middle" et "end" peuvent être utilisées dans un souci de rétro-compatibilité. Par défaut, si aucun ordre n'est spécifié, il est ajouté dans l'ordre 20. |
setHTMLHeadJs(mixed $js = array(), boolean $categories = false) : void
Permet de surcharger le registre des scripts JS.
Le layout est en charge du registre des scripts JS de base, cette méthode permet de remplacer l'appel aux scripts JS de base par les scripts passés en paramètre pour un script PHP spécifique par exemple. Utilisation :
| mixed | $js | Tableau (array) représentant une liste de chemin vers les scripts JS à ajouter au registre ou chemin (string) vers le script JS à ajouter au registre organisé ou non en catégorie (voir second paramètre). |
| boolean | $categories | Le paramètre $js est organisée en catégories. Par défaut on part du principe que ce n'est pas le cas. |
addHTMLHeadCss(mixed $css = array(), mixed $order = null) : void
Permet d'ajouter un script CSS au registre des scripts CSS.
Le layout est en charge du registre des scripts CSS de base, cette méthode permet d'ajouter l'appel à un script CSS pour un script PHP spécifique par exemple. Utilisation :
| mixed | $css | Tableau (array) représentant une liste de chemin vers les scripts CSS à ajouter au registre ou chemin (string) vers le script CSS à ajouter au registre. |
| mixed | $order | Catégorie (integer) représentant l'odre dans le registre dans lequel on souhaite ajouter le script. Les anciennes catégories (string) : "begin", "middle" et "end" peuvent être utilisées dans un souci de rétro-compatibilité. Par défaut, si aucun ordre n'est spécifié, il est ajouté dans l'ordre 20. |
setHTMLHeadCss(mixed $css = array(), boolean $categories = false) : void
Permet de surcharger le registre des scripts CSS.
Le layout est en charge du registre des scripts CSS de base, cette méthode permet de remplacer l'appel aux scripts CSS de base par les scripts passés en paramètre pour un script PHP spécifique par exemple. Utilisation :
| mixed | $css | Tableau (array) représentant une liste de chemin vers les scripts CSS à ajouter au registre ou chemin (string) vers le script CSS à ajouter au registre organisé ou non en catégorie (voir second paramètre). |
| boolean | $categories | Le paramètre $css est organisée en catégories. Par défaut on part du principe que ce n'est pas le cas. |
addPasswordResetKey( $login, $key, $timeout) : void
Ajoute une nouvelle cle dans la table de redifinition de mot de passe.
| $login | Login de l'utilisateur reinitialisant son mot de passe |
|
| $key | Cle valide necessaire au changement de mot de passe |
|
| $timeout | Date de creation de la cle |
sendMail(string $title, string $message, string $recipient, array $file = array()) : boolean
Envoie un mail.
| string | $title | Titre du mail |
| string | $message | Corps du mail |
| string | $recipient | Destinataire(s) du mail (séparés par une virgule) |
| array | $file | Liste de fichiers à envoyer en pièce jointe |
True si le mail est correctement envoye, false sinon.
get_config__html_head_title() : mixed
Titre HTML.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
get_config__favicon() : mixed
Gestion du favicon de l'application.
L'objectif ici est d'avoir trois niveaux de configuration pour cet élément : framework, application et instance. Voici l'ordre de préférence si les trois niveaux sont configurés : instance > application > framework.
displayLinkJsCloseWindow(string $js_function_close = "") : void
Affiche un lien 'Fermer'.
A destination d'une popup pour fermer la popup. Le nom d'une fonction JS peut être passé en paramètre pour que celle-ci soit appelée lors du clic sur le lien fermer.
| string | $js_function_close | Nom de la fonction JS à appeler. |
get_database_extra_parameters(string $key = null) : \string/array
Permet de récupérer un ou plusieurs paramètres optionnels du tableau 'extras' de la configuration de database active.
| string | $key | Clé de la valeur à récupérer, paramètre optionnel. |
$extras Si on fournit une clé, on renvoie la valeur correspondante sous forme de string. Sinon, on renvoie le tableau 'extras' entier.
get_file_type(string $path, string $backup_type = '') : string
Retourne le type mime du fichier pour un chemin donné.
On peut préciser un type de secours au cas où cette méthode ne parvient pas à le récupérer.
| string | $path | chemin du fichier |
| string | $backup_type | type de secours |
type mime du fichier
get_inst__om_import(array $args = array()) : \om_import
Instanciation de la classe *om_import*.
| array | $args | Arguments à passer au constructeur. |
get_inst__om_reqmo(array $args = array()) : \om_reqmo
Instanciation de la classe *om_reqmo*.
| array | $args | Arguments à passer au constructeur. |
get_inst__om_gen(array $args = array()) : \om_gen
Instanciation de la classe *om_gen*.
| array | $args | Arguments à passer au constructeur. |
get_inst__om_edition(array $args = array()) : \om_edition
Instanciation de la classe *om_edition*.
| array | $args | Arguments à passer au constructeur. |
get_inst__om_table(array $args = array()) : \om_table
Instanciation de la classe *om_table*.
| array | $args | Arguments à passer au constructeur. |
get_inst__om_dbform(array $args = array()) : \om_dbform
Instanciation de la classe *om_dbform*.
| array | $args | Arguments à passer au constructeur. |
get_inst__om_formulaire(array $args = array()) : \om_formulaire
Instanciation de la classe *om_formulaire*.
| array | $args | Arguments à passer au constructeur. |
get_inst__om_map(array $args = array()) : \om_map
Instanciation de la classe *om_map*.
| array | $args | Arguments à passer au constructeur. |
handle_and_display_session_message() : void
Gère un éventuel message de session.
Si le paramètre message_id est passé en GET et que sa valeur correspond à un message existant dans le session de l'utilisateur. Alors on affiche le message et on le supprime de la session.
getNextPasswordResetId(integer $id_column, string $table) : integer
Recuperation du prochain id de la table de reinitialisation de mot de passe.
Si cette table n'existe pas, elle est cree et l'id renvoye est 1.
| integer | $id_column | Nom de la colonne contenant l'identifiant de type int |
| string | $table | Nom de la table à interroger |
Valeur du prochain identifiant devant être insere