0 关注者

类 yii\test\ActiveFixture

所有类 | 属性 | 方法
继承关系yii\test\ActiveFixture » yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject
实现接口ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
使用 Traitsyii\base\ArrayAccessTrait, yii\test\FileFixtureTrait
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/test/ActiveFixture.php

ActiveFixture 代表一个由 ActiveRecord 类 或 数据库表 支持的 fixture。

必须设置 $modelClass 或 $tableName。如果要使用代码生成 fixture 数据，则还应在 $dataFile 指定的文件中提供 fixture 数据，或覆盖 getData()。

加载 fixture 时，它将首先调用 resetTable() 删除表中所有现有数据。然后，它将使用 getData() 返回的数据填充表。

加载 fixture 后，可以通过 $data 属性访问加载的数据。如果设置了 $modelClass，还可以通过 getModel() 获取填充了数据的 $modelClass 实例。

有关 ActiveFixture 的更多详细信息和用法信息，请参阅 关于 fixture 的指南文章。

公共属性

隐藏继承属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$data array yii\base\ArrayAccessTrait
$dataDirectory string 包含 fixture 数据的目录路径或 路径别名 yii\test\FileFixtureTrait
$dataFile string|boolean|null 数据文件的路径或 路径别名，该文件包含 getData() 要返回的 fixture 数据。 yii\test\ActiveFixture
$db yii\db\Connection|array|string 数据库连接对象或数据库连接的应用程序组件 ID。 yii\test\DbFixture
$depends array 此 fixture 依赖的 fixture。 yii\test\Fixture
$iterator ArrayIterator 用于遍历集合中 cookie 的迭代器。 yii\base\ArrayAccessTrait
$modelClass string 与此 fixture 关联的 AR 模型类。 yii\test\BaseActiveFixture
$tableName string|null 此 fixture 相关的数据库表名称。 yii\test\ActiveFixture
$tableSchema yii\db\TableSchema 与此 fixture 关联的数据库表的架构信息。 yii\test\ActiveFixture

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 在通过克隆现有对象创建对象后调用此方法。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置，即定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
afterLoad() 此方法在当前测试的所有 fixture 数据加载完成后调用。 yii\test\Fixture
afterUnload() 此方法在当前测试的所有 fixture 数据卸载完成后调用。 yii\test\Fixture
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeLoad() 此方法在当前测试加载任何 fixture 数据之前调用。 yii\test\Fixture
beforeUnload() 此方法在当前测试卸载任何 fixture 数据之前调用。 yii\test\Fixture
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
count() 返回数据项的数量。 yii\base\ArrayAccessTrait
detachBehavior() 从组件分离行为。 yii\base\Component
detachBehaviors() 从组件分离所有行为。 yii\base\Component
ensureBehaviors() 确保 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getIterator() 返回用于遍历数据的迭代器。 yii\base\ArrayAccessTrait
getModel() 返回指定模型名称的 AR 模型。 yii\test\BaseActiveFixture
getTableSchema() yii\test\ActiveFixture
hasEventHandlers() 返回一个值，指示是否将任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值，指示此组件是否定义了属性。 yii\base\Component
init() 初始化对象。 yii\test\ActiveFixture
load() 加载 fixture。 yii\test\ActiveFixture
off() 从此组件分离现有的事件处理程序。 yii\base\Component
offsetExists() 此方法是接口 ArrayAccess 所必需的。 yii\base\ArrayAccessTrait
offsetGet() 此方法是接口 ArrayAccess 所必需的。 yii\base\ArrayAccessTrait
offsetSet() 此方法是接口 ArrayAccess 所必需的。 yii\base\ArrayAccessTrait
offsetUnset() 此方法是接口 ArrayAccess 所必需的。 yii\base\ArrayAccessTrait
on() 将事件处理程序附加到事件。 yii\base\Component
trigger() 触发事件。 yii\base\Component
unload() 卸载 fixture。 yii\test\ActiveFixture

受保护方法

隐藏继承方法

