AssetsController
- Type
- Class
- Namespace
- craft\controllers
- Inherits
- craft\controllers\AssetsController » craft\web\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable, yii\base\ViewContextInterface
- Since
- 3.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.
Public Properties
| Property | Description |
|---|---|
| $action | yii\base\Action – The action that is currently being executed. |
| $actionParams | array – The parameters bound to the current action. |
| $behaviors | yii\base\Behavior – List of behaviors attached to this component |
| $defaultAction | string – The ID of the action that is used when the action ID is not specified in the request. |
| $enableCsrfValidation | boolean – Whether to enable CSRF validation for the actions in this controller. |
| $id | string – The ID of this controller. |
| $layout | null, string, false – The name of the layout to be applied to this controller's views. |
| $module | yii\base\Module – The module that this controller belongs to. |
| $modules | yii\base\Module – All ancestor modules that this controller is located within. |
| $route | string – The route (module ID, controller ID and action ID) of the current request. |
| $uniqueId | string – The controller ID that is prefixed with the module ID (if any). |
| $view | yii\base\View, yii\web\View – The view object that can be used to render views or view files. |
| $viewPath | string – The view path that may be prefixed to a relative view name. |
Protected Properties
| Property | Description |
|---|---|
| $allowAnonymous | boolean, string[] – Whether this controller’s actions can be accessed anonymously If set to false, you are required to be logged in to execute any of the given controller's actions. |
$allowAnonymous
Whether this controller’s actions can be accessed anonymously If set to false, you are required to be logged in to execute any of the given controller's actions. If set to true, anonymous access is allowed for all of the given controller's actions. If the value is an array of action IDs, then you must be logged in for any actions except for the ones in the array list. If you have a controller that where the majority of actions allow anonymous access, but you only want require login on a few, you can set this to true and call requireLogin() in the individual methods.
Signature
protected boolean, string[] $allowAnonymous = ['generate-thumb', 'generate-transform']
Public Methods
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __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. |
| actionCreateFolder() | Create a folder. |
| actionDeleteAsset() | Delete an Asset. |
| actionDeleteFolder() | Delete a folder. |
| actionDownloadAsset() | Download a file. |
| actionEditImage() | Get the image being edited. |
| actionGenerateThumb() | Generates a thumbnail. |
| actionGenerateTransform() | Generate a transform. |
| actionImageEditor() | Return the image editor template. |
| actionMoveAsset() | Move an Asset or multiple Assets. |
| actionMoveFolder() | Move a folder. |
| actionPreviewFile() | Return the file preview for an Asset. |
| actionRenameFolder() | Rename a folder |
| actionReplaceFile() | Replace a file |
| actionSaveAsset() | Upload a file |
| actionSaveImage() | Save an image according to posted parameters. |
| actionThumb() | Returns an asset’s thumbnail. |
| actions() | Declares external actions for the controller. |
| afterAction() | This method is invoked right after an action is executed. |
| asErrorJson() | Responds to the request with a JSON error message. |
| asJson() | 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() | Send data formatted as XML. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| beforeAction() | This method is invoked right before an action is executed. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| bindActionParams() | Binds the parameters to the action. |
| 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. |
| createAction() | Creates an action based on the given action ID. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| findLayoutFile() | Finds the applicable layout file. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getModules() | Returns all ancestor modules of this controller. |
| getRoute() | Returns the route of the current request. |
| getUniqueId() | Returns the unique ID of the controller. |
| getView() | Returns the view object that can be used to render views or view files. |
| getViewPath() | |
| goBack() | Redirects the browser to the last visited page. |
| goHome() | Redirects the browser to the home page. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | 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() | Refreshes the current page. |
| render() | Renders a view and applies layout if available. |
| renderAjax() | Renders a view in response to an AJAX request. |
| renderContent() | Renders a static string by applying a layout. |
| renderFile() | Renders a view file. |
| renderPartial() | 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. |
| requireElevatedSession() | Requires that the user has an elevated session. |
| 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 |
| requireToken() | Throws a 400 error if the current request doesn’t have a valid token. |
| run() | Runs a request specified in terms of a route. |
| runAction() | Runs an action within this controller with the specified action ID and parameters. |
| setView() | Sets the view object to be used by this controller. |
| setViewPath() | Sets the directory that contains the view files. |
| trigger() | Triggers an event. |
actionCreateFolder()
Signature
public yii\web\Response actionCreateFolder ( )
actionDeleteAsset()
Signature
public yii\web\Response actionDeleteAsset ( )
actionDeleteFolder()
Signature
public yii\web\Response actionDeleteFolder ( )
actionDownloadAsset()
Download a file.
Returns
Throws
- yii\web\BadRequestHttpException
if the file to download cannot be found.
Signature
public yii\web\Response actionDownloadAsset ( )
actionEditImage()
Signature
public yii\web\Response actionEditImage ( )
actionGenerateThumb()
Signature
public yii\web\Response actionGenerateThumb ( \craft\controllers\string $uid, \craft\controllers\int $width, \craft\controllers\int $height )
actionGenerateTransform()
Generate a transform.
Arguments
Returns
Throws
- yii\web\NotFoundHttpException
if the transform can't be found
Signature
public yii\web\Response actionGenerateTransform ( \craft\controllers\int $transformId = null )
actionImageEditor()
Return the image editor template.
Returns
Throws
- yii\web\BadRequestHttpException
if the Asset is missing.
Signature
public yii\web\Response actionImageEditor ( )
actionMoveAsset()
Move an Asset or multiple Assets.
Returns
Throws
- yii\web\BadRequestHttpException
if the asset or the target folder cannot be found
Signature
public yii\web\Response actionMoveAsset ( )
actionMoveFolder()
Move a folder.
Returns
Throws
- yii\web\BadRequestHttpException
if the folder to move, or the destination parent folder, cannot be found
Signature
public yii\web\Response actionMoveFolder ( )
actionPreviewFile()
Return the file preview for an Asset.
Returns
Throws
- yii\web\BadRequestHttpException
if not a valid request
Signature
public yii\web\Response actionPreviewFile ( )
actionRenameFolder()
Signature
public yii\web\Response actionRenameFolder ( )
actionReplaceFile()
Replace a file
Returns
Throws
- yii\web\BadRequestHttpException
if incorrect combination of parameters passed. - yii\web\NotFoundHttpException
if Asset cannot be found by id.
Signature
public yii\web\Response actionReplaceFile ( )
actionSaveAsset()
Signature
public yii\web\Response actionSaveAsset ( )
actionSaveImage()
Save an image according to posted parameters.
Returns
Throws
- yii\web\BadRequestHttpException
if some parameters are missing. - Throwable
if something went wrong saving the Asset.
Signature
public yii\web\Response actionSaveImage ( )
actionThumb()
- Since
- 3.0.13
Returns an asset’s thumbnail.
Arguments
Returns
Signature
public yii\web\Response actionThumb ( \craft\controllers\string $uid, \craft\controllers\int $width, \craft\controllers\int $height )