CakePHP3をインストール後、最初に行っておくと良い初期設定をここに記します。このページはこれからも更新していきます。

【入門】CakePHP3をインストール後に行っておくべき初期設定

CakePHP3 をインストール後、最初に行っておくと良い初期設定をここに記します。
尚、このページはこれからも更新していきます。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E6%A4%9C%E8%A8%BC%E7%92%B0%E5%A2%83">検証環境</a></li>
<li><a href="#%E3%82%BF%E3%82%A4%E3%83%A0%E3%82%BE%E3%83%BC%E3%83%B3%E3%81%AE%E8%A8%AD%E5%AE%9A">タイムゾーンの設定</a></li>
<li><a href="#dotenv-%E3%81%AE%E6%9C%89%E5%8A%B9%E5%8C%96">Dotenv の有効化</a>
<ol>
<li><a href="#env-%E3%81%AE%E4%BD%9C%E6%88%90">.env の作成</a></li>
<li><a href="#%E7%92%B0%E5%A2%83%E5%A4%89%E6%95%B0%E3%81%AE%E8%A8%AD%E5%AE%9A">環境変数の設定</a></li>
<li><a href="#dotenv-%E3%82%92%E6%9C%89%E5%8A%B9%E5%8C%96%E3%81%99%E3%82%8B">Dotenv を有効化する</a></li>
</ol>
</li>
<li><a href="#%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9%E3%81%B8%E3%81%AE%E6%8E%A5%E7%B6%9A">データベースへの接続</a>
<ol>
<li><a href="#env-%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E8%A8%AD%E5%AE%9A">env ファイルへの設定</a></li>
<li><a href="#%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9%E6%8E%A5%E7%B6%9A%E8%A8%AD%E5%AE%9A%E3%81%AE%E5%A4%89%E6%9B%B4">データベース接続設定の変更</a></li>
</ol>
</li>
</ol>
<h2 id="検証環境">検証環境</h2>
<ul>
<li>linux CentOS 7</li>
<li>Apache 2.4</li>
<li>PHP 7.1</li>
<li>MySQL 5.7</li>
<li>CakePHP 3.5</li>
</ul>
CakePHP のルートディレクトリを「cakephp/」とします。
<h2 id="タイムゾーンの設定">タイムゾーンの設定</h2>
時間を日本時間に設定します。
設定ファイル app.php の 236行目あたり。「Datasources 」の、「default 」の中の「timezone 」を「UTC 」から「+09:00 」へ変更します。
<dl class="description_setting">
<dt>cakephp/config/app.php</dt>
<dd>
<pre><code class="hljs language-php">'Datasources' => [
'default' => [
 // 'timezone' => 'UTC',
 'timezone' => '+09:00',
 ],
</code></pre>
</dd>
</dl>
bootstrap.php の 96行目あたり。「date_default_timezone_set 」を「UTC 」から「Asia/Tokyo 」へ変更します。
<dl class="description_setting">
<dt>cakephp/config/bootstrap.php</dt>
<dd>
<pre><code class="hljs language-php">// date_default_timezone_set('UTC');
date_default_timezone_set('Asia/Tokyo');
</code></pre>
</dd>
</dl>
<h2 id="dotenv-の有効化">Dotenv の有効化</h2>
環境変数を env ファイルで管理できるように設定します。
<h3 id="env-の作成">.env の作成</h3>
cakephp/config/.env.default をコピーし、.env へリネームします。
<pre><code class="hljs language-shell">cakephp
├─ config
｜ ├─ .env.default // ①このファイルをコピー
｜ ├─ .env // ②コピーしたファイルをリネーム
</code></pre>
<h3 id="環境変数の設定">環境変数の設定</h3>
作成した.env に設定を記述します。
<pre><code class="hljs language-shell">#!/usr/bin/env bash
# Used as a default to seed config/.env which
# enables you to use environment variables to configure
# the aspects of your application that vary by
# environment.
#
# To use this file, first copy it into `config/.env`. Also ensure the related
# code block for loading this file is uncommented in `config/boostrap.php`
#
# In development .env files are parsed by PHP
# and set into the environment. This provides a simpler
# development workflow over standard environment variables.

#export APP_NAME=__APP_NAME__
export APP_NAME=MY_APP

export DEBUG=true
export APP_ENCODING=UTF-8

#export APP_DEFAULT_LOCALE=en_US
export APP_DEFAULT_LOCALE=ja_JP

#export SECURITY_SALT=__SALT__
export SECURITY_SALT=039448d2d0e265c5a21fcdc3dn40ce2ba98cpx1a2c609e308c84419fbc4da9d2

# Uncomment these to define cache configuration via environment variables.
#export CACHE_DURATION=+2 minutes
#export CACHE_DEFAULT_URL=file://tmp/cache/?prefix=${APP_NAME}_default&#x26;duration=${CACHE_DURATION}
#export CACHE_CAKECORE_URL=file://tmp/cache/persistent?prefix=${APP_NAME}_cake_core&#x26;serialize=true&#x26;duration=${CACHE_DURATION}
#export CACHE_CAKEMODEL_URL=file://tmp/cache/models?prefix=${APP_NAME}_cake_model&#x26;serialize=true&#x26;duration=${CACHE_DURATION}

# Uncomment these to define email transport configuration via environment variables.
#export EMAIL_TRANSPORT_DEFAULT_URL=

# Uncomment these to define database configuration via environment variables.
#export DATABASE_URL=mysql://my_app:secret@localhost/${APP_NAME}?encoding=utf8&#x26;timezone=UTC&#x26;cacheMetadata=true&#x26;quoteIdentifiers=false&#x26;persistent=false
#export DATABASE_TEST_URL=mysql://my_app:secret@localhost/test_${APP_NAME}?encoding=utf8&#x26;timezone=UTC&#x26;cacheMetadata=true&#x26;quoteIdentifiers=false&#x26;persistent=false

# Uncomment these to define logging configuration via environment variables.
#export LOG_DEBUG_URL=file://logs?levels[]=notice&#x26;levels[]=info&#x26;levels[]=debug&#x26;file=debug
#export LOG_ERROR_URL=file://logs?levels[]=warning&#x26;levels[]=error&#x26;levels[]=critical&#x26;levels[]=alert&#x26;levels[]=emergency&#x26;file=error

</code></pre>
記述を変更した箇所は以下になります。
<pre><code class="hljs language-shell">#export APP_NAME=__APP_NAME__
export APP_NAME=MY_APP

#export APP_DEFAULT_LOCALE=en_US
export APP_DEFAULT_LOCALE=ja_JP

#export SECURITY_SALT=__SALT__
export SECURITY_SALT=039448d2d0e265c5a21fcdc3dn40ce2ba98cpx1a2c609e308c84419fbc4da9d2

</code></pre>
<dl class="description_setting">
<dt>APP_NAME アプリケーションの名前を記述します。 APP_DEFAULT_LOCALE デフォルトのロケールを日本語にします。 SECURITY_SALTsalt 値を記述します。 salt 値は、cakephp/config/app.php の 67行目あたりにある値を記述します。</dt>
<dd>
<pre><code class="hljs language-php">'Security' => [
 'salt' => env('SECURITY_SALT', '【ここに記述されている値が salt 値です】'),
],
</code></pre>
</dd>
</dl>
<h4 id="salt-値">salt 値</h4>
salt（ソルト）値とは、セキュリティと暗号化の設定値で、ハッシュ関数で使用されるランダムな文字列です。また、暗号化キーとしても使用されます。
ソルト値は、非常に機密性の高いデータとして扱う必要があります。
SECURITY_SALT を設定したら、app.php に記述されている salt 値は削除し空にしておきます。
<pre><code class="hljs language-php">'Security' => [
 'salt' => env('SECURITY_SALT', ''),
],
</code></pre>
<h3 id="dotenv-を有効化する">Dotenv を有効化する</h3>
.env を読み込むように Dotenv を有効化します。
bootstrap.php の 52行目あたりにある Dotenv のコメントアウトを外すことで Dotenv が有効化され、.env が読み込まれるようになります。
<dl class="description_setting">
<dt>cakephp/config/bootstrap.php</dt>
<dd>
<pre><code class="hljs language-php">// if (!env('APP_NAME') &#x26;&#x26; file_exists(CONFIG . '.env')) {
// $dotenv = new \josegonzalez\Dotenv\Loader([CONFIG . '.env']);
// $dotenv->parse()
// ->putenv()
// ->toEnv()
// ->toServer();
// }

// ↓ コメントアウトを外す

 if (!env('APP_NAME') &#x26;&#x26; file_exists(CONFIG . '.env')) {
$dotenv = new \josegonzalez\Dotenv\Loader([CONFIG . '.env']);
 $dotenv->parse()
 ->putenv()
 ->toEnv()
 ->toServer();
 }
</code></pre>
</dd>
</dl>
<h2 id="データベースへの接続">データベースへの接続</h2>
CakePHP からデータベースへの接続設定を行います。今回は通常の設定ではなく、env ファイルに情報を集約する流れで行います。
<h3 id="env-ファイルへの設定">env ファイルへの設定</h3>
.env へデータベースへの接続情報を記述します。
<pre><code class="hljs language-shell">export DB_HOST=your_database_host
export DB_SCHEMA=your_database_name
export DB_USERNAME=your_username
export DB_PASSWORD=your_password
</code></pre>
<h3 id="データベース接続設定の変更">データベース接続設定の変更</h3>
データベース接続設定を、env ファイルから読み込むように変更します。
<dl class="description_setting">
<dt>cakephp/config/app.php</dt>
<dd>
<pre><code class="hljs language-php">'Datasources' => [
'default' => [
 // 'host' => 'localhost',
 // 'username' => 'my_app',
 // 'password' => 'secret',
 // 'database' => 'my_app',
 // ↓
 'host' => env('DB_HOST', 'localhost'),
 'username' => env('DB_USERNAME', ''),
 'password' => env('DB_PASSWORD', ''),
 'database' => env('DB_SCHEMA', ''),
</code></pre>
</dd>
</dl>
最後にブラウザから初期画面へアクセスし、左側「Database 」が緑色のアイコンと共に「CakePHP is able to connect to the database.」と表示されていれば接続成功です。
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/59/ZZX7q9QmtKazeU1WWlvc.png" width="600" height="436" alt="CakePHP3 初期画面"></div>

CakePHP3 をインストール後、最初に行っておくと良い初期設定をここに記します。
尚、このページはこれからも更新していきます。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E6%A4%9C%E8%A8%BC%E7%92%B0%E5%A2%83">検証環境</a></li>
<li><a href="#%E3%82%BF%E3%82%A4%E3%83%A0%E3%82%BE%E3%83%BC%E3%83%B3%E3%81%AE%E8%A8%AD%E5%AE%9A">タイムゾーンの設定</a></li>
<li><a href="#dotenv-%E3%81%AE%E6%9C%89%E5%8A%B9%E5%8C%96">Dotenv の有効化</a>
<ol>
<li><a href="#env-%E3%81%AE%E4%BD%9C%E6%88%90">.env の作成</a></li>
<li><a href="#%E7%92%B0%E5%A2%83%E5%A4%89%E6%95%B0%E3%81%AE%E8%A8%AD%E5%AE%9A">環境変数の設定</a></li>
<li><a href="#dotenv-%E3%82%92%E6%9C%89%E5%8A%B9%E5%8C%96%E3%81%99%E3%82%8B">Dotenv を有効化する</a></li>
</ol>
</li>
<li><a href="#%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9%E3%81%B8%E3%81%AE%E6%8E%A5%E7%B6%9A">データベースへの接続</a>
<ol>
<li><a href="#env-%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E8%A8%AD%E5%AE%9A">env ファイルへの設定</a></li>
<li><a href="#%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9%E6%8E%A5%E7%B6%9A%E8%A8%AD%E5%AE%9A%E3%81%AE%E5%A4%89%E6%9B%B4">データベース接続設定の変更</a></li>
</ol>
</li>
</ol>
<h2 id="検証環境">検証環境</h2>
<ul>
<li>linux CentOS 7</li>
<li>Apache 2.4</li>
<li>PHP 7.1</li>
<li>MySQL 5.7</li>
<li>CakePHP 3.5</li>
</ul>
CakePHP のルートディレクトリを「cakephp/」とします。
<h2 id="タイムゾーンの設定">タイムゾーンの設定</h2>
時間を日本時間に設定します。
設定ファイル app.php の 236行目あたり。「Datasources 」の、「default 」の中の「timezone 」を「UTC 」から「+09:00 」へ変更します。
<dl class="description_setting">
<dt>cakephp/config/app.php</dt>
<dd>
<pre><code class="hljs language-php">'Datasources' => [
'default' => [
 // 'timezone' => 'UTC',
 'timezone' => '+09:00',
 ],
</code></pre>
</dd>
</dl>
bootstrap.php の 96行目あたり。「date_default_timezone_set 」を「UTC 」から「Asia/Tokyo 」へ変更します。
<dl class="description_setting">
<dt>cakephp/config/bootstrap.php</dt>
<dd>
<pre><code class="hljs language-php">// date_default_timezone_set('UTC');
date_default_timezone_set('Asia/Tokyo');
</code></pre>
</dd>
</dl>
<h2 id="dotenv-の有効化">Dotenv の有効化</h2>
環境変数を env ファイルで管理できるように設定します。
<h3 id="env-の作成">.env の作成</h3>
cakephp/config/.env.default をコピーし、.env へリネームします。
<pre><code class="hljs language-shell">cakephp
├─ config
｜ ├─ .env.default // ①このファイルをコピー
｜ ├─ .env // ②コピーしたファイルをリネーム
</code></pre>
<h3 id="環境変数の設定">環境変数の設定</h3>
作成した.env に設定を記述します。
<pre><code class="hljs language-shell">#!/usr/bin/env bash
# Used as a default to seed config/.env which
# enables you to use environment variables to configure
# the aspects of your application that vary by
# environment.
#
# To use this file, first copy it into `config/.env`. Also ensure the related
# code block for loading this file is uncommented in `config/boostrap.php`
#
# In development .env files are parsed by PHP
# and set into the environment. This provides a simpler
# development workflow over standard environment variables.

#export APP_NAME=__APP_NAME__
export APP_NAME=MY_APP

export DEBUG=true
export APP_ENCODING=UTF-8

#export APP_DEFAULT_LOCALE=en_US
export APP_DEFAULT_LOCALE=ja_JP

#export SECURITY_SALT=__SALT__
export SECURITY_SALT=039448d2d0e265c5a21fcdc3dn40ce2ba98cpx1a2c609e308c84419fbc4da9d2

# Uncomment these to define cache configuration via environment variables.
#export CACHE_DURATION=+2 minutes
#export CACHE_DEFAULT_URL=file://tmp/cache/?prefix=${APP_NAME}_default&#x26;duration=${CACHE_DURATION}
#export CACHE_CAKECORE_URL=file://tmp/cache/persistent?prefix=${APP_NAME}_cake_core&#x26;serialize=true&#x26;duration=${CACHE_DURATION}
#export CACHE_CAKEMODEL_URL=file://tmp/cache/models?prefix=${APP_NAME}_cake_model&#x26;serialize=true&#x26;duration=${CACHE_DURATION}

# Uncomment these to define email transport configuration via environment variables.
#export EMAIL_TRANSPORT_DEFAULT_URL=

# Uncomment these to define database configuration via environment variables.
#export DATABASE_URL=mysql://my_app:secret@localhost/${APP_NAME}?encoding=utf8&#x26;timezone=UTC&#x26;cacheMetadata=true&#x26;quoteIdentifiers=false&#x26;persistent=false
#export DATABASE_TEST_URL=mysql://my_app:secret@localhost/test_${APP_NAME}?encoding=utf8&#x26;timezone=UTC&#x26;cacheMetadata=true&#x26;quoteIdentifiers=false&#x26;persistent=false

# Uncomment these to define logging configuration via environment variables.
#export LOG_DEBUG_URL=file://logs?levels[]=notice&#x26;levels[]=info&#x26;levels[]=debug&#x26;file=debug
#export LOG_ERROR_URL=file://logs?levels[]=warning&#x26;levels[]=error&#x26;levels[]=critical&#x26;levels[]=alert&#x26;levels[]=emergency&#x26;file=error

</code></pre>
記述を変更した箇所は以下になります。
<pre><code class="hljs language-shell">#export APP_NAME=__APP_NAME__
export APP_NAME=MY_APP

#export APP_DEFAULT_LOCALE=en_US
export APP_DEFAULT_LOCALE=ja_JP

#export SECURITY_SALT=__SALT__
export SECURITY_SALT=039448d2d0e265c5a21fcdc3dn40ce2ba98cpx1a2c609e308c84419fbc4da9d2

</code></pre>
<dl class="description_setting">
<dt>APP_NAME アプリケーションの名前を記述します。 APP_DEFAULT_LOCALE デフォルトのロケールを日本語にします。 SECURITY_SALTsalt 値を記述します。 salt 値は、cakephp/config/app.php の 67行目あたりにある値を記述します。</dt>
<dd>
<pre><code class="hljs language-php">'Security' => [
 'salt' => env('SECURITY_SALT', '【ここに記述されている値が salt 値です】'),
],
</code></pre>
</dd>
</dl>
<h4 id="salt-値">salt 値</h4>
salt（ソルト）値とは、セキュリティと暗号化の設定値で、ハッシュ関数で使用されるランダムな文字列です。また、暗号化キーとしても使用されます。
ソルト値は、非常に機密性の高いデータとして扱う必要があります。
SECURITY_SALT を設定したら、app.php に記述されている salt 値は削除し空にしておきます。
<pre><code class="hljs language-php">'Security' => [
 'salt' => env('SECURITY_SALT', ''),
],
</code></pre>
<h3 id="dotenv-を有効化する">Dotenv を有効化する</h3>
.env を読み込むように Dotenv を有効化します。
bootstrap.php の 52行目あたりにある Dotenv のコメントアウトを外すことで Dotenv が有効化され、.env が読み込まれるようになります。
<dl class="description_setting">
<dt>cakephp/config/bootstrap.php</dt>
<dd>
<pre><code class="hljs language-php">// if (!env('APP_NAME') &#x26;&#x26; file_exists(CONFIG . '.env')) {
// $dotenv = new \josegonzalez\Dotenv\Loader([CONFIG . '.env']);
// $dotenv->parse()
// ->putenv()
// ->toEnv()
// ->toServer();
// }

// ↓ コメントアウトを外す

 if (!env('APP_NAME') &#x26;&#x26; file_exists(CONFIG . '.env')) {
$dotenv = new \josegonzalez\Dotenv\Loader([CONFIG . '.env']);
 $dotenv->parse()
 ->putenv()
 ->toEnv()
 ->toServer();
 }
</code></pre>
</dd>
</dl>
<h2 id="データベースへの接続">データベースへの接続</h2>
CakePHP からデータベースへの接続設定を行います。今回は通常の設定ではなく、env ファイルに情報を集約する流れで行います。
<h3 id="env-ファイルへの設定">env ファイルへの設定</h3>
.env へデータベースへの接続情報を記述します。
<pre><code class="hljs language-shell">export DB_HOST=your_database_host
export DB_SCHEMA=your_database_name
export DB_USERNAME=your_username
export DB_PASSWORD=your_password
</code></pre>
<h3 id="データベース接続設定の変更">データベース接続設定の変更</h3>
データベース接続設定を、env ファイルから読み込むように変更します。
<dl class="description_setting">
<dt>cakephp/config/app.php</dt>
<dd>
<pre><code class="hljs language-php">'Datasources' => [
'default' => [
 // 'host' => 'localhost',
 // 'username' => 'my_app',
 // 'password' => 'secret',
 // 'database' => 'my_app',
 // ↓
 'host' => env('DB_HOST', 'localhost'),
 'username' => env('DB_USERNAME', ''),
 'password' => env('DB_PASSWORD', ''),
 'database' => env('DB_SCHEMA', ''),
</code></pre>
</dd>
</dl>
最後にブラウザから初期画面へアクセスし、左側「Database 」が緑色のアイコンと共に「CakePHP is able to connect to the database.」と表示されていれば接続成功です。
<div class="img_wrap"><img src="/images/posts/59/ZZX7q9QmtKazeU1WWlvc.png" width="600" height="436" alt="CakePHP3 初期画面"></div>

Author