Class yii\debug\components\search\Filter
| Inheritance | yii\debug\components\search\Filter » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-debug/blob/master/components/search/Filter.php |
Provides array filtering capabilities.
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $rules | array | Rules for matching filters in the way: [:fieldName => [rule1, rule2,. | yii\debug\components\search\Filter |
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\Component |
| __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 |
| addMatcher() | Adds data filtering rule. | yii\debug\components\search\Filter |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| 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\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 |
| 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 |
| filter() | Applies filter on a given array and returns filtered data. | yii\debug\components\search\Filter |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| 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 |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| trigger() | Triggers an event. | yii\base\Component |
Property Details
Rules for matching filters in the way: [:fieldName => [rule1, rule2,..]]
Method Details
Adds data filtering rule.
| public void addMatcher ( $name, yii\debug\components\search\matchers\MatcherInterface $rule ) | ||
| $name | string | Attribute name |
| $rule | yii\debug\components\search\matchers\MatcherInterface | |
Applies filter on a given array and returns filtered data.
| public array filter ( array $data ) | ||
| $data | array | Data to filter |
| return | array | Filtered data |
|---|---|---|