AssetFixture

Type

Abstract Class

Namespace

craft\test\fixtures\elements

Inherits

craft\test\fixtures\elements\AssetFixture » craft\test\fixtures\elements\ElementFixture » yii\test\ActiveFixture (opens new window) » yii\test\BaseActiveFixture (opens new window) » yii\test\DbFixture (opens new window) » yii\test\Fixture (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

ArrayAccess (opens new window), Countable (opens new window), IteratorAggregate (opens new window), yii\base\Configurable (opens new window)

Uses traits

yii\base\ArrayAccessTrait (opens new window), yii\test\FileFixtureTrait (opens new window)

Since

3.2

Class AssetFixture.

Credit to: https://github.com/robuust/craft-fixtures

View source (opens new window)

Public Properties

Property	Description
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component
data (opens new window)	array (opens new window) – The data rows.
dataDirectory (opens new window)	string (opens new window) – The directory path or path alias that contains the fixture data
dataFile (opens new window)	string (opens new window), boolean (opens new window) – The file path or path alias of the data file that contains the fixture data to be returned by \yii\test\getData().
db (opens new window)	yii\db\Connection (opens new window), array (opens new window), string (opens new window) – The DB connection object or the application component ID of the DB connection.
depends (opens new window)	array (opens new window) – The fixtures that this fixture depends on.
element	craft\base\ElementInterface
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the cookies in the collection.
modelClass	string (opens new window) – The AR model class associated with this fixture.
tableName (opens new window)	string (opens new window) – The name of the database table that this fixture is about.
tableSchema (opens new window)	yii\db\TableSchema (opens new window) – The schema information of the database table associated with this fixture.
unload	boolean (opens new window) – Whether the fixture data should be unloaded

element

Type

craft\base\ElementInterface

Default value

null

Access

Read-only

View source (opens new window)

modelClass

Type

string (opens new window)

Default value

\craft\elements\Asset::class

The AR model class associated with this fixture.

View source (opens new window)

Protected Properties

Property	Description
destinationAssetPath	string (opens new window)
files	array (opens new window) – Used to track the files the fixture data file defines.
folderIds	array (opens new window)
siteIds	array (opens new window)
sourceAssetPath	string (opens new window)
volumeIds	array (opens new window)

destinationAssetPath

Type

string (opens new window)

Default value

null

View source (opens new window)

files

Type

array (opens new window)

Default value

[]

Used to track the files the fixture data file defines.

View source (opens new window)

folderIds

Type

array (opens new window)

Default value

[]

View source (opens new window)

sourceAssetPath

Type

string (opens new window)

Default value

null

View source (opens new window)

volumeIds

Type

array (opens new window)

Default value

[]

View source (opens new window)

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of an object property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets value of an object property.
__unset() (opens new window)	Sets an object property to null.
afterLoad() (opens new window)	This method is called AFTER all fixture data have been loaded for the current test.
afterUnload() (opens new window)	This method is called AFTER all fixture data have been unloaded for the current test.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
beforeLoad()	This method is called BEFORE any fixture data is loaded for the current test.
beforeUnload()	This method is called BEFORE any fixture data is unloaded for the current test.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
count() (opens new window)	Returns the number of data items.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
generateElementQuery()
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getElement()	Get asset model.
getIterator() (opens new window)	Returns an iterator for traversing the data.
getModel()	Returns the AR model by the specified model name.
getTableSchema() (opens new window)
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined.
init()	Initializes the object.
load()	Loads the fixture.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	This method is required by the interface ArrayAccess (opens new window).
offsetGet() (opens new window)	This method is required by the interface ArrayAccess (opens new window).
offsetSet() (opens new window)	This method is required by the interface ArrayAccess (opens new window).
offsetUnset() (opens new window)	This method is required by the interface ArrayAccess (opens new window).
on() (opens new window)	Attaches an event handler to an event.
trigger() (opens new window)	Triggers an event.
unload()	Unloads the fixture.

beforeLoad()

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

View source (opens new window)

beforeUnload()

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

View source (opens new window)

getElement()

Get asset model.

View source (opens new window)

Arguments

• $data (array (opens new window))

Returns

craft\base\ElementInterface

init()

Initializes the object.

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

View source (opens new window)

Protected Methods

Method	Description
getData() (opens new window)	Returns the fixture data.
isPrimaryKey()	See if an element's handle is a primary key.
loadData() (opens new window)	Returns the fixture data.
resetTable() (opens new window)	Removes all existing data from the specified table and resets sequence number to 1 (if any).

isPrimaryKey()

See if an element's handle is a primary key.

View source (opens new window)

Arguments

• $key (string (opens new window))

Returns

boolean (opens new window)