Skip to content

メッセージIDの精査#3593

Merged
okazy merged 155 commits intoEC-CUBE:4.0from
chihiro-adachi:fix-message-id
Aug 16, 2018
Merged

メッセージIDの精査#3593
okazy merged 155 commits intoEC-CUBE:4.0from
chihiro-adachi:fix-message-id

Conversation

@chihiro-adachi
Copy link
Copy Markdown
Contributor

@chihiro-adachi chihiro-adachi commented Aug 16, 2018

メッセージIDの精査および関する不具合の修正を行っています。

命名規約

原則、以下のフォーマットで作成しています。

[prefix].[機能または画面].[操作や文言を表す文字列]

prefix

同じ意味だが異なる文言が存在するため, フロント画面と管理画面ではprefixをつけ

たとえば、ご注文(フロント) / 受注 (管理画面) などの文言です。

Prefixは以下のとおりです。

  • admin: 管理画面全般
  • tooltip: 管理画面ツールチップ
  • front:フロント画面全般
  • install: インストール画面

区切り文字

namespaceには.を使用します。
単語の区切り文字としては_を使用しています。

また、同一の意味で表示箇所により文言が変わるものや、類義語には__を使用しています。

たとえば商品画像は、商品登録画面では商品画像、商品一覧画面では画像と省略されるため、以下のようにメッセージIDをつけています。

amdin.product.image: 商品画像
amdin.product.image__short: 画像

namespaceの粒度

namespaceの区切りは、細かい粒度でつけると重複が多く発生するため、機能単位レベルで区切るほうが命名しやすいです。

メッセージファイル

メッセージファイルは、従来のPHPファイルからyamlファイルに変更しました。
messages.ja.yaml, validators.ja.yamlとなります。

その他

実装中等の理由により、以下の画面は対応していません。

  • フロント:購入フロー複数配送設定画面
  • 管理:受注編集>メール通知
  • 管理:新着情報
  • 管理:オーナーズストア
  • インストール:マイグレーション

ツールチップや、フォームタイプのエラーメッセージは本PRでは対応していません。

@chihiro-adachi chihiro-adachi added this to the 4.0 milestone Aug 16, 2018
@chihiro-adachi chihiro-adachi added the document Improvements or additions to documentation label Aug 16, 2018
@@ -38,7 +38,7 @@ class ShopController extends AbstractController
/**
* @var BaseInfo
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BaseInfoRepository に変更をお願いします

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

document Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants