import
extends om_base
in package
Définition de la classe 'import'.
Cette classe gère le module 'Import' du framework openMairie. Ce module permet l'intégration de données dans l'applicatif depuis des fichiers CSV. Chaque import disponible est paramétré dans un fichier de configuration qui peut être composé manuellement ou généré depuis le générateur.
Table of Contents
- $import_list : null|array<string|int, mixed>
- Liste des imports disponibles.
- $script_extension : string
- Suffixe (extension) des scripts PHP correspondant à des imports.
- $f : null|application
- Instance de la classe 'application'.
- __construct() : mixed
- Constructeur.
- __destruct() : mixed
- Destructeur.
- compute_import_list() : void
- Récupération de la liste des imports disponibles.
- display_import_form() : void
- Affichage du formulaire d'import.
- display_import_helper() : void
- Affichage de l'assistant d'import.
- display_import_list() : void
- Affichage de la liste des imports disponibles.
- get_import_list() : array<string|int, mixed>
- Accesseur.
- get_import_list_in_folder() : array<string|int, mixed>
- Méthode utilitaire.
- sort_by_lower_title() : bool
- Méthode utilitaire.
- treatment_import() : void
- Traitement d'import.
- view_import() : void
- Sélecteur de vue.
- view_import_csv_template() : void
- Fichier CSV modèle.
- view_import_main() : void
- Vue principale du module import.
- addToLog() : void
- Ajout d'un message au système de logs.
- init_om_application() : bool
- Initialisation de la classe 'application'.
Properties
$import_list
Liste des imports disponibles.
public
null|array<string|int, mixed>
$import_list
= \null
$script_extension
Suffixe (extension) des scripts PHP correspondant à des imports.
public
string
$script_extension
= ".import.inc.php"
$f
Instance de la classe 'application'.
protected
null|application
$f
= \null
Methods
__construct()
Constructeur.
public
__construct() : mixed
Return values
mixed —__destruct()
Destructeur.
public
__destruct() : mixed
Return values
mixed —compute_import_list()
Récupération de la liste des imports disponibles.
public
compute_import_list() : void
Ces imports correspondent aux requêtes mémorisées paramétrées dans des
scripts
Return values
void —display_import_form()
Affichage du formulaire d'import.
public
display_import_form(string $obj) : void
Parameters
- $obj : string
-
Identifiant de l'import.
Return values
void —display_import_helper()
Affichage de l'assistant d'import.
public
display_import_helper(string $obj) : void
Parameters
- $obj : string
-
Identifiant de l'import.
Return values
void —display_import_list()
Affichage de la liste des imports disponibles.
public
display_import_list() : void
Return values
void —get_import_list()
Accesseur.
public
get_import_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_import_list_in_folder()
Méthode utilitaire.
public
get_import_list_in_folder([string $folder_path = "" ][, array<string|int, mixed> $import_list = array() ]) : array<string|int, mixed>
Cette fonction permet de lister les imports disponibles dans un répertoire.
Parameters
- $folder_path : string = ""
-
Path vers le répertoire.
- $import_list : array<string|int, mixed> = array()
-
Liste des imports (optionnelle).
Return values
array<string|int, mixed> —Liste des imports disponibles.
sort_by_lower_title()
Méthode utilitaire.
public
sort_by_lower_title(array<string|int, mixed> $a, array<string|int, mixed> $b) : bool
Cette fonction permet de comparer (ordre alphabétique) les valeurs de l'attribut title des deux tableaux passés en paramètre.
Parameters
- $a : array<string|int, mixed>
-
Premier tableau.
- $b : array<string|int, mixed>
-
Second tableau.
Return values
bool —treatment_import()
Traitement d'import.
public
treatment_import(string $obj) : void
Parameters
- $obj : string
-
Identifiant de l'import.
Tags
Return values
void —view_import()
Sélecteur de vue.
public
view_import() : void
Return values
void —view_import_csv_template()
Fichier CSV modèle.
public
view_import_csv_template() : void
Return values
void —view_import_main()
Vue principale du module import.
public
view_import_main() : void
Cette vue gère l'intégralité du module import :
- le listing des imports disponibles,
- le formulaire d'import d'un objet sélectionné,
- la validation du formulaire d'import,
- l'appel au traitement d'import,
- l'affichage du retour du traitement.
Return values
void —addToLog()
Ajout d'un message au système de logs.
protected
addToLog(string $message[, int $type = DEBUG_MODE ]) : void
Cette méthode permet de logger un message.
Parameters
- $message : string
-
Message à logger.
- $type : int = DEBUG_MODE
-
Niveau de log du message.
Return values
void —init_om_application()
Initialisation de la classe 'application'.
protected
init_om_application() : bool
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.