ExampleTemplatesController ​
- Type
- Class
- Namespace
- craft\commerce\console\controllers
- Inherits
- craft\commerce\console\controllers\ExampleTemplatesController » craft\commerce\console\Controller » craft\console\Controller » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable, yii\base\ViewContextInterface
- Uses traits
- craft\console\ControllerTrait
- Since
- 3.3
Console command to build example templates.
Public Properties ​
| Property | Description |
|---|---|
| action | yii\base\Action, null – The action that is currently being executed. |
| baseColor | string, null – The base color for the generated example templates. |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| color | boolean, null – Whether to enable ANSI color in the output. |
| defaultAction | string – The ID of the action that is used when the action ID is not specified in the request. |
| devBuild | boolean – Whether to generate and copy to the example-templates build folder (used by Craft Commerce developers) |
| folderName | string, null – Name of the target folder the templates will be copied to. |
| help | boolean – Whether to display help information about current command. |
| helpSummary | string – The one-line short summary describing this controller. |
| id | string – The ID of this controller. |
| interactive | boolean – Whether to run the command interactively. |
| isolated | – Whether the command should ensure it is only being run once at a time. |
| 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. |
| overwrite | boolean – Whether to overwrite an existing folder. |
| passedOptionValues | array – The properties corresponding to the passed options. |
| passedOptions | array – The names of the options passed during execution. |
| request | craft\console\Request |
| response | yii\base\Response, array, string – The response. |
| route | string – The route (module ID, controller ID and action ID) of the current request. |
| silentExitOnException | boolean, null – If true - script finish with ExitCode::OK in case of exception. |
| uniqueId | string – The controller ID that is prefixed with the module ID (if any). |
| view | yii\base\View, yii\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. |
baseColor ​
The base color for the generated example templates.
defaultAction ​
- Type
- string
- Default value
'generate'
The ID of the action that is used when the action ID is not specified in the request. Defaults to 'index'.
devBuild ​
- Type
- boolean
- Default value
false- Since
- 3.3
Whether to generate and copy to the example-templates build folder (used by Craft Commerce developers)
folderName ​
Name of the target folder the templates will be copied to.
overwrite ​
- Type
- boolean
- Default value
false- Since
- 3.3
Whether to overwrite an existing folder. Must be passed if a folder with that name already exists.
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. |
| actionGenerate() | Generates and copies the example templates. |
| actions() | Declares external actions for the controller. |
| afterAction() | This method is invoked right after an action is executed. |
| ansiFormat() | Formats a string with ANSI codes. |
| 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. |
| confirm() | Asks user to confirm by typing y or n. |
| createAction() | Creates an action based on the given action ID. |
| createDirectory() | Creates a directory, and outputs to the console. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| do() | Performs an action with descriptive output. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| failure() | Outputs a failure message to the console. |
| findLayoutFile() | Finds the applicable layout file. |
| getActionArgsHelp() | Returns the help information for the anonymous arguments for the action. |
| getActionHelp() | Returns the detailed help information for the specified action. |
| getActionHelpSummary() | Returns a one-line short summary describing the specified action. |
| getActionOptionsHelp() | Returns the help information for the options for the action. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getHelp() | Returns help information for this controller. |
| getHelpSummary() | Returns one-line short summary describing this controller. |
| getModules() | Returns all ancestor modules of this controller. |
| getOptionValues() | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. |
| getPassedOptionValues() | Returns the properties corresponding to the passed options. |
| getPassedOptions() | Returns the names of valid options passed during execution. |
| 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. |
| 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. |
| isColorEnabled() | Returns a value indicating whether ANSI color is enabled. |
| markdownToAnsi() | Converts Markdown to be better readable in console environments by applying some ANSI format. |
| note() | Outputs a note to the console. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| optionAliases() | Returns option alias names. |
| options() | Returns the names of valid options for the action (id). |
| passwordPrompt() | Prompts the user for a password and validates it. |
| prompt() | Prompts the user for input and validates it. |
| render() | Renders a view and applies layout if available. |
| renderContent() | Renders a static string by applying a layout. |
| renderFile() | Renders a view file. |
| renderPartial() | Renders a view without applying layout. |
| run() | Runs a request specified in terms of a route. |
| runAction() | Runs an action with the specified action ID and parameters. |
| select() | 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() | Sets the view object to be used by this controller. |
| setViewPath() | Sets the directory that contains the view files. |
| stderr() | Prints a string to STDERR. |
| stdout() | Prints a string to STDOUT. |
| success() | Outputs a success message to the console. |
| table() | Outputs a table via craft\helpers\Console::table(). |
| tip() | Outputs a tip to the console. |
| trigger() | Triggers an event. |
| warning() | Outputs a warning to the console. |
| writeJson() | JSON-encodes a value and writes it to a file. |
| writeToFile() | Writes contents to a file, and outputs to the console. |
actionGenerate() ​
Generates and copies the example templates.
Throws ​
options() ​
Returns the names of valid options for the action (id).
Arguments ​
$actionID(string) – The action ID of the current request.
Returns ​
string[] – The names of the options valid for the action.
Protected Methods ​
| Method | Description |
|---|---|
| bindInjectedParams() | Fills parameters based on types and names in action method signature. |
| checkRootUser() | 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() | Sets yii\console\Controller::$interactive to false if this isn’t a TTY shell. |
| createAttributeValidator() | Creates a function for the validator option of Controller::prompt. |
| defineActions() | Returns an array of custom actions that should be available on the controller. |
| getActionMethodReflection() | |
| outputCommand() | |
| parseDocCommentDetail() | Returns full description from the docblock. |
| parseDocCommentSummary() | Returns the first line of docblock. |
| parseDocCommentTags() | Parses the comment block into tags. |
Constants ​
| Constant | Description |
|---|---|
EXIT_CODE_ERROR | |
EXIT_CODE_NORMAL |