\gen

Définition de la classe 'gen'.

Cette classe gère le module 'Générateur' du framework openMairie. Ce module permet la génération de code à partir du modèle de données, ainsi que divers assistants de migration et de création d'éditions.

Summary

Methods
Properties
Constants
__destruct()
__construct()
get_all_tables_from_database()
get_fields_list_from_table()
init_generation_for_table()
def_php_script_header()
def_robot_script_header()
table_sql_inc()
table_sql_inc_core()
table_sql_inc_gen()
def_ent()
def_selection_inc()
def_sousformulaire_inc()
table_sql_forminc()
table_sql_forminc_core()
table_sql_forminc_gen()
def_sql_select()
table_obj_class()
table_obj_class_core()
table_obj_class_gen()
table_tests_crud()
resources_tests_crud()
gen_full_tests()
def_obj_attr_table()
def_obj_attr_cleprimaire()
def_obj_attr_typecle()
def_obj_attr_required_field()
def_obj_attr_unique_key()
def_obj_attr_foreign_keys_extended()
def_sql_var_foreign_keys_extended()
def_var_foreign_keys_extended()
def_obj_meth_verifier()
def_obj_meth_settype()
def_obj_meth_settype_by_maj()
def_obj_meth_setvalf()
def_obj_meth_setonchange()
def_obj_meth_settaille()
def_obj_meth_setmax()
def_obj_meth_setlib()
def_obj_meth_setselect()
def_obj_meth_setval()
def_obj_meth_setvalsousformulaire()
def_obj_meth_clesecondaire()
def_obj_meth_setid()
def_obj_meth_setvalfajout()
def_obj_meth_verifierajout()
table_sql_pdfinc()
table_sql_reqmoinc()
table_sql_importinc()
def_champaffichedatemysql()
def_champaffichedatepgsql()
def_champaffichedatepdfmysql()
def_champaffichedatepdfpgsql()
init_configuration()
get_general_option()
is_om_validite()
check_om_validite()
filter_om_validite()
_init_foreign_tables()
_init_other_tables()
_init_foreign_tables_information_schema_for_mysql()
_init_foreign_tables_information_schema_for_pgsql()
_init_other_tables_information_schema_for_mysql()
_init_other_tables_information_schema_for_pgsql()
_init_constraint_notnull()
is_omframework_table()
set_unique_key()
is_generable()
has_primary_key()
foreign_tables_have_primary_key()
get_primary_key()
get_libelle_of()
ecrirefichier()
supprimerfichier()
is_editable()
stream_slightly_equals_file()
get_gen_parameters()
affichecol()
affichetitre()
afficheinfo()
getPathFromFile()
returnFSRightOnFile()
display_analyse()
view_gen_gen_generate()
view_gen_gen_delete()
view_gen_gen_full()
view_gen()
view_gen_permissions()
treatment_gen_permissions()
get_all_permissions()
view_gen_editions_etat()
view_gen_editions_lettretype()
view_gen_editions_sousetat()
view_gen_editions_old()
$table
$msg
$typecle
$longueur
$info
$clesecondaire
$geom
$sousformulaires
$tablebase
$multi
$primary_key
$foreign_tables
$other_tables
$unique_key
$unique_multiple_key
$_columns_notnull
$_om_validite_debut
$_om_validite_fin
$_php_script_header
$_tables_to_overload
$_om_dbform_class_override
$_om_dbform_path_override
No constants found
init_om_application()
addToLog()
$f
N/A
No private methods found
No private properties found
N/A

Properties

$table

$table : string

Nom de la table en cours de traitement

Type

string

$msg

$msg : string

Chaine de caractères stockant le message de retour du traitement pour l'utilisateur

Type

string

$typecle

$typecle : string

Type de la colonne clé primaire de la table en cours de traitement A : clé alphanumérique ou N : clé numérique

Type

string

$longueur

$longueur : integer

Longueur de l'enregistrement de la table en cours de traitement utilisée pour la largeur des colonnes dans la généréation des pdf

Type

integer

$info

$info : array

Description de la table.

Type

array

$clesecondaire

$clesecondaire : array

Liste des clés secondaires.

Type

array

$geom

