UtilityAccess ​
- Type
- Class
- Namespace
- craft\filters
- Inherits
- craft\filters\UtilityAccess » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Uses traits
- craft\filters\ConditionalFilterTrait
- Since
- 5.5.0
Filter for ensuring the user should be able to access the configured utility.
Public Properties ​
| Property | Description |
|---|---|
| except | array – List of action IDs that this filter should not apply to. |
| only | array – List of action IDs that this filter should apply to. |
| owner | craft\web\Controller |
| utility | class-string<\craft\base\UtilityInterface> – The utility class |
| when | callable, null – A PHP callable that determines when this filter should be applied. |
owner ​
- Type
- craft\web\Controller
- Default value
null
utility ​
- Type
class-string<\craft\base\UtilityInterface>- Default value
null
The utility class
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __construct() | Constructor. |
| __get() | Returns the value of an object property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets value of an object property. |
| __unset() | Sets an object property to null. |
| afterAction() | This method is invoked right after an action is executed. |
| afterFilter() | |
| attach() | Attaches the behavior object to the component. |
| beforeAction() | This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action. |
| beforeFilter() | |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| detach() | Detaches the behavior object from the component. |
| events() | Declares event handlers for the owner's events. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
beforeAction() ​
This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.
Arguments ​
$action(yii\base\Action) – The action to be executed.
Returns ​
boolean – Whether the action should continue to be executed.
Protected Methods ​
| Method | Description |
|---|---|
| getActionId() | Returns an action ID by converting yii\base\Action::$uniqueId into an ID relative to the module. |
| isActive() | Returns a value indicating whether the filter is active for the given action. |