Configuration¶

Charger les Fichiers de Configuration Supplémentaires¶

Si votre application a beaucoup d’options de configuration, il peut être utile de séparer la configuration dans plusieurs fichiers. Après avoir créé chacun des fichiers dans votre répertoire config/, vous pouvez les charger dans bootstrap.php:

use Cake\Core\Configure;
use Cake\Core\Configure\Engine\PhpConfig;

Configure::config('default', new PhpConfig());
Configure::load('app', 'default', false);
Configure::load('other_config', 'default');

Configuration Générale¶

Ci-dessous se trouve une description des variables et la façon dont elles modifient votre application CakePHP.

debug

Change la sortie de debug de CakePHP. false = Mode Production. Pas de messages, d’erreurs ou d’avertissements montrés. true = Errors et avertissements montrés.

App.namespace

Le namespace sous lequel se trouvent les classes de l’app.

Note

Quand vous changez le namespace dans votre configuration, vous devez aussi mettre à jour le fichier composer.json pour utiliser aussi ce namespace. De plus, créez un nouvel autoloader en lançant php composer.phar dumpautoload.

App.baseUrl

Décommentez cette définition si vous n” envisagez pas d’utiliser le mod_rewrite d’Apache avec CakePHP. N’oubliez pas aussi de retirer vos fichiers .htaccess.

App.base

Le répertoire de base où l’app se trouve. Si à false, il sera détecté automatiquement. Si ce n’est pas false, assurez-vous que votre chaîne commence avec un / et ne se termine PAS par un /. Par exemple, / basedir est une valeur correcte pour App.base. Sinon, le composant AuthComponent ne fonctionnera pas correctement.

App.encoding

Définit l’encodage que votre application utilise. Cet encodage est utilisé pour générer le charset dans le layout, et les entities encodées. Il doit correspondre aux valeurs d’encodage spécifiées pour votre base de données.

App.webroot

Le répertoire webroot.

App.wwwRoot

Le chemin vers webroot.

App.fullBaseUrl

Le nom de domaine complet (y compris le protocole) vers la racine de votre application. Ceci est utilisé pour la génération d’URLS absolues. Par défaut, cette valeur est générée en utilisant la variable d’environnement $_SERVER. Cependant, vous devriez la définir manuellement pour optimiser la performance ou si vous êtes inquiets sur le fait que des gens puissent manipuler le header Host. Dans un contexte de CLI (à partir des shells), fullBaseUrl ne peut pas être lu dans $_SERVER, puisqu’il n’y a aucun serveur web impliqué. Vous devez le spécifier vous-même si vous avez besoin de générer des URLs à partir d’un shell (par exemple pour envoyer des emails).

App.imageBaseUrl

Le chemin Web vers le répertoire public des images dans webroot. Si vous utilisez un CDN, vous devez définir cette valeur vers la localisation du CDN.

App.cssBaseUrl

Le chemin Web vers le répertoire public des css dans webroot. Si vous utilisez un CDN, vous devez définir cette valeur vers la localisation du CDN.

App.jsBaseUrl

Le chemin Web vers le répertoire public des js dans webroot. Si vous utilisez un CDN, vous devriez définir cette valeur vers la localisation du CDN.

App.paths

Les chemins de Configure pour les ressources non basées sur les classes. Accepte les sous-clés plugins, templates, locales, qui permettent la définition de chemins respectivement pour les plugins, les templates de view et les fichiers de locales.

App.uploadedFilesAsObjects

Définit si les fichiers téléchargés sont représentés sous forme d’objets (true), ou de tableaux (false). Cette option est considérée comme activée par défaut. Référez-vous à File Uploads section dans le chapitre Objets Request & Response pour de plus amples informations.

Security.salt

Une chaîne au hasard utilisée dans les hashages. Cette valeur est aussi utilisée comme sel HMAC quand on fait des chiffrements symétriques.

Asset.timestamp

Ajoute un timestamp qui est le dernier temps modifié du fichier particulier à la fin des URLs des fichiers d’asset (CSS, JavaScript, Image) lors de l’utilisation des helpers adéquats. Valeurs valides:

• (bool) false - Ne fait rien (par défaut)

• (bool) true - Ajoute le timestamp quand debug est à true

• (string) “force” - Ajoute toujours le timestamp.

Asset.cacheTime

Fixe la valeur de la mise en cache des ressources (assets). Elle détermine la valeur du header http Cache-Control max-age, ansi que du header http Expire pour les ressources. Cela peut-être tout ce que votre version de la fonction strtotime de php accepte. La valeur par défaut est +1 day.

