From 8a2848951e36b0a8bbf2618fbd5d569b5ccd7c2f Mon Sep 17 00:00:00 2001
From: kteraguchi <kteraguchi@commonsnet.org>
Date: Wed, 11 Nov 2015 16:19:27 +0900
Subject: [PATCH] Add M17nBehavior comment for phpDocumentor

---
 Model/Behavior/M17nBehavior.php | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/Model/Behavior/M17nBehavior.php b/Model/Behavior/M17nBehavior.php
index ab1dd9d..864ec3e 100644
--- a/Model/Behavior/M17nBehavior.php
+++ b/Model/Behavior/M17nBehavior.php
@@ -16,6 +16,34 @@
 /**
  * M17nBehavior
  *
+ * 登録するコンテンツデータに対して、対応している言語分登録します。<br>
+ * 対応言語を運用途中で追加できません。
+ *
+ * コンテンツデータのテーブルに以下のフィールドを保持してください。
+ * * key
+ *     異なる言語で同一のデータが登録されます。
+ * * language_id
+ *     言語コードに対応するidが登録されます。
+ *
+ * コンテンツデータがbelongsToのアソシエーションを持ち、アソシエーション側でも言語ごとにデータがある場合は、
+ * 登録時に外部キーとしてのIDを取得するための情報を指定してください。<br>
+ * 指定内容は、外部キーのフィールド名、アソシエーションモデル名、ID取得条件です。
+ *
+ * #### サンプルコード
+ * ```
+ * public $actsAs = array(
+ * 	'M17n.M17n' => array(
+ * 		'associations' => array(
+ * 			'faq_id' => array(
+ * 				'className' => 'Faqs.Faq',
+ * 			),
+ * 			'category_id' => array(
+ * 				'className' => 'Categories.Category',
+ * 			),
+ * 		)
+ * 	),
+ * ```
+ *
  * @author Shohei Nakajima <nakajimashouhei@gmail.com>
  * @package  NetCommons\M17n\Model\Befavior
  */