$geom : array

Liste des champs geom.

Type

array

$sousformulaires

$sousformulaires : array

Liste des tables en sous formulaire.

Type

array

$tablebase

$tablebase : array

Liste des tables de la base de données.

Type

array

$multi

$multi : integer

Marqueur indiquant la présence de la colonne 'om_collectivite' dans la table en cours de traitement.

  • 1 : la colonne n'est pas présente
  • 2 : la colonne n'est pas présente

Type

integer

$primary_key

$primary_key : string

Nom de la colonne clé primaire de la table en cours de traitement

Type

string

$foreign_tables

$foreign_tables : \array(string)

Liste des cles etrangeres de la table actuelle.

array_keys : noms des cles etrangeres. array_values : tableaux d'informations sur les tables etrangeres.

Type

\array(string)

$other_tables

$other_tables : \array(string)

Liste des couples "table.colonne" faisant reference a la table actuelle.

array_keys : index numerique. array_values : chaines de caracteres de la forme "table.colonne".

Type

\array(string)

$unique_key

$unique_key : \array(string)

Liste des nom de colonnes avec contrainte unique.

Type

\array(string)

$unique_multiple_key

$unique_multiple_key : \array(string)

Liste des nom de colonnes avec contrainte unique multiple.

Type

\array(string)

$_columns_notnull

$_columns_notnull : \array(string)

Liste des colonnes avec la propriété 'NOT NULL'.

Type

\array(string)

$_om_validite_debut

$_om_validite_debut : boolean

Marqueur indiquant la présence de la colonne 'om_validite_debut' dans la table en cours de traitement

Type

boolean

$_om_validite_fin

$_om_validite_fin : boolean

Marqueur indiquant la présence de la colonne 'om_validite_fin' dans la table en cours de traitement

Type

boolean

$_php_script_header

$_php_script_header : string

Chaine de caractères représentant l'entête (deux premières lignes) des scripts PHP générés.

Type

string

$_tables_to_overload

$_tables_to_overload : mixed

Tableau de configuration.

Ce tableau de configuration permet de donner des informations de surcharges sur certains objets pour qu'elles soient prises en compte par le générateur. $_tables_to_overload = array( "

" => array( // définition de la liste des classes qui surchargent la classe //
pour que le générateur puisse générer ces surcharges // et les inclure dans les tests de sous formulaire "extended_class" => array("", ), // définition de la liste des champs à afficher dans l'affichage du // tableau champAffiche dans
.inc.php "displayed_fields_in_tableinc" => array("", ), ), );

Type

mixed
None found

$_om_dbform_class_override

$_om_dbform_class_override : null|string

Configuratin du nom de la classe 'dbform'.

Type

null|string

$_om_dbform_path_override

$_om_dbform_path_override : null|string

Configuratin du path vers le fichier déclarant la classe 'dbform'.

Type

null|string

$f

$f : null|\application

Instance de la classe 'application'.

Type

null|\application

Methods

__destruct()

__destruct() 

Destructeur.

__construct()

__construct() 

Constructeur.

get_all_tables_from_database()

get_all_tables_from_database() : array

Retourne les liste des tables de la base de données.

Returns

array

get_fields_list_from_table()

get_fields_list_from_table(string  $table) : array

Retour la liste des champs d'une table.

Parameters

string $table

Nom de la table.

Returns

array

init_generation_for_table()

init_generation_for_table(string  $table) 

Initialisation obligatoire des paramètres pour la table à générer.

Parameters

string $table

Nom de la table.

def_php_script_header()

def_php_script_header() : string

Renvoi l'entête des scripts PHP générés.

Attention repris en modification de fichier.

Returns

string

def_robot_script_header()

def_robot_script_header() : string

Renvoi l'entête des scripts ROBOT générés.

Attention repris en modification de fichier.

Returns

string

table_sql_inc()

table_sql_inc() : string

Construit le contenu du script [sql/<OM_DB_PHPTYPE>/<TABLE>.inc.php].

Returns

string

table_sql_inc_core()

table_sql_inc_core() : string

Construit le contenu du script [<PATH_OPENMAIRIE>/sql/<OM_DB_PHPTYPE>/<TABLE>.inc.php].

