Class yii\data\DataFilter

Inheritanceyii\data\DataFilter » yii\base\Model » yii\base\Component » yii\base\BaseObject
ImplementsArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses Traitsyii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Subclassesyii\data\ActiveDataFilter
Available since version2.0.13
Source Code https://github.com/yiisoft/yii2/blob/master/framework/data/DataFilter.php

DataFilter is a special yii\base\Model for processing query filtering specification.

It allows validating and building a filter condition passed via request.

Filter example:

{
    "or": [
        {
            "and": [
                {
                    "name": "some name",
                },
                {
                    "price": "25",
                }
            ]
        },
        {
            "id": {"in": [2, 5, 9]},
            "price": {
                "gt": 10,
                "lt": 50
            }
        }
    ]
}

In the request the filter should be specified using a key name equal to $filterAttributeName. Thus actual HTTP request body will look like following:

{
    "filter": {"or": {...}},
    "page": 2,
    ...
}

Raw filter value should be assigned to \yii\data\filter property of the model. You may populate it from request data via load() method:

use yii\data\DataFilter;

$dataFilter = new DataFilter();
$dataFilter->load(Yii::$app->request->getBodyParams());

In order to function this class requires a search model specified via \yii\data\searchModel. This search model should declare all available search attributes and their validation rules. For example:

class SearchModel extends \yii\base\Model
{
    public $id;
    public $name;

    public function rules()
    {
        return [
            [['id', 'name'], 'trim'],
            ['id', 'integer'],
            ['name', 'string'],
        ];
    }
}

In order to reduce amount of classes, you may use yii\base\DynamicModel instance as a \yii\data\searchModel. In this case you should specify \yii\data\searchModel using a PHP callable:

function () {
    return (new \yii\base\DynamicModel(['id' => null, 'name' => null]))
        ->addRule(['id', 'name'], 'trim')
        ->addRule('id', 'integer')
        ->addRule('name', 'string');
}

You can use validate() method to check if filter value is valid. If validation fails you can use getErrors() to get actual error messages.

In order to acquire filter condition suitable for fetching data use build() method.

Note: This is a base class. Its implementation of build() simply returns normalized \yii\data\filter value. In order to convert filter to particular format you should use descendant of this class that implements buildInternal() method accordingly.

See also yii\data\ActiveDataFilter.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attributeMap array Actual attribute names to be used in searched condition, in format: [filterAttribute => actualAttribute]. yii\data\DataFilter
$conditionValidators array Maps filter condition keywords to validation methods. 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
$multiValueOperators array List of operators keywords, which should accept multiple values. yii\data\DataFilter
$operatorTypes array Specifies the list of supported search attribute types per each operator. yii\data\DataFilter

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\data\DataFilter
__isset() Checks if a property is set, i.e. defined and not null. yii\data\DataFilter
__set() Sets the value of a component property. yii\data\DataFilter
__unset() Sets a component property to be null. yii\data\DataFilter
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\data\DataFilter
attributes() Returns the list of attribute names. yii\data\DataFilter
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 \yii\data\filter value. yii\data\DataFilter
canGetProperty() Returns a value indicating whether a property can be read. yii\data\DataFilter
canSetProperty() Returns a value indicating whether a property can be set. yii\data\DataFilter
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\data\DataFilter
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name. yii\base\Model
getActiveValidators() Returns the validators applicable to the current \yii\base\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
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() 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
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\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
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() 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\data\DataFilter
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

Hide inherited methods

MethodDescriptionDefined By
buildInternal() Performs actual filter build. yii\data\DataFilter
defaultErrorMessages() Returns default values for \yii\data\errorMessages. yii\data\DataFilter
detectSearchAttributeTypes() Composes default value for \yii\data\searchAttributeTypes from the \yii\data\searchModel validation rules. yii\data\DataFilter
filterAttributeValue() Validates attribute value in the scope of \yii\data\searchModel, applying attribute value filters if any. yii\data\DataFilter
parseErrorMessage() Parses content of the message from \yii\data\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 \yii\data\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

Hide inherited events

EventTypeDescriptionDefined 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

Hide inherited constants

ConstantValueDescriptionDefined 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_FLOAT 'float' yii\data\DataFilter
TYPE_INTEGER 'integer' yii\data\DataFilter
TYPE_STRING 'string' yii\data\DataFilter

