guide WIP [skip ci]

Author: qiangxue

Diff for: docs/guide/README.md

@@ -173,6 +173,7 @@ Special Topics
 * [Advanced Application Template](tutorial-advanced-app.md)
 * [Building Application from Scratch](tutorial-start-from-scratch.md)
 * [Console Commands](tutorial-console.md)
+* [Core Validators](tutorial-core-validators.md)
 * [Internationalization](tutorial-i18n.md)
 * [Mailing](tutorial-mailing.md)
 * [Performance Tuning](tutorial-performance-tuning.md)

Diff for: docs/guide/input-forms.md

@@ -1,4 +1,4 @@
-Working with forms
+Working with Forms
 ==================
 
 > Note: This section is under development.

Diff for: docs/guide/input-validation.md

@@ -1,248 +1,25 @@
 Validating Input
 ================
 
+> Note: This section is under development.
+
 In the [Models](structure-models.md#validation) section, we have described how data validation works
 in general. In this section, we will mainly focus on describing core validators, how to define your
 own validators, and different ways of using validators.
 
 
-## Error Messages
-
-## Core Validators
-
-Yii provides a set of commonly used validators, found primarily within the `yii\validators` namespace.
-
-Instead of using lengthy validator class names, you may use *aliases* to specify the use of these core
-validators. For example, you can use the alias `required` to refer to the [[yii\validators\RequiredValidator]] class:
-
-```php
-public function rules()
-{
-    return [
-        [['email', 'password'], 'required'],
-    ];
-}
-```
-
-The [[yii\validators\Validator::builtInValidators]] property declares all supported validator aliases.
-
-In the following, we will describe the main usage and properties of every core validator.
-
-
-### [[yii\validators\BooleanValidator|boolean]] <a name="boolean"></a>
-
-This validator checks if the input value is a boolean.
-
-- `trueValue`: the value representing *true*. Defaults to `'1'`.
-- `falseValue`: the value representing *false*. Defaults to `'0'`.
-- `strict`: whether the type of the input value should match that of `trueValue` and `falseValue`. Defaults to `false`.
-
-```php
-[
-    // checks if "selected" is either 0 or 1, regardless of data type
-    ['selected', 'boolean'],
-
-    // checks if "deleted" is of boolean type, either true or false
-    ['deleted', 'boolean', 'trueValue' => true, 'falseValue' => false, 'strict' => true],
-]
-```
-
-> Note: Because data input submitted via HTML forms are all strings, you normally should leave the
-  [[yii\validators\BooleanValidator::strict|strict]] property as false.
-
-
-### [[yii\captcha\CaptchaValidator|captcha]] <a name="captcha"></a>
-
-This validator is usually used together with [[yii\captcha\CaptchaAction]] and [[yii\captcha\Captcha]]
-to make sure an input is the same as the verification code displayed by [[yii\captcha\Captcha|CAPTCHA]] widget.
-
-- `caseSensitive`: whether the comparison of the verification code is case sensitive. Defaults to false.
-- `captchaAction`: the [route](structure-controllers.md#routes) corresponding to the
-  [[yii\captcha\CaptchaAction|CAPTCHA action]] that renders the CAPTCHA image. Defaults to `'site/captcha'`.
-- `skipOnEmpty`: whether the validation can be skipped if the input is empty. Defaults to false,
-  which means the input is required.
-  
-```php
-[
-    ['verificationCode', 'captcha'],
-]
-```
-
-
-### [[yii\validators\CompareValidator|compare]] <a name="compare"></a>
-
-This validator compares the specified input value with another one and make sure if their relationship
-is as specified by the `operator` property.
-
-- `compareAttribute`: the name of the attribute whose value should be compared with. When the validator
-  is being used to validate an attribute, the default value of this property would be the name of
-  the attribute suffixed with `_repeat`. For example, if the attribute being validated is `password`,
-  then this property will default to `password_repeat`.
-- `compareValue`: a constant value that the input value should be compared with. When both 
-  of this property and `compareAttribute` are specified, this property will take precedence.
-- `operator`: the comparison operator. Defaults to `==`, meaning checking if the input value is equal
-  to that of `compareAttribute` or `compareValue`. The following operators are supported:
-     * `==`: check if two values are equal. The comparison is done is non-strict mode.
-     * `===`: check if two values are equal. The comparison is done is strict mode.
-     * `!=`: check if two values are NOT equal. The comparison is done is non-strict mode.
-     * `!==`: check if two values are NOT equal. The comparison is done is strict mode.
-     * `>`: check if value being validated is greater than the value being compared with.
-     * `>=`: check if value being validated is greater than or equal to the value being compared with.
-     * `<`: check if value being validated is less than the value being compared with.
-     * `<=`: check if value being validated is less than or equal to the value being compared with.
-  
-```php
-[
-    // validates if the value of "password" attribute equals to that of "password_repeat"
-    ['password', 'compare'],
-
-    // validates if age is greater than or equal to 30
-    ['age', 'compare', 'compareValue' => 30, 'operator' => '>='],
-]
-```
-
-
-### [[yii\validators\DateValidator|date]] <a name="date"></a>
-
-Verifies if the attribute represents a date, time, or datetime in a proper format.
-
-- `format`, the date format that the value being validated should follow according to
-  [PHP date_create_from_format](http://www.php.net/manual/en/datetime.createfromformat.php). _('Y-m-d')_
-- `timestampAttribute`, the name of the attribute that should receive the parsed result.
-
-### [[yii\validators\DefaultValueValidator|default]] <a name="default"></a>
-
-Sets the attribute to be the specified default value.
-
-- `value`, the default value to be assigned.
-
-### [[yii\validators\NumberValidator|double]] <a name="double"></a>
-
-Validates that the attribute value is a number, integer or decimal.
-
-- `max`, the upper limit of the number (inclusive). _(null)_
-- `min`, the lower limit of the number (inclusive). _(null)_
-
-### [[yii\validators\EmailValidator|email]] <a name="email"></a>
+## Declaring Validation Rules
 
-Validates that the attribute value is a valid email address. By default, this validator checks if the attribute value is a syntactical valid email address, but the validator can be configured to check the address's domain for the address's existence.
+## Data Validation
 
-- `allowName`, whether to allow the name in the email address (e.g. `John Smith <[email protected]>`). _(false)_.
-- `checkMX`, whether to check the MX record for the email address. _(false)_
-- `checkPort`, whether to check port 25 for the email address. _(false)_
-- `enableIDN`, whether the validation process should take into account IDN (internationalized domain names). _(false)_
+### Getting Error Messages
 
-### [[yii\validators\ExistValidator|exist]] <a name="exist"></a>
+### Empty Values
 
-Validates that the attribute value exists in a table.
+### Array Values
 
-- `targetClass`, the ActiveRecord class name or alias of the class that should be used to look for the attribute value being
-  validated. _(ActiveRecord class of the attribute being validated)_
-- `targetAttribute`, the ActiveRecord attribute name that should be used to look for the attribute value being validated.
-  _(name of the attribute being validated)_
-
-### [[yii\validators\FileValidator|file]] <a name="file"></a>
-
-Verifies if an attribute is receiving a valid uploaded file.
-
-- `types`, an array of file name extensions that are allowed to be uploaded. _(any)_
-- `minSize`, the minimum number of bytes required for the uploaded file.
-- `maxSize`, the maximum number of bytes allowed for the uploaded file.
-- `maxFiles`, the maximum number of files that the given attribute can hold. _(1)_
-
-### [[yii\validators\FilterValidator|filter]] <a name="filter"></a>
-
-Converts the attribute value by sending it through a filter.
-
-- `filter`, a PHP callback that defines a filter.
-
-Typically a callback is either the name of PHP function:
-
-```php
-['password', 'filter', 'filter' => 'trim'],
-```
-
-Or an anonymous function:
-
-```php
-['text', 'filter', 'filter' => function ($value) {
-    // here we are removing all swear words from text
-    return $newValue;
-}],
-```
-
-### [[yii\validators\ImageValidator|image]] <a name="image"></a>
-
-### [[yii\validators\RangeValidator|in]] <a name="in"></a>
-
-Validates that the attribute value is among a list of values.
-
-- `range`, a list of valid values that the attribute value should be among (inclusive).
-- `strict`, whether the comparison should be strict (both the type and value must be the same). _(false)_
-- `not`, whether to invert the validation logic. _(false)_
-
-
-### [[yii\validators\NumberValidator|integer]] <a name="integer"></a>
-
-Validates that the attribute value is an integer.
-
-- `max`, the upper limit of the number (inclusive). _(null)_
-- `min`, the lower limit of the number (inclusive). _(null)_
-
-### [[yii\validators\RegularExpressionValidator|match]] <a name="match"></a>
-
-Validates that the attribute value matches the specified pattern defined by a regular expression.
-
-- `pattern`, the regular expression to be matched.
-- `not`, whether to invert the validation logic. _(false)_
-
-### [[yii\validators\NumberValidator|number]] <a name="number"></a>
-
-Validates that the attribute value is a number.
-
-- `max`, the upper limit of the number (inclusive). _(null)_
-- `min`, the lower limit of the number (inclusive). _(null)_
-
-### [[yii\validators\RequiredValidator|required]] <a name="required"></a>
-
-Validates that the specified attribute does not have a null or empty value.
-
-- `requiredValue`, the desired value that the attribute must have. _(any)_
-- `strict`, whether the comparison between the attribute value and
-  [[yii\validators\RequiredValidator::requiredValue|requiredValue]] must match both value and type. _(false)_
-
-### [[yii\validators\SafeValidator|safe]] <a name="safe"></a>
-
-Serves as a dummy validator whose main purpose is to mark the attributes to be safe for massive assignment.
-
-### [[yii\validators\StringValidator|string]] <a name="string"></a>
-
-Validates that the attribute value is of certain length.
-
-- `length`, specifies the length limit of the value to be validated (inclusive). Can be `exactly X`, `[min X]`, `[min X, max Y]`.
-- `max`, the upper length limit (inclusive). If not set, it means no maximum length limit.
-- `min`, the lower length limit (inclusive). If not set, it means no minimum length limit.
-- `encoding`, the encoding of the string value to be validated. _([[yii\base\Application::charset]])_
-
-### [[yii\validators\FilterValidator|trim]] <a name="trim"></a>
-
-### [[yii\validators\UniqueValidator|unique]] <a name="unique"></a>
-
-Validates that the attribute value is unique in the corresponding database table.
-
-- `targetClass`, the ActiveRecord class name or alias of the class that should be used to look for the attribute value being
-  validated. _(ActiveRecord class of the attribute being validated)_
-- `targetAttribute`, the ActiveRecord attribute name that should be used to look for the attribute value being validated.
-  _(name of the attribute being validated)_
-
-### [[yii\validators\UrlValidator|url]] <a name="url"></a>
-
-Validates that the attribute value is a valid http or https URL.
+## Data Filtering
 
-- `validSchemes`, an array of URI schemes that should be considered valid. _['http', 'https']_
-- `defaultScheme`, the default URI scheme. If the input doesn't contain the scheme part, the default scheme will be
-  prepended to it. _(null)_
-- `enableIDN`, whether the validation process should take into account IDN (internationalized domain names). _(false)_
 
 
 ## Creating Validators
@@ -336,7 +113,7 @@ public function rules()
 This guide describes all of Yii's validators and their parameters.
 
 
-## Data Filtering
+
 
 ## Ad Hoc Validation