Skip to content

BaseElementFixture ​

Type
Abstract Class
Namespace
craft\test\fixtures\elements
Inherits
craft\test\fixtures\elements\BaseElementFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Uses traits
craft\test\DbFixtureTrait, yii\test\FileFixtureTrait
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

Public Properties ​

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component.
checkIntegrityboolean – Whether database integrity checks should be explicitly enabled before deleting fixture data, and then re-disabled afterwards.
dataDirectorystring – The directory path or path alias that contains the fixture data
dataFilestring, boolean – The file path or path alias of the data file that contains the fixture data to be returned by \yii\test\getData().
dbyii\db\Connection, array, string – The DB connection object or the application component ID of the DB connection.
dependsarray – The fixtures that this fixture depends on.

Protected Properties ​

PropertyDescription
siteIdsarray

siteIds ​

Type
array
Default value
[]

View source

Public Methods ​

MethodDescription
__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 a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
afterLoad()This method is called AFTER all fixture data have been loaded for the current test.
afterUnload()This method is called AFTER all fixture data have been unloaded for the current test.
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.
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.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getElement()Get element model.
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 for this component.
init()Initializes the object.
load()Loads the fixture.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
trigger()Triggers an event.
unload()Unloads the fixture.

getElement() ​

Get element model.

View source

Arguments ​

Returns ​

craft\base\ElementInterface, null

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

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

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

Protected Methods ​

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

createElement() ​

Creates an element.

View source

deleteElement() ​

Deletes an element.

View source

Arguments ​

Returns ​

boolean – Whether the deletion was successful

populateElement() ​

Populates an element’s attributes.

View source

Arguments ​

saveElement() ​

Saves an element.

View source

Arguments ​

Returns ​

boolean – Whether the save was successful