Commit 93a9c5eb by Alexander Makarov

Fixed some class references in the guide

parent 76f6896b
...@@ -39,7 +39,8 @@ $component->on($eventName, function($event) { ...@@ -39,7 +39,8 @@ $component->on($eventName, function($event) {
}); });
``` ```
As shown in the anonymous function example, the event handling function must be defined so that it takes one argument. This will be an [[Event]] object. As shown in the anonymous function example, the event handling function must be defined so that it takes one argument.
This will be an [[\yii\base\Event]] object.
Removing Event Handlers Removing Event Handlers
......
...@@ -66,7 +66,7 @@ In the config above we are defining two log targets: [[\yii\log\FileTarget|file] ...@@ -66,7 +66,7 @@ In the config above we are defining two log targets: [[\yii\log\FileTarget|file]
In both cases we are filtering messages handles by these targets by severity. In case of file target we're In both cases we are filtering messages handles by these targets by severity. In case of file target we're
additionally filter by category. `yii\*` means all categories starting with `yii\`. additionally filter by category. `yii\*` means all categories starting with `yii\`.
Each log target can have a name and can be referenced via the [[targets]] property as follows: Each log target can have a name and can be referenced via the [[yii\log\Logger::targets|targets]] property as follows:
```php ```php
Yii::$app->log->targets['file']->enabled = false; Yii::$app->log->targets['file']->enabled = false;
......
...@@ -226,7 +226,7 @@ When `validate()` is called, the actual validation rules executed are determined ...@@ -226,7 +226,7 @@ When `validate()` is called, the actual validation rules executed are determined
### Creating your own validators (Inline validators) ### Creating your own validators (Inline validators)
If none of the built in validators fit your needs, you can create your own validator by creating a method in you model class. If none of the built in validators fit your needs, you can create your own validator by creating a method in you model class.
This method will be wrapped by an [[InlineValidator|yii\validation\InlineValidator]] an be called upon validation. This method will be wrapped by an [[InlineValidator|yii\validators\InlineValidator]] an be called upon validation.
You will do the validation of the attribute and [[add errors|yii\base\Model::addError()]] to the model when validation fails. You will do the validation of the attribute and [[add errors|yii\base\Model::addError()]] to the model when validation fails.
The method has the following signature `public function myValidator($attribute, $params)` while you are free to choose the name. The method has the following signature `public function myValidator($attribute, $params)` while you are free to choose the name.
...@@ -251,8 +251,8 @@ public function rules() ...@@ -251,8 +251,8 @@ public function rules()
} }
``` ```
You may also set other properties of the [[InlineValidator|yii\validation\InlineValidator]] in the rules definition, You may also set other properties of the [[InlineValidator|yii\validators\InlineValidator]] in the rules definition,
for example the [[skipOnEmpty|yii\validation\InlineValidator::skipOnEmpty]] property: for example the [[skipOnEmpty|yii\validators\InlineValidator::skipOnEmpty]] property:
```php ```php
[['birthdate'], 'validateAge', 'params' => ['min' => '12'], 'skipOnEmpty' => false], [['birthdate'], 'validateAge', 'params' => ['min' => '12'], 'skipOnEmpty' => false],
......
...@@ -10,7 +10,7 @@ Standard Yii validators ...@@ -10,7 +10,7 @@ Standard Yii validators
Standard Yii validators could be specified using aliases instead of referring to class names. Here's the list of all Standard Yii validators could be specified using aliases instead of referring to class names. Here's the list of all
validators bundled with Yii with their most useful properties: validators bundled with Yii with their most useful properties:
### `boolean`: [[yii\validation\BooleanValidator|BooleanValidator]] ### `boolean`: [[yii\validators\BooleanValidator|BooleanValidator]]
Checks if the attribute value is a boolean value. Checks if the attribute value is a boolean value.
...@@ -26,7 +26,7 @@ with [[yii\captcha\CaptchaAction]]. ...@@ -26,7 +26,7 @@ with [[yii\captcha\CaptchaAction]].
- `caseSensitive` whether the comparison is case sensitive. _(false)_ - `caseSensitive` whether the comparison is case sensitive. _(false)_
- `captchaAction` the route of the controller action that renders the CAPTCHA image. _('site/captcha')_ - `captchaAction` the route of the controller action that renders the CAPTCHA image. _('site/captcha')_
### `compare`: [[yii\validation\CompareValidator|CompareValidator]] ### `compare`: [[yii\validators\CompareValidator|CompareValidator]]
Compares the specified attribute value with another value and validates if they are equal. Compares the specified attribute value with another value and validates if they are equal.
...@@ -34,7 +34,7 @@ Compares the specified attribute value with another value and validates if they ...@@ -34,7 +34,7 @@ Compares the specified attribute value with another value and validates if they
- `compareValue` the constant value to be compared with. - `compareValue` the constant value to be compared with.
- `operator` the operator for comparison. _('==')_ - `operator` the operator for comparison. _('==')_
### `date`: [[yii\validation\DateValidator|DateValidator]] ### `date`: [[yii\validators\DateValidator|DateValidator]]
Verifies if the attribute represents a date, time or datetime in a proper format. Verifies if the attribute represents a date, time or datetime in a proper format.
...@@ -42,20 +42,20 @@ Verifies if the attribute represents a date, time or datetime in a proper format ...@@ -42,20 +42,20 @@ Verifies if the attribute represents a date, time or datetime in a proper format
[PHP date_create_from_format](http://www.php.net/manual/en/datetime.createfromformat.php). _('Y-m-d')_ [PHP date_create_from_format](http://www.php.net/manual/en/datetime.createfromformat.php). _('Y-m-d')_
- `timestampAttribute` the name of the attribute to receive the parsing result. - `timestampAttribute` the name of the attribute to receive the parsing result.
### `default`: [[yii\validation\DefaultValueValidator|DefaultValueValidator]] ### `default`: [[yii\validators\DefaultValueValidator|DefaultValueValidator]]
Sets the attribute to be the specified default value. Sets the attribute to be the specified default value.
- `value` the default value to be set to the specified attributes. - `value` the default value to be set to the specified attributes.
### `double`: [[yii\validation\NumberValidator|NumberValidator]] ### `double`: [[yii\validators\NumberValidator|NumberValidator]]
Validates that the attribute value is a number. Validates that the attribute value is a number.
- `max` limit of the number. _(null)_ - `max` limit of the number. _(null)_
- `min` lower limit of the number. _(null)_ - `min` lower limit of the number. _(null)_
### `email`: [[yii\validation\EmailValidator|EmailValidator]] ### `email`: [[yii\validators\EmailValidator|EmailValidator]]
Validates that the attribute value is a valid email address. Validates that the attribute value is a valid email address.
...@@ -64,7 +64,7 @@ Validates that the attribute value is a valid email address. ...@@ -64,7 +64,7 @@ Validates that the attribute value is a valid email address.
- `checkPort` whether to check port 25 for the email address. _(false)_ - `checkPort` whether to check port 25 for the email address. _(false)_
- `enableIDN` whether validation process should take into account IDN (internationalized domain names). _(false)_ - `enableIDN` whether validation process should take into account IDN (internationalized domain names). _(false)_
### `exist`: [[yii\validation\ExistValidator|ExistValidator]] ### `exist`: [[yii\validators\ExistValidator|ExistValidator]]
Validates that the attribute value exists in a table. Validates that the attribute value exists in a table.
...@@ -73,7 +73,7 @@ Validates that the attribute value exists in a table. ...@@ -73,7 +73,7 @@ Validates that the attribute value exists in a table.
- `targetAttribute` the ActiveRecord attribute name that should be used to look for the attribute value 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)_ _(name of the attribute being validated)_
### `file`: [[yii\validation\FileValidator|FileValidator]] ### `file`: [[yii\validators\FileValidator|FileValidator]]
Verifies if an attribute is receiving a valid uploaded file. Verifies if an attribute is receiving a valid uploaded file.
...@@ -82,7 +82,7 @@ Verifies if an attribute is receiving a valid uploaded file. ...@@ -82,7 +82,7 @@ Verifies if an attribute is receiving a valid uploaded file.
- `maxSize` the maximum number of bytes required for the uploaded file. - `maxSize` the maximum number of bytes required for the uploaded file.
- `maxFiles` the maximum file count the given attribute can hold. _(1)_ - `maxFiles` the maximum file count the given attribute can hold. _(1)_
### `filter`: [[yii\validation\FilterValidator|FilterValidator]] ### `filter`: [[yii\validators\FilterValidator|FilterValidator]]
Converts the attribute value according to a filter. Converts the attribute value according to a filter.
...@@ -103,7 +103,7 @@ Or an anonymous function: ...@@ -103,7 +103,7 @@ Or an anonymous function:
}], }],
``` ```
### `in`: [[yii\validation\RangeValidator|RangeValidator]] ### `in`: [[yii\validators\RangeValidator|RangeValidator]]
Validates that the attribute value is among a list of values. Validates that the attribute value is among a list of values.
...@@ -111,7 +111,7 @@ Validates that the attribute value is among a list of values. ...@@ -111,7 +111,7 @@ Validates that the attribute value is among a list of values.
- `strict` whether the comparison is strict (both type and value must be the same). _(false)_ - `strict` whether the comparison is strict (both type and value must be the same). _(false)_
- `not` whether to invert the validation logic. _(false)_ - `not` whether to invert the validation logic. _(false)_
### `inline`: [[yii\validation\InlineValidator|InlineValidator]] ### `inline`: [[yii\validators\InlineValidator|InlineValidator]]
Uses a custom function to validate the attribute. You need to define a public method in your Uses a custom function to validate the attribute. You need to define a public method in your
model class which will evaluate the validity of the attribute. For example, if an attribute model class which will evaluate the validity of the attribute. For example, if an attribute
...@@ -126,40 +126,40 @@ public function myValidationMethod($attribute) { ...@@ -126,40 +126,40 @@ public function myValidationMethod($attribute) {
} }
``` ```
### `integer`: [[yii\validation\NumberValidator|NumberValidator]] ### `integer`: [[yii\validators\NumberValidator|NumberValidator]]
Validates that the attribute value is an integer number. Validates that the attribute value is an integer number.
- `max` limit of the number. _(null)_ - `max` limit of the number. _(null)_
- `min` lower limit of the number. _(null)_ - `min` lower limit of the number. _(null)_
### `match`: [[yii\validation\RegularExpressionValidator|RegularExpressionValidator]] ### `match`: [[yii\validators\RegularExpressionValidator|RegularExpressionValidator]]
Validates that the attribute value matches the specified pattern defined by regular expression. Validates that the attribute value matches the specified pattern defined by regular expression.
- `pattern` the regular expression to be matched with. - `pattern` the regular expression to be matched with.
- `not` whether to invert the validation logic. _(false)_ - `not` whether to invert the validation logic. _(false)_
### `number`: [[yii\validation\NumberValidator|NumberValidator]] ### `number`: [[yii\validators\NumberValidator|NumberValidator]]
Validates that the attribute value is a number. Validates that the attribute value is a number.
- `max` limit of the number. _(null)_ - `max` limit of the number. _(null)_
- `min` lower limit of the number. _(null)_ - `min` lower limit of the number. _(null)_
### `required`: [[yii\validation\RequiredValidator|RequiredValidator]] ### `required`: [[yii\validators\RequiredValidator|RequiredValidator]]
Validates that the specified attribute does not have null or empty value. Validates that the specified attribute does not have null or empty value.
- `requiredValue` the desired value that the attribute must have. _(any)_ - `requiredValue` the desired value that the attribute must have. _(any)_
- `strict` whether the comparison between the attribute value and - `strict` whether the comparison between the attribute value and
[[yii\validation\RequiredValidator::requiredValue|requiredValue]] is strict. _(false)_ [[yii\validators\RequiredValidator::requiredValue|requiredValue]] is strict. _(false)_
### `safe`: [[yii\validation\SafeValidator|SafeValidator]] ### `safe`: [[yii\validators\SafeValidator|SafeValidator]]
Serves as a dummy validator whose main purpose is to mark the attributes to be safe for massive assignment. Serves as a dummy validator whose main purpose is to mark the attributes to be safe for massive assignment.
### `string`: [[yii\validation\StringValidator|StringValidator]] ### `string`: [[yii\validators\StringValidator|StringValidator]]
Validates that the attribute value is of certain length. Validates that the attribute value is of certain length.
...@@ -168,7 +168,7 @@ Validates that the attribute value is of certain length. ...@@ -168,7 +168,7 @@ Validates that the attribute value is of certain length.
- `min` minimum length. If not set, it means no minimum length limit. - `min` minimum length. If not set, it means no minimum length limit.
- `encoding` the encoding of the string value to be validated. _([[\yii\base\Application::charset]])_ - `encoding` the encoding of the string value to be validated. _([[\yii\base\Application::charset]])_
### `unique`: [[yii\validation\UniqueValidator|UniqueValidator]] ### `unique`: [[yii\validators\UniqueValidator|UniqueValidator]]
Validates that the attribute value is unique in the corresponding database table. Validates that the attribute value is unique in the corresponding database table.
...@@ -177,7 +177,7 @@ Validates that the attribute value is unique in the corresponding database table ...@@ -177,7 +177,7 @@ Validates that the attribute value is unique in the corresponding database table
- `targetAttribute` the ActiveRecord attribute name that should be used to look for the attribute value 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)_ _(name of the attribute being validated)_
### `url`: [[yii\validation\UrlValidator|UrlValidator]] ### `url`: [[yii\validators\UrlValidator|UrlValidator]]
Validates that the attribute value is a valid http or https URL. Validates that the attribute value is a valid http or https URL.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment