HumHub Documentation (unofficial)

ActiveFixture extends BaseActiveFixture
in package

Application

ActiveFixture represents a fixture backed up by a [[modelClass|ActiveRecord class]] or a [[tableName|database table]].

Either [[modelClass]] or [[tableName]] must be set. You should also provide fixture data in the file specified by [[dataFile]] or overriding [[getData()]] if you want to use code to generate the fixture data.

When the fixture is being loaded, it will first call [[resetTable()]] to remove any existing data in the table. It will then populate the table with the data returned by [[getData()]].

After the fixture is loaded, you can access the loaded data via the [[data]] property. If you set [[modelClass]], you will also be able to retrieve an instance of [[modelClass]] with the populated data via [[getModel()]].

For more details and usage information on ActiveFixture, see the guide article on fixtures.

Properties

$behaviors : array<string|int, Behavior>
$data : array<string|int, mixed>
$dataDirectory : string
$dataFile : string|bool|null
$db : Connection|array<string|int, mixed>|string
$depends : array<string|int, mixed>
$modelClass : string
$tableName : string|null
$tableSchema : TableSchema
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_models : array<string|int, ActiveRecord>
$_table : TableSchema

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
afterLoad() : mixed: This method is called AFTER all fixture data have been loaded for the current test.
afterUnload() : mixed: This method is called AFTER all fixture data have been unloaded for the current test.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
beforeLoad() : mixed: This method is called BEFORE any fixture data is loaded for the current test.
beforeUnload() : mixed: This method is called BEFORE any fixture data is unloaded for the current test.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
count() : int: Returns the number of data items.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getIterator() : ArrayIterator: Returns an iterator for traversing the data.
getModel() : ActiveRecord|null: Returns the AR model by the specified model name.
getTableSchema() : TableSchema
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
load() : mixed: Loads the fixture.
off() : bool: Detaches an existing event handler from this component.
offsetExists() : bool: This method is required by the interface [[\ArrayAccess]].
offsetGet() : mixed: This method is required by the interface [[\ArrayAccess]].
offsetSet() : mixed: This method is required by the interface [[\ArrayAccess]].
offsetUnset() : mixed: This method is required by the interface [[\ArrayAccess]].
on() : mixed: Attaches an event handler to an event.
trigger() : mixed: Triggers an event.
unload() : mixed: Unloads the fixture.
getData() : array<string|int, mixed>: Returns the fixture data.
loadData() : array<string|int, mixed>: Returns the fixture data.
resetTable() : mixed: Removes all existing data from the specified table and resets sequence number to 1 (if any).
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$data


    public
        array<string|int, mixed>
    $data
     = []

the data rows. Each array element represents one row of data (column name => column value).

$dataDirectory


    public
        string
    $dataDirectory

the directory path or path alias that contains the fixture data

$dataFile


    public
        string|bool|null
    $dataFile

the file path or path alias of the data file that contains the fixture data to be returned by [[getData()]]. If this is not set, it will default to FixturePath/data/TableName.php, where FixturePath stands for the directory containing this fixture class, and TableName stands for the name of the table associated with this fixture. You can set this property to be false to prevent loading any data.

$db


    public
        Connection|array<string|int, mixed>|string
    $db
     = 'db'

the DB connection object or the application component ID of the DB connection. After the DbFixture object is created, if you want to change this property, you should only assign it with a DB connection object. Starting from version 2.0.2, this can also be a configuration array for creating the object.

$depends


    public
        array<string|int, mixed>
    $depends
     = []

the fixtures that this fixture depends on. This must be a list of the dependent fixture class names.

$modelClass


    public
        string
    $modelClass

the AR model class associated with this fixture.

$tableName


    public
        string|null
    $tableName

the name of the database table that this fixture is about. If this property is not set, the table name will be determined via [[modelClass]].

$tableSchema read-only


    public
        TableSchema
    $tableSchema

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

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_models


    private
        array<string|int, ActiveRecord>
    $_models
     = []

