0 关注者

类 yii\data\ActiveDataProvider

继承yii\data\ActiveDataProvider » yii\data\BaseDataProvider » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\data\DataProviderInterface
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/data/ActiveDataProvider.php

ActiveDataProvider 实现了一个基于 yii\db\Queryyii\db\ActiveQuery 的数据提供者。

ActiveDataProvider 通过使用 $query 执行数据库查询来提供数据。

以下是如何使用 ActiveDataProvider 提供 ActiveRecord 实例的示例

$provider = new ActiveDataProvider([
    'query' => Post::find(),
    'pagination' => [
        'pageSize' => 20,
    ],
]);

// get the posts in the current page
$posts = $provider->getModels();

以下示例展示了如何在没有 ActiveRecord 的情况下使用 ActiveDataProvider

$query = new Query();
$provider = new ActiveDataProvider([
    'query' => $query->from('post'),
    'pagination' => [
        'pageSize' => 20,
    ],
]);

// get the posts in the current page
$posts = $provider->getModels();

有关 ActiveDataProvider 的更多详细信息和使用信息,请参见 关于数据提供者的指南文章

公共属性

隐藏继承属性

属性 类型 描述 定义位置
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$count integer 当前页面中的数据模型数量。 yii\data\BaseDataProvider
$db yii\db\Connection|array|string|null 数据库连接对象或数据库连接的应用程序组件 ID。 yii\data\ActiveDataProvider
$id string|null 在所有数据提供者中唯一标识数据提供者的 ID。 yii\data\BaseDataProvider
$key string|callable|null 用作数据模型键的列。 yii\data\ActiveDataProvider
$keys array $models 相对应的键值列表。 yii\data\BaseDataProvider
$models array 当前页面中的数据模型列表。 yii\data\BaseDataProvider
$pagination yii\data\Pagination|false 分页对象。 yii\data\BaseDataProvider
$query yii\db\QueryInterface|null 用于获取数据模型和 $totalCount 的查询(如果未明确设置)。 yii\data\ActiveDataProvider
$sort yii\data\Sort|boolean 排序对象。 yii\data\BaseDataProvider
$totalCount integer 可能的总数据模型数量。 yii\data\BaseDataProvider

公共方法

隐藏继承方法

方法 描述 定义位置
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() yii\data\ActiveDataProvider
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否设置,即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应该表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getBehavior() 返回命名行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getCount() 返回当前页面中的数据模型数量。 yii\data\BaseDataProvider
getKeys() 返回与数据模型关联的键值。 yii\data\BaseDataProvider
getModels() 返回当前页面中的数据模型。 yii\data\BaseDataProvider
getPagination() 返回此数据提供者使用的分页对象。 yii\data\BaseDataProvider
getSort() 返回此数据提供者使用的排序对象。 yii\data\BaseDataProvider
getTotalCount() 返回总数据模型数量。 yii\data\BaseDataProvider
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化数据库连接组件。 yii\data\ActiveDataProvider
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
prepare() 准备数据模型和键。 yii\data\BaseDataProvider
refresh() 刷新数据提供者。 yii\data\BaseDataProvider
setKeys() 设置与数据模型关联的键值。 yii\data\BaseDataProvider
setModels() 设置当前页面中的数据模型。 yii\data\BaseDataProvider
setPagination() 设置此数据提供者的分页。 yii\data\BaseDataProvider
setSort() 设置此数据提供者的排序定义。 yii\data\ActiveDataProvider
setTotalCount() 设置总数据模型数量。 yii\data\BaseDataProvider
trigger() 触发事件。 yii\base\Component

受保护方法

隐藏继承方法

方法 描述 定义位置
prepareKeys() 准备与当前可用数据模型关联的键。 yii\data\ActiveDataProvider
prepareModels() 准备将在当前页面中提供的数据模型。 yii\data\ActiveDataProvider
prepareTotalCount() 返回一个值,指示此数据提供者中的总数据模型数量。 yii\data\ActiveDataProvider

属性详细信息