Utilisation d’un CDN¶

Pour utiliser un CDN pour charger vos actifs statiques, modifiez App.imageBaseUrl, App.cssBaseUrl, App.jsBaseUrl pour pointer vers l’URI du CDN, par exemple: https://mycdn.example.com/ (notez le / à la fin).

A toutes les images, scripts et styles chargés via HtmlHelper sera ajouté le path absolu du CDN, correspondant au même chemin relatif utilisé dans l’application. Notez s’il vous plaît il existe un cas d’utilisation spécifique lors de l’utilisation de ressources basée sur les plugins: les plugins n’utiliseront pas le prefixe de plugin quand l’URI absolue définie dans ... BaseUrl est utilisée, par exemple par défaut:

• $this->Helper->assetUrl('TestPlugin.logo.png') resolves to test_plugin/logo.png

Si vous fixez App.imageBaseUrl à https://mycdn.example.com/:

• $this->Helper->assetUrl('TestPlugin.logo.png') resolves to https://mycdn.example.com/logo.png.

Configuration de la Base de Données¶

Regardez la Configuration de la Base de Données pour plus d’informations sur la configuration de vos connections à la base de données.

Configuration de la Mise en Cache¶

Consultez Configuration du cache pour plus d’informations sur la configuration de la mise en cache dans CakePHP.

Configuration de Gestion des Erreurs et des Exceptions¶

Consultez les sections sur Configuration des erreurs et des exceptions pour des informations sur la configuration des gestionnaires d’erreur et d’exception.

Configuration des Logs¶

Consultez Configuration des flux d’un log (journal) pour des informations sur la configuration des logs dans CakePHP.

Configuration de Email¶

Consultez Configuration des Email pour avoir des informations sur la configuration prédéfinie d’email dans CakePHP.

Configuration de Session¶

Consultez Configuration de Session pour avoir des informations sur la configuration de la gestion des sessions dans CakePHP.

Configuration du Routing¶

Consultez Configuration des Routes pour plus d’informations sur la configuration du routing et de la création de routes pour votre application.

Les chemins de Plugin, View Template et de Locale¶

Puisque les plugins, view templates et locales ne sont pas des classes, ils ne peuvent pas avoir un autoloader configuré. CakePHP fournit trois variables de configuration pour configurer des chemins supplémentaires pour vos ressources. Dans votre config/app.php, vous pouvez définir les variables:

return [
    // Plus de configuration
    'App' => [
        'paths' => [
            'plugins' => [
                ROOT . DS . 'plugins' . DS,
                '/path/to/other/plugins/'
            ],
            'templates' => [
                ROOT . DS . 'templates' . DS,
                ROOT . DS . 'templates2' . DS
            ],
            'locales' => [
                ROOT . DS . 'resources' . DS . 'locales' . DS
            ]
        ]
    ]
];

Les chemins doivent finir par un séparateur de répertoire, sinon ils ne fonctionneront pas correctement.

Ecrire des Données de Configuration¶

static Cake\Core\Configure::write($key, $value)¶

Utilisez write() pour stocker les données de configuration de l’application:

Configure::write('Company.name','Pizza, Inc.');
Configure::write('Company.slogan','Pizza for your body and soul');

L’exemple ci-dessus pourrait aussi être écrit en un appel unique:

Configure::write('Company', [
    'name' => 'Pizza, Inc.',
    'slogan' => 'Pizza for your body and soul'
]);

Vous pouvez utiliser Configure::write('debug', $bool) pour intervertir les modes de debug et de production à la volée.

Lire les Données de Configuration¶

static Cake\Core\Configure::read($key = null, $default = null)¶

Utilisé pour lire les données de configuration de l’application. Si une clé est fournie, la donnée est retournée. En utilisant nos exemples pour write() ci-dessus, nous pouvons lire cette donnée:

// Renvoie: 'Pizza, Inc.'
Configure::read('Company.name');

// Renvoie: 'Pizza for your body and soul'
Configure::read('Company.slogan');

Configure::read('Company');
// Retourne:
['name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul'];

// Renvoie 'fallback' car Company.nope nexiste pas.
Configure::read('Company.nope', 'fallback');

Si $key est laissée à null, toutes les valeurs dans Configure seront retournées.

static Cake\Core\Configure::readOrFail($key)¶

Permet de lire les données de configuration tout comme Cake\Core\Configure::read mais s’attend à trouver une paire clé/valeur. Dans le cas où la paire demandée n’existe pas, une RuntimeException sera lancée:

Configure::readOrFail('Company.name');    // Renvoie: 'Pizza, Inc.'
Configure::readOrFail('Company.geolocation');  // Lancera un exception

