AssetsController

Type

Class

Namespace

craft\controllers

Inherits

craft\controllers\AssetsController » craft\web\Controller » yii\web\Controller (opens new window) » yii\base\Controller (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

yii\base\Configurable (opens new window), yii\base\ViewContextInterface (opens new window)

Since

3.0.0

The AssetsController class is a controller that handles various actions related to asset tasks, such as uploading files and creating/deleting/renaming files and folders.

Note that all actions in the controller except for actionGenerateTransform() and actionGenerateThumb() require an authenticated Craft session via allowAnonymous.

View source (opens new window)

Public Properties

Property	Description
action (opens new window)	yii\base\Action (opens new window), null (opens new window) – The action that is currently being executed.
actionParams (opens new window)	array (opens new window) – The parameters bound to the current action.
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
defaultAction (opens new window)	string (opens new window) – The ID of the action that is used when the action ID is not specified in the request.
enableCsrfValidation (opens new window)	boolean (opens new window) – Whether to enable CSRF validation for the actions in this controller.
id (opens new window)	string (opens new window) – The ID of this controller.
layout (opens new window)	null (opens new window), string (opens new window), false (opens new window) – The name of the layout to be applied to this controller's views.
module (opens new window)	yii\base\Module (opens new window) – The module that this controller belongs to.
modules (opens new window)	yii\base\Module (opens new window) – All ancestor modules that this controller is located within.
request	craft\web\Request
response	craft\web\Response
route (opens new window)	string (opens new window) – The route (module ID, controller ID and action ID) of the current request.
uniqueId (opens new window)	string (opens new window) – The controller ID that is prefixed with the module ID (if any).
view	craft\web\View – The view object that can be used to render views or view files
viewPath (opens new window)	string (opens new window) – The directory containing the view files for this controller.

Protected Properties

Property	Description
allowAnonymous	integer (opens new window), boolean (opens new window), integer (opens new window)[], string (opens new window)[] – Whether this controller’s actions can be accessed anonymously.

allowAnonymous

Type

integer (opens new window), boolean (opens new window), integer (opens new window)[], string (opens new window)[]

Default value

[ 'generate-thumb', 'generate-transform', ]

Whether this controller’s actions can be accessed anonymously.

This can be set to any of the following:

• false or self::ALLOW_ANONYMOUS_NEVER (default) – indicates that all controller actions should never be accessed anonymously
• true or self::ALLOW_ANONYMOUS_LIVE – indicates that all controller actions can be accessed anonymously when the system is live
• self::ALLOW_ANONYMOUS_OFFLINE – indicates that all controller actions can be accessed anonymously when the system is offline
• self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE – indicates that all controller actions can be accessed anonymously when the system is live or offline
• An array of action IDs (e.g. ['save-guest-entry', 'edit-guest-entry']) – indicates that the listed action IDs can be accessed anonymously when the system is live
• An array of action ID/bitwise pairs (e.g. ['save-guest-entry' => self::ALLOW_ANONYMOUS_OFFLINE] – indicates that the listed action IDs can be accessed anonymously per the bitwise int assigned to it.

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)
__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.
actionCreateFolder()	Creates a folder.
actionDeleteAsset()	Deletes an asset.
actionDeleteFolder()	Delete a folder.
actionDownloadAsset()	Returns a file’s contents.
actionEditAsset()	Edits an asset.
actionEditImage()	Returns the image being edited.
actionGenerateThumb()	Generates a thumbnail.
actionGenerateTransform()	Generates a transform.
actionImageEditor()	Returns the Image Editor template.
actionIndex()	Displays the Assets index page.
actionMoveAsset()	Move one or more assets.
actionMoveFolder()	Moves a folder.
actionPreviewFile()	Returns file preview info for an asset.
actionPreviewThumb()	Returns an updated preview image for an asset.
actionRenameFolder()	Renames a folder.
actionReplaceFile()	Replaces a file.
actionSaveAsset()	Saves an asset.
actionSaveImage()	Saves an image according to the posted parameters.
actionThumb()	Returns a thumbnail’s contents.
actionUpload()	Handles a file upload.
actions() (opens new window)	Declares external actions for the controller.
afterAction() (opens new window)	This method is invoked right after an action is executed.
asErrorJson()	Responds to the request with a JSON error message.
asJson() (opens new window)	Send data formatted as JSON.
asJsonP()	Sets the response format of the given data as JSONP.
asRaw()	Sets the response format of the given data as RAW.
asXml() (opens new window)	Send data formatted as XML.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
beforeAction()	This method is invoked right before an action is executed.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
bindActionParams() (opens new window)	Binds the parameters to the action.
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.
className() (opens new window)	Returns the fully qualified name of this class.
createAction() (opens new window)	Creates an action based on the given action ID.
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.
findLayoutFile() (opens new window)	Finds the applicable layout file.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getModules() (opens new window)	Returns all ancestor modules of this controller.
getRoute() (opens new window)	Returns the route of the current request.
getUniqueId() (opens new window)	Returns the unique ID of the controller.
getView()	Returns the view object that can be used to render views or view files
getViewPath() (opens new window)	Returns the directory containing view files for this controller.
goBack() (opens new window)	Redirects the browser to the last visited page.
goHome() (opens new window)	Redirects the browser to the home page.
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()	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.
redirect()	Redirects the browser to the specified URL.
redirectToPostedUrl()	Redirects to the URI specified in the POST.
refresh() (opens new window)	Refreshes the current page.
render() (opens new window)	Renders a view and applies layout if available.
renderAjax() (opens new window)	Renders a view in response to an AJAX request.
renderContent() (opens new window)	Renders a static string by applying a layout.
renderFile() (opens new window)	Renders a view file.
renderPartial() (opens new window)	Renders a view without applying layout.
renderTemplate()	Renders a template.
requireAcceptsJson()	Throws a 400 error if the request doesn't accept JSON.
requireAdmin()	Throws a 403 error if the current user is not an admin.
requireAuthorization()	Checks whether the current user can perform a given action, and ends the request with a 403 error if they don’t.
requireCpRequest()	Throws a 400 error if the current request isn’t a control panel request.
requireElevatedSession()	Requires that the user has an elevated session.
requireGuest()	Redirects the user to the account template if they are logged in.
requireLogin()	Redirects the user to the login template if they're not logged in.
requirePermission()	Checks whether the current user has a given permission, and ends the request with a 403 error if they don’t.
requirePostRequest()	Throws a 400 error if this isn’t a POST request
requireSiteRequest()	Throws a 400 error if the current request isn’t a site request.
requireToken()	Throws a 400 error if the current request doesn’t have a valid Craft token.
run() (opens new window)	Runs a request specified in terms of a route.
runAction() (opens new window)	Runs an action within this controller with the specified action ID and parameters.
setFailFlash()	Sets an error flash message on the user session.
setSuccessFlash()	Sets a success flash message on the user session.
setView() (opens new window)	Sets the view object to be used by this controller.
setViewPath() (opens new window)	Sets the directory that contains the view files.
trigger() (opens new window)	Triggers an event.

actionCreateFolder()

Creates a folder.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the parent folder cannot be found

actionDeleteAsset()

Deletes an asset.

View source (opens new window)

Returns

yii\web\Response (opens new window), null (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the folder cannot be found
• yii\web\ForbiddenHttpException (opens new window)
• yii\base\UserException (opens new window)

actionDeleteFolder()

Delete a folder.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the folder cannot be found

actionDownloadAsset()

Returns a file’s contents.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the file to download cannot be found.

actionEditAsset()

Since

3.4.0

Edits an asset.

View source (opens new window)

Arguments

• $assetId (integer (opens new window)) – The asset ID
• $asset (craft\elements\Asset, null (opens new window)) – The asset being edited, if there were any validation errors.
• $site (string (opens new window), null (opens new window)) – The site handle, if specified.

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if $assetId is invalid
• yii\web\ForbiddenHttpException (opens new window)
  if the user isn't permitted to edit the asset

actionEditImage()

Returns the image being edited.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)

actionGenerateThumb()

DEPRECATED

Deprecated in 3.0.13. Use actionThumb() instead.

Generates a thumbnail.

View source (opens new window)

Arguments

• $uid (string (opens new window)) – The asset's UID
• $width (integer (opens new window)) – The thumbnail width
• $height (integer (opens new window)) – The thumbnail height

Returns

yii\web\Response (opens new window)

actionGenerateTransform()

Generates a transform.

View source (opens new window)

Arguments

• $transformId (integer (opens new window), null (opens new window))

Returns

yii\web\Response (opens new window)

Throws

• yii\web\NotFoundHttpException (opens new window)
  if the transform can't be found
• yii\web\ServerErrorHttpException (opens new window)
  if the transform can't be generated

actionImageEditor()

Returns the Image Editor template.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the asset is missing.

actionIndex()

Since

3.8.0

Displays the Assets index page.

View source (opens new window)

Arguments

• $defaultSource

Returns

yii\web\Response (opens new window)

actionMoveAsset()

Move one or more assets.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the asset or the target folder cannot be found

actionMoveFolder()

Moves a folder.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the folder to move, or the destination parent folder, cannot be found

actionPreviewFile()

Returns file preview info for an asset.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if not a valid request

actionPreviewThumb()

Since

3.4.0

Returns an updated preview image for an asset.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)