隐藏继承属性

$db 公共属性

数据库连接对象或数据库连接的应用程序组件 ID。如果设置了它,它将覆盖 $query 的默认数据库连接。从 2.0.2 版本开始,这也可以是用于创建对象的配置数组。

$key 公共属性

用作数据模型键的列。这可以是列名,也可以是返回给定数据模型键值的回调函数。

如果未设置此值,将使用以下规则来确定数据模型的键

另见 getKeys()

public string|callable|null $key null
$query 公共属性

用于获取数据模型和 $totalCount 的查询(如果未明确设置)。

方法详情

隐藏继承方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查是否有任何附加的行为具有命名的 method,如果可用,将执行该方法。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name string

方法名称

$params array

方法参数

返回值 mixed

方法返回值

抛出 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

public void __clone ( )

                public function __clone()
{
    if (is_object($this->query)) {
        $this->query = clone $this->query;
    }
    parent::__clone();
}

            
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果此方法在子类中被覆盖,建议

  • 构造函数的最后一个参数是一个配置数组,就像这里的 $config 一样。
  • 在构造函数的末尾调用父实现。
public void __construct ( $config = [] )
$config array

将用于初始化对象属性的名称-值对

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $component->property; 时会隐式调用。

另见 __set()

public mixed __get ( $name )
$name string

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只写的。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否设置,即定义且不为 null。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 isset($component->property) 时会隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

命名的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性:设置属性值
  • "on xyz" 格式的事件:将处理程序附加到事件 "xyz"
  • "as xyz" 格式的行为:附加名为 "xyz" 的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $component->property = $value; 时会隐式调用。

另见 __get()

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

属性名称或事件名称

$value mixed

属性值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 unset($component->property) 时会隐式调用。

另见 https://php.ac.cn/manual/en/function.unset.php

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另见 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。这可以是以下之一

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都按其名称索引,应该是 yii\base\Behavior 对象、指定行为类的字符串,或创建行为的配置数组。

另见 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应该表现为的行为列表。

子类可以重写此方法以指定它们想要执行的行为。

此方法的返回值应该是一个行为对象或配置的数组,由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当使用名称作为数组键时,可以使用此名称在以后使用 getBehavior() 获取行为,或使用 detachBehavior() 卸载行为。匿名行为不能被检索或卸载。

在此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示是否可以读取属性。

属性可读,如果

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参见 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

属性可写,如果

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参见 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 起已弃用。在 PHP >= 5.5 上,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

已卸载的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在,则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getCount() 公共方法

定义于: yii\data\BaseDataProvider::getCount()

返回当前页面中的数据模型数量。

public integer getCount ( )
返回值 integer

当前页面中的数据模型数量。

                public function getCount()
{
    return count($this->getModels());
}

            
getKeys() 公共方法

定义于: yii\data\BaseDataProvider::getKeys()

返回与数据模型关联的键值。

public array getKeys ( )
返回值 array

$models 对应的键值列表。 $models 中的每个数据模型都由此数组中的相应键值唯一标识。

                public function getKeys()
{
    $this->prepare();
    return $this->_keys;
}

            
getModels() 公共方法

定义于: yii\data\BaseDataProvider::getModels()

返回当前页面中的数据模型。

public array getModels ( )
返回值 array

当前页面中的数据模型列表。

                public function getModels()
{
    $this->prepare();
    return $this->_models;
}

            
getPagination() 公共方法

定义于: yii\data\BaseDataProvider::getPagination()

返回此数据提供者使用的分页对象。

请注意,您应该先调用 prepare()getModels() 来获取 yii\data\Pagination::$totalCountyii\data\Pagination::$pageCount 的正确值。

public yii\data\Pagination|false getPagination ( )
返回值 yii\data\Pagination|false

分页对象。如果为 false,表示分页已禁用。

                public function getPagination()
{
    if ($this->_pagination === null) {
        $this->setPagination([]);
    }
    return $this->_pagination;
}

            
getSort() 公共方法

定义于: yii\data\BaseDataProvider::getSort()

