Notesオブジェクトを使ったメッセージ文字列の構築

例えば、PageクラスのgetNotes()メソッドが返すNotesオブジェクトから現在のロケールに従ったメッセージ文字列を表示するには、ZPTテンプレート中で次のように書きます。

<ul>
  <li tal:repeat="note self/notes/notes" tal:content="note/%value">メッセージ</li>
</ul>

Noteオブジェクトを格納する変数「note」について「note/%value」と書くと現在のロケールに従ったメッセージ文字列がMessagesコンポーネントから取り出され、Noteがパラメータを持つ場合はパラメータが埋め込まれてメッセージ文字列が構築されて表示されます。

パラメータが埋め込まれる際、パラメータの値の先頭に「label.」をつけたキーに対応する値がMessagesコンポーネントにあればそれが実際の値として埋め込まれます。なければパラメータの値がそのまま埋め込まれます。

例えばNoteが持つキー（Note#getValue()の値）が「error.required」、Noteが持つパラメータ（Note#getParameters()の値）の1つ目の値が「name」、messages.xpropertiesの内容が以下のような場合、

error.required={0}を指定して下さい
label.name=なまえ

実際に表示されるメッセージは「なまえを指定して下さい」となります。キーが「error.required」、パラメータの1つ目の値が「password」である場合は、label.passwordのエントリが登録されていないので「passwordを指定して下さい」となります。

messages.xpropertiesからメッセージ文字列やパラメータ文字列を取り出す際の処理についてはページ固有のメッセージ文字列の探索も参照して下さい。

[Ymir-1.0.3以降] Noteがパラメータを1つ以上持つ場合、キーと最初のパラメータ値を「+」で結合したキーに対応するメッセージ文字列があれば、それが使用されます。例えば上の例で、

error.required+name={0}を教えて下さい

というエントリがmessages.xpropertiesにある場合、キーが「error.required」、パラメータが「name」であるNoteからメッセージ文字列を構築すると「なまえを教えて下さい」になります。

user.first.name
names[10]
fruits.fruit[10].name

_.note.parameter.segment.direction=r
_.note.parameter.head=
_.note.parameter.delimiter=の
_.note.parameter.tail=
_.note.parameter.segment.template={1}番目の{0}

label.first=

fruits.fruit.name → name

メッセージキーを直接指定したメッセージ文字列の構築

例えば、メッセージキー「message.ok」に対応する現在のロケールに応じたメッセージ文字列を表示するには、ZPTテンプレート中で次のように書きます。

<span tal:replace="messages/%message.ok">メッセージ</span>

なお、この方法ではパラメータの埋め込みはできません。

ロケールによらずデフォルトのメッセージを表示したい場合は次のように「%」をつけずに書いて下さい。

<span tal:replace="messages/message.ok">メッセージ</span>

詳しくは「ZPTテンプレート」の「セグメントの解釈」の表のMessagesに関する項目を参照して下さい

プログラムコードにおけるメッセージ文字列の構築

プログラム中でメッセージ文字列を構築するには、メッセージリソースを管理するMessagesコンポーネントを取得して利用します。

Pageクラス等から利用する場合は特に設定は不要ですが、app.diconに登録されているアプリケーション用コンポーネントからMessagesコンポーネントを利用したい場合は、app.diconからymir-component.diconをインクルードしておいて下さい。

このコンポーネントを利用したいクラスでMessagesクラスを引数に持つSetterメソッドを用意するだけで、自動的にMessagesコンポーネントがインジェクトされます。後はMessagesインタフェースの提供メソッドを呼び出してメッセージ文字列を構築することができます。

メッセージ文字列の取得には、Messages#getMessage(String key)を使って下さい。指定したキーに対応するメッセージ文字列のうち、現在のロケールに合うものが返されます。

ページ固有のメッセージ文字列の探索

Ymirでは、あるキーに対応するメッセージをページ毎に変えることができるようになっています。具体的には、指定されたキーからページ固有のキーを生成し、そのキーに対応するメッセージ文字列を使用するようになっています。見つからない場合は、指定されたキーそのものに対応するメッセージ文字列が使用されます。

ページ固有のキーは、次のルールに従って生成されます。

• キーがドットを含まない場合、ページのコンポーネント名（またはページのコンポーネント名の末尾から「Page」を取り除いたもの）とキーをドット区切りで連結したもの
• キーがドットを含む場合、キーのドットより前の部分とページのコンポーネント名（またはページのコンポーネント名の末尾から「Page」を取り除いたもの）とキーのドットより後ろの部分をドット区切りで連結したもの

例えば「/index.html」ページ（コンポーネント名はindexPage）内でメッセージ文字列を検索する場合は、ページ固有のキーは以下のようになります:

例1: 元のキー：pageTitle → ページ固有のキー：indexPage.pageTitle, index.pageTitle
例2: 元のキー：label.userName → ページ固有のキー：label.indexPage.userName, label.index.userName
例3: 元のキー：message.action.succeed → ページ固有のキー：message.indexPage.action.succeed, message.index.action.succeed

キーの探索順序は以下のようになります:

indexPage.pageTitle → index → pageTitle

上記のようなメッセージ文字列探索が行なわれるのは、以下の場合です。

• バリデーションエラーなどのエラーメッセージを格納するNoteオブジェクトから実際のメッセージ文字列を構築する場合（パラメータ文字列についても上記のような探索が行なわれます）
• ZPTテンプレート中にメッセージリソースのキーを「%」つきで指定したTALES式を埋め込むことで、メッセージ文字列を表示する場合
• Messages#getMessage(String)を使用してメッセージ文字列を取得する場合

[Ymir-1.0.7以降] またページのコンポーネント名がパッケージ名を含む場合は、パッケージ名についてもキーが生成され探索対象となります。

例えば「/member/edit/index.html」ページ（コンポーネント名はmember_edit_indexPage）内でメッセージ文字列を検索する場合は、以下のようにキーが生成され探索されます:

member_edit_indexPage.pageTitle → member_edit_index.pageTitle → member_edit.pageTitle → member.pageTitle → pageTitle