Class yii\debug\models\search\Debug
Inheritance | yii\debug\models\search\Debug » yii\debug\models\search\Base » yii\base\Model » yii\base\Component » yii\base\Object |
---|---|
Implements | ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable |
Uses Traits | yii\base\ArrayableTrait |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-debug/blob/master/models/search/Debug.php |
Search model for requests manifest data.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$activeValidators | yii\validators\Validator[] | The validators applicable to the current $scenario. | yii\base\Model |
$ajax | integer | Ajax attribute input search value | yii\debug\models\search\Debug |
$attributes | array | Attribute values (name => value). | yii\base\Model |
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$criticalCodes | array | Critical codes, used to determine grid row options. | yii\debug\models\search\Debug |
$errors | array | Errors for all attributes or the specified attribute. | yii\base\Model |
$firstErrors | array | The first errors. | yii\base\Model |
$ip | string | Ip attribute input search value | yii\debug\models\search\Debug |
$iterator | ArrayIterator | An iterator for traversing the items in the list. | yii\base\Model |
$mailCount | integer | Total mail count attribute input search value | yii\debug\models\search\Debug |
$method | string | Method attribute input search value | yii\debug\models\search\Debug |
$scenario | string | The scenario that this model is in. | yii\base\Model |
$sqlCount | integer | Sql count attribute input search value | yii\debug\models\search\Debug |
$statusCode | string | Status code attribute input search value | yii\debug\models\search\Debug |
$tag | string | Tag attribute input search value | yii\debug\models\search\Debug |
$url | string | Url attribute input search value | yii\debug\models\search\Debug |
$validators | ArrayObject|yii\validators\Validator[] | All the validators declared in the model. | yii\base\Model |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Object |
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() | Constructor. | yii\base\Object |
__get() | Returns the value of an object property. | yii\base\Object |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
__set() | Sets value of an object property. | yii\base\Object |
__unset() | Sets an object property to null. | yii\base\Object |
activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. | yii\base\Model |
addCondition() | Adds filtering condition for a given attribute | yii\debug\models\search\Base |
addError() | Adds a new error to the specified attribute. | yii\base\Model |
addErrors() | Adds a list of errors. | yii\base\Model |
afterValidate() | This method is invoked after validation ends. | yii\base\Model |
attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
attributeHints() | Returns the attribute hints. | yii\base\Model |
attributeLabels() | Returns the attribute labels. | yii\debug\models\search\Debug |
attributes() | Returns the list of attribute names. | yii\base\Model |
beforeValidate() | This method is invoked before validation starts. | yii\base\Model |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
className() | Returns the fully qualified name of this class. | yii\base\Object |
clearErrors() | Removes errors for all attributes or a single attribute. | yii\base\Model |
createValidators() | Creates validator objects based on the validation rules specified in rules(). | yii\base\Model |
detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). | yii\base\ArrayableTrait |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. | yii\base\ArrayableTrait |
formName() | Returns the form name that this model class should use. | yii\base\Model |
generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. | yii\base\Model |
getActiveValidators() | Returns the validators applicable to the current $scenario. | yii\base\Model |
getAttributeHint() | Returns the text hint for the specified attribute. | yii\base\Model |
getAttributeLabel() | Returns the text label for the specified attribute. | yii\base\Model |
getAttributes() | Returns attribute values. | yii\base\Model |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getErrors() | Returns the errors for all attributes or a single attribute. | yii\base\Model |
getFirstError() | Returns the first error of the specified attribute. | yii\base\Model |
getFirstErrors() | Returns the first error of every attribute in the model. | yii\base\Model |
getIterator() | Returns an iterator for traversing the attributes in the model. | yii\base\Model |
getScenario() | Returns the scenario that this model is used in. | yii\base\Model |
getValidators() | Returns all the validators declared in rules(). | yii\base\Model |
hasErrors() | Returns a value indicating whether there is any validation error. | yii\base\Model |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
init() | Initializes the object. | yii\base\Object |
isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. | yii\base\Model |
isAttributeRequired() | Returns a value indicating whether the attribute is required. | yii\base\Model |
isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. | yii\base\Model |
isCodeCritical() | Checks if code is critical. | yii\debug\models\search\Debug |
load() | Populates the model with input data. | yii\base\Model |
loadMultiple() | Populates a set of models with the data from end user. | yii\base\Model |
off() | Detaches an existing event handler from this component. | yii\base\Component |
offsetExists() | Returns whether there is an element at the specified offset. | yii\base\Model |
offsetGet() | Returns the element at the specified offset. | yii\base\Model |
offsetSet() | Sets the element at the specified offset. | yii\base\Model |
offsetUnset() | Sets the element value at the specified offset to null. | yii\base\Model |
on() | Attaches an event handler to an event. | yii\base\Component |
onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. | yii\base\Model |
rules() | Returns the validation rules for attributes. | yii\debug\models\search\Debug |
safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. | yii\base\Model |
scenarios() | Returns a list of scenarios and the corresponding active attributes. | yii\base\Model |
search() | Returns data provider with filled models. Filter applied if needed. | yii\debug\models\search\Debug |
setAttributes() | Sets the attribute values in a massive way. | yii\base\Model |
setScenario() | Sets the scenario for the model. | yii\base\Model |
toArray() | Converts the model into an array. | yii\base\ArrayableTrait |
trigger() | Triggers an event. | yii\base\Component |
validate() | Performs the data validation. | yii\base\Model |
validateMultiple() | Validates multiple models. | yii\base\Model |
Protected Methods
Method | Description | Defined By |
---|---|---|
resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
Events
Event | Type | Description | Defined By |
---|---|---|---|
EVENT_AFTER_VALIDATE | yii\base\Event | An event raised at the end of validate() | yii\base\Model |
EVENT_BEFORE_VALIDATE | yii\base\ModelEvent | An event raised at the beginning of validate(). | yii\base\Model |
Constants
Constant | Value | Description | Defined By |
---|---|---|---|
SCENARIO_DEFAULT | 'default' | The name of the default scenario. | yii\base\Model |
Property Details
$ajax public property
Ajax attribute input search value
public integer $ajax = null
$criticalCodes public property
Critical codes, used to determine grid row options.
public array $criticalCodes = [400, 404, 500]
$ip public property
Ip attribute input search value
public string $ip = null
$mailCount public property
Total mail count attribute input search value
public integer $mailCount = null
$method public property
Method attribute input search value
public string $method = null
$sqlCount public property
Sql count attribute input search value
public integer $sqlCount = null
$statusCode public property
Status code attribute input search value
public string $statusCode = null
$tag public property
Tag attribute input search value
public string $tag = null
$url public property
Url attribute input search value
public string $url = null
Method Details
attributeLabels() public method
Returns the attribute labels.
Attribute labels are mainly used for display purpose. For example, given an attribute firstName
, we can declare a label First Name
which is more user-friendly and can be displayed to end users.
By default an attribute label is generated using generateAttributeLabel(). This method allows you to explicitly specify attribute labels.
Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge()
.
public array attributeLabels ( ) | ||
---|---|---|
return | array |
Attribute labels (name => label) |
isCodeCritical() public method
Checks if code is critical.
public boolean isCodeCritical ( $code ) | ||
---|---|---|
$code | integer |
rules() public method
Returns the validation rules for attributes.
Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.
Each rule is an array with the following structure:
[ ['attribute1', 'attribute2'], 'validator type', 'on' => ['scenario1', 'scenario2'], //...other parameters... ]
where
- attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
- validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
- on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
- additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.
A validator can be either an object of a class extending \yii\debug\models\search\Validator, or a model class method (called inline validator) that has the following signature:
// $params refers to validation parameters given in the rule function validatorName($attribute, $params)
In the above $attribute
refers to the attribute currently being validated while $params
contains an array of validator configuration options such as max
in case of string
validator. The value of the attribute currently being validated can be accessed as $this->$attribute
. Note the $
before attribute
; this is taking the value of the variable $attribute
and using it as the name of the property to access.
Yii also provides a set of \yii\debug\models\search\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.
Below are some examples:
[ // built-in "required" validator [['username', 'password'], 'required'], // built-in "string" validator customized with "min" and "max" properties ['username', 'string', 'min' => 3, 'max' => 12], // built-in "compare" validator that is used in "register" scenario only ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'], // an inline validator defined via the "authenticate()" method in the model class ['password', 'authenticate', 'on' => 'login'], // a validator of class "DateRangeValidator" ['dateRange', 'DateRangeValidator'], ];
Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge()
.
public array rules ( ) | ||
---|---|---|
return | array |
Validation rules |
search() public method
Returns data provider with filled models. Filter applied if needed.
public yii\data\ArrayDataProvider search ( $params, $models ) | ||
---|---|---|
$params | array |
An array of parameter values indexed by parameter names |
$models | array |
Data to return provider for |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-models-search-debug.html