FieldLayoutFixture
- Type
- Abstract Class
- Namespace
- craft\test\fixtures
- Inherits
- craft\test\fixtures\FieldLayoutFixture » craft\test\Fixture » yii\test\ActiveFixture » yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
- Uses traits
- yii\base\ArrayAccessTrait, yii\test\FileFixtureTrait
- Since
- 3.2
Class FieldLayoutFixture.
Public Properties
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component |
| data | array – The data rows. |
| dataDirectory | string – The directory path or path alias that contains the fixture data |
| dataFile | string, boolean – The file path or path alias of the data file that contains the fixture data to be returned by getData(). |
| db | yii\db\Connection, array, string – The DB connection object or the application component ID of the DB connection. |
| depends | array – The fixtures that this fixture depends on. |
| iterator | ArrayIterator – An iterator for traversing the cookies in the collection. |
| modelClass | string – The AR model class associated with this fixture. |
| tableName | string – The name of the database table that this fixture is about. |
| tableSchema | yii\db\TableSchema – The schema information of the database table associated with this fixture. |
Protected Properties
Public Methods
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of an object property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets value of an object property. |
| __unset() | Sets an object property to null. |
| afterLoad() | 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() | Attaches a behavior to this component. |
| attachBehaviors() | 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() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| count() | Returns the number of data items. |
| deleteAllByFieldHandle() | Attempt to delete all fields and field layout by a field handle. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| ensureColumnIntegrity() | |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getIterator() | Returns an iterator for traversing the data. |
| getModel() | Returns the AR model by the specified model name. |
| getTableSchema() | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
| load() | |
| off() | Detaches an existing event handler from this component. |
| offsetExists() | This method is required by the interface ArrayAccess. |
| offsetGet() | This method is required by the interface ArrayAccess. |
| offsetSet() | This method is required by the interface ArrayAccess. |
| offsetUnset() | This method is required by the interface ArrayAccess. |
| on() | Attaches an event handler to an event. |
| trigger() | 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);
Throws
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.
Arguments
$fieldHandle(string)
Returns
Throws
load()
Throws
unload()
Returns
Throws
Protected Methods
| Method | Description |
|---|---|
| extractTabsFromFieldLayout() | |
| getData() | Returns the fixture data. |
| getTabsForFieldLayout() | |
| linkFieldToLayout() | |
| loadData() | Returns the fixture data. |
| resetTable() | Removes all existing data from the specified table and resets sequence number to 1 (if any). |
| throwModelError() |
extractTabsFromFieldLayout()
Arguments
$fieldLayout(array)
Returns
getTabsForFieldLayout()
Arguments
$tabs(array)
Returns
linkFieldToLayout()
Arguments
$link(array)$field(craft\base\Field)$fieldLayout(craft\models\FieldLayout)$tab(craft\models\FieldLayoutTab)
Returns
Throws
throwModelError()
Arguments
$model(craft\base\Model)