Structures

Type
Class
Namespace
craft\services
Inherits
craft\services\Structures » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

Structures service.

An instance of the Structures service is globally accessible in Craft via Craft::$app->structures.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component

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 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.
append()Appends an element to another within a given structure.
appendToRoot()Appends an element to the root of a given structure.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
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.
deleteStructureById()Deletes a structure by its ID.
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.
getElementLevelDelta()Returns the descendant level delta for a given element.
getStructureById()Returns a structure by its ID.
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.
moveAfter()Moves an element after another within a given structure.
moveBefore()Moves an element before another within a given structure.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
prepend()Prepends an element to another within a given structure.
prependToRoot()Prepends an element to the root of a given structure.
saveStructure()Saves a structure
trigger()Triggers an event.

append()

Appends an element to another within a given structure.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean append ( \craft\services\int $structureId, craft\base\ElementInterface $element, craft\base\ElementInterface $parentElement, \craft\services\string $mode = 'auto' )

appendToRoot()

Appends an element to the root of a given structure.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean appendToRoot ( \craft\services\int $structureId, craft\base\ElementInterface $element, \craft\services\string $mode = 'auto' )

deleteStructureById()

Deletes a structure by its ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteStructureById ( \craft\services\int $structureId )

getElementLevelDelta()

Returns the descendant level delta for a given element.

View source

Arguments

Returns

integer

Signature

public integer getElementLevelDelta ( \craft\services\int $structureId, craft\base\ElementInterface $element )

getStructureById()

Returns a structure by its ID.

View source

Arguments

Returns

craft\models\Structure, null

Signature

public craft\models\Structure, null getStructureById ( \craft\services\int $structureId )

moveAfter()

Moves an element after another within a given structure.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean moveAfter ( \craft\services\int $structureId, craft\base\ElementInterface $element, craft\base\ElementInterface $prevElement, \craft\services\string $mode = 'auto' )

moveBefore()

Moves an element before another within a given structure.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean moveBefore ( \craft\services\int $structureId, craft\base\ElementInterface $element, craft\base\ElementInterface $nextElement, \craft\services\string $mode = 'auto' )

prepend()

Prepends an element to another within a given structure.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean prepend ( \craft\services\int $structureId, craft\base\ElementInterface $element, craft\base\ElementInterface $parentElement, \craft\services\string $mode = 'auto' )

prependToRoot()

Prepends an element to the root of a given structure.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean prependToRoot ( \craft\services\int $structureId, craft\base\ElementInterface $element, \craft\services\string $mode = 'auto' )

saveStructure()

Saves a structure

View source

Arguments

Returns

boolean – Whether the structure was saved successfully

Throws

Signature

public boolean saveStructure ( craft\models\Structure $structure )

Events

EVENT_AFTER_MOVE_ELEMENT

Type
craft\events\MoveElementEvent

The event that is triggered after an element is moved.

EVENT_BEFORE_MOVE_ELEMENT

Type
craft\events\MoveElementEvent

The event that is triggered before an element is moved.