StructuresService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\StructuresService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 2.0
Class StructuresService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | 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() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| deleteStructureById() | Deletes a structure by its ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getElementLevelDelta() | Returns the descendant level delta for a given element. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getStructureById() | Returns a structure by its ID. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | 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() (opens new window) | Raises an event. |
| saveStructure() | Saves a structure |
# append()
Appends an element to another within a given structure.
View source (opens new window)
Arguments
$structureId(integer (opens new window))$element(Craft\BaseElementModel)$parentElement(Craft\BaseElementModel)$mode(string (opens new window)) – Whether this is an "insert", "update", or "auto".
Returns
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 (opens new window)
Arguments
$structureId(integer (opens new window))$element(Craft\BaseElementModel)$mode(string (opens new window)) – Whether this is an "insert", "update", or "auto".
Returns
Signature
public boolean appendToRoot ( $structureId, Craft\BaseElementModel $element, $mode = 'auto' )
# deleteStructureById()
Deletes a structure by its ID.
View source (opens new window)
Arguments
$structureId(integer (opens new window))
Returns
Signature
public boolean deleteStructureById ( $structureId )
# getElementLevelDelta()
Returns the descendant level delta for a given element.
View source (opens new window)
Arguments
$structureId(integer (opens new window))$element(Craft\BaseElementModel)
Returns
Signature
public integer getElementLevelDelta ( $structureId, Craft\BaseElementModel $element )
# getStructureById()
Returns a structure by its ID.
View source (opens new window)
Arguments
$structureId(integer (opens new window))
Returns
Signature
public Craft\StructureModel, null getStructureById ( $structureId )
# moveAfter()
Moves an element after another within a given structure.
View source (opens new window)
Arguments
$structureId(integer (opens new window))$element(Craft\BaseElementModel)$prevElement(Craft\BaseElementModel)$mode(string (opens new window)) – Whether this is an "insert", "update", or "auto".
Returns
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 (opens new window)
Arguments
$structureId(integer (opens new window))$element(Craft\BaseElementModel)$nextElement(Craft\BaseElementModel)$mode(string (opens new window)) – Whether this is an "insert", "update", or "auto".
Returns
Signature
public boolean moveBefore ( $structureId, Craft\BaseElementModel $element, Craft\BaseElementModel $nextElement, $mode = 'auto' )
# onBeforeMoveElement()
Fires an 'onBeforeMoveElement' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeMoveElement ( Craft\Event $event )
# onMoveElement()
Fires an 'onMoveElement' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onMoveElement ( Craft\Event $event )
# prepend()
Prepends an element to another within a given structure.
View source (opens new window)
Arguments
$structureId(integer (opens new window))$element(Craft\BaseElementModel)$parentElement(Craft\BaseElementModel)$mode(string (opens new window)) – Whether this is an "insert", "update", or "auto".
Returns
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 (opens new window)
Arguments
$structureId(integer (opens new window))$element(Craft\BaseElementModel)$mode(string (opens new window)) – Whether this is an "insert", "update", or "auto".
Returns
Signature
public boolean prependToRoot ( $structureId, Craft\BaseElementModel $element, $mode = 'auto' )
# saveStructure()
Saves a structure
View source (opens new window)
Arguments
$structure(Craft\StructureModel)
Returns
Throws
Signature
public boolean saveStructure ( Craft\StructureModel $structure )