Configuration du projet CakePHP

Dans ce chapitre, nous comprendrons les Variables d'environnement, configuration générale, configuration de la base de données et Configuration de la messagerie dans CakePHP.

Configuration CakePHP est livré avec un fichier de configuration par défaut, et nous pouvons le modifier en fonction de nos besoins. Il existe un dossier dédié « config » à cet effet. CakePHP est livré avec différentes options de configuration.

Commençons par comprendre les variables d'environnement dans CakePHP.

Variables d'environnement

Les variables d'environnement facilitent le fonctionnement de votre application sur différents environnements. Par exemple, sur un serveur de développement, un serveur de test, un serveur intermédiaire et un environnement de serveur de production. Pour tous ces environnements, vous pouvez utiliser la fonction env() pour lire la configuration de l'environnement dont vous avez besoin et créer votre application.

Dans votre dossier de configuration, vous rencontrerez config/.env.example. Ce fichier contient toutes les variables qui seront modifiées en fonction de votre environnement. Pour commencer, vous pouvez créer un fichier dans le dossier de configuration, c'est-à-dire config/.env, définir ces variables et les utiliser. Si vous avez besoin de variables supplémentaires, elles peuvent être placées dans ce fichier.

Vous pouvez lire votre variable d'environnement en utilisant la fonction env() comme indiqué ci-dessous −

Exemple

$debug = env('APP_DEBUG', false);

La première est le nom de la variable d'environnement souhaitée et la deuxième valeur est la valeur par défaut. La valeur par défaut est utilisée si aucune valeur n'est trouvée pour la variable d'environnement.

Configuration générale

Le tableau suivant décrit le rôle des différentes variables et comment elles affectent votre application CakePHP.

Sr.Non

Nom et description de la variable

1

Sr.No	Variable Name & Description
1	debug Changes CakePHP debugging output. false = Production mode. No error messages, errors, or warnings shown. true = Errors and warnings shown.
2	App.namespace The namespace to find app classes under.
3	App.baseUrl Un-comment this definition, if you don’t plan to use Apache’s mod_rewrite with CakePHP. Don’t forget to remove your .htaccess files too.
4	App.base The base directory the app resides in. If false, this will be auto detected.
5	App.encoding Define what encoding your application uses. This encoding is used to generate the charset in the layout, and encode entities. It should match the encoding values specified for your database.
6	App.webroot The webroot directory.
7	App.wwwRoot The file path to webroot.
8	App.fullBaseUrl The fully qualified domain name (including protocol) to your application’s root.
9	App.imageBaseUrl Web path to the public images directory under webroot.
10	App.cssBaseUrl Web path to the public css directory under webroot.
11	App.jsBaseUrl Web path to the public js directory under webroot.
12	App.paths Configure paths for non-class based resources. Supports the plugins, templates, locales, subkeys, which allow the definition of paths for plugins, view templates and locale files respectively.
13	Security.salt A random string used in hashing. This value is also used as the HMAC salt when doing symmetric encryption.
14	Asset.timestamp Appends a timestamp, which is last modified time of the particular file at the end of asset files URLs (CSS, JavaScript, Image) when using proper helpers. The valid values are − (bool) false - Doesn’t do anything (default). (bool) true - Appends the timestamp, when debug is true. (string) ‘force’ - Always appends the timestamp.

débogage Modifie la sortie de débogage de CakePHP. faux = Mode production. Aucun message d'erreur, erreur ou avertissement affiché. true = Erreurs et avertissements affichés.

2

App.namespace L'espace de noms sous lequel rechercher les classes d'application.

3

App.baseUrl Dé-commentez cette définition, si vous ne prévoyez pas d'utiliser le mod_rewrite d'Apache avec CakePHP. N'oubliez pas de supprimer également vos fichiers .htaccess.

4

App.base Le répertoire de base dans lequel réside l'application. Si faux, cela sera détecté automatiquement.

5

App.encoding Définissez le codage utilisé par votre application. Cet encodage est utilisé pour générer le jeu de caractères dans la mise en page et encoder les entités. Il doit correspondre aux valeurs d'encodage spécifiées pour votre base de données.

6

App.webroot Le répertoire webroot.

7

App.wwwRoot Le chemin du fichier vers webroot.

8

App.fullBaseUrl Le nom de domaine complet (y compris le protocole) à la racine de votre application.

9

App.imageBaseUrl Chemin Web vers le répertoire public des images sous webroot.

10

App.cssBaseUrl Chemin Web vers le répertoire CSS public sous webroot.

11

App.jsBaseUrl Chemin Web vers le répertoire public js sous webroot.

12

App.paths Configurez les chemins pour les ressources non basées sur les classes. Prend en charge les plugins, modèles, paramètres régionaux, sous-clés qui permettent respectivement de définir des chemins pour les plugins, d'afficher les modèles et les fichiers de paramètres régionaux.