the loaded AR models

$_table


    private
        TableSchema
    $_table

the table schema for the table associated with this fixture

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

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


    public
                    __clone() : mixed

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

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

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.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

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;.

Parameters

$name : string: the property name

Return values

mixed —

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

__isset()

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


    public
                    __isset(string $name) : bool

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).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

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;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

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).

Parameters

$name : string: the property name

afterLoad()

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


    public
                    afterLoad() : mixed

afterUnload()

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


    public
                    afterUnload() : mixed

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

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 [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

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

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

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

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

beforeLoad()

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


    public
                    beforeLoad() : mixed

beforeUnload()

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


    public
                    beforeUnload() : mixed

behaviors()

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


    public
                    behaviors() : array<string|int, mixed>

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 [[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).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

count()

Returns the number of data items.


    public
                    count() : int

This method is required by Countable interface.

#[ReturnTypeWillChange]

Return values

int —

number of data elements.

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

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

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

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


    public
                    ensureBehaviors() : mixed

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

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

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getIterator()

Returns an iterator for traversing the data.


    public
                    getIterator() : ArrayIterator

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

#[ReturnTypeWillChange]

Return values

ArrayIterator —

an iterator for traversing the cookies in the collection.

getModel()

Returns the AR model by the specified model name.


    public
                    getModel(string $name) : ActiveRecord|null

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

Parameters

$name : string: the model name.

Return values

ActiveRecord|null —

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

getTableSchema()


    public
                    getTableSchema() : TableSchema

Return values

TableSchema —

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

hasEventHandlers()

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


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

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


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

load()

Loads the fixture.


    public
                    load() : mixed

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.

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

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.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

offsetExists()

This method is required by the interface [[\ArrayAccess]].


    public
                    offsetExists(mixed $offset) : bool

Parameters

$offset : mixed: the offset to check on

#[ReturnTypeWillChange]

Return values

bool

offsetGet()

This method is required by the interface [[\ArrayAccess]].


    public
                    offsetGet(int $offset) : mixed

Parameters

$offset : int: the offset to retrieve element.

#[ReturnTypeWillChange]

Return values

mixed —

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

offsetSet()

This method is required by the interface [[\ArrayAccess]].


    public
                    offsetSet(int $offset, mixed $item) : mixed

Parameters

$offset : int: the offset to set element
$item : mixed: the element value

#[ReturnTypeWillChange]

offsetUnset()

This method is required by the interface [[\ArrayAccess]].


    public
                    offsetUnset(mixed $offset) : mixed

Parameters

$offset : mixed: the offset to unset element

#[ReturnTypeWillChange]

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

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 [[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.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: 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 [[Event::data]].
$append : bool = true: 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.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

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

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

unload()

Unloads the fixture.


    public
                    unload() : mixed

getData()

Returns the fixture data.


    protected
                    getData() : array<string|int, mixed>

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.

Return values

array<string|int, mixed> —

the data rows to be inserted into the database table.

loadData()

Returns the fixture data.


    protected
                    loadData(string $file[, bool $throwException = true ]) : array<string|int, mixed>

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.

Parameters

$file : string: the data file path
$throwException : bool = true: whether to throw exception if fixture data file does not exist.

Return values

array<string|int, mixed> —

the data to be put into the database

resetTable()

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


    protected
                    resetTable() : mixed

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

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

ActiveFixture extends BaseActiveFixture in package Application

Tags

Table of Contents

Properties

Methods

Properties

$behaviors read-only

$data

$dataDirectory

$dataFile

$db

$depends

$modelClass

$tableName

Tags

$tableSchema read-only

$_behaviors

$_events

$_eventWildcards

Tags

$_models

$_table

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

afterLoad()

afterUnload()

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

beforeLoad()

beforeUnload()

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

count()

Attributes

Return values

detachBehavior()

Parameters

ActiveFixture extends BaseActiveFixture
in package

Application