AssetsControllerTrait
- Type
- Trait
- Namespace
- craft\controllers
- Implemented by
- craft\controllers\AssetsController
- Since
- 4.5.0
Provides asset permission enforcement methods for controllers.
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| requirePeerVolumePermissionByAsset() | Requires a peer permission for a given asset, unless it was uploaded by the current user. |
| requireVolumePermission() | Requires a volume permission by its UID. |
| requireVolumePermissionByAsset() | Requires a volume permission for a given asset. |
| requireVolumePermissionByFolder() | Requires a volume permission for a given folder. |
# requirePeerVolumePermissionByAsset()
Requires a peer permission for a given asset, unless it was uploaded by the current user.
View source (opens new window)
Arguments
$permissionName(string (opens new window)) – The name of the peer permission to require (sans:<volume-uid>suffix)$asset(craft\elements\Asset) – The asset whose volume should be checked
Throws
# requireVolumePermission()
Requires a volume permission by its UID.
View source (opens new window)
Arguments
$permissionName(string (opens new window)) – The name of the peer permission to require (sans:<volume-uid>suffix)$volumeUid(string (opens new window)) – The volume’s UID
Throws
# requireVolumePermissionByAsset()
Requires a volume permission for a given asset.
View source (opens new window)
Arguments
$permissionName(string (opens new window)) – The name of the permission to require (sans:<volume-uid>suffix)$asset(craft\elements\Asset) – The asset whose volume should be checked
Throws
- yii\web\ForbiddenHttpException (opens new window)
- yii\base\InvalidConfigException (opens new window)
- craft\errors\VolumeException
# requireVolumePermissionByFolder()
Requires a volume permission for a given folder.
View source (opens new window)
Arguments
$permissionName(string (opens new window)) – The name of the peer permission to require (sans:<volume-uid>suffix)$folder(craft\models\VolumeFolder) – The folder whose volume should be checked