Class luya\testsuite\fixtures\ActiveRecordFixture

Inheritanceluya\testsuite\fixtures\ActiveRecordFixture » yii\test\ActiveFixture » yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject
ImplementsArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
Uses Traitsyii\base\ArrayAccessTrait, yii\test\FileFixtureTrait
Subclassesluya\testsuite\fixtures\NgRestModelFixture
Available since version1.0.10
Source Code https://github.com/luyadev/luya-testsuite/blob/master/src/fixtures/ActiveRecordFixture.php

Active Record Fixture.

Provides a very basic way to generate a database schema for the given table based on the rules or via $schema definition. So you don't have to create migrations or sql files. Just provide the $modelClass to the ActiveRecord you'd like to test.

When working with NgRestModels you can also use {{luya\testsuite\fixtures\NgRestModelFixture}} or maybe checkout {{luya\testsuite\cases\NgRestTestCase}} which makes model testing even more easy, as it will auto setup the sqlite connection.

The only requirement for the ActiveRecordFixture is to have the sqlite database connection enabled. You could use {{luya\testsuite\cases\NgRestTestCase}} which ensures this behavior by default.

'components' => [
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => 'sqlite::memory:',
    ]
]

ActiveRecordFixture usage example:

$fixture = new ActiveRecordFixture([
    'modelClass' => 'luya\testsuite\tests\data\TestModel', // path to the model
    'fixtureData' => ['model1' => [
        'id' => 1,
        'user_id' => 1,
        'group_id' => 1,
    ]]
]);

