SetupController

Type: Class
Namespace: craft\console\controllers
Inherits: craft\console\controllers\SetupController » craft\console\Controller » 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
Since: 3.0.0

Craft CMS setup installer.

# 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.
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.
database	string (opens new window), null (opens new window) – The name of the database to select.
defaultAction (opens new window)	string (opens new window) – The ID of the action that is used when the action ID is not specified in the request.
driver	string (opens new window), null (opens new window) – The database driver to use.
help (opens new window)	boolean (opens new window) – Whether to display help information about current command.
helpSummary (opens new window)	string (opens new window)
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)	string (opens new window), null (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.
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.
password	string (opens new window), null (opens new window) – The database password to connect with.
port	integer (opens new window), null (opens new window) – The database server port.
request	craft\console\Request
response (opens new window)	yii\base\Response (opens new window), array (opens new window), string (opens new window) – The response.
route (opens new window)	string (opens new window) – The route (module ID, controller ID and action ID) of the current request.
schema	string (opens new window), null (opens new window) – The schema that Postgres is configured to use by default (PostgreSQL only).
server	string (opens new window), null (opens new window) – The database server name or IP address.
silentExitOnException (opens new window)	boolean (opens new window), null (opens new window) – If true - script finish with `ExitCode::OK` in case of exception.
tablePrefix	string (opens new window), null (opens new window) – The table prefix to add to all database tables.
uniqueId (opens new window)	string (opens new window) – The controller ID that is prefixed with the module ID (if any).
user	string (opens new window), null (opens new window) – The database username to connect with.
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.

# `database`

Type: string (opens new window), null (opens new window)
Default value: null

The name of the database to select.

View source (opens new window)

# `driver`

Type: string (opens new window), null (opens new window)
Default value: null

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

View source (opens new window)

# `password`

Type: string (opens new window), null (opens new window)
Default value: null

The database password to connect with.

View source (opens new window)

# `port`

Type: integer (opens new window), null (opens new window)
Default value: null

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

View source (opens new window)

# `schema`

Type: string (opens new window), null (opens new window)
Default value: null

The schema that Postgres is configured to use by default (PostgreSQL only).

See also https://www.postgresql.org/docs/8.2/static/ddl-schemas.html

View source (opens new window)

# `server`

Type: string (opens new window), null (opens new window)
Default value: null

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

View source (opens new window)

# `tablePrefix`

Type: string (opens new window), null (opens new window)
Default value: null

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

View source (opens new window)

# `user`

Type: string (opens new window), null (opens new window)
Default value: null

The database username to connect with.

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()	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() (opens new window)	Sets a component property to be null.
actionAppId()	Generates a new application ID and saves it in the `.env` file.
actionDb()	Alias for setup/db-creds.
actionDbCacheTable()	Creates a database table for storing DB caches.
actionDbCreds()	Stores new DB connection settings to the `.env` file.
actionIndex()	Sets up all the things.
actionPhpSessionTable()	Creates a database table for storing PHP session information.
actionSecurityKey()	Generates a new security key and saves it in the `.env` file.
actionWelcome()	Called from the `post-create-project-cmd` Composer hook.
actions()	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()	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()	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() (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()	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()	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()	Runs a request specified in terms of a route.
runAction()	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()	Outputs a table via craft\helpers\Console::table().
trigger() (opens new window)	Triggers an event.

# `actionAppId()`

Since: 3.4.25

Generates a new application ID and saves it in the .env file.

View source (opens new window)

Returns

integer (opens new window)

# `actionDb()`

Alias for setup/db-creds.

View source (opens new window)

Returns

integer (opens new window)

# `actionDbCacheTable()`

Since: 3.4.14

Creates a database table for storing DB caches.

View source (opens new window)

Returns

integer (opens new window)

# `actionDbCreds()`

Stores new DB connection settings to the .env file.

View source (opens new window)

Returns

integer (opens new window)

# `actionIndex()`

Sets up all the things.

View source (opens new window)

Returns

integer (opens new window)

# `actionPhpSessionTable()`

Since: 3.4.0

Creates a database table for storing PHP session information.

View source (opens new window)

Returns

integer (opens new window)

# `actionSecurityKey()`

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

View source (opens new window)

Returns

integer (opens new window)

# `actionWelcome()`

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

View source (opens new window)

Returns

integer (opens new window)

# `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.

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()	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 (opens new window) 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() (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`

← ServeController TestsController →

SetupController

# Public Properties

# database

# driver

# password

# port

# schema

# server

# tablePrefix

# user

# Public Methods

# actionAppId()

Returns

# actionDb()

Returns

# actionDbCacheTable()

Returns

# actionDbCreds()

Returns

# actionIndex()

Returns

# actionPhpSessionTable()

Returns

# actionSecurityKey()

Returns

# actionWelcome()

Returns

# options()

Arguments

Returns

# Protected Methods

# Constants

# `database`

# `driver`

# `password`

# `port`

# `schema`

# `server`

# `tablePrefix`

# `user`

# `actionAppId()`

# `actionDb()`

# `actionDbCacheTable()`

# `actionDbCreds()`

# `actionIndex()`

# `actionPhpSessionTable()`

# `actionSecurityKey()`

# `actionWelcome()`

# `options()`