Craft 5 Class Reference

Appearance

ProjectConfig ​

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\ProjectConfig
Since
3.1.0

Class ProjectConfig

View source

Public Methods ​

MethodDescription
cleanupConfig()Traverse and clean a config array, removing empty values and sorting keys.
diff()Returns a diff of the pending project config YAML changes, compared to the currently loaded project config.
encodeValueAsString()Returns a project config compatible value encoded for storage.
ensureAllEntryTypesProcessed()Ensure all entry type config changes are processed immediately in a safe manner.
ensureAllFieldsProcessed()Ensures all field config changes are processed immediately in a safe manner.
ensureAllFilesystemsProcessed()Ensures all filesystem config changes are processed immediately in a safe manner.
ensureAllGqlSchemasProcessed()Ensure all GraphQL schema config changes are processed immediately in a safe manner.
ensureAllSectionsProcessed()Ensure all section config changes are processed immediately in a safe manner.
ensureAllSitesProcessed()Ensure all site config changes are processed immediately in a safe manner.
ensureAllUserGroupsProcessed()Ensure all user group config changes are processed immediately in a safe manner.
flattenConfigArray()Flatten a config array to a dot.based.key array.
lastPathSegment()Returns the last segment in a given project config path.
packAssociativeArray()Prepares an associative array for storage in project config, so that the order of its items will be remembered.
packAssociativeArrays()Loops through an array, and prepares any nested associative arrays for storage in project config, so that the order of its items will be remembered.
pathSegments()Returns an array of the individual segments in a given project config path.
pathWithoutLastSegment()Returns the given project config path with all but its last segment, or null if the path only had one segment.
reset()Resets the static memoization variables.
splitConfigIntoComponents()Take a project config array and split it into components.
touch()Updates the dateModified value in config/project/project.yaml.
traverseDataArray()Traverse a nested data array according to path and perform an action depending on parameters.
unpackAssociativeArray()Restores an array that was prepared via packAssociativeArray() to its original form.
unpackAssociativeArrays()Loops through an array, and restores any arrays that were prepared via packAssociativeArray() to their original form.

cleanupConfig() ​

Since
3.1.14

Traverse and clean a config array, removing empty values and sorting keys.

View source

Arguments ​

  • $config (array) – Config array to clean

Returns ​

array

Throws ​

diff() ​

Since
3.5.6

Returns a diff of the pending project config YAML changes, compared to the currently loaded project config.

View source

Arguments ​

  • $invert (boolean) – Whether to reverse the diff, so the loaded config is treated as the source of truth

Returns ​

string

encodeValueAsString() ​

Since
4.0.0

Returns a project config compatible value encoded for storage.

View source

Arguments ​

  • $value (mixed)

Returns ​

string

ensureAllEntryTypesProcessed() ​

Since
5.0.0

Ensure all entry type config changes are processed immediately in a safe manner.

View source

ensureAllFieldsProcessed() ​

Ensures all field config changes are processed immediately in a safe manner.

View source

ensureAllFilesystemsProcessed() ​

Since
4.1.2

Ensures all filesystem config changes are processed immediately in a safe manner.

View source

ensureAllGqlSchemasProcessed() ​

Ensure all GraphQL schema config changes are processed immediately in a safe manner.

View source

ensureAllSectionsProcessed() ​

Since
4.0.0

Ensure all section config changes are processed immediately in a safe manner.

View source

ensureAllSitesProcessed() ​

Ensure all site config changes are processed immediately in a safe manner.

View source

Arguments ​

  • $force (boolean) – Whether to proceed even if YAML changes are not currently being applied

ensureAllUserGroupsProcessed() ​

Ensure all user group config changes are processed immediately in a safe manner.

View source

flattenConfigArray() ​

Since
3.4.0

Flatten a config array to a dot.based.key array.

View source

Arguments ​

lastPathSegment() ​

Since
3.7.44

Returns the last segment in a given project config path.

View source

Arguments ​

Returns ​

string, null

Throws ​

packAssociativeArray() ​

Since
3.4.0

Prepares an associative array for storage in project config, so that the order of its items will be remembered.

TIP

Use unpackAssociativeArray() to restore the array to its original form when fetching the value from the Project Config.

View source

Arguments ​

  • $array (array)
  • $recursive (boolean) – Whether to process nested associative arrays as well

Returns ​

array

Example ​

php
$myArray = [
    'foo' => 1,
    'bar' => 2,
];

// "Pack" the array so it doesn't get reordered to [bar=>2,foo=>1]
$packedArray = \craft\helpers\ProjectConfig::packAssociativeArray($myArray);

Craft::$app->projectConfig->set($configKey, $packedArray);

packAssociativeArrays() ​

Since
3.4.0

Loops through an array, and prepares any nested associative arrays for storage in project config, so that the order of its items will be remembered.

View source

Arguments ​

  • $array (array)
  • $recursive (boolean) – Whether to process nested associative arrays as well

Returns ​

array

pathSegments() ​

Since
3.7.44

Returns an array of the individual segments in a given project config path.

View source

Arguments ​

Returns ​

string[]

Throws ​

pathWithoutLastSegment() ​

Since
3.7.44

Returns the given project config path with all but its last segment, or null if the path only had one segment.

View source

Arguments ​

Returns ​

string, null

Throws ​

reset() ​

Resets the static memoization variables.

View source

splitConfigIntoComponents() ​

Since
3.5.0

Take a project config array and split it into components.

Components are defined per each second-level config entry, where all the sibling entries are keyed by UIDs.

View source

Arguments ​

Returns ​

array – In the form of [$file => $config], where $file is the relative config file path in Project Config folder

touch() ​

Since
3.5.14

Updates the dateModified value in config/project/project.yaml.

If a Git conflict is detected on the dateModified value, a conflict resolution will also be attempted.

View source

Arguments ​

  • $timestamp (integer, null) – The updated dateModified value. If null, the current time will be used.

traverseDataArray() ​

Since
4.0.0

Traverse a nested data array according to path and perform an action depending on parameters.

View source

Arguments ​

  • $data (array) – A nested array of data to traverse
  • $path (string, string[]) – Path used to traverse the array. Either an array or a dot.based.path
  • $value (mixed) – Value to set at the destination. If null, will return the value, unless deleting
  • $delete (boolean) – Whether to delete the value at the destination or not.

Returns ​

mixed

unpackAssociativeArray() ​

Since
3.4.0

Restores an array that was prepared via packAssociativeArray() to its original form.

View source

Arguments ​

  • $array (array)
  • $recursive (boolean) – Whether to process nested associative arrays as well

Returns ​

array

unpackAssociativeArrays() ​

Since
3.4.0

Loops through an array, and restores any arrays that were prepared via packAssociativeArray() to their original form.

View source

Arguments ​

Returns ​

array