\import

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.

Summary

Methods
Properties
Constants
__destruct()
__construct()
compute_import_list()
get_import_list()
display_import_list()
display_import_form()
display_import_helper()
treatment_import()
view_import_main()
view_import_csv_template()
view_import()
get_import_list_in_folder()
sort_by_lower_title()
$import_list
$script_extension
No constants found
init_om_application()
addToLog()
$f
N/A
No private methods found
No private properties found
N/A

Properties

$import_list

$import_list : null|array

Liste des imports disponibles.

Type

null|array

$script_extension

$script_extension : string

Suffixe (extension) des scripts PHP correspondant à des imports.

Type

string

$f

$f : null|\application

Instance de la classe 'application'.

Type

null|\application

Methods

__destruct()

__destruct() 

Destructeur.

__construct()

__construct() 

Constructeur.

compute_import_list()

compute_import_list() : void

Récupération de la liste des imports disponibles.

Ces imports correspondent aux requêtes mémorisées paramétrées dans des scripts .import.inc.php. Ces scripts sont généralement présents dans le répertoire sql// de l'application mais peuvent également être présents dans le répertoire CUSTOM prévu à cet effet.

get_import_list()

get_import_list() : array

Accesseur.

Returns

array

display_import_list()

display_import_list() : void

Affichage de la liste des imports disponibles.

display_import_form()

display_import_form(string  $obj) : void

Affichage du formulaire d'import.

Parameters

string $obj

Identifiant de l'import.

display_import_helper()

display_import_helper(string  $obj) : void

Affichage de l'assistant d'import.

Parameters

string $obj

Identifiant de l'import.

treatment_import()

treatment_import(string  $obj) : void

Traitement d'import.

Parameters

string $obj

Identifiant de l'import.

view_import_main()

view_import_main() : void

Vue principale du module import.

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.

view_import_csv_template()

view_import_csv_template() : void

Fichier CSV modèle.

view_import()

view_import() : void

Sélecteur de vue.

get_import_list_in_folder()

get_import_list_in_folder(string  $folder_path = "", array  $import_list = array()) : array

Méthode utilitaire.

Cette fonction permet de lister les imports disponibles dans un répertoire.

Parameters

string $folder_path

Path vers le répertoire.

array $import_list

Liste des imports (optionnelle).

Returns

array —

Liste des imports disponibles.

sort_by_lower_title()

sort_by_lower_title(array  $a, array  $b) : boolean

Méthode utilitaire.

Cette fonction permet de comparer (ordre alphabétique) les valeurs de l'attribut title des deux tableaux passés en paramètre.

Parameters

array $a

Premier tableau.

array $b

Second tableau.

Returns

boolean

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.