Returns

string

table_sql_inc_gen()

table_sql_inc_gen(mixed  $dyn = null) : string

Construit le contenu du script [gen/sql/<OM_DB_PHPTYPE>/<TABLE>.inc.php].

Parameters

mixed $dyn

Fichier de paramétrage.

Returns

string

def_ent()

def_ent() : string

Renvoi le titre de l'écran.

Returns

string

def_selection_inc()

def_selection_inc() : string

Construit une partie du script [gen/sql/<OM_DB_PHPTYPE>/<TABLE>.inc.php].

La partie construite ici concerne la clause WHERE de la requête. Cette clause est stockée dans la variable $selection du script en question.

Returns

string

def_sousformulaire_inc()

def_sousformulaire_inc() : string

Construit la partie.

..

Returns

string

table_sql_forminc()

table_sql_forminc() : string

Construit le contenu du script [sql/<OM_DB_PHPTYPE>/<TABLE>.form.inc.php].

Returns

string

table_sql_forminc_core()

table_sql_forminc_core() : string

Construit le contenu du script [<PATH_OPENMAIRIE>/sql/<OM_DB_PHPTYPE>/<TABLE>.form.inc.php].

Returns

string

table_sql_forminc_gen()

table_sql_forminc_gen(mixed  $dyn = null) : string

Construit le contenu du script [gen/sql/<OM_DB_PHPTYPE>/<TABLE>.form.inc.php].

Parameters

mixed $dyn

Fichier de paramétrage.

Returns

string

def_sql_select()

def_sql_select() : string

Construit une partie du script.

..

Returns

string

table_obj_class()

table_obj_class() : string

Construit le contenu du script [obj/<TABLE>.class.php].

Cette méthode permet de générer la définition de la classe qui est définie dans le dossier obj/ et qui étend la classe définit dans le dossier gen/obj/. Cette classe a pour objectif de contenir les surcharges spécifiques aux objets en questions dans l'applicatif.

Returns

string

table_obj_class_core()

table_obj_class_core() : string

Construit le contenu du script [<PATH_OPENMAIRIE>/obj/<TABLE>.class.php].

Cette méthode permet de générer la définition de la classe qui est définie dans le dossier /obj/ et qui étend la classe définit dans le dossier gen/obj/. Cette classe a pour objectif de contenir les surcharges spécifiques aux objets en questions dans l'applicatif.

Returns

string

table_obj_class_gen()

table_obj_class_gen(mixed  $dyn = null) : string

Construit le contenu du script [gen/obj/<TABLE>.class.php].

Cette méthode permet de générer la définition de la classe qui est définie dans le dossier gen/obj/ et qui étend la classe obj/om_dbform.class.php. Cette classe a pour objectif de contenir les méthodes générées à partir du modèle de données.

Parameters

mixed $dyn

Fichier de paramétrage.

Returns

string

table_tests_crud()

table_tests_crud() : string

Construit des mots-clefs Robot Framework dans le fichier : [tests/resources/app/gen/<TABLE>.robot]

Ces derniers correspondent aux modes de base du framework :

  • AJOUTER,
  • MODIFIER,
  • SUPPRIMER.
  • CONSULTER.

Le mot-clef SAISIR est commun à AJOUTER et MODIFIER. Le mot-clef AJOUTER retourne l'ID du nouvel enregistrement.

Le script se base sur la surcharge des obj et sql, et différencie les tables métier de celles du framework.

Returns

string —

Fichier généré

resources_tests_crud()

resources_tests_crud(array  $tables, string  $type) : string

Construit les deux fichiers ressources des mots-clefs générés : celui pour les objets métier et celui pour les objets framework.

Parameters

array $tables

Tables générées

string $type

app OU core

Returns

string —

Fichier généré

gen_full_tests()

gen_full_tests(array  $tables) : string

Appelle la méthode de génération de mots-clefs adéquate (gestion APP et CORE) et affiche le message du résultat.

Parameters

array $tables

Tables générées

Returns

string —

Fichier généré

def_obj_attr_table()

def_obj_attr_table() : string

Construit la définition de l'attribut $table pour table_obj.

Returns

string