Property Details

$attributeMap public property

Actual attribute names to be used in searched condition, in format: [filterAttribute => actualAttribute]. For example, in case of using table joins in the search query, attribute map may look like the following:

[
    'authorName' => '{{author}}.[[name]]'
]

Attribute map will be applied to filter condition in normalize() method.

public array $attributeMap = []
$conditionValidators public property

Maps filter condition keywords to validation methods. These methods are used by validateCondition() to validate raw filter conditions.

public array $conditionValidators = ['AND' => 'validateConjunctionCondition''OR' => 'validateConjunctionCondition''NOT' => 'validateBlockCondition''<' => 'validateOperatorCondition''>' => 'validateOperatorCondition''<=' => 'validateOperatorCondition''>=' => 'validateOperatorCondition''=' => 'validateOperatorCondition''!=' => 'validateOperatorCondition''IN' => 'validateOperatorCondition''NOT IN' => 'validateOperatorCondition''LIKE' => 'validateOperatorCondition']
$filterAttributeLabel public property

Label for the filter attribute specified via $filterAttributeName. It will be used during error messages composition.

$filterAttributeName public property

Name of the attribute that handles filter value. The name is used to load data via load() method.

public string $filterAttributeName 'filter'
$filterControls public property

Keywords or expressions that could be used in a filter. Array keys are the expressions used in raw filter value obtained from user request. Array values are internal build keys used in this class methods.

Any unspecified keyword will not be recognized as a filter control and will be treated as an attribute name. Thus you should avoid conflicts between control keywords and attribute names. For example: in case you have control keyword 'like' and an attribute named 'like', specifying condition for such attribute will be impossible.

You may specify several keywords for the same filter build key, creating multiple aliases. For example:

[
    'eq' => '=',
    '=' => '=',
    '==' => '=',
    '===' => '=',
    // ...
]

Note: while specifying filter controls take actual data exchange format, which your API uses, in mind. Make sure each specified control keyword is valid for the format. For example, in XML tag name can start only with a letter character, thus controls like >, '=' or $gt will break the XML schema.

public array $filterControls = ['and' => 'AND''or' => 'OR''not' => 'NOT''lt' => '<''gt' => '>''lte' => '<=''gte' => '>=''eq' => '=''neq' => '!=''in' => 'IN''nin' => 'NOT IN''like' => 'LIKE']
$multiValueOperators public property

List of operators keywords, which should accept multiple values.

public array $multiValueOperators = ['IN''NOT IN']
$operatorTypes public property

Specifies the list of supported search attribute types per each operator. This field should be in format: 'operatorKeyword' => ['type1', 'type2' ...]. Supported types list can be specified as *, which indicates that operator supports all types available. Any unspecified keyword will not be considered as a valid operator.

public array $operatorTypes = ['<' => [self::TYPE_INTEGERself::TYPE_FLOAT], '>' => [self::TYPE_INTEGERself::TYPE_FLOAT], '<=' => [self::TYPE_INTEGERself::TYPE_FLOAT], '>=' => [self::TYPE_INTEGERself::TYPE_FLOAT], '=' => '*''!=' => '*''IN' => '*''NOT IN' => '*''LIKE' => [self::TYPE_STRING]]

Method Details

__get() public method

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

__isset() public method

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

__set() public method

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

__unset() public method

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

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)

attributes() public method

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

public array attributes ( )
return array

List of attribute names.

build() public method

Builds actual filter specification form \yii\data\filter value.

public mixed|false build ( $runValidation true )
$runValidation boolean

Whether to perform validation (calling validate()) before building the filter. Defaults to true. If the validation fails, no filter will be built and this method will return false.

return mixed|false

Built actual filter value, or false if validation fails.

buildInternal() protected method

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.

canGetProperty() public method

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).
public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

canSetProperty() public method

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).
public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

defaultErrorMessages() protected method

Returns default values for \yii\data\errorMessages.

protected array defaultErrorMessages ( )
return array

Default error messages in [errorKey => message] format.

detectSearchAttributeTypes() protected method

Composes default value for \yii\data\searchAttributeTypes from the \yii\data\searchModel validation rules.

protected array detectSearchAttributeTypes ( )
return array