方法 描述 定义于
getData() 返回 fixture 数据。 yii\test\ActiveFixture
loadData() 返回 fixture 数据。 yii\test\FileFixtureTrait
resetTable() 删除指定表中的所有现有数据并将序列号重置为 1（如果有）。 yii\test\ActiveFixture

属性详情

隐藏继承属性

$dataFile 公共属性

数据文件的路径或 路径别名，该文件包含 getData() 要返回的 fixture 数据。如果未设置此属性，则默认为 FixturePath/data/TableName.php，其中 FixturePath 代表包含此 fixture 类的目录，TableName 代表与此 fixture 关联的表的名称。您可以将此属性设置为 false 以防止加载任何数据。

public 字符串|布尔值|null $dataFile = null
$tableName 公共属性

此加载项所关联的数据库表名称。如果未设置此属性，则表名称将通过 $modelClass 确定。

另请参阅 $modelClass。

public 字符串|null $tableName = null
$tableSchema 公共属性

与此 fixture 关联的数据库表的架构信息。

public yii\db\TableSchema $tableSchema = null

方法详情

隐藏继承方法

__call() 公共方法

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

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

此方法将检查任何附加的行为是否具有指定的方法，如果可用则执行该方法。

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

public 混合 __call ( $name, $params )
$name string

方法名
$params array

方法参数
返回值 混合

方法返回值
抛出 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() 公共方法

定义于： yii\base\Component::__clone()

在通过克隆现有对象创建对象后调用此方法。

它删除所有行为，因为它们附加到旧对象。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}
__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 混合 __get ( $name )
$name string

属性名
返回值 混合

属性值或行为属性的值
抛出 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()

检查属性是否已设置，即定义且不为空。

此方法将按以下顺序检查并相应地采取行动

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

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

另请参阅 https://php.ac.cn/manual/en/function.isset.php。

public 布尔值 __isset ( $name )
$name string

属性名或事件名
返回值 布尔值

指定的属性是否已设置

 

                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 混合

属性值
抛出 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);
}
afterLoad() 公共方法

定义于： yii\test\Fixture::afterLoad()

此方法在当前测试的所有 fixture 数据加载完成后调用。

public void afterLoad ( )

                public function afterLoad()
{
}
afterUnload() 公共方法

定义于： yii\test\Fixture::afterUnload()

此方法在当前测试的所有 fixture 数据卸载完成后调用。

public void afterUnload ( )

                public function afterUnload()
{
}
attachBehavior() 公共方法

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

将行为附加到此组件。

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

另请参阅 detachBehavior()。

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

行为的名称。
$behavior 字符串|数组|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);
    }
}
beforeLoad() 公共方法

定义于： yii\test\Fixture::beforeLoad()

此方法在当前测试加载任何 fixture 数据之前调用。

public void beforeLoad ( )

                public function beforeLoad()
{
}
beforeUnload() 公共方法

定义于： yii\test\Fixture::beforeUnload()

此方法在当前测试卸载任何 fixture 数据之前调用。

public void beforeUnload ( )

                public function beforeUnload()
{
}
behaviors() 公共方法

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

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

子类可以重写此方法以指定它们希望表现出的行为。

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

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

请注意，行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时，使用此名称，以后可以使用 getBehavior() 检索行为，或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

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

public 数组 behaviors ( )
返回值 array

行为配置。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公共方法

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

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

如果可以读取属性

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

另请参阅 canSetProperty()。

public 布尔值 canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名
$checkVars 布尔值

是否将成员变量视为属性
$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性
返回值 布尔值

属性是否可读

 

                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 布尔值 canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名
$checkVars 布尔值

是否将成员变量视为属性
$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性
返回值 布尔值

属性是否可写

 

                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 字符串 className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
count() 公共方法

定义于： yii\base\ArrayAccessTrait::count()

返回数据项的数量。

此方法是 Countable 接口所必需的。

public 整数 count ( )
返回值 整数

数据元素的数量。

 

                #[\ReturnTypeWillChange]
public function count()
{
    return count($this->data);
}
detachBehavior() 公共方法

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

从组件分离行为。

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

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