def_obj_attr_cleprimaire()

def_obj_attr_cleprimaire() : string

Construit la définition de l'attribut $clePrimaire pour table_obj.

Returns

string

def_obj_attr_typecle()

def_obj_attr_typecle() : string

Construit la définition de l'attribut $typeCle pour table_obj.

Returns

string

def_obj_attr_required_field()

def_obj_attr_required_field() : string

Construit la définition de l'attribut $required_field pour table_obj.

Returns

string

def_obj_attr_unique_key()

def_obj_attr_unique_key() : string

Construit la définition de l'attribut $unique_key pour table_obj.

Returns

string

def_obj_attr_foreign_keys_extended()

def_obj_attr_foreign_keys_extended() : string

Construit la définition de l'attribut $foreign_keys_extended pour table_obj.

Returns

string

def_sql_var_foreign_keys_extended()

def_sql_var_foreign_keys_extended() : string

Construit la définition de l'attribut $foreign_keys_extended pour table_obj.

Returns

string

def_var_foreign_keys_extended()

def_var_foreign_keys_extended(string  $context = "attr") : string

Construit la définition de l'attribut $foreign_keys_extended pour table_obj.

Parameters

string $context

Contexte d'utilisation de la méthode :

  • attr : attribut de classe,
  • var : variable dans un script.

Returns

string

def_obj_meth_verifier()

def_obj_meth_verifier() : string

Construit la définition de la méthode verifier() pour table_obj.

Returns

string

def_obj_meth_settype()

def_obj_meth_settype() : string

Construit la définition de la méthode setType() pour table_obj.

Returns

string

def_obj_meth_settype_by_maj()

def_obj_meth_settype_by_maj(integer  $maj) : string

Construit une partie de la définition de la méthode setType().

Methode permettant de definir le widget de formulaire a utiliser en fonction du type de champ dans la base de donnees

Parameters

integer $maj

Valeur de l'action de formulaire pour laquelle on souhaite définir les widgets.

Returns

string

def_obj_meth_setvalf()

def_obj_meth_setvalf() : string

Construit la définition de la méthode setvalF() pour table_obj.

Returns

string

def_obj_meth_setonchange()

def_obj_meth_setonchange() : string

Construit la définition de la méthode setOnchange() pour table_obj.

Returns

string

def_obj_meth_settaille()

def_obj_meth_settaille() : string

Construit la définition de la méthode setTaille() pour table_obj.

Returns

string

def_obj_meth_setmax()

def_obj_meth_setmax() : string

Construit la définition de la méthode setMax() pour table_obj.

Returns

string

def_obj_meth_setlib()

def_obj_meth_setlib() : string

Construit la définition de la méthode setLib() pour table_obj.

Returns

string

def_obj_meth_setselect()

def_obj_meth_setselect() : string

Construit la définition de la méthode setSelect() pour table_obj.

Returns

string

def_obj_meth_setval()

def_obj_meth_setval() : string

Construit la définition de la méthode setVal() pour table_obj.

Returns

string

def_obj_meth_setvalsousformulaire()

def_obj_meth_setvalsousformulaire() : string

Construit la définition de la méthode setValsousformulaire() pour table_obj.

Returns

string

def_obj_meth_clesecondaire()

def_obj_meth_clesecondaire() : string

Construit la définition de la méthode clesecondaire() pour table_obj.

Returns

string

def_obj_meth_setid()

def_obj_meth_setid() : string

Construit la définition de la méthode setId() pour table_obj.

Returns

string

def_obj_meth_setvalfajout()

def_obj_meth_setvalfajout() : string

Construit la définition de la méthode setValFAjout() pour table_obj.

Returns

string

def_obj_meth_verifierajout()

def_obj_meth_verifierajout() : string

Construit la définition de la méthode verifierAjout() pour table_obj.

Returns

string

table_sql_pdfinc()

table_sql_pdfinc(mixed  $dyn = null) : string

Construit le contenu du script [sql/<OM_DB_PHPTYPE>/<TABLE>.pdf.inc.php].

Cette méthode permet de générer l'intégralité du script.

Parameters

mixed $dyn

Fichier de paramétrage.

Returns

string

