Globals
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Globals » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
Globals service.
An instance of the service is available via Craft::$app->globals
.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
allSetIds | array (opens new window) |
allSets | craft\elements\GlobalSet[] |
behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
editableSetIds | array (opens new window) |
editableSets | craft\elements\GlobalSet[] |
totalEditableSets | integer (opens new window) |
totalSets | integer (opens new window) |
# allSetIds
- Type
- array (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# allSets
- Type
- craft\elements\GlobalSet[]
- Default value
null
- Access
- Read-only
View source (opens new window)
# editableSetIds
- Type
- array (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# editableSets
- Type
- craft\elements\GlobalSet[]
- Default value
null
- Access
- Read-only
View source (opens new window)
# totalEditableSets
- Type
- integer (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# totalSets
- Type
- integer (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of a component property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__serialize() | Serializer |
__set() (opens new window) | Sets the value of a component property. |
__unset() (opens new window) | Sets a component property to be null. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
deleteGlobalSetById() | Deletes a global set by its ID. |
deleteSet() | 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. |
ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
getAllSetIds() | Returns all of the global set IDs. |
getAllSets() | Returns all global sets. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
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. |
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. |
handleChangedGlobalSet() | Handle global set change |
handleDeletedGlobalSet() | Handle global set getting deleted |
hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
init() (opens new window) | Initializes the object. |
off() (opens new window) | Detaches an existing event handler from this component. |
on() (opens new window) | Attaches an event handler to an event. |
pruneDeletedField() | |
reorderSets() | Reorders global sets. |
reset() | Resets the memoized globals. |
saveSet() | Saves a global set. |
trigger() (opens new window) | Triggers an event. |
# __serialize()
- Since
- 3.5.14
Serializer
View source (opens new window)
# deleteGlobalSetById()
Deletes a global set by its ID.
View source (opens new window)
Arguments
$globalSetId
(integer (opens new window))
Returns
boolean (opens new window) – Whether the global set was deleted successfully
Throws
- Throwable (opens new window)
if reasons
# deleteSet()
- Since
- 3.6.0
Deletes a global set by its ID.
View source (opens new window)
Arguments
$globalSet
(craft\elements\GlobalSet)
# getAllSetIds()
# getAllSets()
# getEditableSetIds()
Returns all of the global set IDs that are editable by the current user.
View source (opens new window)
Returns
# getEditableSets()
Returns all global sets that are editable by the current user.
View source (opens new window)
Returns
# getSetByHandle()
Returns a global set by its handle.
View source (opens new window)
Arguments
$globalSetHandle
(string (opens new window))$siteId
(integer (opens new window), null (opens new window))$withTrashed
(boolean (opens new window))
Returns
# getSetById()
Returns a global set by its ID.
View source (opens new window)
Arguments
$globalSetId
(integer (opens new window))$siteId
(integer (opens new window), null (opens new window))
Returns
# getTotalEditableSets()
Returns the total number of global sets that are editable by the current user.
View source (opens new window)
Returns
# getTotalSets()
# handleChangedGlobalSet()
Handle global set change
View source (opens new window)
Arguments
$event
(craft\events\ConfigEvent)
# handleDeletedGlobalSet()
Handle global set getting deleted
View source (opens new window)
Arguments
$event
(craft\events\ConfigEvent)
# pruneDeletedField()
DEPRECATED
Deprecated in 4.0.5. Unused fields will be pruned automatically as field layouts are resaved.
View source (opens new window)
# reorderSets()
- Since
- 3.7.0
Reorders global sets.
View source (opens new window)
Arguments
$setIds
(array (opens new window))
Returns
Throws
# reset()
- Since
- 3.6.0
Resets the memoized globals.
View source (opens new window)
# saveSet()
Saves a global set.
View source (opens new window)
Arguments
$globalSet
(craft\elements\GlobalSet) – The global set to be saved$runValidation
(boolean (opens new window)) – Whether the global set should be validated
Returns
Throws
- craft\errors\GlobalSetNotFoundException
if $globalSet->id is invalid - Throwable (opens new window)
if reasons
# Events
# EVENT_AFTER_SAVE_GLOBAL_SET
The event that is triggered after a global set is saved.
# EVENT_BEFORE_SAVE_GLOBAL_SET
The event that is triggered before a global set is saved.