Utilities
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Utilities » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
The Utilities service provides APIs for managing utilities.
An instance of the service is available via Craft::$app->utilities()
.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
allUtilityTypes | string (opens new window)[] |
authorizedUtilityTypes | string (opens new window)[] |
behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
# allUtilityTypes
- Type
- string (opens new window)[]
- Default value
null
- Access
- Read-only
View source (opens new window)
# authorizedUtilityTypes
- Type
- string (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. |
__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. |
checkAuthorization() | Returns whether the current user is authorized to use a given utility. |
className() (opens new window) | Returns the fully qualified name of this class. |
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. |
getAllUtilityTypes() | Returns all available utility type classes. |
getAuthorizedUtilityTypes() | Returns all utility type classes that the user has permission to use. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
getUtilityTypeById() | Returns a utility class by its ID |
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. |
trigger() (opens new window) | Triggers an event. |
# checkAuthorization()
Returns whether the current user is authorized to use a given utility.
View source (opens new window)
Arguments
$class
(string (opens new window)) – The utility class
Returns
# getAllUtilityTypes()
Returns all available utility type classes.
View source (opens new window)
Returns
# getAuthorizedUtilityTypes()
Returns all utility type classes that the user has permission to use.
View source (opens new window)
Returns
# getUtilityTypeById()
Returns a utility class by its ID
View source (opens new window)
Arguments
Returns
string (opens new window), null (opens new window)
# Events
# EVENT_REGISTER_UTILITY_TYPES
The event that is triggered when registering utilities.
Utilities must implement craft\base\UtilityInterface. craft\base\Utility provides a base implementation.
Read more about creating utilities in the documentation (opens new window).
Example
use craft\events\RegisterComponentTypesEvent;
use craft\services\Utilities;
use yii\base\Event;
Event::on(Utilities::class,
Utilities::EVENT_REGISTER_UTILITY_TYPES,
function(RegisterComponentTypesEvent $event) {
$event->types[] = MyUtilityType::class;
}
);