table_sql_reqmoinc()

table_sql_reqmoinc(string  $cle = "") : string

Construit le contenu du script [sql/<OM_DB_PHPTYPE>/<ELEM>.reqmo.inc.php].

Cette méthode permet de générer l'intégralité du script.

Parameters

string $cle

Clé secondaire éventuelle.

Returns

string

table_sql_importinc()

table_sql_importinc() : string

Construit le contenu du script [sql/<OM_DB_PHPTYPE>/<TABLE>.import.inc.php].

Cette méthode permet de générer l'intégralité du script.

Returns

string

def_champaffichedatemysql()

def_champaffichedatemysql(string  $temp, mixed  $alias = null) : string

Renvoi l'élément de requête pour des dates au format francais pour MySQL.

Avec alias et séquence d'échappement.

Parameters

string $temp

Nom de la colonne date à traiter.

mixed $alias

Alias éventuel de la colonne date.

Returns

string

def_champaffichedatepgsql()

def_champaffichedatepgsql(string  $temp, mixed  $alias = null) : string

Renvoi l'élément de requête pour des dates au format francais pour PostGreSQL.

Avec alias et séquence d'échappement.

Parameters

string $temp

Nom de la colonne date à traiter.

mixed $alias

Alias éventuel de la colonne date.

Returns

string

def_champaffichedatepdfmysql()

def_champaffichedatepdfmysql(string  $temp) : string

Renvoi l'élément de requête pour des dates au format francais pour MySQL.

Sans alias et séquence d'échappement.

Parameters

string $temp

Nom de la colonne date à traiter.

Returns

string

def_champaffichedatepdfpgsql()

def_champaffichedatepdfpgsql(string  $temp) : string

Renvoi l'élément de requête pour des dates au format francais pour PostGreSQL.

Sans alias et séquence d'échappement.

Parameters

string $temp

Nom de la colonne date à traiter.

Returns

string

init_configuration()

init_configuration() : void

Initialisation des fichiers de configuration du générateur.

Cette méthode permet de récupérer les fichiers configurations pour initialiser les paramètres et permettre leur utilisation dans les méthodes de la classe

get_general_option()

get_general_option(string  $option = "") : mixed

Renvoi la valeur d'une option.

Parameters

string $option

Libellé de l'option souhaitée.

Returns

mixed

is_om_validite()

is_om_validite() : boolean

Renvoi la valeur du cas d'utilisation 'om_validite'.

Retourne true si la table traitee actuellement contient les colonnes:

  • om_validite_debut
  • om_validite_fin

Cette methode ne fait aucune requete en base de donnees. Elle se contente de lire les informations analysees par la methode gen().

Voir aussi check_om_validite()

Returns

boolean

check_om_validite()

check_om_validite(string  $table) : boolean

Vérifie en base l'existence des colonnes 'om_validite' sur une table.

Retourne true si la table specifiee contient les colonnes:

  • om_validite_debut
  • om_validite_fin

Cette methode effectue une requete en base de donnees. Utilisez cette methode si la table actuelle != table specifiee.

Voir aussi is_om_validite()

Parameters

string $table

Nom de la table à examiner.

Returns

boolean

filter_om_validite()

filter_om_validite(string  $table, boolean  $with_operator = false) : string

Retourne la condition SQL des objets à date de validité.

Parameters

string $table

Nom de la table.

boolean $with_operator

Indicateur avec ou sans opérateur.

Returns

string

_init_foreign_tables()

_init_foreign_tables() : void

Initialisation des informations concernant les clés étrangères.

Cette méthode permet d'initialiser les deux attributs :

  • $this->clesecondaire
  • $this->foreign_tables

Ces deux attributs permettent de gérer la notion de FOREIGN KEY de la table en cours vers les autres tables de la base.

_init_other_tables()

_init_other_tables() : void

Initialisation des informations concernant les autres tables.

Cette méthode permet d'initialiser les deux attributs :

  • $this->sousformulaires
  • $this->other_tables

Ces deux attributs permettent de gérer la notion de FOREIGN KEY des autres tables de la base vers la table en cours.

_init_foreign_tables_information_schema_for_mysql()