行为的名称。
返回值 yii\base\Behavior|空

分离的行为。如果行为不存在，则为 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

 

                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;
}
getData() 受保护方法

返回 fixture 数据。

默认实现将尝试通过包含由 $dataFile 指定的外部文件来返回固定数据。该文件应返回一个数据行数组（列名 => 列值），每个数组对应表中的一行。

如果数据文件不存在，则返回空数组。

protected array getData ( )
返回值 array

要插入数据库表中的数据行。

 

                protected function getData()
{
    if ($this->dataFile === null) {
        if ($this->dataDirectory !== null) {
            $dataFile = $this->getTableSchema()->fullName . '.php';
        } else {
            $class = new \ReflectionClass($this);
            $dataFile = dirname($class->getFileName()) . '/data/' . $this->getTableSchema()->fullName . '.php';
        }
        return $this->loadData($dataFile, false);
    }
    return parent::getData();
}
getIterator() 公共方法

定义于： yii\base\ArrayAccessTrait::getIterator()

返回用于遍历数据的迭代器。

此方法是 SPL 接口 IteratorAggregate 所必需的。当您使用 foreach 遍历集合时，将隐式调用此方法。

public ArrayIterator getIterator ( )
返回值 ArrayIterator

用于遍历集合中 cookie 的迭代器。

 

                #[\ReturnTypeWillChange]
public function getIterator()
{
    return new \ArrayIterator($this->data);
}
getModel() 公共方法

定义于： yii\test\BaseActiveFixture::getModel()

返回指定模型名称的 AR 模型。

模型名称是 $data 中对应数据行的键。

public yii\db\ActiveRecord|null getModel ( $name )
$name string

模型名称。
返回值 yii\db\ActiveRecord|null

AR 模型，如果数据库中找不到模型则为 null
抛出 yii\base\InvalidConfigException

如果 $modelClass 未设置。

 

                public function getModel($name)
{
    if (!isset($this->data[$name])) {
        return null;
    }
    if (array_key_exists($name, $this->_models)) {
        return $this->_models[$name];
    }
    if ($this->modelClass === null) {
        throw new InvalidConfigException('The "modelClass" property must be set.');
    }
    $row = $this->data[$name];
    /* @var $modelClass \yii\db\ActiveRecord */
    $modelClass = $this->modelClass;
    $keys = [];
    foreach ($modelClass::primaryKey() as $key) {
        $keys[$key] = isset($row[$key]) ? $row[$key] : null;
    }
    return $this->_models[$name] = $modelClass::findOne($keys);
}
getTableSchema() 公共方法

public yii\db\TableSchema getTableSchema ( )
返回值 yii\db\TableSchema

与此 fixture 关联的数据库表的架构信息。
抛出 yii\base\InvalidConfigException

如果表不存在

 

                public function getTableSchema()
{
    if ($this->_table !== null) {
        return $this->_table;
    }
    $db = $this->db;
    $tableName = $this->tableName;
    if ($tableName === null) {
        /* @var $modelClass \yii\db\ActiveRecord */
        $modelClass = $this->modelClass;
        $tableName = $modelClass::tableName();
    }
    $this->_table = $db->getSchema()->getTableSchema($tableName);
    if ($this->_table === null) {
        throw new InvalidConfigException("Table does not exist: {$tableName}");
    }
    return $this->_table;
}
hasEventHandlers() 公共方法

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名称
返回值 布尔值

事件是否附加了任何处理程序。

 

                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 布尔值

是否将行为的方法视为此组件的方法
返回值 布尔值

方法是否已定义

 

                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 布尔值

是否将成员变量视为属性
$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性
返回值 布尔值

属性是否已定义

 

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

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化之后调用。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->tableName === null) {
        if ($this->modelClass === null) {
            throw new InvalidConfigException('Either "modelClass" or "tableName" must be set.');
        }
        /** @var ActiveRecord $modelClass */
        $modelClass = $this->modelClass;
        $this->db = $modelClass::getDb();
    }
}
load() 公共方法

加载 fixture。

