Fork me on GitHub

Configuration

Le comportement de la librairie Jaxon peut être adapté à l'aide de ses options de configuration.

La fonction $jaxon->setOption($name, $value) permet de fixer la valeur d'une option de configuration, tandis que la fonction $jaxon->getOption($name) permet de la lire.

Les fichiers de configuration

Il est également possible de lire la configuration de la librairie dans un fichier, qui peut être au format JSON, YAML ou PHP.

$jaxon->readPhpConfigFile($yamlFilePath);   // Lire la configuration dans un fichier PHP.
                                            // Le fichier contient du code PHP qui retourne un tableau.
$jaxon->readYamlConfigFile($jsonFilePath);  // Lire la configuration dans un fichier YAML.
$jaxon->readJsonConfigFile($phpFilePath);   // Lire la configuration dans un fichier JSON.
$jaxon->readConfigFile($phpFilePath);       // Lire la configuration en fonction de l'extension du fichier.

Si le fichier contient d'autres données que la configuration de la librairie Jaxon, chacune de ces fonctions peut prendre un second paramètre qui permet de lire la configuration dans une section du fichier.

La liste des options de configuration

Ces options sont celles de la librairie Jaxon. D'autres options peuvent exister pour les plugins de Jaxon.

Nom Type Description
core.version string Le numéro de version de la librairie
core.language string La langue de la librairie
core.encoding string L'encodage des caractères à utiliser
core.decode_utf8 boolean Active ou non le décodage en UTF8 des paramètres des fonctions Jaxon
core.prefix.function string Le préfixe à ajouter au nom des fonctions exportées en javascript
core.prefix.class string Le préfixe à ajouter au nom des classes exportées en javascript
core.prefix.event string Le préfixe à ajouter au nom des évènements exportés en javascript
core.request.uri string L'URL à laquelle toutes les requêtes sont envoyées
core.request.mode string Le mode des requêtes. Peut être "asynchronous" or "synchronous"
core.request.method string La méthode des requêtes. Peut être "POST" or "GET"
core.request.csrf_meta string Le nom de l'entête HTML meta qui contient le token CSRF
core.process.clean boolean Active ou non le vidage des buffers après le traitement d'une requête
core.process.exit boolean Indique si la fonction exit() doit être appelée après le traitement d'une requête
core.process.timeout integer
core.error.handle boolean Active ou non la gestion des erreurs
core.error.log_file string Le chemin du fichier de log des erreurs
core.debug.on boolean Active ou non le mode debug
core.debug.verbose boolean Active ou non le mode debug verbeux
core.debug.output_id string L'id de la sortie des debug javascript
core.template.cache string Le chemin du répertoire de cache des templates
js.lib.uri string Le lien vers les libraries javascript de Jaxon
js.lib.queue_size integer Le nombre max de commandes que la librairie javascript attend dans une réponse
js.lib.show_cursor boolean Active ou non l'affichage d'un curseur
js.lib.show_status boolean Active ou non l'affichage du statut de la requête
js.app.uri string Le lien vers les fichiers javascript générés par Jaxon
js.app.dir string Le répertoire qui contient les fichiers javascript générés par Jaxon
js.app.extern boolean Active ou non la création d'un fichier javascript contenant le code généré par Jaxon
js.app.minify boolean Active ou non la minification du code généré par Jaxon
js.app.options string Les options à ajouter à la balise javascript dans le code HTML généré