設定
コンテンツエディターで管理されるキー/値パラメータのシステムで、コードは不要です。
はじめに
設定は、バックオフィスのコンテンツエディターで管理されるキー/値パラメータのシステムです。頻繁に変更されるウェブサイトの値や、言語ごとに異なる値(例:電話番号、住所、ソーシャルメディアのリンク、ロゴ画像)を、コードに触れることなく扱うためのものです。
バックオフィスには3つのフォームがあります。
- タイプ (
configuration_parameter_type) - パラメータ (
configuration_parameter) - 設定 (
configuration)
タイプ
パラメータが受け入れる値の種類を定義します。コード (code) と 名前 (name) のみを持ちます。次のものはデフォルトで作成済みです。
| コード | 名前 |
|---|---|
boolean | ブール値 |
number | 数値 |
image | 画像 |
color | 色 |
text | テキスト |
html | HTML |
パラメータ
設定の「キー」を定義します。コード (code、コード内で値を取得するために使用)、説明、およびタイプ(上記のいずれか)を持ちます。例:テキストタイプの phone-number というパラメータ。
設定
特定の言語に対するパラメータの値です。パラメータのタイプに応じて、値 (value、テキスト) または画像 (value_img) になります。
言語なしの値(汎用フォールバック)
設定の言語フィールドが空の場合、その値は、そのパラメータに対して固有の値が定義されていないすべての言語のフォールバックとして使用されます。これにより、同じ値(例:すべての言語で同じ電話番号)を言語ごとに複製する必要がなくなります。言語を関連付けずに一度だけ定義し、本当に異なる場合にのみ言語ごとの固有値を定義します。
プログラムから利用する
website/src/common/Cluar.js では、設定を読み取るための関数が提供されています。
Cluar.configuration(parameter)— 現在の言語でパラメータの値を取得します。その言語の値がない場合は、言語なしの値(フォールバック)を使用します。どちらもない場合は、パラメータ名自体を返します(設定漏れにすぐ気づくのに便利です)。Cluar.configurationNumber(parameter)— 同じですが、値を数値に変換します(数値でない場合は0)。Cluar.configurationMultilines(parameter)— 同じですが、改行を<br>に変換します。
次のステップ
辞書を参照してください。