コンフィギュレーションの概要

必要に応じて Craft を設定するには、いくつかの方法があります。

一般設定

Craft は、いくつかの一般設定をサポートしています。config/general.php ファイルでデフォルト値を上書きすることができます。

return [
    'devMode' => true, 
];

データベース接続設定

Craft は、いくつかのデータベース接続設定をサポートしています。config/db.php ファイルでデフォルト値を上書きすることができます。

Guzzle 設定

Craft は、次のような HTTP リクエストを作成するたびに Guzzle 6 を使用します。

  • Craft のアップデートをチェックするとき
  • Craft のサポートウィジェットからサポートリクエストを送信するとき
  • Feed ウィジェットから RSS フィードを読み込むとき
  • Amazon S3 のようなリモートボリュームにあるアセットを操作するとき

config/ フォルダに guzzle.php ファイルを作成することによって、これらのリクエストを送信する際に Guzzle が使用するコンフィグ設定をカスタマイズできます。そのファイルは、設定を上書きした配列を返さなければなりません。

<?php

return [
    'headers' => ['Foo' => 'Bar'],
    'query'   => ['testing' => '123'],
    'auth'    => ['username', 'password'],
    'proxy'   => 'tcp://localhost:80',
];

ここで定義されたオプションは、新しい GuzzleHttp\Client インスタンスに渡されます。利用可能なオプションのリストは、Guzzle のドキュメントを参照してください。

エイリアス

Craft のいくつかの設定やファンクションでは、基本ファイルシステムのパスや URL を代用する Yii エイリアスをサポートしています。 これには次ものが含まれます。

  • サイトのベース URL 設定
  • ボリュームのベース URL 設定
  • ローカルボリュームのファイルシステムパス設定
  • resourceBasePathresourceBaseUrl のコンフィグ設定
  • Twig ファンクションの svg()

次のエイリアスは、そのまま利用可能です。

エイリアス説明
@appvendor/craftcms/cms/src/ のパス
@configconfig/ フォルダのパス
@contentMigrationsmigrations/ フォルダのパス
@craftvendor/craftcms/cms/src/ のパス
@libvendor/craftcms/cms/lib/ のパス
@rootルートプロジェクトのパス(PHP 定数の CRAFT_BASE_PATH と同じ)
@runtimestorage/runtime/ フォルダのパス
@storagestorage/ フォルダのパス
@templatestemplates/ フォルダのパス
@translationstranslations/ フォルダのパス
@vendorvendor/ フォルダのパス
@webリクエストのために読み込まれた index.php ファイルを含むフォルダの URL
@webrootリクエストのために読み込まれた index.php ファイルを含むフォルダのパス

aliases コンフィグ設定を利用して、追加の独自エイリアスを定義することができます。例えば、アセットボリュームが存在するベース URL とベースパスを定義するエイリアスを作成したいかもしれません。

'aliases' => [
    '@assetBaseUrl' => 'http://my-project.com/assets',
    '@assetBasePath' => '/path/to/web/assets',
],

これらを利用して、アセットボリュームのベース URL やファイルシステムのパス設定を記入しはじめることができます。例:@assetBaseUrl/user-photos@assetBasePath/user-photos

必要であれば、.env ファイルや環境設定のどこかで、環境変数のエイリアス値をセットすることができます。

ASSETS_BASE_URL=http://my-project.com/assets
ASSETS_BASE_PATH=/path/to/web/assets

getenv() を使用して、エイリアスの定義にセットすることができます。

'aliases' => [
    '@assetBaseUrl' => getenv('ASSETS_BASE_URL'),
    '@assetBasePath' => getenv('ASSETS_BASE_PATH'),
],

ボリューム設定の上書き

設定ファイルでボリューム設定を定義することを好む場合、config/volumes.php で設定できます。このファイルは配列を返さなければならず、キーにはボリュームのハンドルをマップし、値には上書きする設定を定義してあるネストされた配列を持たせます。

WARNING

Craft が上書きのために config/volumes.php をチェックしはじめる前に、コントロールパネルでボリュームを作成しておく必要があります。

return [
    'siteAssets' => [
        'path' => getenv('ASSETS_BASE_PATH').'/site',
        'url' => getenv('ASSETS_BASE_URL').'/site',
    ],
    'companyLogos' => [
        'path' => getenv('ASSETS_BASE_PATH').'/logos',
        'url' => getenv('ASSETS_BASE_URL').'/logos',
    ],
];

URL ルール

config/routes.php にカスタムの URL ルール を定義することができます。詳細については、ルーティング を参照してください。

PHP 定数

web/index.php に特定の PHP 定数 を定義することで、システムファイルパスやアクティブな環境などのコア設定を設定できます。

アプリケーション設定

config/app.php から、コンポーネント設定を上書きしたり新しいモジュールやコンポーネントを追加するような Craft の アプリケーション設定 をカスタマイズできます。