Application
- Type
- Class
- Namespace
- craft\console
- Inherits
- craft\console\Application » yii\console\Application (opens new window) » yii\base\Application (opens new window) » yii\base\Module (opens new window) » yii\di\ServiceLocator (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Uses traits
- craft\base\ApplicationTrait
- Since
- 3.0.0
Craft Console Application class
An instance of the Console Application class is globally accessible to console requests in Craft via \Craft::$app.
View source (opens new window)
# Public Properties
# request
- Type
- craft\console\Request
- Default value
null
The request component
View source (opens new window)
# session
- Default value
null- Access
- Read-only
View source (opens new window)
# user
- Type
- craft\console\User
- Default value
null
The user component
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) | Constructor. |
| __get() (opens new window) | Getter magic method. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| afterAction() (opens new window) | This method is invoked right after an action within this module is executed. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| beforeAction() (opens new window) | This method is invoked right before an action within this module is executed. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| bootstrap() | Initializes extensions and executes bootstrap components. |
| 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. |
| clear() (opens new window) | Removes the component from the locator. |
| coreCommands() | Returns the configuration of the built-in commands. |
| coreComponents() (opens new window) | Returns the configuration of core application components. |
| createController() (opens new window) | Creates a controller instance based on the given route. |
| createControllerByID() (opens new window) | Creates a controller based on the given controller ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| disableMaintenanceMode() | Disables Maintenance Mode. |
| enableMaintenanceMode() | Enables Maintenance Mode. |
| end() (opens new window) | Terminates the application. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| get() | Returns the component instance with the specified ID. |
| getAnnouncements() | Returns the announcements service. |
| getApi() | Returns the API service. |
| getAssetIndexer() | Returns the asset indexing service. |
| getAssetManager() | Returns the asset manager component. |
| getAssetTransforms() | Returns the asset transforms service. |
| getAssets() | Returns the assets service. |
| getAuthManager() (opens new window) | Returns the auth manager for this application. |
| getBasePath() (opens new window) | Returns the root directory of the module. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getCache() (opens new window) | Returns the cache component. |
| getCanTestEditions() | Returns whether Craft is running on a domain that is eligible to test out the editions. |
| getCanUpgradeEdition() | Returns whether Craft is eligible to be upgraded to a different edition. |
| getCategories() | Returns the categories service. |
| getComponents() (opens new window) | Returns the list of the component definitions or the loaded component instances. |
| getComposer() | Returns the Composer service. |
| getConfig() | Returns the config service. |
| getContent() | Returns the content service. |
| getContentMigrator() | Returns the content migration manager. |
| getControllerPath() (opens new window) | Returns the directory that contains the controller classes according to controllerNamespace (opens new window). |
| getDashboard() | Returns the dashboard service. |
| getDb() | Returns the database connection component. |
| getDeprecator() | Returns the deprecator service. |
| getDrafts() | Returns the drafts service. |
| getEdition() | Returns the Craft edition. |
| getEditionHandle() | Returns the handle of the Craft edition. |
| getEditionName() | Returns the name of the Craft edition. |
| getElementIndexes() | Returns the element indexes service. |
| getElements() | Returns the elements service. |
| getEntries() | Returns the entries service. |
| getEntryRevisions() | Returns the entry revisions service. |
| getErrorHandler() (opens new window) | Returns the error handler component. |
| getFeeds() | Returns the feeds service. |
| getFields() | Returns the fields service. |
| getFormatter() | Returns the formatter component. |
| getFormattingLocale() | Returns the locale that should be used to define the formatter. |
| getGc() | Returns the garbage collection service. |
| getGlobals() | Returns the globals service. |
| getGql() | Returns the GraphQL service. |
| getHasWrongEdition() | Returns whether Craft is running with the wrong edition. |
| getI18n() | Returns the internationalization (i18n) component. |
| getImages() | Returns the images service. |
| getInfo() | Returns the info model, or just a particular attribute. |
| getInstalledSchemaVersion() | Returns the installed schema version. |
| getInstance() (opens new window) | Returns the currently requested instance of this module class. |
| getIsInMaintenanceMode() | Returns whether someone is currently performing a system update. |
| getIsInitialized() | Returns whether Craft has been fully initialized. |
| getIsInstalled() | Returns whether Craft is installed. |
| getIsLive() | Returns whether the system is currently live. |
| getIsMultiSite() | Returns whether this Craft install has multiple sites. |
| getIsSystemOn() | Returns whether the system is currently live. |
| getLayoutPath() (opens new window) | Returns the directory that contains layout view files for this module. |
| getLicensedEdition() | Returns the edition Craft is actually licensed to run in. |
| getLicensedEditionName() | Returns the name of the edition Craft is actually licensed to run in. |
| getLocale() | Returns a Locale object for the target language. |
| getLog() (opens new window) | Returns the log dispatcher component. |
| getMailer() | Returns the current mailer. |
| getMatrix() | Returns the matrix service. |
| getMigrator() | Returns the application’s migration manager. |
| getModule() (opens new window) | Retrieves the child module of the specified ID. |
| getModules() (opens new window) | Returns the sub-modules in this module. |
| getMutex() | Returns the application’s mutex service. |
| getPath() | Returns the path service. |
| getPluginStore() | Returns the plugin store service. |
| getPlugins() | Returns the plugins service. |
| getProjectConfig() | Returns the system config service. |
| getQueue() | Returns the queue service. |
| getRelations() | Returns the relations service. |
| getRequest() | Returns the request component. |
| getResponse() | Returns the response component. |
| getRevisions() | Returns the revisions service. |
| getRoutes() | Returns the routes service. |
| getRuntimePath() (opens new window) | Returns the directory that stores runtime files. |
| getSearch() | Returns the search service. |
| getSections() | Returns the sections service. |
| getSecurity() | Returns the security component. |
| getSession() | |
| getSites() | Returns the sites service. |
| getStructures() | Returns the structures service. |
| getSystemMessages() | Returns the system email messages service. |
| getSystemName() | Returns the system name. |
| getSystemSettings() | Returns the system settings service. |
| getSystemUid() | Returns the system's UID. |
| getTags() | Returns the tags service. |
| getTargetLanguage() | Returns the target app language. |
| getTemplateCaches() | Returns the template cache service. |
| getTimeZone() (opens new window) | Returns the time zone used by this application. |
| getTokens() | Returns the tokens service. |
| getUniqueId() (opens new window) | Returns an ID that uniquely identifies this module among all modules within the current application. |
| getUpdates() | Returns the updates service. |
| getUrlManager() (opens new window) | Returns the URL manager for this application. |
| getUser() | Returns the user component. |
| getUserGroups() | Returns the user groups service. |
| getUserPermissions() | Returns the user permissions service. |
| getUsers() | Returns the users service. |
| getUtilities() | Returns the utilities service. |
| getVendorPath() (opens new window) | Returns the directory that stores vendor files. |
| getVersion() (opens new window) | Returns current module version. |
| getView() | Returns the view component. |
| getViewPath() (opens new window) | Returns the directory that contains the view files for this module. |
| getVolumes() | Returns the volumes service. |
| getWebpack() | Returns the webpack service. |
| getYiiVersion() | Returns the Yii framework version. |
| handleRequest() | Handles the specified request. |
| has() (opens new window) | Returns a value indicating whether the locator has the specified component definition or has instantiated the component. |
| 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. |
| hasModule() (opens new window) | Checks whether the child module of the specified ID exists. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the console app by creating the command runner. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| preInit() (opens new window) | Pre-initializes the application. |
| requireEdition() | Requires that Craft is running an equal or better edition than what's passed in |
| run() (opens new window) | Runs the application. |
| runAction() | Runs a controller action specified by a route. |
| saveInfo() | Updates the info row. |
| saveInfoAfterRequest() | Updates the info row at the end of the request. |
| set() (opens new window) | Registers a component definition with this locator. |
| setAliases() (opens new window) | Defines path aliases. |
| setBasePath() (opens new window) | Sets the root directory of the application and the @app alias. |
| setComponents() (opens new window) | Registers a set of component definitions in this locator. |
| setContainer() (opens new window) | Configures Yii::$container with the $config. |
| setControllerPath() (opens new window) | Sets the directory that contains the controller classes. |
| setEdition() | Sets the Craft edition. |
| setInstance() (opens new window) | Sets the currently requested instance of this module class. |
| setIsInstalled() | Sets Craft's record of whether it's installed |
| setLayoutPath() (opens new window) | Sets the directory that contains the layout files. |
| setModule() (opens new window) | Adds a sub-module to this module. |
| setModules() (opens new window) | Registers sub-modules in the current module. |
| setRuntimePath() (opens new window) | Sets the directory that stores runtime files. |
| setTimeZone() | Sets the time zone used by this application. |
| setVendorPath() (opens new window) | Sets the directory that stores vendor files. |
| setVersion() (opens new window) | Sets current module version. |
| setViewPath() (opens new window) | Sets the directory that contains the view files. |
| trigger() (opens new window) | Triggers an event. |
| updateTargetLanguage() | Sets the target application language. |
# bootstrap()
Initializes extensions and executes bootstrap components.
This method is called by init() after the application has been fully configured. If you override this method, make sure you also call the parent implementation.
View source (opens new window)
# coreCommands()
Returns the configuration of the built-in commands.
View source (opens new window)
Returns
array (opens new window) – The configuration of the built-in commands.
# get()
Returns the component instance with the specified ID.
See also:
View source (opens new window)
Arguments
$id(string (opens new window)) – Component ID (e.g.db).$throwException(boolean (opens new window)) – Whether to throw an exception if$idis not registered with the locator before.
Returns
object (opens new window), null (opens new window) – The component of the specified ID. If $throwException is false and $id
is not registered before, null will be returned.
Throws
- yii\base\InvalidConfigException (opens new window)
if$idrefers to a nonexistent component ID
# getRequest()
Returns the request component.
View source (opens new window)
Returns
# getResponse()
Returns the response component.
View source (opens new window)
Returns
yii\console\Response (opens new window) –
# getSession()
View source (opens new window)
Throws
# getUser()
Returns the user component.
View source (opens new window)
Returns
# handleRequest()
Handles the specified request.
View source (opens new window)
Arguments
$request(yii\console\Request (opens new window)) – The request to be handled
Returns
yii\console\Response (opens new window) – The resulting response
# init()
Initializes the console app by creating the command runner.
View source (opens new window)
# runAction()
Runs a controller action specified by a route.
This method parses the specified route and creates the corresponding child module(s), controller and action instances. It then calls craft\console\Controller::runAction() to run the action with the given parameters. If the route is empty, the method will use defaultRoute (opens new window).
For example, to run public function actionTest($a, $b) assuming that the controller has options the following
code should be used:
\Yii::$app->runAction('controller/test', ['option' => 'value', $a, $b]);
View source (opens new window)
Arguments
$route(string (opens new window)) – The route that specifies the action.$params(array (opens new window)) – The parameters to be passed to the action
Returns
integer (opens new window), yii\console\Response (opens new window), null (opens new window) – The result of the action. This can be either an exit code or Response object.
Exit code 0 means normal, and other values mean abnormal. Exit code of null is treated as 0 as well.
Throws
- yii\console\Exception (opens new window)
if the route is invalid
# setTimeZone()
Sets the time zone used by this application.
This is a simple wrapper of PHP function date_default_timezone_set(). Refer to the php manual (opens new window) for available timezones.
View source (opens new window)
Arguments
$value(string (opens new window)) – The time zone used by this application.
# Protected Methods
| Method | Description |
|---|---|
| defaultVersion() (opens new window) | Returns default module version. |
| loadConfig() (opens new window) | Loads the configuration. |
| registerErrorHandler() (opens new window) | Registers the errorHandler component as a PHP error handler. |
# Constants
| Constant | Description |
|---|---|
OPTION_APPCONFIG | The option name for specifying the application configuration file path. |
STATE_AFTER_REQUEST | Application state used by state (opens new window): application is triggering EVENT_AFTER_REQUEST (opens new window). |
STATE_BEFORE_REQUEST | Application state used by state (opens new window): application is triggering EVENT_BEFORE_REQUEST (opens new window). |
STATE_BEGIN | Application state used by state (opens new window): application just started. |
STATE_END | Application state used by state (opens new window): application has ended. |
STATE_HANDLING_REQUEST | Application state used by state (opens new window): application is handling the request. |
STATE_INIT | Application state used by state (opens new window): application is initializing. |
STATE_SENDING_RESPONSE | Application state used by state (opens new window): application is about to send response. |