ChartsController
- Type
- Class
- Namespace
- craft\commerce\controllers
- Inherits
- craft\commerce\controllers\ChartsController » craft\controllers\ElementIndexesController (opens new window) » craft\controllers\BaseElementsController (opens new window) » craft\web\Controller (opens new window) » 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
- 2.0
Class Charts Controller
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| action (opens new window) | yii\base\Action (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. |
| 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 (opens new window) | yii\base\View (opens new window), yii\web\View (opens new window) – The view object that can be used to render views or view files. |
| viewPath (opens new window) | string (opens new window) – The view path that may be prefixed to a relative view name. |
# Protected Properties
# 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) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| actionCountElements() (opens new window) | Returns the total number of elements that match the current criteria. |
| actionCreateExportToken() (opens new window) | Creates an export token. |
| actionExport() (opens new window) | Exports element data. |
| actionGetElements() (opens new window) | Renders and returns an element index container, plus its first batch of elements. |
| actionGetMoreElements() (opens new window) | Renders and returns a subsequent batch of elements for an element index. |
| actionGetRevenueData() | Returns the data needed to display a Revenue chart. |
| actionGetSourceTreeHtml() (opens new window) | Returns the source tree HTML for an element index. |
| actionPerformAction() (opens new window) | Performs an action on one or more selected elements. |
| 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() (opens new window) | Responds to the request with a JSON error message. |
| asJson() (opens new window) | Send data formatted as JSON. |
| asJsonP() (opens new window) | Sets the response format of the given data as JSONP. |
| asRaw() (opens new window) | 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() (opens new window) | 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. |
| getElementQuery() (opens new window) | Returns the element query that’s defining which elements will be returned in the current request. |
| 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() (opens new window) | Returns the view object that can be used to render views or view files. |
| getViewPath() (opens new window) | |
| 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. |
| init() (opens new window) | Initializes the application component. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| redirect() (opens new window) | Redirects the browser to the specified URL. |
| redirectToPostedUrl() (opens new window) | 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() (opens new window) | Renders a template. |
| requireAcceptsJson() (opens new window) | Throws a 400 error if the request doesn't accept JSON. |
| requireAdmin() (opens new window) | Throws a 403 error if the current user is not an admin. |
| requireAuthorization() (opens new window) | Checks whether the current user can perform a given action, and ends the request with a 403 error if they don’t. |
| requireCpRequest() (opens new window) | Throws a 400 error if the current request isn’t a control panel request. |
| requireElevatedSession() (opens new window) | Requires that the user has an elevated session. |
| requireGuest() (opens new window) | Redirects the user to the account template if they are logged in. |
| requireLogin() (opens new window) | Redirects the user to the login template if they're not logged in. |
| requirePermission() (opens new window) | Checks whether the current user has a given permission, and ends the request with a 403 error if they don’t. |
| requirePostRequest() (opens new window) | Throws a 400 error if this isn’t a POST request |
| requireSiteRequest() (opens new window) | Throws a 400 error if the current request isn’t a site request. |
| requireToken() (opens new window) | 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. |
| 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. |
# actionGetRevenueData()
Returns the data needed to display a Revenue chart.
View source (opens new window)
# Protected Methods
| Method | Description |
|---|---|
| actionData() (opens new window) | Returns the data for the available actions. |
| availableActions() (opens new window) | Returns the available actions for the current source. |
| availableExporters() (opens new window) | Returns the available exporters for the current source. |
| context() (opens new window) | Returns the context that this controller is being called in. |
| elementQuery() (opens new window) | Returns the element query based on the current params. |
| elementResponseData() (opens new window) | Returns the element data to be returned to the client. |
| elementType() (opens new window) | Returns the posted element type class. |
| exporterData() (opens new window) | Returns the data for the available exporters. |
| includeActions() (opens new window) | Identify whether index actions should be included in the element index |
| source() (opens new window) | Returns the selected source info. |
| viewState() (opens new window) | Returns the current view state. |
# Constants
| Constant | Description |
|---|---|
ALLOW_ANONYMOUS_LIVE | |
ALLOW_ANONYMOUS_NEVER | |
ALLOW_ANONYMOUS_OFFLINE |