// insert new model
$newModel = $fixture->newModel;
$newModel->attributes = ['user_id' => 1, 'group_id' => '1];
$newModel->save();

// or return the defined $fixtureData model
$model = $fixture->getModel('model1'); // definde in `$fixtureData`

By default the primary key id is used as (in general) the primary key wont appear in the rules defintion. You can override the default primary key defintion with the $primarKey property:

$model = new ActiveRecordFixture([
    'modelClass' => 'luya\testsuite\tests\data\TestModel',
    'primaryKey' => ['my_primary_key' => 'int(11) PRIMARY KEY'],
    'fixtureData' => ['model1' => [
         'id' => 1,
         'user_id' => 1,
         'group_id1' => 1,
    ]]
]);

In order to support compisite primary keys on sqlite you have to define primaryKey property as followed: 'primaryKey' => ['user_id' => 'int(11)', 'group_id' => 'int(11)', 'PRIMARY KEY (user_id, group_id)']

An example which provides data and schema from a extended fixture class:

class MyApiModelFixture extends ActiveRecordFixture
{
    public $modelClass = MyApiModel::class;

    public function getSchema()
    {
        return [
            'id' => 'int(11)',
            'access_token' => 'text',
            'name' => 'text',
        ];
    }

    public function getData()
    {
        return [
            1 => [
                'id' => 1,
                'access_token' => '123123123',
                'name' => 'masterapi',
            ]
        ];
    }
}

Public Properties

Hide inherited properties

Property Type Description Defined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$data array luya\testsuite\fixtures\ActiveRecordFixture
$dataDirectory string The directory path or path alias that contains the fixture data yii\test\FileFixtureTrait
$dataFile string|boolean|null The file path or path alias of the data file that contains the fixture data to be returned by getData(). yii\test\ActiveFixture
$db yii\db\Connection|array|string The DB connection object or the application component ID of the DB connection. yii\test\DbFixture
$depends array The fixtures that this fixture depends on. yii\test\Fixture
$fixtureData array luya\testsuite\fixtures\ActiveRecordFixture
$ignoreColumns array An array with columns which will be ignored when creating the table columns. luya\testsuite\fixtures\ActiveRecordFixture
$iterator ArrayIterator An iterator for traversing the cookies in the collection. yii\base\ArrayAccessTrait
$modelClass string The AR model class associated with this fixture. yii\test\BaseActiveFixture
$newModel yii\db\ActiveRecord luya\testsuite\fixtures\ActiveRecordFixture
$primaryKey array luya\testsuite\fixtures\ActiveRecordFixture
$removeSafeAttributes boolean Disabled the default behavior to remove safe attributes as wrongly introduced in 1.0.13. luya\testsuite\fixtures\ActiveRecordFixture
$schema array luya\testsuite\fixtures\ActiveRecordFixture
$skipIfExists boolean If the table already exists while creating, the creation process will be skipped. luya\testsuite\fixtures\ActiveRecordFixture
$tableName string|null The name of the database table that this fixture is about. yii\test\ActiveFixture
$tableSchema yii\db\TableSchema The schema information of the database table associated with this fixture. yii\test\ActiveFixture

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
afterLoad() This method is called AFTER all fixture data have been loaded for the current test. yii\test\Fixture
afterUnload() This method is called AFTER all fixture data have been unloaded for the current test. yii\test\Fixture
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeLoad() This method is called BEFORE any fixture data is loaded for the current test. yii\test\Fixture
beforeUnload() This method is called BEFORE any fixture data is unloaded for the current test. yii\test\Fixture
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
build() Create table, create columns from schema and load fixture data. luya\testsuite\fixtures\ActiveRecordFixture
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
cleanup() Cleanup active record fixture. luya\testsuite\fixtures\ActiveRecordFixture
count() Returns the number of data items. yii\base\ArrayAccessTrait
createColumns() Add columns to table. luya\testsuite\fixtures\ActiveRecordFixture
createSchemaFromRules() Create the database scheme based on the rules as attributes and fields are not available as they are virtual properties from the table definition. luya\testsuite\fixtures\ActiveRecordFixture
createTable() Create the table based on the schema with primary keys luya\testsuite\fixtures\ActiveRecordFixture
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
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getData() Returns the fixture data. luya\testsuite\fixtures\ActiveRecordFixture
getIterator() Returns an iterator for traversing the data. yii\base\ArrayAccessTrait
getModel() Returns the AR model by the specified model name. yii\test\BaseActiveFixture
getNewModel() Create instance of the model class. luya\testsuite\fixtures\ActiveRecordFixture
getPrimaryKey() Returns the primary key name(s) for this AR class. luya\testsuite\fixtures\ActiveRecordFixture
getSchema() luya\testsuite\fixtures\ActiveRecordFixture
getTableName() Decided whether table name should be resolved from property or model (if $tableName is empty). luya\testsuite\fixtures\ActiveRecordFixture
getTableSchema() yii\test\ActiveFixture
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. luya\testsuite\fixtures\ActiveRecordFixture
load() Loads the fixture. yii\test\ActiveFixture
off() Detaches an existing event handler from this component. yii\base\Component
offsetExists() This method is required by the interface ArrayAccess. yii\base\ArrayAccessTrait
offsetGet() This method is required by the interface ArrayAccess. yii\base\ArrayAccessTrait
offsetSet() This method is required by the interface ArrayAccess. yii\base\ArrayAccessTrait
offsetUnset() This method is required by the interface ArrayAccess. yii\base\ArrayAccessTrait
on() Attaches an event handler to an event. yii\base\Component
rebuild() Cleanup (drop table) and then rebuild (create) the table. luya\testsuite\fixtures\ActiveRecordFixture
setFixtureData() luya\testsuite\fixtures\ActiveRecordFixture
setPrimaryKey() Example luya\testsuite\fixtures\ActiveRecordFixture
setSchema() luya\testsuite\fixtures\ActiveRecordFixture
trigger() Triggers an event. yii\base\Component
unload() Unloads the fixture. yii\test\ActiveFixture

Protected Methods

Hide inherited methods

Method Description Defined By
loadData() Returns the fixture data. yii\test\FileFixtureTrait
resetTable() Removes all existing data from the specified table and resets sequence number to 1 (if any). yii\test\ActiveFixture

Constants

Hide inherited constants

Constant Value Description Defined By
RULE_TYPE_BOOLEAN 'boolean' luya\testsuite\fixtures\ActiveRecordFixture
RULE_TYPE_INTEGER 'integer' luya\testsuite\fixtures\ActiveRecordFixture
RULE_TYPE_SAFE 'safe' luya\testsuite\fixtures\ActiveRecordFixture

Property Details

Hide inherited properties

$data public property
public array $data null
$fixtureData public write-only property
public void setFixtureData ( array $data )
$ignoreColumns public property (available since version 1.0.13.1)

An array with columns which will be ignored when creating the table columns.

public array $ignoreColumns = []
$newModel public property
$primaryKey public property
public array $primaryKey null
$removeSafeAttributes public property (available since version 1.0.13.1)

Disabled the default behavior to remove safe attributes as wrongly introduced in 1.0.13. By default this behavior must be disable. If enabled all safe attribute rules column will ignored when creating the table.

$schema public property
public array $schema null
$skipIfExists public property (available since version 1.0.16)

If the table already exists while creating, the creation process will be skipped. This can be the case if any other test created the table but cleanup was not executed therefore an "table exists already" exception can be prevented.

public boolean $skipIfExists true

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

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

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                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 method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

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

            
__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

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

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

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

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

See also __get().

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

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

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

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

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

Defined in: yii\test\Fixture::afterLoad()

This method is called AFTER all fixture data have been loaded for the current test.

public void afterLoad ( )

                public function afterLoad()
{
}

            
afterUnload() public method

Defined in: yii\test\Fixture::afterUnload()

This method is called AFTER all fixture data have been unloaded for the current test.

public void afterUnload ( )

                public function afterUnload()
{
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

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

The name of the behavior.

$behavior string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

return yii\base\Behavior

The behavior object

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

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

List of behaviors to be attached to the component

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

            
beforeLoad() public method

Defined in: yii\test\Fixture::beforeLoad()

This method is called BEFORE any fixture data is loaded for the current test.

public void beforeLoad ( )

                public function beforeLoad()
{
}

            
beforeUnload() public method

Defined in: yii\test\Fixture::beforeUnload()

This method is called BEFORE any fixture data is unloaded for the current test.

public void beforeUnload ( )

                public function beforeUnload()
{
}

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

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

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return array

The behavior configurations.

                public function behaviors()
{
    return [];
}

            
build() public method (available since version 1.0.16)

Create table, create columns from schema and load fixture data.

public void build ( )

                public function build()
{
    // create table schema
    $this->createTable();
    // create
    $this->createColumns();
    // load fixture data into the model
    $this->load();
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).

See also canSetProperty().

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

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

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

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).

See also canGetProperty().

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

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

                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() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

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

            
cleanup() public method

Cleanup active record fixture.

public void cleanup ( )

                public function cleanup()
{
    $class = $this->modelClass;
    $tableName = $this->getTableName();
    // ensure the table exists before dropping
    if ($this->db->schema->getTableSchema($tableName)) {
        $this->db->createCommand()->dropTable($tableName)->execute();
    }
}

            
count() public method

Defined in: yii\base\ArrayAccessTrait::count()

Returns the number of data items.

This method is required by Countable interface.

public integer count ( )
return integer

Number of data elements.

                #[\ReturnTypeWillChange]
public function count()
{
    return count($this->data);
}

            
createColumns() public method

Add columns to table.

public void createColumns ( )

                public function createColumns()
{
    foreach ($this->getSchema() as $column => $type) {
        $tableColumns = $this->db->schema->getTableSchema($this->getTableName(), true);
        if (!$tableColumns->getColumn($column)) {
            $this->db->createCommand()->addColumn($this->getTableName(), $column, $type)->execute();
        }
    }
}

            
createSchemaFromRules() public method

Create the database scheme based on the rules as attributes and fields are not available as they are virtual properties from the table definition.

public void createSchemaFromRules ( )

                public function createSchemaFromRules()
{
    $object = $this->getNewModel();
    
    $fields = [];
    foreach ($object->rules() as $row) {
        list($attributes, $rule) = $row;
        
        // if a none scalar value like callable or object, skip this rule
        if (!is_scalar($rule)) {
            continue;
        }
        $rule = strtolower($rule);
        foreach ((array) $attributes as $name) {
            if ($rule == self::RULE_TYPE_BOOLEAN) {
                $fields[$name] = Schema::TYPE_BOOLEAN;
            } elseif ($rule == self::RULE_TYPE_INTEGER) {
                $fields[$name] = Schema::TYPE_INTEGER;
            }
            if (!isset($fields[$name])) {
                $fields[$name] = Schema::TYPE_TEXT;
            }
            if ($this->removeSafeAttributes && $rule == self::RULE_TYPE_SAFE) {
                // remove safe validators fields as they are commonly used for setter getter
                if (isset($fields[$name])) {
                    unset($fields[$name]);
                }
            }
        }
    }
    
    // remove primary keys
    foreach ($this->primaryKey as $key => $value) {
        ArrayHelper::remove($fields, $key);
    }
    foreach ($fields as $name => $type) {
        if (in_array($name, $this->ignoreColumns)) {
            unset($fields[$name]);
        }
    }
    
    // try to find from labels
    return $fields;
}

            
createTable() public method

Create the table based on the schema with primary keys

public void createTable ( )

                public function createTable()
{
    $fields = [];
    
    foreach ($this->getPrimaryKey() as $key => $value) {
        $fields[$key] = $value;
    }
    // if skipIfExists is enabled, the table will only be created when the table does notexists.
    if ($this->skipIfExists) {
        if (!$this->db->schema->getTableSchema($this->getTableName())) {
            $this->db->createCommand()->createTable($this->getTableName(), $fields)->execute();
        }
    } else {
        $this->db->createCommand()->createTable($this->getTableName(), $fields)->execute();
    }
}

            
detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

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

The behavior's name.

return yii\base\Behavior|null

The detached behavior. Null if the behavior does not exist.

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

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

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

            
ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

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

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

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

The behavior name

return yii\base\Behavior|null

The behavior object, or null if the behavior does not exist

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

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

List of behaviors attached to this component

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

            
getData() public method

Returns the fixture data.

The default implementation will try to return the fixture data by including the external file specified by $dataFile. The file should return an array of data rows (column name => column value), each corresponding to a row in the table.

If the data file does not exist, an empty array will be returned.

See also yii\test\ActiveFixture::getData().

public array getData ( )
return array

The data rows to be inserted into the database table.

                public function getData()
{
    return $this->_data;
}

            
getIterator() public method

Defined in: yii\base\ArrayAccessTrait::getIterator()

Returns an iterator for traversing the data.

This method is required by the SPL interface IteratorAggregate. It will be implicitly called when you use foreach to traverse the collection.

public ArrayIterator getIterator ( )
return ArrayIterator

An iterator for traversing the cookies in the collection.

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

            
getModel() public method

Defined in: yii\test\BaseActiveFixture::getModel()

Returns the AR model by the specified model name.

A model name is the key of the corresponding data row in $data.

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

The model name.

return yii\db\ActiveRecord|null

The AR model, or null if the model cannot be found in the database

throws yii\base\InvalidConfigException

if $modelClass is not set.

                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);
}

            
getNewModel() public method

