FieldLayoutFixture

Type: Abstract Class
Namespace: craft\test\fixtures
Inherits: craft\test\fixtures\FieldLayoutFixture » craft\test\Fixture » 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 FieldLayoutFixture.

# 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.
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the cookies in the collection.
modelClass (opens new window)	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.

# Protected Properties

Property	Description
ids	array (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()	Unloading fixtures removes fields and possible tables - so we need to refresh the DB Schema before our parent calls.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
beforeLoad() (opens new window)	This method is called BEFORE any fixture data is loaded for the current test.
beforeUnload() (opens new window)	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.
deleteAllByFieldHandle()	Attempt to delete all fields and field layout by a field handle.
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.
ensureColumnIntegrity()
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getIterator() (opens new window)	Returns an iterator for traversing the data.
getModel() (opens new window)	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() (opens new window)	Initializes the object.
load()
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()

# `afterUnload()`

Unloading fixtures removes fields and possible tables - so we need to refresh the DB Schema before our parent calls.

Craft::$app->getDb()->createCommand()->checkIntegrity(true);

View source (opens new window)

Throws

yii\base\NotSupportedException (opens new window)

# `deleteAllByFieldHandle()`

Attempt to delete all fields and field layout by a field handle.

Get a field by handle
Get its layout
Traverse down the data (getTabs() and then on each tab getFields()
Delete all fields.
Delete the field layout.

View source (opens new window)

Throws

# `unload()`

View source (opens new window)

Returns

boolean (opens new window)

Throws

Throwable (opens new window)

# Protected Methods

Method	Description
extractTabsFromFieldLayout()
getData() (opens new window)	Returns the fixture data.
getTabsForFieldLayout()
linkFieldToLayout()
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).
throwModelError()