返回此数据提供者使用的排序对象。

public yii\data\Sort|boolean getSort ( )
返回值 yii\data\Sort|boolean

排序对象。如果为 false,表示排序已禁用。

                public function getSort()
{
    if ($this->_sort === null) {
        $this->setSort([]);
    }
    return $this->_sort;
}

            
getTotalCount() 公共方法

定义于: yii\data\BaseDataProvider::getTotalCount()

返回总数据模型数量。

$pagination 为 false 时,它将返回与 $count 相同的值。否则,它将调用 prepareTotalCount() 来获取计数。

public integer getTotalCount ( )
返回值 integer

可能的总数据模型数量。

                public function getTotalCount()
{
    if ($this->getPagination() === false) {
        return $this->getCount();
    } elseif ($this->_totalCount === null) {
        $this->_totalCount = $this->prepareTotalCount();
    }
    return $this->_totalCount;
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

是否存在任何附加到事件的处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

定义于: yii\base\Component::hasMethod()

返回一个值,指示是否定义了方法。

如果定义了方法

  • 该类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

定义于: yii\base\Component::hasProperty()

返回一个值,指示是否为此组件定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() 公共方法

初始化数据库连接组件。

此方法将初始化 $db 属性(如果设置),以确保它引用有效的 DB 连接。

public void init ( )
抛出 yii\base\InvalidConfigException

如果 $db 无效。

                public function init()
{
    parent::init();
    if ($this->db !== null) {
        $this->db = Instance::ensure($this->db);
    }
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要删除的事件处理程序。如果为 null,将删除附加到命名事件的所有处理程序。

返回值 boolean

如果找到并分离了一个处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是一个有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中 $event 是一个 yii\base\Event 对象,它包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
prepare() 公共方法

定义于: yii\data\BaseDataProvider::prepare()

准备数据模型和键。

此方法将准备可通过 getModels()getKeys() 检索的数据模型和键。

如果之前未调用此方法,则 getModels()getKeys() 将隐式调用此方法。

public void prepare ( $forcePrepare false )
$forcePrepare boolean

是否强制数据准备,即使之前已经准备过。

                public function prepare($forcePrepare = false)
{
    if ($forcePrepare || $this->_models === null) {
        $this->_models = $this->prepareModels();
    }
    if ($forcePrepare || $this->_keys === null) {
        $this->_keys = $this->prepareKeys($this->_models);
    }
}

            
prepareKeys() protected method

准备与当前可用数据模型关联的键。

protected array prepareKeys ( $models )
$models array

可用的数据模型

返回值 array

                protected function prepareKeys($models)
{
    $keys = [];
    if ($this->key !== null) {
        foreach ($models as $model) {
            if (is_string($this->key)) {
                $keys[] = $model[$this->key];
            } else {
                $keys[] = call_user_func($this->key, $model);
            }
        }
        return $keys;
    } elseif ($this->query instanceof ActiveQueryInterface) {
        /* @var $class \yii\db\ActiveRecordInterface */
        $class = $this->query->modelClass;
        $pks = $class::primaryKey();
        if (count($pks) === 1) {
            $pk = $pks[0];
            foreach ($models as $model) {
                $keys[] = $model[$pk];
            }
        } else {
            foreach ($models as $model) {
                $kk = [];
                foreach ($pks as $pk) {
                    $kk[$pk] = $model[$pk];
                }
                $keys[] = $kk;
            }
        }
        return $keys;
    }
    return array_keys($models);
}

            
prepareModels() protected method

准备将在当前页面中提供的数据模型。

protected array prepareModels ( )
返回值 array

可用的数据模型

                protected function prepareModels()
{
    if (!$this->query instanceof QueryInterface) {
        throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. yii\db\Query or its subclasses.');
    }
    $query = clone $this->query;
    if (($pagination = $this->getPagination()) !== false) {
        $pagination->totalCount = $this->getTotalCount();
        if ($pagination->totalCount === 0) {
            return [];
        }
        $query->limit($pagination->getLimit())->offset($pagination->getOffset());
    }
    if (($sort = $this->getSort()) !== false) {
        $query->addOrderBy($sort->getOrders());
    }
    return $query->all($this->db);
}

            
prepareTotalCount() protected method

返回一个值,指示此数据提供者中的总数据模型数量。

protected integer prepareTotalCount ( )
返回值 integer

此数据提供器中的数据模型总数。

                protected function prepareTotalCount()
{
    if (!$this->query instanceof QueryInterface) {
        throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. yii\db\Query or its subclasses.');
    }
    $query = clone $this->query;
    return (int) $query->limit(-1)->offset(-1)->orderBy([])->count('*', $this->db);
}

            
refresh() public method

定义于: yii\data\BaseDataProvider::refresh()

刷新数据提供者。

调用此方法后,如果再次调用 getModels()getKeys()getTotalCount(),它们将重新执行查询并返回最新的可用数据。

public void refresh ( )

                public function refresh()
{
    $this->_totalCount = null;
    $this->_models = null;
    $this->_keys = null;
}

            
setKeys() public method

定义于: yii\data\BaseDataProvider::setKeys()

设置与数据模型关联的键值。

public void setKeys ( $keys )
$keys array

$models 相对应的键值列表。

                public function setKeys($keys)
{
    $this->_keys = $keys;
}

            
setModels() public method

定义于: yii\data\BaseDataProvider::setModels()

设置当前页面中的数据模型。

public void setModels ( $models )
$models array

当前页面的模型

                public function setModels($models)
{
    $this->_models = $models;
}

            
setPagination() public method

定义于: yii\data\BaseDataProvider::setPagination()

设置此数据提供者的分页。

public void setPagination ( $value )
$value array|yii\data\Pagination|boolean

此数据提供器要使用的分页。这可以是以下之一

  • 用于创建分页对象的配置数组。 "class" 元素默认为 'yii\data\Pagination'
  • yii\data\Pagination 或其子类的实例
  • false,如果需要禁用分页。
抛出 yii\base\InvalidArgumentException

                public function setPagination($value)
{
    if (is_array($value)) {
        $config = ['class' => Pagination::className()];
        if ($this->id !== null) {
            $config['pageParam'] = $this->id . '-page';
            $config['pageSizeParam'] = $this->id . '-per-page';
        }
        $this->_pagination = Yii::createObject(array_merge($config, $value));
    } elseif ($value instanceof Pagination || $value === false) {
        $this->_pagination = $value;
    } else {
        throw new InvalidArgumentException('Only Pagination instance, configuration array or false is allowed.');
    }
}

            
setSort() public method

设置此数据提供者的排序定义。

public void setSort ( $value )
$value array|yii\data\Sort|boolean

此数据提供器要使用的排序定义。这可以是以下之一

  • 用于创建排序定义对象的配置数组。 "class" 元素默认为 'yii\data\Sort'
  • yii\data\Sort 或其子类的实例
  • false,如果需要禁用排序。
抛出 yii\base\InvalidArgumentException

                public function setSort($value)
{
    parent::setSort($value);
    if ($this->query instanceof ActiveQueryInterface && ($sort = $this->getSort()) !== false) {
        /* @var $modelClass Model */
        $modelClass = $this->query->modelClass;
        $model = $modelClass::instance();
        if (empty($sort->attributes)) {
            foreach ($model->attributes() as $attribute) {
                $sort->attributes[$attribute] = [
                    'asc' => [$attribute => SORT_ASC],
                    'desc' => [$attribute => SORT_DESC],
                ];
            }
        }
        if ($sort->modelClass === null) {
            $sort->modelClass = $modelClass;
        }
    }
}

            
setTotalCount() public method

定义于: yii\data\BaseDataProvider::setTotalCount()

设置总数据模型数量。

public void setTotalCount ( $value )
$value integer

数据模型的总数。

                public function setTotalCount($value)
{
    $this->_totalCount = $value;
}

            
trigger() public method

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}