CategoriesController

Type

Class

Namespace

craft\controllers

Inherits

craft\controllers\CategoriesController » 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.0

The CategoriesController class is a controller that handles various actions related to categories and category groups, such as creating, editing and deleting them.

Note that all actions in the controller require an authenticated Craft session via allowAnonymous.

View source

Public Properties

Property	Description
action	yii\base\Action, null – 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	string, null, 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.
request	craft\web\Request
response	craft\web\Response
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	craft\web\View – The view object that can be used to render views or view files
viewPath	string – The directory containing the view files for this controller.

Protected Properties

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

allowAnonymous

Type

integer, boolean, integer[], string[]

Default value

[ 'view-shared-category', ]

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

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()
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
actionCategoryIndex()	Displays the category index page.
actionDeleteCategory()	Deletes a category.
actionDeleteCategoryGroup()	Deletes a category group.
actionEditCategory()	Displays the category edit page.
actionEditCategoryGroup()	Edit a category group.
actionGroupIndex()	Category groups index.
actionPreviewCategory()	Previews a category.
actionSaveCategory()	Saves an category.
actionSaveGroup()	Save a category group.
actionShareCategory()	Redirects the client to a URL for viewing a disabled category on the front end.
actionViewSharedCategory()	Shows an category/draft/version based on a token.
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()	Returns the directory containing view files for this controller.
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 for this component.
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.
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()	Runs a request specified in terms of a route.
runAction()	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()	Sets the view object to be used by this controller.
setViewPath()	Sets the directory that contains the view files.
trigger()	Triggers an event.

actionCategoryIndex()

Displays the category index page.

View source

Arguments

• $groupHandle (string, null) – The category group’s handle.

Returns

yii\web\Response

Throws

• yii\web\ForbiddenHttpException
  if the user is not permitted to edit categories

actionDeleteCategory()

Deletes a category.

View source

Returns

yii\web\Response, null

Throws

• yii\web\NotFoundHttpException
  if the requested category cannot be found

actionDeleteCategoryGroup()

Deletes a category group.

View source

Returns

yii\web\Response

actionEditCategory()

Displays the category edit page.

View source

Arguments

• $groupHandle (string) – The category group’s handle.
• $categoryId (integer, null) – The category’s ID, if editing an existing category.
• $category (craft\elements\Category, null) – The category being edited, if there were any validation errors.
• $site (string, null) – The site handle, if specified.

Returns

yii\web\Response

Throws

• yii\web\NotFoundHttpException
  if the requested site handle is invalid

actionEditCategoryGroup()

Edit a category group.

View source

Arguments

• $groupId (integer, null) – The category group’s ID, if editing an existing group.
• $categoryGroup (craft\models\CategoryGroup, null) – The category group being edited, if there were any validation errors.

Returns

yii\web\Response

Throws

• yii\web\NotFoundHttpException
  if the requested category group cannot be found

actionGroupIndex()

Category groups index.

View source

Returns

yii\web\Response

actionPreviewCategory()

Previews a category.

View source

Returns

yii\web\Response

actionSaveCategory()

Saves an category.

View source

Returns

yii\web\Response, null

Throws

• yii\web\ServerErrorHttpException

actionSaveGroup()

Save a category group.

View source

Returns

yii\web\Response, null

Throws

• yii\web\BadRequestHttpException

actionShareCategory()

Redirects the client to a URL for viewing a disabled category on the front end.

View source

Arguments

• $categoryId (integer)
• $siteId (integer, null)

Returns

yii\web\Response

Throws

• yii\base\Exception
• yii\web\NotFoundHttpException
  if the requested category cannot be found
• yii\web\ServerErrorHttpException
  if the category group is not configured properly

actionViewSharedCategory()

Shows an category/draft/version based on a token.

View source

Arguments

• $categoryId (integer)
• $siteId (integer, null)

Returns

yii\web\Response

Throws

• yii\web\NotFoundHttpException
  if the requested category cannot be found

Protected Methods

Method	Description
bindInjectedParams()	Fills parameters based on types and names in action method signature.

Constants

Constant	Description
ALLOW_ANONYMOUS_LIVE
ALLOW_ANONYMOUS_NEVER
ALLOW_ANONYMOUS_OFFLINE

Events

EVENT_PREVIEW_CATEGORY

Type

craft\events\ElementEvent

The event that is triggered when a category’s template is rendered for Live Preview.

---