Class craft\console\controllers\InstallController

Inheritance: craft\console\controllers\InstallController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable, yii\base\ViewContextInterface
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/console/controllers/InstallController.php

Craft CMS CLI installer.

Public Properties
Property	Type	Description	Defined By
`$action`	yii\base\Action	The action that is currently being executed.	yii\base\Controller
`$color`	boolean	Whether to enable ANSI color in the output.	yii\console\Controller
`$defaultAction`			craft\console\controllers\InstallController
`$email`	string, null	The default email address for the first user to create during install	craft\console\controllers\InstallController
`$help`	boolean	Whether to display help information about current command.	yii\console\Controller
`$id`	string	The ID of this controller.	yii\base\Controller
`$interactive`	boolean	Whether to run the command interactively.	yii\console\Controller
`$language`	string, null	The default langcode for the first site to create during install	craft\console\controllers\InstallController
`$layout`	null, string, false	The name of the layout to be applied to this controller's views.	yii\base\Controller
`$module`	yii\base\Module	The module that this controller belongs to.	yii\base\Controller
`$password`	string, null	The default password for the first user to create during install	craft\console\controllers\InstallController
`$siteName`	string, null	The default site name for the first site to create during install	craft\console\controllers\InstallController
`$siteUrl`	string, null	The default site url for the first site to create during install	craft\console\controllers\InstallController
`$username`	string, null	The default username for the first user to create during install	craft\console\controllers\InstallController

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`actionCraft()`	Runs the install migration	craft\console\controllers\InstallController
`actionPlugin()`	Installs a plugin	craft\console\controllers\InstallController
`actions()`	Declares external actions for the controller.	yii\base\Controller
`afterAction()`	This method is invoked right after an action is executed.	yii\base\Controller
`ansiFormat()`	Formats a string with ANSI codes.	yii\console\Controller
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`beforeAction()`	This method is invoked right before an action is executed.	yii\base\Controller
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`bindActionParams()`	Binds the parameters to the action.	yii\base\Controller
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`confirm()`	Asks user to confirm by typing y or n.	yii\console\Controller
`createAction()`	Creates an action based on the given action ID.	yii\base\Controller
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`findLayoutFile()`	Finds the applicable layout file.	yii\base\Controller
`getActionArgsHelp()`	Returns the help information for the anonymous arguments for the action.	yii\console\Controller
`getActionHelp()`	Returns the detailed help information for the specified action.	yii\console\Controller
`getActionHelpSummary()`	Returns a one-line short summary describing the specified action.	yii\console\Controller
`getActionOptionsHelp()`	Returns the help information for the options for the action.	yii\console\Controller
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getHelp()`	Returns help information for this controller.	yii\console\Controller
`getHelpSummary()`	Returns one-line short summary describing this controller.	yii\console\Controller
`getModules()`	Returns all ancestor modules of this controller.	yii\base\Controller
`getOptionValues()`	Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.	yii\console\Controller
`getPassedOptionValues()`	Returns the properties corresponding to the passed options.	yii\console\Controller
`getPassedOptions()`	Returns the names of valid options passed during execution.	yii\console\Controller
`getRoute()`	Returns the route of the current request.	yii\base\Controller
`getUniqueId()`	Returns the unique ID of the controller.	yii\base\Controller
`getView()`	Returns the view object that can be used to render views or view files.	yii\base\Controller
`getViewPath()`	Returns the directory containing view files for this controller.	yii\base\Controller
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`isColorEnabled()`	Returns a value indicating whether ANSI color is enabled.	yii\console\Controller
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`on()`	Attaches an event handler to an event.	yii\base\Component
`optionAliases()`	Returns option alias names.	yii\console\Controller
`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.	craft\console\controllers\InstallController
`prompt()`	Prompts the user for input and validates it.	yii\console\Controller
`render()`	Renders a view and applies layout if available.	yii\base\Controller
`renderContent()`	Renders a static string by applying a layout.	yii\base\Controller
`renderFile()`	Renders a view file.	yii\base\Controller
`renderPartial()`	Renders a view without applying layout.	yii\base\Controller
`run()`	Runs a request specified in terms of a route.	yii\base\Controller
`runAction()`	Runs an action within this controller with the specified action ID and parameters.	yii\base\Controller
`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.	yii\console\Controller
`setView()`	Sets the view object to be used by this controller.	yii\base\Controller
`setViewPath()`	Sets the directory that contains the view files.	yii\base\Controller
`stderr()`	Prints a string to STDERR.	yii\console\Controller
`stdout()`	Prints a string to STDOUT.	yii\console\Controller
`trigger()`	Triggers an event.	yii\base\Component
`validateEmail()`		craft\console\controllers\InstallController
`validateLanguage()`		craft\console\controllers\InstallController
`validatePassword()`		craft\console\controllers\InstallController
`validateSiteName()`		craft\console\controllers\InstallController
`validateSiteUrl()`		craft\console\controllers\InstallController
`validateUsername()`		craft\console\controllers\InstallController

Protected Methods
Method	Description	Defined By
`getActionMethodReflection()`		yii\console\Controller
`parseDocCommentDetail()`	Returns full description from the docblock.	yii\console\Controller
`parseDocCommentSummary()`	Returns the first line of docblock.	yii\console\Controller
`parseDocCommentTags()`	Parses the comment block into tags.	yii\console\Controller

Events
Event	Type	Description	Defined By
`EVENT_AFTER_ACTION`	yii\base\ActionEvent	An event raised right after executing a controller action.	yii\base\Controller
`EVENT_BEFORE_ACTION`	yii\base\ActionEvent	An event raised right before executing a controller action.	yii\base\Controller

Constants
Constant	Value	Description	Defined By
`EXIT_CODE_ERROR`	1	Deprecated since 2.0.13. Use \craft\console\controllers\ExitCode::UNSPECIFIED_ERROR instead.	yii\console\Controller
`EXIT_CODE_NORMAL`	0	Deprecated since 2.0.13. Use \craft\console\controllers\ExitCode::OK instead.	yii\console\Controller

Property Details

`$defaultAction` public property #

public  $defaultAction = 'craft'

`$email` public property #

The default email address for the first user to create during install

public string, null $email = null

`$language` public property #

The default langcode for the first site to create during install

public string, null $language = null

`$password` public property #

The default password for the first user to create during install

public string, null $password = null

`$siteName` public property #

The default site name for the first site to create during install

public string, null $siteName = null

`$siteUrl` public property #

The default site url for the first site to create during install

public string, null $siteUrl = null

`$username` public property #

The default username for the first user to create during install

public string, null $username = null

Method Details

`actionCraft()` public method #

Runs the install migration

public void actionCraft ( )

`actionPlugin()` public method #

Installs a plugin

public void actionPlugin ( \craft\console\controllers\string $handle )

$handle string

`options()` public method #

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.

public string[] options ( $actionID )

`$actionID`	string	The action id of the current request
return	string[]	The names of the options valid for the action

`validateEmail()` public method #

public void validateEmail ( \craft\console\controllers\string $value, \craft\console\controllers\string &$error = null )

`$value`
`$error`

`validateLanguage()` public method #

public void validateLanguage ( \craft\console\controllers\string $value, \craft\console\controllers\string &$error = null )

`$value`
`$error`

`validatePassword()` public method #

public void validatePassword ( \craft\console\controllers\string $value, \craft\console\controllers\string &$error = null )

`$value`
`$error`

`validateSiteName()` public method #

public void validateSiteName ( \craft\console\controllers\string $value, \craft\console\controllers\string &$error = null )

`$value`
`$error`

`validateSiteUrl()` public method #

public void validateSiteUrl ( \craft\console\controllers\string $value, \craft\console\controllers\string &$error = null )

`$value`
`$error`

`validateUsername()` public method #

public void validateUsername ( \craft\console\controllers\string $value, \craft\console\controllers\string &$error = null )

`$value`
`$error`

Property Details

$defaultAction public property #

$email public property #

$language public property #

$password public property #

$siteName public property #

$siteUrl public property #

$username public property #

Method Details

actionCraft() public method #

actionPlugin() public method #

options() public method #

validateEmail() public method #

validateLanguage() public method #

validatePassword() public method #

validateSiteName() public method #

validateSiteUrl() public method #

validateUsername() public method #