Configure::readOrFail('Company');

//  Renvoie:
['name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul'];

Vérifier si les Données de Configuration sont Définies¶

static Cake\Core\Configure::check($key)¶

Utilisée pour vérifier si une clé/chemin existe et a une valeur non nulle:

$exists = Configure::check('Company.name');

Supprimer une Donnée de Configuration¶

static Cake\Core\Configure::delete($key)¶

Utilisée pour supprimer l’information de la configuration de l’application:

Configure::delete('Company.name');

Lire & Supprimer les Données de Configuration¶

static Cake\Core\Configure::consume($key)¶

Lit et supprime une clé de Configure. C’est utile quand vous voulez combiner la lecture et la suppression de valeurs en une seule opération.

static Cake\Core\Configure::consumeOrFail($key)¶

Lit et supprime une donnée de configuration tout comme Cake\Core\Configure::consume mais s’attend à trouver une paire clé/valeur. Si la paire demandée n’existe pas une RuntimeException sera levée:

Configure::consumeOrFail('Company.name');    // Renvoie: 'Pizza, Inc.'
Configure::consumeOrFail('Company.geolocation');  // Lèvera une exception

Configure::consumeOrFail('Company');

// Renvoie:
['name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul'];

Chargement des Fichiers de Configuration¶

static Cake\Core\Configure::load($key, $config = 'default', $merge = true)¶

Une fois que vous attachez un lecteur de config à Configure, vous pouvez charger les fichiers de configuration:

// Charge my_file.php en utilisant l'objet de lecture 'default'.
Configure::load('my_file', 'default');

Les fichiers de configuration chargés fusionnent leurs données avec la configuration exécutée existante dans Configure. Cela vous permet d’écraser et d’ajouter de nouvelles valeurs dans la configuration existante exécutée. En configurant $merge à true, les valeurs se combineront à celles de la configuration existante.

Créer et Modifier les Fichiers de Configuration¶

static Cake\Core\Configure::dump($key, $config = 'default', $keys = [])¶

Déverse toute ou quelques données de Configure dans un fichier ou un système de stockage supporté par le lecteur. Le format de sérialisation est décidé en configurant le lecteur de config attaché dans $config. Par exemple, si l’adaptateur “default” est Cake\Core\Configure\Engine\PhpConfig, le fichier généré sera un fichier de configuration PHP qu’on pourra charger avec Cake\Core\Configure\Engine\PhpConfig.

Etant donné que le lecteur “default” est une instance de PhpConfig. Sauvegarder toutes les données de Configure dans le fichier my_config.php:

Configure::dump('my_config', 'default');

Sauvegarde seulement les erreurs gérant la configuration:

Configure::dump('error', 'default', ['Error', 'Exception']);

Configure::dump() peut être utilisée pour soit modifier, soit surcharger les fichiers de configuration qui sont lisibles avec Configure::load()

Stocker la Configuration de Runtime¶

static Cake\Core\Configure::store($name, $cacheConfig = 'default', $data = null)¶

Vous pouvez aussi stocker les valeurs de configuration exécutées pour l’utilisation dans une requête future. Comme configure ne se souvient seulement que des valeurs pour la requête courante, vous aurez besoin de stocker toute information de configuration modifiée si vous souhaitez l’utiliser dans des requêtes suivantes:

// Stocke la configuration courante dans la clé 'user_1234' dans le cache 'default'.
Configure::store('user_1234', 'default');

Les données de configuration stockées persistent dans la configuration appelée Cache. Consultez la documentation sur La mise en cache pour plus d’informations sur la mise en cache.

Restaurer la configuration de runtime¶

static Cake\Core\Configure::restore($name, $cacheConfig = 'default')¶

Une fois que vous avez stocké la configuration exécutée, vous aurez probablement besoin de la restaurer afin que vous puissiez y accéder à nouveau. Configure::restore() fait exactement cela:

// restaure la configuration exécutée à partir du cache.
Configure::restore('user_1234', 'default');

Quand on restaure les informations de configuration, il est important de les restaurer avec la même clé, et la configuration de cache comme elle était utilisée pour les stocker. Les informations restaurées sont fusionnées en haut de la configuration existante exécutée.

Moteurs de Configuration¶

CakePHP vous permet de charger des configurations provenant de plusieurs sources et formats de données différents et vous donne accès à un système extensible pour créer vos propres moteurs de configuration. Les moteurs inclus dans CakePHP sont:

• JsonConfig

• IniConfig

• PhpConfig

Par défaut, votre application utilisera PhpConfig.