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

2023/12/26 2023/12/28

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

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

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

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

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

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

// 定数の設定

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

// 翻訳処理

echo __(TITLE_LIST,"東京都");

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

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

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

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

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

// 定数の設定

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", "神奈川県の一覧ページ");

// 定数の設定

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);
}

// 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] ));

// 都道府県の配列

$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を利用してテンプレートごとに指定する方法を解説
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

: CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを

CakePHP3でルーティングの設定変更をしたけど反映されない！そんなときは慌てず騒がずキャッシュをクリアしよう！ルーティングの設定もキャッシュされることがあるらしい。

: CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介

CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。［”項目名”=>”値”]ではなく[”項目名 = 項目名”］と書くところがポイント。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

: CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。