它使用 getData() 返回的数据填充表。

如果覆盖此方法，则应考虑调用父实现，以便 getData() 返回的数据可以填充到表中。

public void load ( )

                public function load()
{
    $this->data = [];
    $table = $this->getTableSchema();
    foreach ($this->getData() as $alias => $row) {
        $primaryKeys = $this->db->schema->insert($table->fullName, $row);
        $this->data[$alias] = array_merge($row, $primaryKeys);
    }
}
loadData() 受保护方法

定义于： yii\test\FileFixtureTrait::loadData()

返回 fixture 数据。

默认实现将尝试通过包含由 $dataFile 指定的外部文件来返回夹具数据。该文件应返回将在插入数据库后存储在 data 中的数据数组。

protected array loadData ( $file, $throwException = true )
$file string

数据文件路径
$throwException 布尔值

如果夹具数据文件不存在，是否抛出异常。
返回值 array

要放入数据库中的数据
抛出 yii\base\InvalidConfigException

如果指定的数据文件不存在。

 

                protected function loadData($file, $throwException = true)
{
    if ($file === null || $file === false) {
        return [];
    }
    if (basename($file) === $file && $this->dataDirectory !== null) {
        $file = $this->dataDirectory . '/' . $file;
    }
    $file = Yii::getAlias($file);
    if (is_file($file)) {
        return require $file;
    }
    if ($throwException) {
        throw new InvalidConfigException("Fixture data file does not exist: {$file}");
    }
    return [];
}
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参阅 on()。

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

事件名称
$handler callable|null

要移除的事件处理程序。如果为 null，则将移除附加到命名事件的所有处理程序。
返回值 布尔值

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

 

                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;
}
offsetExists() 公共方法

定义于： yii\base\ArrayAccessTrait::offsetExists()

此方法是接口 ArrayAccess 所必需的。

public boolean offsetExists ( $offset )
$offset 混合

要检查的偏移量

 

                #[\ReturnTypeWillChange]
public function offsetExists($offset)
{
    return isset($this->data[$offset]);
}
offsetGet() 公共方法

定义于： yii\base\ArrayAccessTrait::offsetGet()

此方法是接口 ArrayAccess 所必需的。

public mixed offsetGet ( $offset )
$offset 整数

要检索元素的偏移量。
返回值 混合

偏移量处的元素，如果在偏移量处找不到元素，则为 null

 

                #[\ReturnTypeWillChange]
public function offsetGet($offset)
{
    return isset($this->data[$offset]) ? $this->data[$offset] : null;
}
offsetSet() 公共方法

定义于： yii\base\ArrayAccessTrait::offsetSet()

此方法是接口 ArrayAccess 所必需的。

public void offsetSet ( $offset, $item )
$offset 整数

要设置元素的偏移量
$item 混合

元素值

 

                #[\ReturnTypeWillChange]
public function offsetSet($offset, $item)
{
    $this->data[$offset] = $item;
}
offsetUnset() 公共方法

定义于： yii\base\ArrayAccessTrait::offsetUnset()

此方法是接口 ArrayAccess 所必需的。

public void offsetUnset ( $offset )
$offset 混合

要取消设置元素的偏移量

 

                #[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
    unset($this->data[$offset]);
}
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 混合

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

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 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]);
    }
}
resetTable() 受保护方法

删除指定表中的所有现有数据并将序列号重置为 1（如果有）。

此方法在将夹具数据填充到与此夹具关联的表中之前调用。

protected void resetTable ( )

                protected function resetTable()
{
    $table = $this->getTableSchema();
    $this->db->createCommand()->delete($table->fullName)->execute();
    if ($table->sequenceName !== null) {
        $this->db->createCommand()->executeResetSequence($table->fullName, 1);
    }
}
trigger() 公共方法

定义于： 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);
}
unload() 公共方法

卸载 fixture。

此方法在每个测试方法完成后调用。您可以覆盖此方法来执行夹具所需的清理工作。

public void unload ( )

                public function unload()
{
    $this->resetTable();
    parent::unload();
}