Create instance of the model class.

public yii\db\ActiveRecord getNewModel ( )

                public function getNewModel()
{
    $class = $this->modelClass;
    
    return new $class();
}

            
getPrimaryKey() public method

Returns the primary key name(s) for this AR class.

The default implementation will return the primary key(s) as declared in the DB table that is associated with this AR class.

If the DB table does not declare any primary key, you should override this method to return the attributes that you want to use as primary keys for this AR class.

Note that an array should be returned even for a table with single primary key.

public string|array getPrimaryKey ( )
return string|array

The primary keys of the associated database table.

                public function getPrimaryKey()
{
    if ($this->_primaryKey === null) {
        $this->_primaryKey = ['id' => Schema::TYPE_PK];
    }
    
    return $this->_primaryKey;
}

            
getSchema() public method

public void getSchema ( )

                public function getSchema()
{
    // this allows even empty arrays to override.
    if (empty($this->_schema)) {
        $this->_schema = $this->createSchemaFromRules();
    }
    return $this->_schema;
}

            
getTableName() public method (available since version 1.0.23)

Decided whether table name should be resolved from property or model (if $tableName is empty).

public string getTableName ( )

                public function getTableName()
{
    $class = $this->modelClass;
    return $this->tableName ? $this->tableName : $class::tableName();
}

            
getTableSchema() public method
public yii\db\TableSchema getTableSchema ( )
return yii\db\TableSchema

