Class yii\data\ActiveDataFilter
| Inheritance | yii\data\ActiveDataFilter » yii\data\DataFilter » yii\base\Model » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface |
| Uses Traits | yii\base\ArrayableTrait, yii\base\StaticInstanceTrait |
| Available since version | 2.0.13 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/data/ActiveDataFilter.php |
ActiveDataFilter allows composing a filtering condition in a format suitable for yii\db\QueryInterface::where().
See also yii\data\DataFilter.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $activeValidators | yii\validators\Validator[] | The validators applicable to the current $scenario. | yii\base\Model |
| $attributeMap | array | Actual attribute names to be used in searched condition, in format: [filterAttribute => actualAttribute]. | yii\data\DataFilter |
| $attributes | array | Attribute values (name => value). | yii\base\Model |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
| $conditionBuilders | array | Maps filtering condition keywords to build methods. | yii\data\ActiveDataFilter |
| $conditionValidators | array | Maps filter condition keywords to validation methods. | yii\data\DataFilter |
| $errorMessages | array | Error messages in format [errorKey => message]. Note that the type of this
property differs in getter and setter. See getErrorMessages() and setErrorMessages() for details. |
yii\data\DataFilter |
| $errors | array | Errors for all attributes or the specified attribute. Empty array is returned
if no error. See getErrors() for detailed description. Note that when returning errors for all attributes,
the result is a two-dimensional array, like the following: `php [ 'username' => [ 'Username is required.',
'Username must contain only word characters.', ], 'email' => [ 'Email address is invalid.', ] ] ` . |
yii\base\Model |
| $filter | mixed | Raw filter value. | yii\data\DataFilter |
| $filterAttributeLabel | string | Label for the filter attribute specified via $filterAttributeName. | yii\data\DataFilter |
| $filterAttributeName | string | Name of the attribute that handles filter value. | yii\data\DataFilter |
| $filterControls | array | Keywords or expressions that could be used in a filter. | yii\data\DataFilter |
| $firstErrors | array | The first errors. The array keys are the attribute names, and the array values are the corresponding error messages. An empty array will be returned if there is no error. | yii\base\Model |
| $iterator | ArrayIterator | An iterator for traversing the items in the list. | yii\base\Model |
| $multiValueOperators | array | List of operators keywords, which should accept multiple values. | yii\data\DataFilter |
| $nullValue | string | Representation of null instead of literal null in case the latter cannot be used. |
yii\data\DataFilter |
| $operatorTypes | array | Specifies the list of supported search attribute types per each operator. | yii\data\DataFilter |
| $queryOperatorMap | array | Map filtering operators to operators used in yii\db\QueryInterface::where(). | yii\data\ActiveDataFilter |
| $scenario | string | The scenario that this model is in. Defaults to SCENARIO_DEFAULT. | yii\base\Model |
| $searchAttributeTypes | array | Search attribute type map. Note that the type of this property differs in getter and setter. See getSearchAttributeTypes() and setSearchAttributeTypes() for details. | yii\data\DataFilter |
| $searchModel | yii\base\Model | Model instance. Note that the type of this property differs in getter and setter. See getSearchModel() and setSearchModel() for details. | yii\data\DataFilter |
| $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\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Model |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. | yii\base\Model |
| 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\base\Model |
| 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 |
| build() | Builds actual filter specification form $filter value. | yii\data\DataFilter |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| 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 |
| getErrorMessages() | yii\data\DataFilter | |
| getErrorSummary() | Returns the errors for all attributes as a one-dimensional array. | yii\base\Model |
| getErrors() | Returns the errors for all attributes or a single attribute. | yii\base\Model |
| getFilter() | yii\data\DataFilter | |
| 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() | yii\base\Model | |
| getScenario() | Returns the scenario that this model is used in. | yii\base\Model |
| getSearchAttributeTypes() | yii\data\DataFilter | |
| getSearchModel() | yii\data\DataFilter | |
| 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\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\base\BaseObject |
| instance() | Returns static class instance, which can be used to obtain meta information. | yii\base\StaticInstanceTrait |
| 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 |
| 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 |
| normalize() | Normalizes filter value, replacing raw keys according to $filterControls and $attributeMap. | yii\data\DataFilter |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| offsetExists() | yii\base\Model | |
| offsetGet() | yii\base\Model | |
| offsetSet() | yii\base\Model | |
| offsetUnset() | 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\base\Model |
| 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 |
| setAttributes() | Sets the attribute values in a massive way. | yii\base\Model |
| setErrorMessages() | Sets the list of error messages responding to invalid filter structure, in format: [errorKey => message]. |
yii\data\DataFilter |
| setFilter() | yii\data\DataFilter | |
| setScenario() | Sets the scenario for the model. | yii\base\Model |
| setSearchAttributeTypes() | yii\data\DataFilter | |
| setSearchModel() | yii\data\DataFilter | |
| 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 |
| validateFilter() | Validates filter attribute value to match filer condition specification. | yii\data\DataFilter |
| validateMultiple() | Validates multiple models. | yii\base\Model |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| buildAttributeCondition() | Builds search condition for a particular attribute. | yii\data\ActiveDataFilter |
| buildBlockCondition() | Builds block condition, which consists of a single condition. | yii\data\ActiveDataFilter |
| buildCondition() | yii\data\ActiveDataFilter | |
| buildConjunctionCondition() | Builds conjunction condition, which consists of multiple independent ones. | yii\data\ActiveDataFilter |
| buildInternal() | Performs actual filter build. | yii\data\ActiveDataFilter |
| buildOperatorCondition() | Builds an operator condition. | yii\data\ActiveDataFilter |
| defaultErrorMessages() | Returns default values for $errorMessages. | yii\data\DataFilter |
| detectSearchAttributeType() | Detect attribute type from given validator. | yii\data\DataFilter |
| detectSearchAttributeTypes() | Composes default value for $searchAttributeTypes from the $searchModel validation rules. | yii\data\DataFilter |
| extractFieldsFor() | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". | yii\base\ArrayableTrait |
| extractRootFields() | Extracts the root field names from nested fields. | yii\base\ArrayableTrait |
| filterAttributeValue() | Validates attribute value in the scope of $searchModel, applying attribute value filters if any. | yii\data\DataFilter |
| parseErrorMessage() | Parses content of the message from $errorMessages, specified by message key. | yii\data\DataFilter |
| resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
| validateAttributeCondition() | Validates search condition for a particular attribute. | yii\data\DataFilter |
| validateAttributeValue() | Validates attribute value in the scope of model. | yii\data\DataFilter |
| validateBlockCondition() | Validates block condition that consists of a single condition. | yii\data\DataFilter |
| validateCondition() | Validates filter condition. | yii\data\DataFilter |
| validateConjunctionCondition() | Validates conjunction condition that consists of multiple independent ones. | yii\data\DataFilter |
| validateOperatorCondition() | Validates operator condition. | yii\data\DataFilter |
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 |
| TYPE_ARRAY | 'array' | yii\data\DataFilter | |
| TYPE_BOOLEAN | 'boolean' | yii\data\DataFilter | |
| TYPE_DATE | 'date' | yii\data\DataFilter | |
| TYPE_DATETIME | 'datetime' | yii\data\DataFilter | |
| TYPE_FLOAT | 'float' | yii\data\DataFilter | |
| TYPE_INTEGER | 'integer' | yii\data\DataFilter | |
| TYPE_STRING | 'string' | yii\data\DataFilter | |
| TYPE_TIME | 'time' | yii\data\DataFilter |
Property Details
Maps filtering condition keywords to build methods. These methods are used by buildCondition() to build the actual filtering conditions. Particular condition builder can be specified using a PHP callback. For example:
[
'XOR' => function (string $operator, mixed $condition) {
//return array;
},
'LIKE' => function (string $operator, mixed $condition, string $attribute) {
//return array;
},
]
public array $conditionBuilders = [
'AND' => 'buildConjunctionCondition', 'OR' => 'buildConjunctionCondition', 'NOT' => 'buildBlockCondition', '<' => 'buildOperatorCondition', '>' => 'buildOperatorCondition', '<=' => 'buildOperatorCondition', '>=' => 'buildOperatorCondition', '=' => 'buildOperatorCondition', '!=' => 'buildOperatorCondition', 'IN' => 'buildOperatorCondition', 'NOT IN' => 'buildOperatorCondition', 'LIKE' => 'buildOperatorCondition'
]
'AND' => 'buildConjunctionCondition', 'OR' => 'buildConjunctionCondition', 'NOT' => 'buildBlockCondition', '<' => 'buildOperatorCondition', '>' => 'buildOperatorCondition', '<=' => 'buildOperatorCondition', '>=' => 'buildOperatorCondition', '=' => 'buildOperatorCondition', '!=' => 'buildOperatorCondition', 'IN' => 'buildOperatorCondition', 'NOT IN' => 'buildOperatorCondition', 'LIKE' => 'buildOperatorCondition'
]
Map filtering operators to operators used in yii\db\QueryInterface::where().
The format is: [filterOperator => queryOperator].
If particular operator keyword does not appear in the map, it will be used as is.
Usually the map can be left empty as filter operator names are consistent with the ones used in yii\db\QueryInterface::where(). However, you may want to adjust it in some special cases. For example, when using PostgreSQL you may want to setup the following map:
[
'LIKE' => 'ILIKE'
]
Method Details
Builds search condition for a particular attribute.
| protected array buildAttributeCondition ( $attribute, $condition ) | ||
| $attribute | string | Search attribute name. |
| $condition | mixed | Search condition. |
| return | array | Actual condition. |
|---|---|---|
Builds block condition, which consists of a single condition.
It covers such operators as not.
| protected array buildBlockCondition ( $operator, $condition ) | ||
| $operator | string | Operator keyword. |
| $condition | mixed | Raw condition. |
| return | array | Actual condition. |
|---|---|---|
| protected array buildCondition ( $condition ) | ||
| $condition | array | |
| return | array | Built condition. |
|---|---|---|
Builds conjunction condition, which consists of multiple independent ones.
It covers such operators as and and or.
| protected array buildConjunctionCondition ( $operator, $condition ) | ||
| $operator | string | Operator keyword. |
| $condition | mixed | Raw condition. |
| return | array | Actual condition. |
|---|---|---|
Performs actual filter build.
By default this method returns result of normalize(). The child class may override this method providing more specific implementation.
| protected mixed buildInternal ( ) | ||
| return | mixed | Built actual filter value. |
|---|---|---|
Builds an operator condition.
| protected array buildOperatorCondition ( $operator, $condition, $attribute ) | ||
| $operator | string | Operator keyword. |
| $condition | mixed | Attribute condition. |
| $attribute | string | Attribute name. |
| return | array | Actual condition. |
|---|---|---|