actionRenameFolder()

Renames a folder.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if the folder cannot be found

actionReplaceFile()

Replaces a file.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if incorrect combination of parameters passed.
• yii\web\NotFoundHttpException (opens new window)
  if the asset can’t be found

actionSaveAsset()

Since

3.4.0

Saves an asset.

View source (opens new window)

Returns

yii\web\Response (opens new window), null (opens new window)

actionSaveImage()

Saves an image according to the posted parameters.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)
  if some parameters are missing.
• Throwable (opens new window)
  if something went wrong saving the asset.

actionThumb()

Since

3.0.13

Returns a thumbnail’s contents.

View source (opens new window)

Arguments

• $uid (string (opens new window)) – The asset's UID
• $width (integer (opens new window)) – The thumbnail width
• $height (integer (opens new window)) – The thumbnail height

Returns

yii\web\Response (opens new window)

actionUpload()

Since

3.4.0

Handles a file upload.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

• yii\web\BadRequestHttpException (opens new window)

Protected Methods

Method	Description
asBrokenImage()	Sends a broken image response based on a given exception.
bindInjectedParams() (opens new window)	Fills parameters based on types and names in action method signature.
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.

asBrokenImage()

Since

3.4.8

Sends a broken image response based on a given exception.

View source (opens new window)

Arguments

• $e (Throwable (opens new window), null (opens new window)) – The exception that was thrown

Returns

yii\web\Response (opens new window)

requirePeerVolumePermissionByAsset()

Since

3.4.8

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

• yii\web\ForbiddenHttpException (opens new window)

requireVolumePermission()

Since

3.4.8

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

• yii\web\ForbiddenHttpException (opens new window)

requireVolumePermissionByAsset()

Since

3.4.8

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)

requireVolumePermissionByFolder()

Since

3.4.8

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

Throws

• yii\web\ForbiddenHttpException (opens new window)

Constants

Constant	Description
ALLOW_ANONYMOUS_LIVE
ALLOW_ANONYMOUS_NEVER
ALLOW_ANONYMOUS_OFFLINE