Class craft\controllers\SitesController

Inheritance: craft\controllers\SitesController » craft\web\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable, yii\base\ViewContextInterface
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/controllers/SitesController.php

The SitesController 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.

Public Properties
Property	Type	Description	Defined By
`$action`	yii\base\Action	The action that is currently being executed.	yii\base\Controller
`$actionParams`	array	The parameters bound to the current action.	yii\web\Controller
`$defaultAction`	string	The ID of the action that is used when the action ID is not specified in the request.	yii\base\Controller
`$enableCsrfValidation`	boolean	Whether to enable CSRF validation for the actions in this controller.	yii\web\Controller
`$id`	string	The ID of this controller.	yii\base\Controller
`$layout`	null, string, false	The name of the layout to be applied to this controller's views.	yii\base\Controller
`$module`	yii\base\Module	The module that this controller belongs to.	yii\base\Controller

Protected Properties
Property	Type	Description	Defined By
`$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.	craft\web\Controller

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`actionDeleteGroup()`	Deletes a site group.	craft\controllers\SitesController
`actionDeleteSite()`	Deletes a site.	craft\controllers\SitesController
`actionEditSite()`	Edit a category group.	craft\controllers\SitesController
`actionReorderSites()`	Reorders sites.	craft\controllers\SitesController
`actionSaveGroup()`	Saves a site group.	craft\controllers\SitesController
`actionSaveSite()`	Saves a site.	craft\controllers\SitesController
`actionSettingsIndex()`	Site settings index.	craft\controllers\SitesController
`actions()`	Declares external actions for the controller.	yii\base\Controller
`afterAction()`	This method is invoked right after an action is executed.	yii\base\Controller
`asErrorJson()`	Responds to the request with a JSON error message.	craft\web\Controller
`asJson()`	Send data formatted as JSON.	yii\web\Controller
`asJsonP()`	Sets the response format of the given data as JSONP.	craft\web\Controller
`asRaw()`	Sets the response format of the given data as RAW.	craft\web\Controller
`asXml()`	Send data formatted as XML.	yii\web\Controller
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`beforeAction()`	{@inheritdoc}	craft\web\Controller
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`bindActionParams()`	Binds the parameters to the action.	yii\base\Controller
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`createAction()`	Creates an action based on the given action ID.	yii\base\Controller
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`findLayoutFile()`	Finds the applicable layout file.	yii\base\Controller
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getModules()`	Returns all ancestor modules of this controller.	yii\base\Controller
`getRoute()`	Returns the route of the current request.	yii\base\Controller
`getUniqueId()`	Returns the unique ID of the controller.	yii\base\Controller
`getView()`	Returns the view object that can be used to render views or view files.	yii\base\Controller
`getViewPath()`		yii\base\ViewContextInterface
`goBack()`	Redirects the browser to the last visited page.	yii\web\Controller
`goHome()`	Redirects the browser to the home page.	yii\web\Controller
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	craft\controllers\SitesController
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`on()`	Attaches an event handler to an event.	yii\base\Component
`redirect()`	Redirects the browser to the specified URL.	craft\web\Controller
`redirectToPostedUrl()`	Redirects to the URI specified in the POST.	craft\web\Controller
`refresh()`	Refreshes the current page.	yii\web\Controller
`render()`	Renders a view and applies layout if available.	yii\base\Controller
`renderAjax()`	Renders a view in response to an AJAX request.	yii\web\Controller
`renderContent()`	Renders a static string by applying a layout.	yii\base\Controller
`renderFile()`	Renders a view file.	yii\base\Controller
`renderPartial()`	Renders a view without applying layout.	yii\base\Controller
`renderTemplate()`	Renders a template.	craft\web\Controller
`requireAcceptsJson()`	Throws a 400 error if the request doesn't accept JSON.	craft\web\Controller
`requireAdmin()`	Throws a 403 error if the current user is not an admin.	craft\web\Controller
`requireAuthorization()`	Checks whether the current user can perform a given action, and ends the request with a 403 error if they don’t.	craft\web\Controller
`requireElevatedSession()`	Requires that the user has an elevated session.	craft\web\Controller
`requireLogin()`	Redirects the user to the login template if they're not logged in.	craft\web\Controller
`requirePermission()`	Checks whether the current user has a given permission, and ends the request with a 403 error if they don’t.	craft\web\Controller
`requirePostRequest()`	Throws a 400 error if this isn’t a POST request	craft\web\Controller
`requireToken()`	Throws a 400 error if the current request doesn’t have a valid token.	craft\web\Controller
`run()`	Runs a request specified in terms of a route.	yii\base\Controller
`runAction()`	Runs an action within this controller with the specified action ID and parameters.	craft\web\Controller
`setView()`	Sets the view object to be used by this controller.	yii\base\Controller
`setViewPath()`	Sets the directory that contains the view files.	yii\base\Controller
`trigger()`	Triggers an event.	yii\base\Component

Events
Event	Type	Description	Defined By
`EVENT_AFTER_ACTION`	yii\base\ActionEvent	An event raised right after executing a controller action.	yii\base\Controller
`EVENT_BEFORE_ACTION`	yii\base\ActionEvent	An event raised right before executing a controller action.	yii\base\Controller

Method Details

`actionDeleteGroup()` public method #

Deletes a site group.

public yii\web\Response actionDeleteGroup ( )

`actionDeleteSite()` public method #

Deletes a site.

public yii\web\Response actionDeleteSite ( )

`actionEditSite()` public method #

Edit a category group.

public yii\web\Response actionEditSite ( \craft\controllers\int $siteId = null, craft\models\Site $site = null, \craft\controllers\int $groupId = null )

`$siteId`	integer, null	The site’s ID, if editing an existing site
`$site`	craft\models\Site, null	The site being edited, if there were any validation errors
`$groupId`	integer, null	The default group ID that the site should be saved in
throws	yii\web\NotFoundHttpException	if the requested site cannot be found
throws	yii\web\ServerErrorHttpException	if no site groups exist

`actionReorderSites()` public method #

Reorders sites.

public yii\web\Response actionReorderSites ( )

`actionSaveGroup()` public method #

Saves a site group.

public yii\web\Response actionSaveGroup ( )

`actionSaveSite()` public method #

Saves a site.

public yii\web\Response, null actionSaveSite ( )

`actionSettingsIndex()` public method #

Site settings index.

public yii\web\Response actionSettingsIndex ( \craft\controllers\int $groupId = null )

`$groupId`	integer, null
throws	yii\web\NotFoundHttpException	if $groupId is invalid

`init()` public method #

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

Method Details

actionDeleteGroup() public method #

actionDeleteSite() public method #

actionEditSite() public method #

actionReorderSites() public method #

actionSaveGroup() public method #

actionSaveSite() public method #

actionSettingsIndex() public method #

init() public method #