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 Globals service is globally accessible in Craft via Craft::$app->globals.

View source (opens new window)

# Public Properties

# 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 an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__serialize() Serializer
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to 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.
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.
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() Prune a deleted field from global set.
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

Returns

boolean (opens new window) – Whether the global set was deleted successfully

Throws

# getAllSetIds()

Returns all of the global set IDs.

View source (opens new window)

Returns

array (opens new window)

Example

$globalSetIds = Craft::$app->globals->allSetIds;

# getAllSets()

Returns all global sets.

View source (opens new window)

Returns

craft\elements\GlobalSet[]

Example

$globalSets = Craft::$app->globals->allSets;

# getEditableSetIds()

Returns all of the global set IDs that are editable by the current user.

View source (opens new window)

Returns

array (opens new window)

Example

$globalSetIds = Craft::$app->globals->editableSetIds;

# getEditableSets()

Returns all global sets that are editable by the current user.

View source (opens new window)

Returns

craft\elements\GlobalSet[]

Example

$globalSets = Craft::$app->globals->editableSets;

# getSetByHandle()

Example

$globalSet = Craft::$app->globals->getSetByHandle('footerInfo');

# getSetById()

Example

$globalSet = Craft::$app->globals->getSetById(1);

# getTotalEditableSets()

Returns the total number of global sets that are editable by the current user.

View source (opens new window)

Returns

integer (opens new window)

Example

$total = Craft::$app->globals->totalEditableSets;

# getTotalSets()

Returns the total number of global sets.

View source (opens new window)

Returns

integer (opens new window)

Example

$total = Craft::$app->globals->totalSets;

# handleChangedGlobalSet()

Handle global set change

View source (opens new window)

Arguments

# handleDeletedGlobalSet()

Handle global set getting deleted

View source (opens new window)

Arguments

# pruneDeletedField()

Prune a deleted field from global set.

View source (opens new window)

Arguments

# saveSet()

Saves a global set.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# Constants

Constant Description
CONFIG_GLOBALSETS_KEY

# Events

# EVENT_AFTER_SAVE_GLOBAL_SET

Type
craft\events\GlobalSetEvent

The event that is triggered after a global set is saved.

# EVENT_BEFORE_SAVE_GLOBAL_SET

Type
craft\events\GlobalSetEvent

The event that is triggered before a global set is saved.