StructuresService

Type
Class
Namespace
Craft
Inherits
Craft\StructuresService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
2.0

Class StructuresService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
append()Appends an element to another within a given structure.
appendToRoot()Appends an element to the root of a given structure.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
deleteStructureById()Deletes a structure by its ID.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getElementLevelDelta()Returns the descendant level delta for a given element.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
getStructureById()Returns a structure by its ID.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
moveAfter()Moves an element after another within a given structure.
moveBefore()Moves an element before another within a given structure.
onBeforeMoveElement()Fires an 'onBeforeMoveElement' event.
onMoveElement()Fires an 'onMoveElement' event.
prepend()Prepends an element to another within a given structure.
prependToRoot()Prepends an element to the root of a given structure.
raiseEvent()Raises an event.
saveStructure()Saves a structure

append()

Appends an element to another within a given structure.

View source

Arguments

Returns

boolean

Signature

public boolean append ( $structureId, Craft\BaseElementModel $element, Craft\BaseElementModel $parentElement, $mode = 'auto' )

appendToRoot()

Appends an element to the root of a given structure.

View source

Arguments

Returns

boolean

Signature

public boolean appendToRoot ( $structureId, Craft\BaseElementModel $element, $mode = 'auto' )

deleteStructureById()

Deletes a structure by its ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteStructureById ( $structureId )

getElementLevelDelta()

Returns the descendant level delta for a given element.

View source

Arguments

Returns

integer

Signature

public integer getElementLevelDelta ( $structureId, Craft\BaseElementModel $element )

getStructureById()

Returns a structure by its ID.

View source

Arguments

Returns

Craft\StructureModel, null

Signature

public Craft\StructureModel, null getStructureById ( $structureId )

moveAfter()

Moves an element after another within a given structure.

View source

Arguments

Returns

boolean

Signature

public boolean moveAfter ( $structureId, Craft\BaseElementModel $element, Craft\BaseElementModel $prevElement, $mode = 'auto' )

moveBefore()

Moves an element before another within a given structure.

View source

Arguments

Returns

boolean

Signature

public boolean moveBefore ( $structureId, Craft\BaseElementModel $element, Craft\BaseElementModel $nextElement, $mode = 'auto' )

onBeforeMoveElement()

Fires an 'onBeforeMoveElement' event.

View source

Arguments

Returns

null

Signature

public null onBeforeMoveElement ( Craft\Event $event )

onMoveElement()

Fires an 'onMoveElement' event.

View source

Arguments

Returns

null

Signature

public null onMoveElement ( Craft\Event $event )

prepend()

Prepends an element to another within a given structure.

View source

Arguments

Returns

boolean

Signature

public boolean prepend ( $structureId, Craft\BaseElementModel $element, Craft\BaseElementModel $parentElement, $mode = 'auto' )

prependToRoot()

Prepends an element to the root of a given structure.

View source

Arguments

Returns

boolean

Signature

public boolean prependToRoot ( $structureId, Craft\BaseElementModel $element, $mode = 'auto' )

saveStructure()

Saves a structure

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveStructure ( Craft\StructureModel $structure )