_init_foreign_tables_information_schema_for_mysql() : void

Initialisation des informations concernant les clés étrangères (MySQL).

Cette méthode permet d'initialiser les FOREIGN KEY de la table en cours vers les autres tables de la base en recherchant les contraintes dans la base de données pour MySQL.

_init_foreign_tables_information_schema_for_pgsql()

_init_foreign_tables_information_schema_for_pgsql() : void

Initialisation des informations concernant les clés étrangères (PostGreSQL).

Cette méthode permet d'initialiser les FOREIGN KEY de la table en cours vers les autres tables de la base en recherchant les contraintes dans la base de données pour PostGreSQL.

_init_other_tables_information_schema_for_mysql()

_init_other_tables_information_schema_for_mysql() : void

Initialisation des autres tables (MySQL).

Cette méthode permet d'initialiser les FOREIGN KEY des autres tables de la base vers la table en cours en recherchant les contraintes dans la base de données pour MySQL.

_init_other_tables_information_schema_for_pgsql()

_init_other_tables_information_schema_for_pgsql() : void

Initialisation des autres tables (PostGreSQL).

Cette méthode permet d'initialiser les FOREIGN KEY des autres tables de la base vers la table en cours en recherchant les contraintes dans la base de données pour PostGreSQL.

_init_constraint_notnull()

_init_constraint_notnull() : void

Initialisation des contraintes NOT NULL.

Cette méthode permet d'initialiser l'attribut :

  • $this->_columns_notnull

Cet attribut permet de gérer la notion de NOT NULL et de champs requis de la table en cours de traitement.

is_omframework_table()

is_omframework_table(string  $table = null) : boolean

Permet de vérifier si une table fait partie du framework ou non.

Le générateur adopte un comportement différent si la table générée fait partie du framework. Cette méthode indique si c'est le cas ou non.

Parameters

string $table

Le nom de la table.

Returns

boolean

set_unique_key()

set_unique_key(string  $table) : void

Rempli les tableaux unique_key et unique_multiple_key.

Parameters

string $table

Nom de la table à examiner.

is_generable()

is_generable() : boolean

Vérifie si la table en cours est générable.

Returns

boolean

has_primary_key()

has_primary_key(string  $table, boolean  $display_error = true) : boolean

Indique si la table à une clé primaire.

Parameters

string $table

Nom de la table à examiner.

boolean $display_error

Affichage d'erreur à l'écran.

Returns

boolean

foreign_tables_have_primary_key()

foreign_tables_have_primary_key(boolean  $display_error = true) : boolean

Indique si les tables des clés étarngères ont une clé primaire.

Parameters

boolean $display_error

Affichage d'erreur à l'écran.

Returns

boolean

get_primary_key()

get_primary_key(string  $table) : string

Renvoi le libellé.

Cette méthode permet de récupérer le libellé de la clé primaire de la table passée en paramètre.

Parameters

string $table

Nom de la table.

Returns

string

get_libelle_of()

get_libelle_of(string  $table) : string

Renvoi la colonne représentant le libellé d'un enregistrement de la table.

Parameters

string $table

Nom de la table.

Returns

string

ecrirefichier()

ecrirefichier(string  $path_to_file, string  $content) : boolean

Écrit le contenu dans le fichier sur le disque.

Parameters

string $path_to_file

Le chemin du fichier à écrire.

string $content

Contenu du fichier.

Returns

boolean

supprimerfichier()

supprimerfichier(string  $path_to_file) : void

Supprime le fichier du disque.

Parameters

string $path_to_file

Le chemin du fichier à supprimer.

is_editable()

is_editable(string  $path_to_file) : boolean

Vérifie les permissions sur le fichier à générer.

Parameters

string $path_to_file

Le chemin du fichier à examiner.

Returns

boolean

stream_slightly_equals_file()

stream_slightly_equals_file(string  $stream, string  $path_to_file) : boolean

Compare un flux avec un fichier.

L'entete du fichier contenant la date et l'heure de generation n'est pas prise en compte (d'ou le "legerement").

Retourne true si:

  • le flux et le fichier sont legerement identiques

Retourne false si:

  • le fichier ne s'ouvre pas
  • le flux et le fichier sont differents

