类 yii\test\InitDbFixture
InitDbFixture 表示数据库相关测试所需的初始状态。
其主要任务是在数据加载期间切换数据库的完整性检查。其他与数据库相关的夹具（例如 yii\test\ActiveFixture）需要此功能，以便它们可以在不触发完整性检查错误的情况下将数据填充到数据库中。
此外，DbFixture 还尝试加载 初始化脚本（如果存在）。
您通常应该使用 InitDbFixture 来准备一个基本的测试数据库。然后，其他数据库夹具将向此数据库添加特定的表和数据。
有关 InitDbFixture 的更多详细信息和使用信息，请参阅 关于夹具的指南文章。
公共属性
| 属性 | 类型 | 描述 | 定义于 |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | 附加到此组件的行为列表。 | yii\base\Component |
| $db | yii\db\Connection|数组|字符串 | DB 连接对象或 DB 连接的应用程序组件 ID。 | yii\test\DbFixture |
| $depends | 数组 | 此夹具依赖的夹具。 | yii\test\Fixture |
| $initScript | 字符串 | 加载此夹具时应执行的初始化脚本文件。 | yii\test\InitDbFixture |
| $schemas | 数组 | 测试表可能驻留的数据库模式列表。 | yii\test\InitDbFixture |
公共方法
属性详情
加载此夹具时应执行的初始化脚本文件。这应该是一个文件路径或 路径别名。请注意，如果文件不存在，则不会引发错误。
方法详情
定义于： yii\base\Component::__call()
调用不是类方法的命名方法。
此方法将检查任何附加的行为是否具有命名方法，并在可用时执行它。
不要直接调用此方法，因为它是一个 PHP 魔术方法，在调用未知方法时会隐式调用。
| public 混合 __call ( $name, $params ) | ||
| $name | 字符串 |
方法名称 |
| $params | 数组 |
方法参数 |
| 返回值 | 混合 |
方法返回值 |
|---|---|---|
| 抛出 | 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()");
}
| public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定义于： yii\base\BaseObject::__construct()
构造函数。
默认实现执行两件事
- 使用给定的配置
$config初始化对象。 - 调用 init()。
如果此方法在子类中被重写，建议
- 构造函数的最后一个参数是一个配置数组，例如此处的
$config。 - 在构造函数的末尾调用父类的实现。
| public void __construct ( $config = [] ) | ||
| $config | 数组 |
用于初始化对象属性的键值对 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定义于： yii\base\Component::__get()
返回组件属性的值。
此方法将按照以下顺序检查并相应地执行
- 由 getter 定义的属性：返回 getter 的结果
- 行为的属性：返回行为属性的值
不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 $value = $component->property; 时会隐式调用。
另请参阅 __set()。
| public mixed __get ( $name ) | ||
| $name | 字符串 |
属性名称 |
| 返回值 | 混合 |
属性值或行为属性的值 |
|---|---|---|
| 抛出 | 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);
}
定义于： yii\base\Component::__isset()
检查属性是否已设置，即定义且不为 null。
此方法将按照以下顺序检查并相应地执行
- 由 setter 定义的属性：返回属性是否已设置
- 行为的属性：返回属性是否已设置
- 对于不存在的属性，返回
false
不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 isset($component->property) 时会隐式调用。
| public boolean __isset ( $name ) | ||
| $name | 字符串 |
属性名称或事件名称 |
| 返回值 | 布尔值 |
命名的属性是否已设置 |
|---|---|---|
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;
}
定义于： yii\base\Component::__set()
设置组件属性的值。
此方法将按照以下顺序检查并相应地执行
- 由 setter 定义的属性：设置属性值
- 格式为“on xyz”的事件：将处理程序附加到事件“xyz”
- 格式为“as xyz”的行为：附加名为“xyz”的行为
- 行为的属性：设置行为属性的值
不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 $component->property = $value; 时会隐式调用。
另请参阅 __get()。
| public void __set ( $name, $value ) | ||
| $name | 字符串 |
属性名称或事件名称 |
| $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);
}
定义于： yii\base\Component::__unset()
将组件属性设置为 null。
此方法将按照以下顺序检查并相应地执行
- 由 setter 定义的属性：将属性值设置为 null
- 行为的属性：将属性值设置为 null
不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 unset($component->property) 时会隐式调用。
| public void __unset ( $name ) | ||
| $name | 字符串 |
属性名称 |
| 抛出 | 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);
}
此方法在当前测试的所有夹具数据加载完成后被调用。
| public void afterLoad ( ) |
public function afterLoad()
{
$this->checkIntegrity(true);
}
此方法在当前测试的所有夹具数据卸载完成后被调用。
| public void afterUnload ( ) |
public function afterUnload()
{
$this->checkIntegrity(true);
}
定义于： yii\base\Component::attachBehavior()
将行为附加到此组件。
此方法将根据给定的配置创建行为对象。之后，行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。
另请参阅 detachBehavior()。
| public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
| $name | 字符串 |
行为的名称。 |
| $behavior | 字符串|数组|yii\base\Behavior |
行为配置。可以是以下之一：
|
| 返回值 | yii\base\Behavior |
行为对象 |
|---|---|---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定义于： yii\base\Component::attachBehaviors()
将行为列表附加到组件。
每个行为都由其名称索引，并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。
另请参阅 attachBehavior()。
| public void attachBehaviors ( $behaviors ) | ||
| $behaviors | 数组 |
要附加到组件的行为列表 |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
此方法在当前测试加载任何夹具数据之前被调用。
| public void beforeLoad ( ) |
public function beforeLoad()
{
$this->checkIntegrity(false);
}
此方法在当前测试卸载任何夹具数据之前被调用。
| public void beforeUnload ( ) |
public function beforeUnload()
{
$this->checkIntegrity(false);
}
定义于： yii\base\Component::behaviors()
返回此组件应表现为的行为列表。
子类可以重写此方法来指定它们希望表现出的行为。
此方法的返回值应为行为对象或配置的数组，并以行为名称为索引。行为配置可以是指定行为类的字符串，也可以是以下结构的数组
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
请注意，行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用数组键作为名称时，可以使用此名称，然后可以使用 getBehavior() 检索行为，或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。
在此方法中声明的行为将自动附加到组件（按需）。
| public array behaviors ( ) | ||
| 返回值 | 数组 |
行为配置。 |
|---|---|---|
public function behaviors()
{
return [];
}
定义于： yii\base\Component::canGetProperty()
返回一个值，指示是否可以读取属性。
如果可以读取属性，则
- 该类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
- 该类具有与指定名称相同的成员变量（当
$checkVars为 true 时）； - 附加的行为具有给定名称的可读属性（当
$checkBehaviors为 true 时）。
另请参阅 canSetProperty()。
| public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
| $name | 字符串 |
属性名称 |
| $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;
}
定义于： yii\base\Component::canSetProperty()
返回一个值，指示是否可以设置属性。
如果可以写入属性，则
- 该类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
- 该类具有与指定名称相同的成员变量（当
$checkVars为 true 时）； - 附加的行为具有给定名称的可写属性（当
$checkBehaviors为 true 时）。
另请参阅 canGetProperty()。
| public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
| $name | 字符串 |
属性名称 |
| $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;
}
切换 DB 完整性检查。
| public void checkIntegrity ( $check ) | ||
| $check | 布尔值 |
是否开启或关闭完整性检查。 |
public function checkIntegrity($check)
{
if (!$this->db instanceof \yii\db\Connection) {
return;
}
foreach ($this->schemas as $schema) {
$this->db->createCommand()->checkIntegrity($check, $schema)->execute();
}
}
::class。
定义于： yii\base\BaseObject::className()
返回此类的完全限定名称。
| public static string className ( ) | ||
| 返回值 | 字符串 |
此类的完全限定名称。 |
|---|---|---|
public static function className()
{
return get_called_class();
}
| public yii\base\Behavior|null detachBehavior ( $name ) | ||
| $name | 字符串 |
行为的名称。 |
| 返回值 | 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;
}
定义于： yii\base\Component::detachBehaviors()
从组件中分离所有行为。
| public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定义于： 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);
}
}
}
定义于： yii\base\Component::getBehavior()
返回命名的行为对象。
| public yii\base\Behavior|null getBehavior ( $name ) | ||
| $name | 字符串 |
行为名称 |
| 返回值 | yii\base\Behavior|null |
行为对象，如果行为不存在，则为 null |
|---|---|---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定义于： yii\base\Component::getBehaviors()
返回附加到此组件的所有行为。
| public yii\base\Behavior[] getBehaviors ( ) | ||
| 返回值 | yii\base\Behavior[] |
附加到此组件的行为列表 |
|---|---|---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定义于： yii\base\Component::hasEventHandlers()
返回一个值，指示是否有任何处理程序附加到命名的事件。
| public 布尔型 hasEventHandlers ( $name ) | ||
| $name | 字符串 |
事件名称 |
| 返回值 | 布尔值 |
是否存在任何附加到该事件的处理程序。 |
|---|---|---|
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);
}
定义于： yii\base\Component::hasMethod()
返回一个值，指示方法是否已定义。
如果满足以下条件，则定义了一个方法
- 类具有指定名称的方法
- 附加的行为具有给定名称的方法（当
$checkBehaviors为 true 时）。
| public 布尔型 hasMethod ( $name, $checkBehaviors = true ) | ||
| $name | 字符串 |
属性名称 |
| $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;
}
定义于： yii\base\Component::hasProperty()
返回一个值，指示此组件是否定义了属性。
如果满足以下条件，则定义了一个属性
- 类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
- 该类具有与指定名称相同的成员变量（当
$checkVars为 true 时）； - 附加的行为具有给定名称的属性（当
$checkBehaviors为 true 时）。
另请参阅
| public 布尔型 hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
| $name | 字符串 |
属性名称 |
| $checkVars | 布尔值 |
是否将成员变量视为属性 |
| $checkBehaviors | 布尔值 |
是否将行为的属性视为此组件的属性 |
| 返回值 | 布尔值 |
属性是否已定义 |
|---|---|---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
| public void init ( ) |
public function init()
{
parent::init();
$this->db = Instance::ensure($this->db, BaseObject::className());
}
加载夹具。
此方法在执行每个测试方法之前调用。您应该使用关于如何设置夹具的具体实现覆盖此方法。
| public void load ( ) |
public function load()
{
$file = Yii::getAlias($this->initScript);
if (is_file($file)) {
require $file;
}
}
定义于： yii\base\Component::off()
从此组件中分离现有的事件处理程序。
此方法与 on() 相反。
注意：如果为事件名称传递通配符模式，则只会删除使用此通配符注册的处理程序，而使用与该通配符匹配的普通名称注册的处理程序将保留。
另请参阅 on()。
| public 布尔型 off ( $name, $handler = null ) | ||
| $name | 字符串 |
事件名称 |
| $handler | 可调用|空 |
要删除的事件处理程序。如果它是 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;
}
将事件处理程序附加到事件。
事件处理程序必须是有效的 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 | 字符串 |
事件名称 |
| $handler | 可调用 |
事件处理程序 |
| $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]);
}
}
| public void trigger ( $name, yii\base\Event $event = null ) | ||
| $name | 字符串 |
事件名称 |
| $event | yii\base\Event|空 |
事件实例。如果未设置，则将创建一个默认的 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);
}
| public void unload ( ) |
public function unload()
{
}
注册 或 登录 以发表评论。