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 ProjectConfig service is globally accessible in Craft via Craft::$app->projectConfig.

View source

# Public Properties

Property Description
areConfigSchemaVersionsCompatible boolean, array
behaviors yii\base\Behavior – List of behaviors attached to this component
forceUpdate boolean – Whether project config should force updates on entries that aren't new or being removed.
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.
muteEvents boolean – Whether events generated by config changes should be muted.
pendingChangeSummary array
readOnly boolean – Whether the project config is read-only.

# areConfigSchemaVersionsCompatible

Type
boolean, array
Access
Read-only

View source

# forceUpdate

Type
boolean

Whether project config should force updates on entries that aren't new or being removed.

View source

# isApplyingYamlChanges

Type
boolean
Access
Read-only

View source

# maxDefers

Type
integer

The maximum number of times deferred events can be re-deferred before we give up on them

See also:

  • defer()
  • \craft\services\_applyChanges()

View source

# maxDeltas

Type
integer
Since
3.4.0

The maximum number of project.yaml deltas to store in storage/config-backups/

View source

# muteEvents

Type
boolean
Since
3.1.2

Whether events generated by config changes should be muted.

View source

# pendingChangeSummary

Type
array
Access
Read-only

View source

# readOnly

Type
boolean

Whether the project config is read-only.

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() Constructor.
__get() Returns the value of an object property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets value of an object property.
__unset() Sets an object property to null.
applyConfigChanges() Applies given changes to the project config.
applyYamlChanges() Applies changes in project.yaml to the 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.
get() Returns a config item value value by its path.
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.
getIsApplyingYamlChanges() Returns whether project.yaml 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.
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 config/project.yaml for a given path.
rebuild() Rebuilds the project config from the current state in the database.
regenerateYamlFromConfig() Regenerates project.yaml based on the loaded project config.
registerChangeEventHandler() Registers a config change event listener, for a specific config path pattern.
remove() Removes a config item at the given path.
saveModifiedConfigData() Saves all the config data that has been modified up to now.
set() Sets a config item value at the given path.
trigger() Triggers an event.
updateParsedConfigTimes() Updates cached config file modified times immediately.
updateParsedConfigTimesAfterRequest() Updates cached config file modified times after the request ends.
updateStoredConfigAfterRequest() Updates the stored config after the request ends.

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

View source

Arguments

  • $config (array) – Name-value pairs that will be used to initialize the object properties

# applyConfigChanges()

Applies given changes to the project config.

View source

Arguments

# applyYamlChanges()

Applies changes in project.yaml to the project config.

View source

# areChangesPending()

Returns whether a given path has pending changes that need to be applied to the loaded project config.

View source

Arguments

  • $path (string, null) – A specific config path that should be checked for pending changes. If this is null, then true will be returned if there are any pending changes in project.yaml..

Returns

boolean

# defer()

Since
3.1.13

Defers an event until all other project config changes have been processed.

View source

Arguments

# get()

Returns a config item value value by its path.

View source

Arguments

  • $path (string, null) – The config item path, or null if the entire config should be returned
  • $getFromYaml (boolean) – Whether data should be fetched from config/project.yaml instead of the loaded config. Defaults to false.

Returns

mixed – The config item value

Example

$value = Craft::$app->projectConfig->get('foo.bar');

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

View source

Arguments

  • $issues (array) – Passed by reference and populated with issues on error in the following format: [$pluginName, $existingSchema, $incomingSchema]

Returns

boolean, array

# getIsApplyingYamlChanges()

Returns whether project.yaml changes are currently being applied

View source

Returns

boolean

# getPendingChangeSummary()

Returns a summary of all pending config changes.

View source

Returns

array

# handleChangeEvent()

Since
3.4.0

Handles a config change event.

View source

Arguments

# init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

# onAdd()

Attaches an event handler for when an item is added to the config at a given path.

View source

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.

View source

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.

View source

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 config/project.yaml for a given path.

View source

Arguments

  • $path (string) – The config item path
  • $triggerUpdate (boolean) – Is set to true and no changes are detected, an update event will be triggered, anyway.
  • $message (string, null) – The message describing changes, if modifications are made.
  • $force (boolean) – Whether the config change should be processed regardless of previous records

# rebuild()

Since
3.1.20

Rebuilds the project config from the current state in the database.

View source

Throws

# regenerateYamlFromConfig()

Regenerates project.yaml based on the loaded project config.

View source

# registerChangeEventHandler()

Registers a config change event listener, for a specific config path pattern.

View source

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.

# remove()

Removes a config item at the given path.

View source

Arguments

  • $path (string) – The config item path
  • $message (string, null) – The message describing changes.

Example

Craft::$app->projectConfig->remove('foo.bar');

# saveModifiedConfigData()

Saves all the config data that has been modified up to now.

View source

Throws

# set()

Sets a config item value at the given path.

View source

Arguments

  • $path (string) – The config item path
  • $value (mixed) – The config item value
  • $message (string, null) – The message describing changes.

Throws

Example

Craft::$app->projectConfig->set('foo.bar', 'value');

# updateParsedConfigTimes()

Updates cached config file modified times immediately.

View source

Returns

boolean

# updateParsedConfigTimesAfterRequest()

Updates cached config file modified times after the request ends.

View source

# updateStoredConfigAfterRequest()

Updates the stored config after the request ends.

View source

# Protected Methods

Method Description
encodeValueAsString() Returns a project config compatible value encoded for storage.

# encodeValueAsString()

Returns a project config compatible value encoded for storage.

View source

Arguments

  • $value

Returns

string

# Constants

Constant Description
CACHE_DURATION
CACHE_KEY
CONFIG_ALL_KEY Key to use when memoizing the entire config array
CONFIG_ASSOC_KEY Key to use for signaling ordered-to-associative array conversion
CONFIG_DELTA_FILENAME Filename for base config delta files
CONFIG_FILENAME
CONFIG_KEY
CONFIG_SCHEMA_VERSION_KEY
STORED_CACHE_KEY
UID_PATTERN

# Events

# EVENT_ADD_ITEM

Type
craft\events\ConfigEvent

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 changes in config/project.yaml have been applied.

# 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

Type
craft\events\ConfigEvent

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

Type
craft\events\ConfigEvent

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...
});