BaseElementFixture

Type
Abstract Class
Namespace
craft\test\fixtures\elements
Inherits
craft\test\fixtures\elements\BaseElementFixture » 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
yii\base\Configurable (opens new window)
Uses traits
craft\test\DbFixtureTrait, yii\test\FileFixtureTrait (opens new window)
Extended by
craft\test\fixtures\elements\AssetFixture, craft\test\fixtures\elements\CategoryFixture, craft\test\fixtures\elements\EntryFixture, craft\test\fixtures\elements\GlobalSetFixture, craft\test\fixtures\elements\TagFixture, craft\test\fixtures\elements\UserFixture
Since
3.6.0

Class BaseElementFixture is a base class for setting up fixtures for element types.

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.
checkIntegrity boolean (opens new window) – Whether database integrity checks should be explicitly enabled before deleting fixture data, and then re-disabled afterwards.
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.

# Protected Properties

Property Description
siteIds array (opens new window)

# siteIds

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() (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.
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.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getElement() Get element model.
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.
on() (opens new window) Attaches an event handler to an event.
trigger() (opens new window) Triggers an event.
unload() Unloads the fixture.

# getElement()

Get element model.

View source (opens new window)

Arguments

Returns

craft\base\ElementInterface, null (opens new window)

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

# load()

Loads the fixture.

This method is called before performing every test method. You should override this method with concrete implementation about how to set up the fixture.

View source (opens new window)

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

View source (opens new window)

# Protected Methods

Method Description
checkIntegrity() Toggles the DB integrity check.
createElement() Creates an element.
deleteElement() Deletes an element.
hardDelete() Hard-deletes everything in the database.
loadData() (opens new window) Returns the fixture data.
populateElement() Populates an element’s attributes.
saveElement() Saves an element.

# createElement()

Creates an element.

View source (opens new window)

# deleteElement()

Deletes an element.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the deletion was successful

# populateElement()

Populates an element’s attributes.

View source (opens new window)

Arguments

# saveElement()

Saves an element.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the save was successful