GlobalsService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\GlobalsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class GlobalsService
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. |
| 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. |
| deleteSetById() | Deletes a global set 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. |
| getAllSetIds() | Returns all of the global set IDs. |
| getAllSets() | Returns all global sets. |
| getEditableSetIds() | Returns all of the global set IDs that are editable by the current user. |
| getEditableSets() | Returns all global sets that are editable by the current user. |
| 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. |
| getSetByHandle() | Returns a global set by its handle. |
| getSetById() | Returns a global set by its ID. |
| getTotalEditableSets() | Returns the total number of global sets that are editable by the current user. |
| getTotalSets() | Returns the total number of global sets. |
| 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. |
| onBeforeSaveGlobalContent() | Fires an 'onBeforeSaveGlobalContent' event. |
| onSaveGlobalContent() | Fires an 'onSaveGlobalContent' event. |
| raiseEvent() (opens new window) | Raises an event. |
| saveContent() | Saves a global set's content |
| saveSet() | Saves a global set. |
# deleteSetById()
Deletes a global set by its ID.
View source (opens new window)
Arguments
$setId(integer (opens new window))
Returns
Throws
Signature
public boolean deleteSetById ( $setId )
# getAllSetIds()
Signature
public array getAllSetIds ( )
# getAllSets()
Returns all global sets.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getAllSets ( $indexBy = null )
# getEditableSetIds()
Returns all of the global set IDs that are editable by the current user.
View source (opens new window)
Returns
Signature
public array getEditableSetIds ( )
# getEditableSets()
Returns all global sets that are editable by the current user.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getEditableSets ( $indexBy = null )
# getSetByHandle()
Returns a global set by its handle.
View source (opens new window)
Arguments
$globalSetHandle(integer (opens new window))$localeId(string (opens new window), null (opens new window))
Returns
Signature
public Craft\GlobalSetModel, null getSetByHandle ( $globalSetHandle, $localeId = null )
# getSetById()
Returns a global set by its ID.
View source (opens new window)
Arguments
$globalSetId(integer (opens new window))$localeId(string (opens new window), null (opens new window))
Returns
Signature
public Craft\GlobalSetModel, null getSetById ( $globalSetId, $localeId = null )
# getTotalEditableSets()
Returns the total number of global sets that are editable by the current user.
View source (opens new window)
Returns
Signature
public integer getTotalEditableSets ( )
# getTotalSets()
Signature
public integer getTotalSets ( )
# onBeforeSaveGlobalContent()
Fires an 'onBeforeSaveGlobalContent' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeSaveGlobalContent ( Craft\Event $event )
# onSaveGlobalContent()
Fires an 'onSaveGlobalContent' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onSaveGlobalContent ( Craft\Event $event )
# saveContent()
Saves a global set's content
View source (opens new window)
Arguments
$globalSet(Craft\GlobalSetModel)
Returns
Throws
Signature
public boolean saveContent ( Craft\GlobalSetModel $globalSet )
# saveSet()
Saves a global set.
View source (opens new window)
Arguments
$globalSet(Craft\GlobalSetModel)
Returns
Throws
Signature
public boolean saveSet ( Craft\GlobalSetModel $globalSet )