ProjectConfigController

Type

Class

Namespace

craft\console\controllers

Inherits

craft\console\controllers\ProjectConfigController » 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.1.0

Manages the Project Config.

View source

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.
external	boolean – Whether to pull values from the project config YAML files instead of the loaded config.
force	boolean – Whether every entry change should be force-applied.
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.
invert	boolean – Whether to treat the loaded project config as the source of truth, instead of the YAML files.
isolated	– Whether the command should ensure it is only being run once at a time.
layout	string, null, false – The name of the layout to be applied to this controller's views.
message	string, null – A message describing the changes.
module	yii\base\Module – The module that this controller belongs to.
modules	yii\base\Module – All ancestor modules that this controller is located within.
overwrite	boolean – Whether to overwrite an existing export file, if a specific file path is given.
passedOptionValues	array – The properties corresponding to the passed options.
passedOptions	array – The names of the options passed during execution.
quiet	boolean – Whether to reduce the command output.
request	craft\console\Request
response	yii\base\Response, array, string – The response.
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).
updateTimestamp	boolean – Whether the dateModified value should be updated
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.

external

Type

boolean

Default value

false

Since

4.1.0

Whether to pull values from the project config YAML files instead of the loaded config.

View source

force

Type

boolean

Default value

false

Whether every entry change should be force-applied.

View source

invert

Type

boolean

Default value

false

Since

3.5.13

Whether to treat the loaded project config as the source of truth, instead of the YAML files.

View source

message

Type

string, null

Default value

null

Since

4.1.0

A message describing the changes.

See also craft\services\ProjectConfig::set()

View source

overwrite

Type

boolean

Default value

false

Since

4.2.1

Whether to overwrite an existing export file, if a specific file path is given.

View source

quiet

Type

boolean

Default value

false

Since

4.4.0

Whether to reduce the command output.

View source

updateTimestamp

Type

boolean

Default value

false

Since

4.1.0

Whether the dateModified value should be updated

See also craft\services\ProjectConfig::set()

View source

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.
actionApply()	Applies project config file changes.
actionDiff()	Outputs a diff of the pending project config YAML changes.
actionExport()	Exports the entire project config to a single file.
actionGet()	Outputs a project config value.
actionRebuild()	Rebuilds the project config.
actionRemove()	Removes a project config value.
actionSet()	Sets a project config value.
actionSync()	DEPRECATED. Use project-config/apply instead.
actionTouch()	Updates the dateModified value in config/project/project.yaml, attempting to resolve a Git conflict for it.
actionWrite()	Writes out the currently-loaded project config as YAML files to the config/project/ folder, discarding any pending YAML changes.
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.
createDirectory()	Creates a directory, and outputs to the console.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
do()	Performs an action with descriptive output.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
failure()	Outputs a failure message to the console.
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.
markdownToAnsi()	Converts Markdown to be better readable in console environments by applying some ANSI format.
note()	Outputs a note to the console.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
onFinishProcessingItem()	Called when a project config item has finished getting processed.
onStartProcessingItem()	Called when a project config item has started getting processed.
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 within this controller 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.
success()	Outputs a success message to the console.
table()	Outputs a table via craft\helpers\Console::table().
tip()	Outputs a tip to the console.
trigger()	Triggers an event.
warning()	Outputs a warning to the console.
writeJson()	JSON-encodes a value and writes it to a file.
writeToFile()	Writes contents to a file, and outputs to the console.

actionApply()

Applies project config file changes.

View source

Returns

integer

actionDiff()

Since

3.5.6

Outputs a diff of the pending project config YAML changes.

View source

Returns

integer

actionExport()

Since

4.2.1

Exports the entire project config to a single file.

View source

Arguments

• $path (string, null) – The path the project config should be exported to. Can be any of the following:

• A full file path

• A folder path (export will be saved in there with a dynamically-generated name)

• A filename (export will be saved in the working directory with the given name)

• Blank (export will be saved in the working directly with a dynamically-generated name)

actionGet()

Since

4.1.0

Outputs a project config value.

Example:

php craft project-config/get system.edition

The “path” syntax used here may be composed of directory and filenames (within your config/project folder), YAML object keys (including UUIDs for many Craft resources), and integers (referencing numerically-indexed arrays), joined by a dot (.): path.to.nested.array.0.property.

View source

Arguments

• $path (string) – The config item path

Returns

integer

actionRebuild()

Since

3.1.20

Rebuilds the project config.

View source

Returns

integer

actionRemove()

Since

4.1.0

Removes a project config value.

Example:

php craft project-config/remove some.nested.key

DANGER

This should only be used when the equivalent change is not possible through the control panel or other Craft APIs. By directly modifying project config values, you are bypassing all validation and can easily destabilize configuration.

As with set, removing values only updates the root dateModified key when using the --update-timestamp flag. If you do not include this flag, you must run project-config/touch before changes will be detected or applied in other environments!

View source

Arguments

• $path (string) – The config item path

Returns

integer

actionSet()

Since

4.1.0

Sets a project config value.

Example:

php craft project-config/set some.nested.key

See get for the accepted key formats.

DANGER

This should only be used when the equivalent change is not possible through the control panel or other Craft APIs. By directly modifying project config values, you are bypassing all validation and can easily destabilize configuration.

Values are updated in the database and in your local YAML files, but the root dateModified project config property is only touched when using the --update-timestamp flag. If you do not update the timestamp along with the value, the change may not be detected or applied in other environments!

View source

Arguments

• $path (string) – The config item path
• $value (string) – The config item value as a valid YAML string

Returns

integer

actionSync()

DEPRECATED

Deprecated in 3.5.0. Use actionApply() instead.

DEPRECATED. Use project-config/apply instead.

View source

Returns

integer

actionTouch()

Updates the dateModified value in config/project/project.yaml, attempting to resolve a Git conflict for it.

View source

Returns

integer

actionWrite()

Since

3.5.13

Writes out the currently-loaded project config as YAML files to the config/project/ folder, discarding any pending YAML changes.

View source

Returns

integer

onFinishProcessingItem()

Since

3.6.10

Called when a project config item has finished getting processed.

View source

Arguments

• $event (craft\events\ConfigEvent)

onStartProcessingItem()

Since

3.6.10

Called when a project config item has started getting processed.

View source

Arguments

• $event (craft\events\ConfigEvent)

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

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.

Constants

Constant	Description
EXIT_CODE_ERROR
EXIT_CODE_NORMAL