From fbcf677697f09d944f28aad978f9e099b6e9ac66 Mon Sep 17 00:00:00 2001
From: Alexander Makarov <sam@rmcreative.ru>
Date: Thu, 4 Oct 2012 20:16:18 +0400
Subject: [PATCH] documented model validation and scenarios

---
 docs/model.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 docs/model.md

diff --git a/docs/model.md b/docs/model.md
new file mode 100644
index 0000000..ca823ff
--- /dev/null
+++ b/docs/model.md
@@ -0,0 +1,36 @@
+Model
+=====
+
+Validation rules and mass assignment
+------------------------------------
+
+In Yii2 unlike Yii 1.x validation rules are separated from mass assignment. Validation
+rules are described in `rules()` method of the model while what's safe for mass
+assignment is described in `scenarios` method:
+
+```php
+
+function rules() {
+ return array(
+  // rule applied when corresponding field is "safe"
+  array('username', 'length', 'min' => 2),
+  array('first_name', 'length', 'min' => 2),
+  array('password', 'required'),
+
+  // rule applied when scenario is "signup" no matter if field is "safe" or not
+  array('hashcode', 'check', 'on' => 'signup'),
+ );
+}
+
+function scenarios() {
+ return array(
+  // on signup allow mass assignment of username
+  'signup' => array('username', 'password'),
+  'update' => array('username', 'first_name'),
+ );
+}
+
+```
+
+Note that everything is unsafe by default and you can't make field "safe"
+without specifying scenario.
\ No newline at end of file