The schema information of the database table associated with this fixture.

throws yii\base\InvalidConfigException

if the table does not exist

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

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name string

The event name

return boolean

Whether there is any handler attached to the event.

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

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

The property name

$checkBehaviors boolean

Whether to treat behaviors' methods as methods of this component

return boolean

Whether the method is defined

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

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).

See also:

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

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property is defined

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

            
init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
    parent::init();
    $this->build();
}

            
load() public method

Defined in: yii\test\ActiveFixture::load()

Loads the fixture.

It populate the table with the data returned by getData().

If you override this method, you should consider calling the parent implementation so that the data returned by getData() can be populated into the table.

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() protected method

Defined in: yii\test\FileFixtureTrait::loadData()

Returns the fixture data.

The default implementation will try to return the fixture data by including the external file specified by $dataFile. The file should return the data array that will be stored in data after inserting into the database.

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

The data file path

$throwException boolean

Whether to throw exception if fixture data file does not exist.

return array

The data to be put into the database

throws yii\base\InvalidConfigException

if the specified data file does not exist.

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

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

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

Event name

$handler callable|null

The event handler to be removed. If it is null, all handlers attached to the named event will be removed.

return boolean

If a handler is found and detached

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

Defined in: yii\base\ArrayAccessTrait::offsetExists()

