yii\debug\components\search\Filter - Yii2 类参考手册

Class yii\debug\components\search\Filter

Inheritanceyii\debug\components\search\Filter » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0

Provides array filtering capabilities.

Public Properties

隐藏继承的属性 Hide inherited properties

属性Property类型 Type简介 Description定义在 Defined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component

Protected Properties

隐藏继承的属性 Hide inherited 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

隐藏继承的方法 Hide inherited 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 protected property

Rules for matching filters in the way: [:fieldName => [rule1, rule2,..]]

protected array $rules = []

方法详情 Method Details

addMatcher() public method

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
filter() public method

Applies filter on a given array and returns filtered data.

public array filter ( array $data )
$data array

Data to filter

return array

Filtered data