CakePHP プロジェクトの構成

この章では、CakePHP の 環境変数、一般設定、データベース設定 および メール設定 について理解します。

構成 CakePHP にはデフォルトで 1 つの構成ファイルが付属しており、必要に応じて変更できます。この目的のために、「config」 という専用のフォルダーが 1 つあります。 CakePHP にはさまざまな設定オプションが付属しています。

CakePHP の環境変数を理解することから始めましょう。

環境変数

環境変数を使用すると、さまざまな環境でアプリケーションを簡単に動作させることができます。たとえば、開発サーバー、テスト サーバー、ステージング サーバー、運用サーバー環境などです。これらすべての環境について、env() 関数を使用して、必要な環境の構成を読み取り、アプリケーションを構築できます。

config フォルダーに config/.env.example があります。このファイルには、環境に基づいて変更されるすべての変数が含まれています。まず、config フォルダー (config/.env) にファイルを作成し、それらの変数を定義して使用します。追加の変数が必要な場合は、そのファイルに含めることができます。

以下に示すように、env() 関数を使用して環境変数を読み取ることができます -

例

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

最初の値は必要な環境変数の名前で、2 番目の値はデフォルト値です。環境変数の値が見つからない場合は、デフォルト値が使用されます。

一般的な構成

次の表では、さまざまな変数の役割と、それらが CakePHP アプリケーションにどのような影響を与えるかを説明します。

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.

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.

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',
   ],
],

以上がCakePHP プロジェクトの構成の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。