ProjectConfig ​
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\ProjectConfig » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.1.0
Project Config service.
An instance of the service is available via Craft::$app->projectConfig
.
Public Properties ​
Property | Description |
---|---|
appliedChanges | array |
areConfigSchemaVersionsCompatible | boolean |
behaviors | yii\base\Behavior – List of behaviors attached to this component. |
cacheDependency | yii\caching\ExpressionDependency |
cacheDuration | integer, null – The project config cache duration. |
doesExternalConfigExist | boolean |
folderName | string – The folder name to save the project config files in, within the config/ folder. |
forceUpdate | boolean – Whether project config should force updates on entries that aren't new or being removed. |
hadFileWriteIssues | boolean |
isApplyingExternalChanges | boolean |
isApplyingYamlChanges | boolean |
maxDefers | integer – The maximum number of times deferred events can be re-deferred before we give up on them |
maxDeltas | integer – The maximum number of project.yaml deltas to store in storage/config-deltas/ |
muteEvents | boolean – Whether events generated by config changes should be muted. |
pendingChangeSummary | array |
readOnly | boolean – Whether the project config is read-only. |
writeYamlAutomatically | boolean – Whether project config changes should be written to YAML files automatically. |
appliedChanges
​
- Type
- array
- Default value
null
- Access
- Read-only
- Since
- 5.1.0
areConfigSchemaVersionsCompatible
​
- Type
- boolean
- Default value
null
- Access
- Read-only
cacheDependency
​
- Type
- yii\caching\ExpressionDependency
- Default value
null
- Access
- Read-only
- Since
- 3.5.8
cacheDuration
​
The project config cache duration. If null, the config5:cacheDuration config setting will be used.
doesExternalConfigExist
​
- Type
- boolean
- Default value
null
- Access
- Read-only
- Since
- 4.0.0
folderName
​
- Type
- string
- Default value
'project'
- Since
- 3.5.0
The folder name to save the project config files in, within the config/
folder.
forceUpdate
​
- Type
- boolean
- Default value
false
Whether project config should force updates on entries that aren't new or being removed.
hadFileWriteIssues
​
- Type
- boolean
- Default value
null
- Access
- Read-only
- Since
- 3.5.0
isApplyingExternalChanges
​
- Type
- boolean
- Default value
null
isApplyingYamlChanges
​
- Type
- boolean
- Default value
null
maxDefers
​
- Type
- integer
- Default value
500
The maximum number of times deferred events can be re-deferred before we give up on them
See also:
- defer()
\craft\services\_applyChanges()
maxDeltas
​
- Type
- integer
- Default value
50
- Since
- 3.4.0
The maximum number of project.yaml deltas to store in storage/config-deltas/
muteEvents
​
- Type
- boolean
- Default value
false
- Since
- 3.1.2
Whether events generated by config changes should be muted.
pendingChangeSummary
​
- Type
- array
- Default value
null
- Access
- Read-only
readOnly
​
- Type
- boolean
- Default value
false
Whether the project config is read-only.
writeYamlAutomatically
​
- Type
- boolean
- Default value
true
- Since
- 3.5.13
Whether project config changes should be written to YAML files automatically.
If set to false
, you can manually write out project config YAML files using the project-config/write
command.
WARNING
If this is set to false
, Craft won’t have a strong grasp of whether the YAML files or database contain the most relevant project config data, so there’s a chance that the Project Config utility will be a bit misleading.
See also flush()
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() | Constructor. |
__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. |
applyConfigChanges() | Applies given changes to the project config. |
applyExternalChanges() | Applies changes in external config to project config. |
areChangesPending() | Returns whether a given path has pending changes that need to be applied to the loaded project config. |
attachBehavior() | Attaches a behavior to this component. |
attachBehaviors() | Attaches a list of behaviors to the component. |
behaviors() | Returns a list of behaviors that this component should behave as. |
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. |
defer() | Defers an event until all other project config changes have been processed. |
detachBehavior() | Detaches a behavior from the component. |
detachBehaviors() | Detaches all behaviors from the component. |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
find() | Finds all config items that pass a condition, and returns their paths and configs as key/value pairs. |
flush() | Saves the modified project confgi state and writes out updated YAML files, if needed. |
get() | Returns a config item value by its path. |
getAppliedChanges() | Get the list of applied changes |
getAreConfigSchemaVersionsCompatible() | Returns whether all schema versions stored in the config are compatible with the actual codebase. |
getBehavior() | Returns the named behavior object. |
getBehaviors() | Returns all behaviors attached to this component. |
getCacheDependency() | Returns the cache dependency that should be used for project config caches. |
getDoesExternalConfigExist() | Returns whether external project config files appear to exist. |
getHadFileWriteIssues() | Returns whether we have a record of issues writing out files to the project config folder. |
getIsApplyingExternalChanges() | Returns whether external changes are currently being applied |
getPendingChangeSummary() | Returns a summary of all pending config changes. |
handleChangeEvent() | Handles a config change event. |
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. |
ignorePendingChanges() | Ignores any pending changes in the project config files. |
init() | Initializes the object. |
off() | Detaches an existing event handler from this component. |
on() | Attaches an event handler to an event. |
onAdd() | Attaches an event handler for when an item is added to the config at a given path. |
onRemove() | Attaches an event handler for when an item is removed from the config at a given path. |
onUpdate() | Attaches an event handler for when an item is updated in the config at a given path. |
processConfigChanges() | Processes changes in the project config files for a given config item path. |
rebuild() | Rebuilds the project config from the current state in the database. |
regenerateExternalConfig() | Regenerates the external config based on the loaded project config. |
registerChangeEventHandler() | Registers a config change event listener, for a specific config path pattern. |
rememberAppliedChanges() | Update Craft's internal config store for a path with the new value. If the value is null, it will be removed instead. |
remove() | Removes a config item at the given path. |
removeNameMapping() | Removes a UUID/name mapping on the working config. |
saveModifiedConfigData() | Saves all the config data that has been modified up to now. |
set() | Sets a config item value at the given path. |
setNameMapping() | Sets a UUID/name mapping on the working config. |
trigger() | Triggers an event. |
updateParsedConfigTimes() | Updates cached config file modified times immediately. |
updateParsedConfigTimesAfterRequest() | Updates cached config file modified times after the request ends. |
writeYamlFiles() | Update the config YAML files with the buffered changes. |
__construct()
​
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
Arguments ​
$config
(array) – Name-value pairs that will be used to initialize the object properties
applyConfigChanges()
​
Applies given changes to the project config.
Arguments ​
$configData
(array)
applyExternalChanges()
​
- Since
- 4.0.0
Applies changes in external config to project config.
Throws ​
- craft\errors\BusyResourceException
if a lock could not be acquired - craft\errors\StaleResourceException
if the loaded project config is out-of-date
areChangesPending()
​
Returns whether a given path has pending changes that need to be applied to the loaded project config.
Arguments ​
$path
(string, null) – A specific config path that should be checked for pending changes. If this is null, thentrue
will be returned if there are any pending changes in external config.$force
(boolean) – Whether to check for changes even if it doesn’t look like anything has changed since the last time ignorePendingChanges() has been called.
Returns ​
defer()
​
- Since
- 3.1.13
Defers an event until all other project config changes have been processed.
Arguments ​
$event
(craft\events\ConfigEvent)$handler
(callable)
find()
​
- Since
- 5.0.0
Finds all config items that pass a condition, and returns their paths and configs as key/value pairs.
Arguments ​
$callback
(callable)$fromExternalConfig
(boolean) – Whether to find config items in the external config
Returns ​
flush()
​
- Since
- 5.0.0
Saves the modified project confgi state and writes out updated YAML files, if needed.
get()
​
Returns a config item value by its path.
Arguments ​
$path
(string, null) – The config item path, ornull
if the entire config should be returned$getFromExternalConfig
(boolean) – Whether data should be fetched from the working config instead of the loaded config. Defaults tofalse
.
Returns ​
mixed
– The config item value
Example ​
$value = Craft::$app->projectConfig->get('foo.bar');
getAppliedChanges()
​
- Since
- 5.1.0
Get the list of applied changes
Returns ​
getAreConfigSchemaVersionsCompatible()
​
Returns whether all schema versions stored in the config are compatible with the actual codebase.
The schemas must match exactly to avoid unpredictable behavior that can occur when running migrations and applying project config changes at the same time.
Arguments ​
$issues
(array) – Passed by reference and populated with issues on error in the following format:[$pluginName, $existingSchema, $incomingSchema]
Returns ​
getCacheDependency()
​
- Since
- 3.5.8
Returns the cache dependency that should be used for project config caches.
Returns ​
yii\caching\ExpressionDependency
getDoesExternalConfigExist()
​
- Since
- 4.0.0
Returns whether external project config files appear to exist.
Returns ​
getHadFileWriteIssues()
​
- Since
- 3.5.0
Returns whether we have a record of issues writing out files to the project config folder.
Returns ​
getIsApplyingExternalChanges()
​
- Since
- 4.0.0
Returns whether external changes are currently being applied
Returns ​
getPendingChangeSummary()
​
Returns a summary of all pending config changes.
Returns ​
handleChangeEvent()
​
- Since
- 3.4.0
Handles a config change event.
Arguments ​
$event
(craft\events\ConfigEvent)
ignorePendingChanges()
​
- Since
- 3.5.0
Ignores any pending changes in the project config files.
init()
​
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
onAdd()
​
Attaches an event handler for when an item is added to the config at a given path.
Arguments ​
$path
(string) – The config path pattern. Can contain{uri}
tokens, which will be passed to the handler.$handler
(callable) – The handler method.$data
(mixed
) – The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via craft\events\ConfigEvent::$data.
Returns ​
static
– Self reference
Example ​
use craft\events\ConfigEvent;
use craft\helpers\Db;
Craft::$app->projectConfig->onAdd('foo.{uid}', function(ConfigEvent $event) {
// Get the UID from the item path
$uid = $event->tokenMatches[0];
// Prep the row data
$data = array_merge($event->newValue);
// See if the row already exists (maybe it was soft-deleted)
$id = Db::idByUid('{{%tablename}}', $uid);
if ($id) {
$data['dateDeleted'] = null;
Craft::$app->db->createCommand()->update('{{%tablename}}', $data, [
'id' => $id,
]);
} else {
$data['uid'] = $uid;
Craft::$app->db->createCommand()->insert('{{%tablename}}', $data);
}
});
onRemove()
​
Attaches an event handler for when an item is removed from the config at a given path.
Arguments ​
$path
(string) – The config path pattern. Can contain{uri}
tokens, which will be passed to the handler.$handler
(callable) – The handler method.$data
(mixed
) – The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via craft\events\ConfigEvent::$data.
Returns ​
static
– Self reference
Example ​
use craft\events\ConfigEvent;
Craft::$app->projectConfig->onRemove('foo.{uid}', function(ConfigEvent $event) {
// Get the UID from the item path
$uid = $event->tokenMatches[0];
// Soft-delete the item from the database
Craft::$app->db->createCommand()->softDelete('{{%tablename}}', [
'uid' => $uid,
]);
});
onUpdate()
​
Attaches an event handler for when an item is updated in the config at a given path.
Arguments ​
$path
(string) – The config path pattern. Can contain{uri}
tokens, which will be passed to the handler.$handler
(callable) – The handler method.$data
(mixed
) – The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via craft\events\ConfigEvent::$data.
Returns ​
static
– Self reference
Example ​
use craft\events\ConfigEvent;
Craft::$app->projectConfig->onUpdate('foo.{uid}', function(ConfigEvent $event) {
// Get the UID from the item path
$uid = $event->tokenMatches[0];
// Update the item in the database
$data = array_merge($event->newValue);
Craft::$app->db->createCommand()->update('{{%tablename}}', $data, [
'uid' => $uid,
]);
});
processConfigChanges()
​
Processes changes in the project config files for a given config item path.
Note that this will only have an effect if external project config changes are currently getting applied.
Arguments ​
$path
(string) – The config item path$force
(boolean) – Whether the config change should be processed regardless of previous records, or whether external changes are currently being applied
rebuild()
​
- Since
- 3.1.20
Rebuilds the project config from the current state in the database.
Throws ​
- craft\errors\BusyResourceException
if a lock could not be acquired - craft\errors\StaleResourceException
if the loaded project config is out-of-date - Throwable
if reasons
regenerateExternalConfig()
​
- Since
- 4.0.0
Regenerates the external config based on the loaded project config.
registerChangeEventHandler()
​
Registers a config change event listener, for a specific config path pattern.
Arguments ​
$event
(string) – The event name$path
(string) – The config path pattern. Can contain{uid}
tokens, which will be passed to the handler.$handler
(callable) – The handler method.$data
(mixed
) – The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via craft\events\ConfigEvent::$data.
rememberAppliedChanges()
​
- Since
- 4.0.0
Update Craft's internal config store for a path with the new value. If the value is null, it will be removed instead.
Arguments ​
$path
(string)$oldValue
(mixed
)$newValue
(mixed
)$message
(string, null) – Message describing the changes made.
remove()
​
Removes a config item at the given path.
Arguments ​
Example ​
Craft::$app->projectConfig->remove('foo.bar');
removeNameMapping()
​
- Since
- 4.4.17
Removes a UUID/name mapping on the working config.
Arguments ​
$uid
(string)
saveModifiedConfigData()
​
Saves all the config data that has been modified up to now.
Throws ​
set()
​
Sets a config item value at the given path.
Arguments ​
$path
(string) – The config item path$value
(mixed
) – The config item value$message
(string, null) – A message describing the changes$updateTimestamp
(boolean) – Whether thedateModified
value should be updated, if it hasn’t been updated yet for this request$force
(boolean) – Whether the update should be processed regardless of whether the value actually changed
Returns ​
boolean – Whether the project config was modified
Throws ​
- yii\base\ErrorException
- yii\base\Exception
- yii\base\NotSupportedException
if the service is set to read-only mode - yii\web\ServerErrorHttpException
- yii\base\InvalidConfigException
- craft\errors\BusyResourceException
if a lock could not be acquired - craft\errors\StaleResourceException
if the loaded project config is out-of-date
Example ​
Craft::$app->projectConfig->set('foo.bar', 'value');
setNameMapping()
​
- Since
- 4.4.17
Sets a UUID/name mapping on the working config.
Arguments ​
updateParsedConfigTimes()
​
Updates cached config file modified times immediately.
Returns ​
updateParsedConfigTimesAfterRequest()
​
Updates cached config file modified times after the request ends.
writeYamlFiles()
​
- Since
- 5.0.0
Update the config YAML files with the buffered changes.
Arguments ​
$force
(boolean) – Whether to write out the YAML even if there aren’t any new changes
Throws ​
- yii\base\Exception
if something goes wrong
Protected Methods ​
Method | Description |
---|---|
getCurrentWorkingConfig() | Get the current working project config data. |
getExternalConfig() | Get the external project config data. |
getInternalConfig() | Get the internal project config data. |
persistInternalConfigValues() | Persist an array of $path => $value to the internal config. |
removeInternalConfigValuesByPaths() | Remove values from internal config by a list of paths. |
storeYamlHistory() | Store yaml history |
updateConfigVersion() | Updates the config version used for cache invalidation. |
getCurrentWorkingConfig()
​
Get the current working project config data.
Returns ​
craft\models\ProjectConfigData
getExternalConfig()
​
Get the external project config data.
Returns ​
craft\models\ReadOnlyProjectConfigData
getInternalConfig()
​
Get the internal project config data.
Returns ​
craft\models\ReadOnlyProjectConfigData
persistInternalConfigValues()
​
Persist an array of $path => $value
to the internal config.
Arguments ​
$values
(array)
Throws ​
removeInternalConfigValuesByPaths()
​
Remove values from internal config by a list of paths.
Arguments ​
$paths
(array)
storeYamlHistory()
​
Store yaml history
Arguments ​
$configData
(array) – Config data to be saved as history
Throws ​
updateConfigVersion()
​
Updates the config version used for cache invalidation.
Constants ​
Constant | Description |
---|---|
ASSOC_KEY | The array key to use for signaling ordered-to-associative array conversion. |
CACHE_DURATION | The duration that project config caches should be cached. |
CACHE_KEY | The cache key that is used to store the modified time of the project config files, at the time they were last applied. |
CONFIG_DELTA_FILENAME | Filename for base config delta files |
CONFIG_FILENAME | |
DIFF_CACHE_KEY | The cache key that is used to store the current project config diff |
FILE_ISSUES_CACHE_KEY | The cache key that is used to store whether there were any issues writing the project config files out. |
IGNORE_CACHE_KEY | The cache key that is used to store the modified time of the project config files, at the time they were last applied or ignored. |
MUTEX_NAME | |
PATH_ADDRESSES | |
PATH_ADDRESS_FIELD_LAYOUTS | |
PATH_CATEGORY_GROUPS | |
PATH_DATE_MODIFIED | |
PATH_ELEMENT_SOURCES | |
PATH_ENTRY_TYPES | |
PATH_FIELDS | |
PATH_FS | |
PATH_GLOBAL_SETS | |
PATH_GRAPHQL | |
PATH_GRAPHQL_PUBLIC_TOKEN | |
PATH_GRAPHQL_SCHEMAS | |
PATH_IMAGE_TRANSFORMS | |
PATH_META | |
PATH_META_NAMES | |
PATH_PLUGINS | |
PATH_ROUTES | |
PATH_SCHEMA_VERSION | |
PATH_SECTIONS | |
PATH_SITES | |
PATH_SITE_GROUPS | |
PATH_SYSTEM | |
PATH_TAG_GROUPS | |
PATH_USERS | |
PATH_USER_FIELD_LAYOUTS | |
PATH_USER_GROUPS | |
PATH_VOLUMES | |
STORED_CACHE_KEY | The cache key that is used to store the loaded project config data. |
UID_PATTERN | Regexp pattern to determine a string that could be used as an UID. |
Events ​
EVENT_ADD_ITEM ​
The event that is triggered when an item is added to the config.
Example ​
use craft\events\ParseConfigEvent;
use craft\services\ProjectConfig;
use yii\base\Event;
Event::on(ProjectConfig::class, ProjectConfig::EVENT_ADD_ITEM, function(ParseConfigEvent $e) {
// Ensure the item is also added in the database...
});
EVENT_AFTER_APPLY_CHANGES ​
- Type
craft\services\Event
The event that is triggered after pending project config file changes have been applied.
EVENT_AFTER_WRITE_YAML_FILES ​
- Type
craft\services\Event
- Since
- 4.8.0
The event that is triggered after the YAML files have been written out.
EVENT_REBUILD ​
- Type
- craft\events\RebuildConfigEvent
- Since
- 3.1.20
The event that is triggered when the project config is being rebuilt.
Example ​
use craft\events\RebuildConfigEvent;
use craft\services\ProjectConfig;
use yii\base\Event;
Event::on(ProjectConfig::class, ProjectConfig::EVENT_REBUILD, function(RebuildConfigEvent $e) {
// Add plugin’s project config data...
$e->config['myPlugin']['key'] = $value;
});
EVENT_REMOVE_ITEM ​
The event that is triggered when an item is removed from the config.
Example ​
use craft\events\ParseConfigEvent;
use craft\services\ProjectConfig;
use yii\base\Event;
Event::on(ProjectConfig::class, ProjectConfig::EVENT_REMOVE_ITEM, function(ParseConfigEvent $e) {
// Ensure the item is also removed in the database...
});
EVENT_UPDATE_ITEM ​
The event that is triggered when an item is updated in the config.
Example ​
use craft\events\ParseConfigEvent;
use craft\services\ProjectConfig;
use yii\base\Event;
Event::on(ProjectConfig::class, ProjectConfig::EVENT_UPDATE_ITEM, function(ParseConfigEvent $e) {
// Ensure the item is also updated in the database...
});