国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法

翻訳機能「__()」を使って定数に変数を埋め込む方法

　
定数は変更できないからこその「定数」なわけですが、CakePHP4でその定数に変数を埋め込むみ、翻訳機能「__()」を使って変数を処理する方法を紹介します。
（CakePHP4と CakePHP3とでは定数の設定方法が少し異なりますが、CakePHP3でも同じような方法で処理をすることができます。）
　
　

「国際化と地域化」の翻訳機能である「__()」を使って定数を変換

　
「国際化と地域化」の翻訳機能である「__()」を利用して、定数の中の変数を埋め込み、それを処理させる方法です。
　

// 定数の設定
define("TITLE_LIST", "{0}の一覧ページ");

// 翻訳処理
echo __(TITLE_LIST,"東京都");

　
出力は「東京都の一覧ページ」となります。
　
　
ちなみに、翻訳機能を使わずに単純に「echo TITLE_LIST;」とすると、定数に指定されたままの「{0}の一覧ページ」が出力されます。
　
また、「__()」は翻訳機能ですので、「default.po」などの翻訳ファイルを設置している場合は、翻訳させることもできます。
　
　

翻訳機能「__()」で変数を複数処理したい場合

　
また、複数の変数を処理したい場合は「{0}」「{1}」「{2}」のように数値を増やして記載することで対応が可能です。
　

// 定数の設定
define("TITLE_LIST", "{0}・{1}の一覧ページ");

// 翻訳処理
echo __(TITLE_LIST,"東京都","千代田区");

　
出力は「東京都・千代田区の一覧ページ」となります。
　
　

CakePHP4の翻訳機能、定数の定義方法についての関連記事

　
CakePHP4で定数についての記事、および、翻訳に関する記事はそれぞれ下記を参照してください。
　
CakePHP4のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）
CakePHP4、CakePHP5のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）
　
CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）
CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）
　
　

翻訳機能「__()」を使って定数を変換する処理の使いどころ

　
どういうときに使うか、私の例を参考に紹介します。
　
例えば、ページタイトルを定数で指定したいとします。
　
ページタイトルは SEOの対応で重要な要素ですので、定期的に見直しも必要です。
そのため、可能であれば一つの設定ファイルにまとまっている方がメンテナンスの効率がいいため、定数ファイル内に定数として設定したい、と考えたわけです。
　
そして、ページ構成の中に「都道府県」ごとの一覧画面があるとします。
　
　

都道府県ごとに定数を設定する場合

　
この場合、下記のように都道府県ごとに定数を指定します。
　

// 定数の設定
define("TITLE_LIST_SAITAMA",  "埼玉県の一覧ページ");
define("TITLE_LIST_CHIBA",    "千葉県の一覧ページ");
define("TITLE_LIST_TOKYO",    "東京都の一覧ページ");
define("TITLE_LIST_KANAGAWA", "神奈川県の一覧ページ");

　
そして、都道府県コードを元にしてタイトルを振り分ける処理になるかと思います。
　

// titleへのアサイン
if       ($prefecture == 11){
  $this->assign("title", TITLE_LIST_SAITAMA);
} elseif ($prefecture == 12){
  $this->assign("title", TITLE_LIST_CHIBA);
} elseif ($prefecture == 13){
  $this->assign("title", TITLE_LIST_TOKYO);
} elseif ($prefecture == 14){
  $this->assign("title", TITLE_LIST_KANAGAWA);
}

　
ただ、これでは、47県分の定数を設定し、47に分岐する if文（もしくは switch文）を記述する必要があり、まったく効率的ではありません。
　
　

翻訳機能を使う場合の定数の設定

　
そこで、翻訳機能である「__()」を使用します。
　
これを下記のように翻訳処理を利用することで処理を簡潔にすることができるようになります。
　

// 都道府県の配列
$prefectureArray = [
  11 => "埼玉県",
  12 => "千葉県",
  13 => "東京都",
  14 => "神奈川県",
];

// 定数の指定
define("TITLE_LIST", "{0}の一覧ページ");

// 翻訳処理、および、titleへのアサイン
$this->assign("title", __( TITLE_LIST, $prefectureArray[13] ));

　
「定数の指定」は、定数ファイルに記述します。
「翻訳処理、および、titleへのアサイン」は、各 templateファイルに記述します。
　
また、「titleへのアサイン」の処理で、「fetch('title') ?>」が記述されている箇所に出力されます。
「fetch('title') ?>」は、デフォルトでは「/templates/layout/default.php」に記載されています。
　
　

CakePHP3のタイトルタグ編集、fetch、asignについての関連記事

　
主に CakePHP3用の記事ですが、基本的な処理は CakePHP4でも同じですので、titleタグをアサインする方法や、metaタグなどを編集する方法については下記の記事を参照してください。
　
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
　
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
　
　

CakePHP4の関連記事