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

必要に応じて 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 config settings
  • 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

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

You can define additional custom aliases using the aliases config setting as well. For example, you may wish to create aliases that define the base URL and base path that your asset volumes will live in.

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

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

TIP

設定でエイリアスを参照する場合、URL やパスに追加のセグメントを付加することができます。例えば、@assetBaseUrl/user-photos をボリュームのベース URL にセットできます。

{{ alias('@assetBaseUrl') }}

TIP

alias() ファンクションに渡すことによって、テンプレート内でエイリアスをパースできます。

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

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

{{ alias('@assetBaseUrl') }}

:::

URL ルール

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

PHP 定数

You can configure core settings like system file paths and the active environment by defining certain PHP constants in web/index.php.

アプリケーション設定

You can customize Craft’s application configuration from config/app.php, such as overriding component configs, or adding new modules and components.