OffController ​
- Type
- Class
- Namespace
- craft\console\controllers
- Inherits
- craft\console\controllers\OffController » craft\console\controllers\BaseSystemStatusController » 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.5.7
Takes the system offline.
Public Properties ​
| Property | Description |
|---|---|
| action | yii\base\Action, null – The action that is currently being executed. |
| 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. |
| help | boolean – Whether to display help information about current command. |
| helpSummary | string |
| id | string – The ID of this controller. |
| interactive | boolean – Whether to run the command interactively. |
| 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. |
| 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. |
| retry | integer, null – Number of seconds the Retry-After HTTP header should be set to for 503 responses. |
| 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. |
retry ​
Number of seconds the Retry-After HTTP header should be set to for 503 responses.
The retryDuration config setting can be used to configure a system-wide Retry-After header.
WARNING
The isSystemLive config setting takes precedence over the system.live project config value, so if config/general.php sets isSystemLive to true or false these on/off commands error out.
Example
Running the following takes the system offline and returns 503 responses until it’s switched on again:
$ php craft off --retry=60
The system is now offline.
The retry duration is now set to 60.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. |
| actionIndex() | Disables system.live project config value—bypassing any allowAdminChanges config setting restrictions—meant for temporary use during the deployment process. |
| 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. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| 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. |
| 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) An option requires the existence of a public member variable whose name is the option name. |
| 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. |
| table() | Outputs a table via craft\helpers\Console::table(). |
| trigger() | Triggers an event. |
actionIndex() ​
Disables system.live project config value—bypassing any allowAdminChanges config setting restrictions—meant for temporary use during the deployment process.
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() is being called.
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. |
| set() | Sets a value in the project config. |
Constants ​
| Constant | Description |
|---|---|
EXIT_CODE_ERROR | |
EXIT_CODE_NORMAL |