Parameters

string $stream

Contenu du fichier à générer.

string $path_to_file

Chemin vers le fichier existant.

Returns

boolean

get_gen_parameters()

get_gen_parameters() : array

Renvoi le tableau de paramètres listants les fichiers générables.

Returns

array

affichecol()

affichecol(string  $col1, string  $col2, string  $col3) : void

Affiche une ligne de tableau.

Parameters

string $col1

Contenu de la colonne 1.

string $col2

Contenu de la colonne 2.

string $col3

Contenu de la colonne 3.

affichetitre()

affichetitre(string  $col) : void

Affiche une ligne de tableau.

Parameters

string $col

Contenu de la colonne.

afficheinfo()

afficheinfo(string  $col1, string  $col2) : void

Affiche une ligne de tableau.

Parameters

string $col1

Contenu de la colonne 1.

string $col2

Contenu de la colonne 2.

getPathFromFile()

getPathFromFile(string  $path_to_file) : string

Renvoi le chemin vers le répertoire parent.

Parameters

string $path_to_file

Le chemin du fichier à examiner.

Returns

string

returnFSRightOnFile()

returnFSRightOnFile(string  $path_to_file) : string

Retourne en vert si le fichier existe, sinon une erreur en rouge.

Parameters

string $path_to_file

Le chemin du fichier à examiner.

Returns

string

display_analyse()

display_analyse() : void

Affiche les informations sur la table en cours de traitement.

Cet affichage permet sur l'écran de génération d'indiquer à l'utilisateur les informations dont le générateur dispose sur la table en cours de traitement.

view_gen_gen_generate()

view_gen_gen_generate() : void

VIEW - view_gen_gen_generate.

Cette vue permet d'interfacer la génération d'une table.

view_gen_gen_delete()

view_gen_gen_delete() : void

VIEW - view_gen_gen_delete.

Cette vue permet d'interfacer la suppression des fichiers générés d'une table.

view_gen_gen_full()

view_gen_gen_full() : void

VIEW - view_gen_gen_full.

Cette vue permet d'interfacer la génération complète de toutes les tables.

view_gen()

view_gen() : void

VIEW - view_gen.

Cette vue gère la page d'accueil du module qui présente l'accès à toutes les fonctionnalités du module gen. Elle permet également de dispatcher sur les autres vues en fonction de son paramètre $_GET['view'].

view_gen_permissions()

view_gen_permissions() : void

VIEW - view_gen_permissions.

Vue permettant de gérer l'interface utilisateur de génération automatique des permissions de l'application.

treatment_gen_permissions()

treatment_gen_permissions() : boolean

TREATMENT - treatment_gen_permissions.

Ce traitement permet de :

  • mettre à jour la table de vocabulaire des permissions avec les permissions de l'application "calculées" directement à partir du code,
  • mettre à jour le fichier SQL d'initialisation des permissions avec les permissions de l'application "calculées" directement à partir du code,
  • supprimer tous les éléments obsolètes de la table de matrice des droits.

Returns

boolean

get_all_permissions()

get_all_permissions() : array

Retourne la liste des permissions "calculées".

Cette méthode "calcule" l'intégralité des permissions présente dans l'application :

  • toutes les permissions spécifiques déclarées dans gen/dyn/permissions.inc.php,
  • toutes les permissions utilisées dans l'attribut class_actions de chacune des classes présentes dans le répertoire obj/,
  • toutes les permissions utilisées dans dyn/menu.inc.php,
  • toutes les permissions utilisées dans dyn/actions.inc.php,
  • toutes les permissions utilisées dans dyn/footer.inc.php,
  • toutes les permissions utilisées dans dyn/shortlinks.inc.php.

Returns

array

view_gen_editions_etat()

view_gen_editions_etat() : void

VIEW - view_gen_editions_etat.

view_gen_editions_lettretype()

view_gen_editions_lettretype() : void

VIEW - view_gen_editions_lettretype.

view_gen_editions_sousetat()

view_gen_editions_sousetat() : void

VIEW - view_gen_editions_sousetat.

view_gen_editions_old()

view_gen_editions_old() : void

VIEW - view_gen_editions_old.

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.