Globals

Type

Class

Namespace

craft\web\twig\variables

Inherits

craft\web\twig\variables\Globals

Since

3.0.0

Deprecated in

in 3.0.0

Globals functions.

View source

Public Methods

Method	Description
getAllSets()	Returns all global sets.
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.

getAllSets()

Returns all global sets.

View source

Arguments

• $indexBy (string, null)

Returns

array

getEditableSets()

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

View source

Arguments

• $indexBy (string, null)

Returns

array

getSetByHandle()

Returns a global set by its handle.

View source

Arguments

• $globalSetHandle (string)
• $siteHandle (string, null)

Returns

craft\elements\GlobalSet, null

Throws

• yii\base\Exception
  if|null $siteHandle is invalid

getSetById()

Returns a global set by its ID.

View source

Arguments

• $globalSetId (integer)
• $siteHandle (string, null)

Returns

craft\elements\GlobalSet, null

Throws

• yii\base\Exception
  if|null $siteHandle is invlaid

getTotalEditableSets()

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

View source

Returns

integer

getTotalSets()

Returns the total number of global sets.

View source

Returns

integer