13

Sécurité.salt Une chaîne aléatoire utilisée dans le hachage. Cette valeur est également utilisée comme sel HMAC lors du cryptage symétrique.

14

Actif.timestamp Ajoute un horodatage, qui correspond à l'heure de la dernière modification du fichier particulier à la fin des URL des fichiers d'actifs (CSS, JavaScript, Image) lors de l'utilisation des aides appropriées. Les valeurs valides sont −

• (bool) false - Ne fait rien (par défaut).
• (bool) true - Ajoute l'horodatage lorsque le débogage est vrai.
• (string) 'force' - Ajoute toujours l'horodatage.

Databases Configuration

Database can be configured in config/app.php and config/app_local.php file. This file contains a default connection with provided parameters, which can be modified as per our choice.

The below snippet shows the default parameters and values, which should be modified as per the requirement.

Config/app_local.php

*/
   'Datasources' => [
      'default' => [
         'host' => 'localhost',
         'username' => 'my_app',
         'password' => 'secret',
         'database' => 'my_app',
         'url' => env('DATABASE_URL', null),
      ],
      /*
         * The test connection is used during the test suite.
      */
      'test' => [
         'host' => 'localhost',
         //'port' => 'non_standard_port_number',
         'username' => 'my_app',
         'password' => 'secret',
         'database' => 'test_myapp',
         //'schema' => 'myapp',
      ],
   ],

Let us understand each parameter in detail in config/app_local.php.

Host	The database server’s hostname (or IP address).
username	Database username
password	Database password.
database	Name of Database.
Port	The TCP port or Unix socket used to connect to the server.

config/app.php

'Datasources' => [
   'default' => [
      'className' => Connection::class,
      'driver' => Mysql::class,
      'persistent' => false,
      'timezone' => 'UTC',
      //'encoding' => 'utf8mb4',
      'flags' => [],
      'cacheMetadata' => true,
      'log' => false,
      'quoteIdentifiers' => false,
      //'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'],
   ],
]   

Let us understand each parameter in detail in config/app.php.

log

Sr.No	Key & Description
1	className The fully namespaced class name of the class that represents the connection to a database server. This class is responsible for loading the database driver, providing SQL transaction mechanisms and preparing SQL statements among other things.
2	driver The class name of the driver used to implement all specificities for a database engine. This can either be a short classname using plugin syntax, a fully namespaced name, or a constructed driver instance. Examples of short classnames are Mysql, Sqlite, Postgres, and Sqlserver.
3	persistent Whether or not to use a persistent connection to the database.
4	encoding Indicates the character set to use, when sending SQL statements to the server like ‘utf8’ etc.
5	timezone Server timezone to set.
6	init A list of queries that should be sent to the database server as and when the connection is created.
7	log Set to true to enable query logging. When enabled queries will be logged at a debug level with the queriesLog scope.
8	quoteIdentifiers Set to true, if you are using reserved words or special characters in your table or column names. Enabling this setting will result in queries built using the Query Builder having identifiers quoted when creating SQL. It decreases performance.
9	flags An associative array of PDO constants that should be passed to the underlying PDO instance.
10	cacheMetadata Either boolean true, or a string containing the cache configuration to store meta data in. Having metadata caching disable is not advised and can result in very poor performance.

Email Configuration

Email can be configured in file config/app.php. It is not required to define email configuration in config/app.php. Email can be used without it. Just use the respective methods to set all configurations separately or load an array of configs. Configuration for Email defaults is created using config() and configTransport().

Email Configuration Transport

By defining transports separately from delivery profiles, you can easily re-use transport configuration across multiple profiles. You can specify multiple configurations for production, development and testing. Each transport needs a className. Valid options are as follows −

• Mail − Send using PHP mail function

• Smtp − Send using SMTP

• Debug − Do not send the email, just return the result

You can add custom transports (or override existing transports) by adding the appropriate file to src/Mailer/Transport. Transports should be named YourTransport.php, where 'Your' is the name of the transport.

Following is the example of Email configuration transport.

'EmailTransport' => [
   'default' => [
      'className' => 'Mail',
      // The following keys are used in SMTP transports
      'host' => 'localhost',
      'port' => 25,
      'timeout' => 30,
      'username' => 'user',
      'password' => 'secret',
      'client' => null,
      'tls' => null,
      'url' => env('EMAIL_TRANSPORT_DEFAULT_URL', null),
   ],
],

Email Delivery Profiles

Delivery profiles allow you to predefine various properties about email messages from your application, and give the settings a name. This saves duplication across your application and makes maintenance and development easier. Each profile accepts a number of keys.

Following is an example of Email delivery profiles.

'Email' => [
   'default' => [
   
      'transport' => 'default',
      'from' => 'you@localhost',
   ],
],

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!