Class craft\console\controllers\SetupController

Inheritance: craft\console\controllers\SetupController » 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/SetupController.php

Craft CMS setup 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
`$database`	string, null	The name of the database to select.	craft\console\controllers\SetupController
`$defaultAction`	string	The ID of the action that is used when the action ID is not specified in the request.	yii\base\Controller
`$driver`	string, null	The database driver to use.	craft\console\controllers\SetupController
`$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
`$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 database password to connect with.	craft\console\controllers\SetupController
`$port`	integer, null	The database server port.	craft\console\controllers\SetupController
`$schema`	string, null	The database schema to use (PostgreSQL only).	craft\console\controllers\SetupController
`$server`	string, null	The database server name or IP address.	craft\console\controllers\SetupController
`$tablePrefix`	string, null	The table prefix to add to all database tables.	craft\console\controllers\SetupController
`$user`	string, null	The database username to connect with.	craft\console\controllers\SetupController

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
`actionDb()`	Alias for setup/db-creds.	craft\console\controllers\SetupController
`actionDbCreds()`	Stores new DB connection settings to the .env file.	craft\console\controllers\SetupController
`actionIndex()`	Sets up all the things.	craft\console\controllers\SetupController
`actionSecurityKey()`	Generates a new security key and saves it in the .env file.	craft\console\controllers\SetupController
`actionWelcome()`	Called from the post-create-project-cmd Composer hook.	craft\console\controllers\SetupController
`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\SetupController
`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

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

`$database` public property #

The name of the database to select.

public string, null $database = null

`$driver` public property #

The database driver to use. Either 'mysql' for MySQL or 'pgsql' for PostgreSQL.

public string, null $driver = null

`$password` public property #

The database password to connect with.

public string, null $password = null

`$port` public property #

The database server port. Defaults to 3306 for MySQL and 5432 for PostgreSQL.

public integer, null $port = 0

`$schema` public property #

The database schema to use (PostgreSQL only).

public string, null $schema = null

`$server` public property #

The database server name or IP address. Usually 'localhost' or '127.0.0.1'.

public string, null $server = null

`$tablePrefix` public property #

The table prefix to add to all database tables. This can be no more than 5 characters, and must be all lowercase.

public string, null $tablePrefix = null

`$user` public property #

The database username to connect with.

public string, null $user = null

Method Details

`actionDb()` public method #

Alias for setup/db-creds.

public void actionDb ( )

`actionDbCreds()` public method #

Stores new DB connection settings to the .env file.

public void actionDbCreds ( )

`actionIndex()` public method #

Sets up all the things.

public void actionIndex ( )

`actionSecurityKey()` public method #

Generates a new security key and saves it in the .env file.

public void actionSecurityKey ( )

`actionWelcome()` public method #

Called from the post-create-project-cmd Composer hook.

public void actionWelcome ( )

`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

Property Details

$database public property #

$driver public property #

$password public property #

$port public property #

$schema public property #

$server public property #

$tablePrefix public property #

$user public property #