Commerce 3 Class Reference

ProductsPreviewController

Type
Class
Namespace
craft\commerce\controllers
Inherits
craft\commerce\controllers\ProductsPreviewController » 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 Products Preview Controller

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 (opens new window) craft\web\Request (opens new window)
response (opens new window) craft\web\Response (opens new window)
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) craft\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 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
true

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.
actionPreviewProduct() Previews a product.
actionSaveProduct() Save a new or existing product.
actionShareProduct() Redirects the client to a URL for viewing a disabled product on the front end.
actionViewSharedProduct() Shows a product/draft/version based on a token.
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.
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) 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() (opens new window) 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() (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.
setFailFlash() (opens new window) Sets an error flash message on the user session.
setSuccessFlash() (opens new window) 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.

# actionPreviewProduct()

Previews a product.

View source (opens new window)

Throws

# actionSaveProduct()

DEPRECATED

Deprecated in 3.4.8. Use craft\commerce\controllers\ProductsController::actionSaveProduct() instead.

Save a new or existing product.

View source (opens new window)

Returns

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

Throws

# actionShareProduct()

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

View source (opens new window)

Arguments

  • $productId (mixed)
  • $siteId (mixed)

Returns

yii\web\Response (opens new window)

Throws

# actionViewSharedProduct()

Shows a product/draft/version based on a token.

View source (opens new window)

Arguments

  • $productId (mixed)
  • $site (mixed)

Returns

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

Throws

# Protected Methods

Method Description
bindInjectedParams() (opens new window) Fills parameters based on types and names in action method signature.
enforceEditProductPermissions()
enforceProductPermissions()

# enforceEditProductPermissions()

Since
3.4.8

View source (opens new window)

Arguments

Throws

# enforceProductPermissions()

DEPRECATED

Deprecated in 3.4.8. Use enforceEditProductPermissions() instead.

View source (opens new window)

Arguments

Throws

# Constants

Constant Description
ALLOW_ANONYMOUS_LIVE
ALLOW_ANONYMOUS_NEVER
ALLOW_ANONYMOUS_OFFLINE

← PromotionsController →