ioFormatCette section décrit la manière de paramétrer les formats d'import/export
pour un type d'&LSobject; donné.La configuration des ioFormats se situe dans la
configuration des &LSobjects;, dans la variable ioFormat
($GLOBALS['LSobjects']['[nom du type d'LSobject]']['ioFormat']).
Cette variable est un tableau associatif dont la clé est l'identifiant du format et
dont la valeur associée est la configuration du format.
Le moteur d'importation simule la validation d'un formulaire de
création du type d'&LSobject;. En conséquence :
seul les attributs présent dans le formulaire de création peuvent
être importés.tous les attributs obligatoires présents dans le formulaire de
création doivent être fournis par le fichier source ou générer à partir des autres
attributs.Les valeurs des attributs issus de l'importation seront vue comme
des valeurs retournées par le formulaire et non comme des valeurs des attribus LDAP
eux-même. Ainsi et par exemple, un attribut traité comme un booléen dans un formulaire
pourra prendre comme valeur par défaut yes ou no.
Structure
array (
'label' => '[Label du type de fichier]',
'driver' => '[Pilote d'ioFormat utilisé]',
'driver_options' => array([Options du pilote d'ioFormat utilisé]),
'fields => array (
'[champ 1]' => '[attribut 1]',
'[champ 2]' => '[attribut 2]',
[...]
),
'generated_fields' => array (
'[attribute 3]' => '[LSformat]',
'[attribute 4]' => array('[LSformat1]', '[LSformat2]', ...)
'[attribute 5]' => function($attrs, $row) {
return array([...]);
},
[...]
)
),
[...]
);]]>
Paramètres de configurationlabelLe label du formatdriverLe pilote a utilisé pour ce format. Le pilote permet de gérér la lecture
et l'écriture dans un type de fichier d'import/export. Pour plus d'information sur
les pilotes disponibles, Voir la
section concernée.driver_optionsTableau associatif des options du pilote utilisé pour ce format. Pour
plus d'informations, consulter la documentation du pilote utilisé.fieldsTableau associatif permettant d'associer un champ du fichier source (la clé)
avec attribut de l'objet LDAP (la valeur).generated_fieldsTableau associatif permettant de définir soit des &LSformats;, soit un
callable (au sens PHP) pour générer les valeurs d'attributs automatiquement.
Ce tableau contient en clé, le nom de l'attribut à générer, et en valeur associée, un ou plusieurs
&LSformat; ou un callable à utiliser pour générer ses valeurs. En cas de
&LSformat;, ils seront composés à l'aide des valeurs des autres attributs de l'objet. En cas d'un
callable, il sera appeler avec en paramètre le tableau des valeurs des autres
attributs ($attrs), le tableau des données issues du fichier source
($row) et devra retourner le tableau des valeurs générées de l'attribut.
Pilote d'ioFormatCette section décrit la manière de configurer les pilotes d'ioFormat utilisés
lors des imports/exports d'&LSobjects;.Pilote de fichiers CSVCe pilote permet de gérer l'import/export de &LSobject; à partir d'un fichier
CSV. Depuis la version 4 d'LdapSaisie, ce pilote utilise les
fonctions standards fgetcsv() et fputcsv
fournis par PHP. Avant cela, la classe PEAR File_CSV_DataSource
était utilisée. Par défaut, les paramètres de lecture et
d'écriture des fichiers sont : la virgule sert de délimiteur, le caractère
" peut être utilisé pour encadrer les valeurs des champs et la
longueur maximale d'une ligne est infini. Ces paramètres peuvent être modifiés en
configurant les options du pilote.
Structure
'[délimiteur]',
'enclosure' => '[caractère d'encadrement de texte]',
'length' => [longueur maximale d'une ligne],
'escape' => '[caractère d'échappement]',
'multiple_value_delimiter' => '[délimiteur]',
);]]>
Paramètres de configurationdelimiterLe caractère utilisé pour délimiter les champs (Par défaut, une virgule).lengthLa longueur maximale d'une ligne du fichier. Si zéro est spécifié, la longueur d'une
ligne ne sera pas limité, mais la lecture du fichier sera ralentie. (Par défaut : 0
)
enclosureLe caractère utilisé pour encadrer les valeurs des champs
(Par défaut : ").escapeLe caractère d'échappement utilisé si un des champs d'une ligne de fichier contient le
caractère utilisé pour encadrer les valeurs. (Par défaut : \).Selon la RFC4180, l'echappement du caractère utilisé pour encadrer les valeurs des
champs doit se faire en le doublant. Le caractère défini ici est une alternative à ce comportement
par défaut. Pour désactiver ce caractère d'échappement alternatif, il est possible depuis de la
version 7.4.0 de PHP de mettre ici une chaine vide.multiple_value_delimiterLe caractère utilisé pour délimiter au sein d'un champs, les valeurs valeurs multiples d'un
attribut (Par défaut : |).