ExampleTemplatesController
- Type
- Class
- Namespace
- craft\commerce\console\controllers
- Inherits
- craft\commerce\console\controllers\ExampleTemplatesController » craft\commerce\console\Controller » craft\console\Controller (opens new window) » yii\console\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)
- Uses traits
- craft\console\ControllerTrait (opens new window)
- Since
- 3.3
Console command to build example templates.
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. |
| baseColor | string (opens new window) – The base color for the generated example templates. |
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| color (opens new window) | boolean (opens new window), null (opens new window) – Whether to enable ANSI color in the output. |
| defaultAction | string (opens new window) – The ID of the action that is used when the action ID is not specified in the request. |
| devBuild | boolean (opens new window) – Whether to generate and copy to the example-templates build folder (used by Craft Commerce developers) |
| folderName | string (opens new window) – Name of the folder the templates will copy into |
| help (opens new window) | boolean (opens new window) – Whether to display help information about current command. |
| helpSummary (opens new window) | string (opens new window) – The one-line short summary describing this controller. |
| id (opens new window) | string (opens new window) – The ID of this controller. |
| interactive (opens new window) | boolean (opens new window) – Whether to run the command interactively. |
| 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. |
| overwrite | boolean (opens new window) – Whether to overwrite an existing folder. |
| passedOptionValues (opens new window) | array (opens new window) – The properties corresponding to the passed options. |
| passedOptions (opens new window) | array (opens new window) – The names of the options passed during execution. |
| request | \craft\commerce\console\Request |
| response (opens new window) | yii\console\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. |
| silentExitOnException (opens new window) | boolean (opens new window), null (opens new window) – If true - script finish with ExitCode::OK in case of exception. |
| uniqueId (opens new window) | string (opens new window) – The controller ID that is prefixed with the module ID (if any). |
| useHtmx | boolean (opens new window) – Whether to use HTMX |
| 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 directory containing the view files for this controller. |
# baseColor
- Type
- string (opens new window)
- Default value
null
The base color for the generated example templates. Possible values are: red, yellow, green, blue, indigo, purple, or pink.
View source (opens new window)
# defaultAction
- Type
- string (opens new window)
- Default value
'generate'
The ID of the action that is used when the action ID is not specified in the request. Defaults to 'index'.
View source (opens new window)
# devBuild
- Type
- boolean (opens new window)
- Default value
false- Since
- 3.3
Whether to generate and copy to the example-templates build folder (used by Craft Commerce developers)
View source (opens new window)
# folderName
- Type
- string (opens new window)
- Default value
null- Since
- 3.3
Name of the folder the templates will copy into
View source (opens new window)
# overwrite
- Type
- boolean (opens new window)
- Default value
false- Since
- 3.3
Whether to overwrite an existing folder. Must be passed if a folder with that name already exists.
View source (opens new window)
# useHtmx
- Type
- boolean (opens new window)
- Default value
null- Since
- 3.3
Whether to use HTMX
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. |
| actionGenerate() | Generate and copy the example templates. |
| actions() (opens new window) | Declares external actions for the controller. |
| afterAction() (opens new window) | This method is invoked right after an action is executed. |
| ansiFormat() (opens new window) | Formats a string with ANSI codes. |
| 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. |
| confirm() (opens new window) | Asks user to confirm by typing y or n. |
| 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. |
| getActionArgsHelp() (opens new window) | Returns the help information for the anonymous arguments for the action. |
| getActionHelp() (opens new window) | Returns the detailed help information for the specified action. |
| getActionHelpSummary() (opens new window) | Returns a one-line short summary describing the specified action. |
| getActionOptionsHelp() (opens new window) | Returns the help information for the options for the action. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getHelp() (opens new window) | Returns help information for this controller. |
| getHelpSummary() (opens new window) | Returns one-line short summary describing this controller. |
| getModules() (opens new window) | Returns all ancestor modules of this controller. |
| getOptionValues() (opens new window) | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. |
| getPassedOptionValues() (opens new window) | Returns the properties corresponding to the passed options. |
| getPassedOptions() (opens new window) | Returns the names of valid options passed during execution. |
| 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. |
| 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. |
| isColorEnabled() (opens new window) | Returns a value indicating whether ANSI color is enabled. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| optionAliases() (opens new window) | Returns option alias names. |
| options() | Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. |
| passwordPrompt() (opens new window) | Prompts the user for a password and validates it. |
| prompt() (opens new window) | Prompts the user for input and validates it. |
| render() (opens new window) | Renders a view and applies layout if available. |
| 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. |
| run() (opens new window) | Runs a request specified in terms of a route. |
| runAction() (opens new window) | Runs an action with the specified action ID and parameters. |
| select() (opens new window) | Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. |
| 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. |
| stderr() (opens new window) | Prints a string to STDERR. |
| stdout() (opens new window) | Prints a string to STDOUT. |
| table() (opens new window) | Outputs a table via craft\helpers\Console::table() (opens new window). |
| trigger() (opens new window) | Triggers an event. |
# actionGenerate()
Generate and copy the example templates.
View source (opens new window)
Returns
# options()
Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.
Child classes may override this method to specify possible options.
Note that the values setting via options are not available until beforeAction() (opens new window) is being called.
View source (opens new window)
Arguments
$actionID(string (opens new window)) – The action id of the current request
Returns
string (opens new window)[] – The names of the options valid for the action
# Protected Methods
| Method | Description |
|---|---|
| bindInjectedParams() (opens new window) | Fills parameters based on types and names in action method signature. |
| checkRootUser() (opens new window) | Returns whether a command should be executed depending on whether it's being run as a root user, and whether they're OK with that. |
| checkTty() (opens new window) | Sets yii\console\Controller::$interactive (opens new window) to false if this isn’t a TTY shell. |
| createAttributeValidator() (opens new window) | Creates a function for the validator option of Controller::prompt. |
| defineActions() (opens new window) | Returns an array of custom actions that should be available on the controller. |
| getActionMethodReflection() (opens new window) | |
| outputCommand() (opens new window) | |
| parseDocCommentDetail() (opens new window) | Returns full description from the docblock. |
| parseDocCommentSummary() (opens new window) | Returns the first line of docblock. |
| parseDocCommentTags() (opens new window) | Parses the comment block into tags. |
# Constants
| Constant | Description |
|---|---|
EXIT_CODE_ERROR | |
EXIT_CODE_NORMAL |