CakePHP 專案配置

本章我們將了解CakePHP中的環境變數、常規設定、資料庫設定和郵件配置。

設定 CakePHP 預設自帶一個設定文件，我們可以依照自己的需求進行修改。為此，有一個專用資料夾 “config”。 CakePHP 具有不同的配置選項。

讓我們先從了解 CakePHP 中的環境變數開始。

環境變數

環境變數使您的應用程式在不同環境下的工作變得容易。例如，在開發伺服器、測試伺服器、登台伺服器和生產伺服器環境上。對於所有這些環境，您可以使用 env() 函數 讀取所需環境的配置並建立您的應用程式。

在您的 config 資料夾中，您將看到 config/.env.example。該文件包含將根據您的環境進行更改的所有變數。首先，您可以在 config 資料夾中建立一個文件，即 config/.env 並定義這些變數並使用它們。如果您需要任何其他變量，可以將其放入該文件中。

您可以使用 env() 函數讀取環境變量，如下所示 -

範例

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

第一個是您想要的環境變數的名稱，第二個值是預設值。如果沒有找到環境變數的值，則使用預設值。

常規設定

下表描述了各種變數的作用以及它們如何影響您的 CakePHP 應用程式。

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

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