Attribute type map.

filterAttributeValue() protected method

Validates attribute value in the scope of \yii\data\searchModel, applying attribute value filters if any.

protected mixed filterAttributeValue ( $attribute, $value )
$attribute string

Attribute name.

$value mixed

Attribute value.

return mixed

Filtered attribute value.

formName() public method

Returns the form name that this model class should use.

The form name is mainly used by yii\widgets\ActiveForm to determine how to name the input fields for the attributes in a model. If the form name is "A" and an attribute name is "b", then the corresponding input name would be "A[b]". If the form name is an empty string, then the input name would be "b".

The purpose of the above naming schema is that for forms which contain multiple different models, the attributes of each model are grouped in sub-arrays of the POST-data and it is easier to differentiate between them.

By default, this method returns the model class name (without the namespace part) as the form name. You may override it when the model is used in different forms.

public string formName ( )
return string

The form name of this model class.

getErrorMessages() public method

public array getErrorMessages ( )
return array

Error messages in format [errorKey => message].

getFilter() public method

public mixed getFilter ( )
return mixed

Raw filter value.

getSearchAttributeTypes() public method

public array getSearchAttributeTypes ( )
return array

Search attribute type map.

getSearchModel() public method

public yii\base\Model getSearchModel ( )
return yii\base\Model

Model instance.

throws yii\base\InvalidConfigException

on invalid configuration.

normalize() public method

Normalizes filter value, replacing raw keys according to $filterControls and $attributeMap.

public array|boolean normalize ( $runValidation true )
$runValidation boolean

Whether to perform validation (calling validate()) before normalizing the filter. Defaults to true. If the validation fails, no filter will be processed and this method will return false.

return array|boolean

Normalized filter value, or false if validation fails.

parseErrorMessage() protected method

Parses content of the message from \yii\data\errorMessages, specified by message key.

protected string parseErrorMessage ( $messageKey, $params = [] )
$messageKey string

Message key.

$params array

Params to be parsed into the message.

return string

Composed message string.

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 \yii\data\scenario 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\data\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\data\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

setErrorMessages() public method

Sets the list of error messages responding to invalid filter structure, in format: [errorKey => message].

Message may contain placeholders that will be populated depending on the message context. For each message a {filter} placeholder is available referring to the label for $filterAttributeName attribute.

public void setErrorMessages ( $errorMessages )
$errorMessages array|Closure

Error messages in [errorKey => message] format, or a PHP callback returning them.

setFilter() public method

public void setFilter ( $filter )
$filter mixed

Raw filter value.

setSearchAttributeTypes() public method

public void setSearchAttributeTypes ( $searchAttributeTypes )
$searchAttributeTypes array|null

Search attribute type map.

setSearchModel() public method

public void setSearchModel ( $model )
$model yii\base\Model|array|string|callable

Model instance or its DI compatible configuration.

throws yii\base\InvalidConfigException

on invalid configuration.

validateAttributeCondition() protected method

Validates search condition for a particular attribute.

protected void validateAttributeCondition ( $attribute, $condition )
$attribute string

Search attribute name.

$condition mixed

Search condition.

validateAttributeValue() protected method

Validates attribute value in the scope of \yii\data\model.

protected void validateAttributeValue ( $attribute, $value )
$attribute string

Attribute name.

$value mixed

Attribute value.

validateBlockCondition() protected method

Validates block condition that consists of a single condition.

This covers such operators as not.

protected void validateBlockCondition ( $operator, $condition )
$operator string

Raw operator control keyword.

$condition mixed

Raw condition.

validateCondition() protected method

Validates filter condition.

protected void validateCondition ( $condition )
$condition mixed

Raw filter condition.

validateConjunctionCondition() protected method

Validates conjunction condition that consists of multiple independent ones.

This covers such operators as and and or.

protected void validateConjunctionCondition ( $operator, $condition )
$operator string

Raw operator control keyword.

$condition mixed

Raw condition.

validateFilter() public method

Validates filter attribute value to match filer condition specification.

public void validateFilter ( )
validateOperatorCondition() protected method

Validates operator condition.

protected void validateOperatorCondition ( $operator, $condition, $attribute null )
$operator string

Raw operator control keyword.

$condition mixed

Attribute condition.

$attribute string

Attribute name.