This method is required by the interface ArrayAccess.

public boolean offsetExists ( $offset )
$offset mixed

The offset to check on

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

            
offsetGet() public method

Defined in: yii\base\ArrayAccessTrait::offsetGet()

This method is required by the interface ArrayAccess.

public mixed offsetGet ( $offset )
$offset integer

The offset to retrieve element.

return mixed

The element at the offset, null if no element is found at the offset

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

            
offsetSet() public method

Defined in: yii\base\ArrayAccessTrait::offsetSet()

This method is required by the interface ArrayAccess.

public void offsetSet ( $offset, $item )
$offset integer

The offset to set element

$item mixed

The element value

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

            
offsetUnset() public method

Defined in: yii\base\ArrayAccessTrait::offsetUnset()

This method is required by the interface ArrayAccess.

public void offsetUnset ( $offset )
$offset mixed

The offset to unset element

                #[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
    unset($this->data[$offset]);
}

            
on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

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

The event handler must be defined with the following signature,

function ($event)

where $event is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

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

See also off().

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

The event name

$handler callable

The event handler

$data mixed

The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.

$append boolean

Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

                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]);
    }
}

            
rebuild() public method (available since version 1.0.15)

Cleanup (drop table) and then rebuild (create) the table.

public void rebuild ( )

                public function rebuild()
{
    $this->cleanup();
    $this->build();
}

            
resetTable() protected method

Defined in: yii\test\ActiveFixture::resetTable()

Removes all existing data from the specified table and resets sequence number to 1 (if any).

This method is called before populating fixture data into the table associated with this fixture.

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);
    }
}

            
setFixtureData() public method

public void setFixtureData ( array $data )
$data array

                public function setFixtureData(array $data)
{
    $this->_data = $data;
}

            
setPrimaryKey() public method

Example

'primaryKey' => ['id' => 'INT(11) PRIMARY KEY],
public void setPrimaryKey ( array $primaryKey )
$primaryKey array

                public function setPrimaryKey(array $primaryKey)
{
    $this->_primaryKey = $primaryKey;
}

            
setSchema() public method

public void setSchema ( array $schema )
$schema array

                public function setSchema(array $schema)
{
    $this->_schema = $schema;
}

            
trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

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

The event name

$event yii\base\Event|null

The event instance. If not set, a default yii\base\Event object will be created.

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

Defined in: yii\test\ActiveFixture::unload()

Unloads the fixture.

This method is called after every test method finishes. You may override this method to perform necessary cleanup work for the fixture.

public void unload ( )

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