Class craft\services\Globals
- Inheritance
- craft\services\Globals » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/services/Globals.php
Globals service.
An instance of the Globals service is globally accessible in Craft via Craft::$app->globals.
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getAllSetIds() |
Returns all of the global set IDs. | craft\services\Globals |
getAllSets() |
Returns all global sets. | craft\services\Globals |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
getEditableSetIds() |
Returns all of the global set IDs that are editable by the current user. | craft\services\Globals |
getEditableSets() |
Returns all global sets that are editable by the current user. | craft\services\Globals |
getSetByHandle() |
Returns a global set by its handle. | craft\services\Globals |
getSetById() |
Returns a global set by its ID. | craft\services\Globals |
getTotalEditableSets() |
Returns the total number of global sets that are editable by the current user. | craft\services\Globals |
getTotalSets() |
Returns the total number of global sets. | craft\services\Globals |
hasEventHandlers() |
Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() |
Initializes the object. | yii\base\BaseObject |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
saveSet() |
Saves a global set. | craft\services\Globals |
trigger() |
Triggers an event. | yii\base\Component |
| Event | Type | Description | Defined By |
|---|---|---|---|
EVENT_AFTER_SAVE_GLOBAL_SET |
craft\events\GlobalSetEvent | The event that is triggered after a global set is saved. | craft\services\Globals |
EVENT_BEFORE_SAVE_GLOBAL_SET |
craft\events\GlobalSetEvent | The event that is triggered before a global set is saved. | craft\services\Globals |
Method Details
getAllSetIds()
public method
#
Returns all of the global set IDs.
public array getAllSetIds ( )
getAllSets()
public method
#
Returns all global sets.
public craft\elements\GlobalSet[] getAllSets ( )
getEditableSetIds()
public method
#
Returns all of the global set IDs that are editable by the current user.
public array getEditableSetIds ( )
getEditableSets()
public method
#
Returns all global sets that are editable by the current user.
public craft\elements\GlobalSet[] getEditableSets ( )
getSetByHandle()
public method
#
Returns a global set by its handle.
public craft\elements\GlobalSet, null getSetByHandle ( \craft\services\string $globalSetHandle, \craft\services\int $siteId = null )$globalSetHandle |
string | |
$siteId |
integer, null |
getSetById()
public method
#
Returns a global set by its ID.
public craft\elements\GlobalSet, null getSetById ( \craft\services\int $globalSetId, \craft\services\int $siteId = null )$globalSetId |
integer | |
$siteId |
integer, null |
getTotalEditableSets()
public method
#
Returns the total number of global sets that are editable by the current user.
public integer getTotalEditableSets ( )
getTotalSets()
public method
#
Returns the total number of global sets.
public integer getTotalSets ( )
saveSet()
public method
#
Saves a global set.
public boolean saveSet ( craft\elements\GlobalSet $globalSet, \craft\services\bool $runValidation = true )$globalSet |
craft\elements\GlobalSet | The global set to be saved |
$runValidation |
boolean | Whether the global set should be validated |
| throws | craft\errors\GlobalSetNotFoundException | if $globalSet->id is invalid |
|---|---|---|
| throws | Throwable | if reasons |
Event Details
EVENT_AFTER_SAVE_GLOBAL_SET
event of type craft\events\GlobalSetEvent
#
The event that is triggered after a global set is saved.
EVENT_BEFORE_SAVE_GLOBAL_SET
event of type craft\events\GlobalSetEvent
#
The event that is triggered before a global set is saved.