Class craft\services\Utilities

Inheritance: craft\services\Utilities » 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/Utilities.php

The Utilities service provides APIs for managing utilities.

An instance of the Utilities service is globally accessible in Craft via Craft::$app->utilities().

Public Methods
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
`checkAuthorization()`	Returns whether the current user is authorized to use a given utility.	craft\services\Utilities
`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
`getAllUtilityTypes()`	Returns all available utility type classes.	craft\services\Utilities
`getAuthorizedUtilityTypes()`	Returns all utility type classes that the user has permission to use.	craft\services\Utilities
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getUtilityTypeById()`	Returns a utility class by its ID	craft\services\Utilities
`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
`trigger()`	Triggers an event.	yii\base\Component

Events
Event	Type	Description	Defined By
`EVENT_REGISTER_UTILITY_TYPES`	craft\events\RegisterComponentTypesEvent	The event that is triggered when registering utility types.	craft\services\Utilities

Method Details

`checkAuthorization()` public method #

Returns whether the current user is authorized to use a given utility.

public boolean checkAuthorization ( \craft\services\string $class )

$class string The utility class

`getAllUtilityTypes()` public method #

Returns all available utility type classes.

public string[] getAllUtilityTypes ( )

`getAuthorizedUtilityTypes()` public method #

Returns all utility type classes that the user has permission to use.

public string[] getAuthorizedUtilityTypes ( )

`getUtilityTypeById()` public method #

Returns a utility class by its ID

public string, null getUtilityTypeById ( \craft\services\string $id )

$id string

Event Details

`EVENT_REGISTER_UTILITY_TYPES` event of type craft\events\RegisterComponentTypesEvent #

The event that is triggered when registering utility types.

Method Details

checkAuthorization() public method #

getAllUtilityTypes() public method #

getAuthorizedUtilityTypes() public method #