Drupal 8  8.0.2
LanguageConfigFactoryOverride Class Reference
Inheritance diagram for LanguageConfigFactoryOverride:

Public Member Functions

 __construct (StorageInterface $storage, EventDispatcherInterface $event_dispatcher, TypedConfigManagerInterface $typed_config)
 
 loadOverrides ($names)
 
 getOverride ($langcode, $name)
 
 getStorage ($langcode)
 
 getCacheSuffix ()
 
 getLanguage ()
 
 setLanguage (LanguageInterface $language=NULL)
 
 setLanguageFromDefault (LanguageDefault $language_default=NULL)
 
 createConfigObject ($name, $collection=StorageInterface::DEFAULT_COLLECTION)
 
 addCollections (ConfigCollectionInfo $collection_info)
 
 onConfigSave (ConfigCrudEvent $event)
 
 onConfigRename (ConfigRenameEvent $event)
 
 onConfigDelete (ConfigCrudEvent $event)
 
 getCacheableMetadata ($name)
 
- Public Member Functions inherited from ConfigFactoryOverrideBase
 addCollections (ConfigCollectionInfo $collection_info)
 
 onConfigSave (ConfigCrudEvent $event)
 
 onConfigDelete (ConfigCrudEvent $event)
 
 onConfigRename (ConfigRenameEvent $event)
 
- Public Member Functions inherited from LanguageConfigFactoryOverrideInterface
 installLanguageOverrides ($langcode)
 

Protected Attributes

 $baseStorage
 
 $storages
 
 $typedConfigManager
 
 $eventDispatcher
 
 $language
 

Additional Inherited Members

- Static Public Member Functions inherited from ConfigFactoryOverrideBase
static getSubscribedEvents ()
 
- Protected Member Functions inherited from ConfigFactoryOverrideBase
 filterOverride (Config $config, StorableConfigBase $override)
 
 filterNestedArray (array $original_data, array &$override_data)
 

Detailed Description

Provides language overrides for the configuration factory.

Constructor & Destructor Documentation

__construct ( StorageInterface  $storage,
EventDispatcherInterface  $event_dispatcher,
TypedConfigManagerInterface  $typed_config 
)

Constructs the LanguageConfigFactoryOverride object.

Parameters
\Drupal\Core\Config\StorageInterface$storageThe configuration storage engine.
\Symfony\Component\EventDispatcher\EventDispatcherInterface$event_dispatcherAn event dispatcher instance to use for configuration events.
\Drupal\Core\Config\TypedConfigManagerInterface$typed_configThe typed configuration manager.

Member Function Documentation

addCollections ( ConfigCollectionInfo  $collection_info)

{}

References ConfigCollectionInfo\addCollection(), and Drupal\languageManager().

Here is the call graph for this function:

createConfigObject (   $name,
  $collection = StorageInterface::DEFAULT_COLLECTION 
)

{Creates a configuration object for use during install and synchronization.If the overrider stores its overrides in configuration collections then it can have its own implementation of . Configuration overriders can link themselves to a configuration collection by listening to the ::COLLECTION_INFO event and adding the collections they are responsible for. Doing this will allow installation and synchronization to use the overrider's implementation of StorableConfigBase.

See Also
::importConfig()
::createConfiguration()
Parameters
string$nameThe configuration object name.
string$collectionThe configuration collection.
Returns
The configuration object for the provided name and collection.
}

Implements ConfigFactoryOverrideInterface.

References LanguageConfigFactoryOverride\getOverride().

Here is the call graph for this function:

getCacheableMetadata (   $name)

{Gets the cacheability metadata associated with the config factory override.

Parameters
string$nameThe name of the configuration override to get metadata for.
Returns
A cacheable metadata object.
}

Implements ConfigFactoryOverrideInterface.

getCacheSuffix ( )

{The string to append to the configuration static cache name.

Returns
string A string to append to the configuration static cache name.
}

Implements ConfigFactoryOverrideInterface.

getLanguage ( )

{Gets the language object used to override configuration data.

Returns
The language object used to override configuration data.
}

Implements LanguageConfigFactoryOverrideInterface.

getOverride (   $langcode,
  $name 
)

{Get language override for given language and configuration name.

Parameters
string$langcodeLanguage code.
string$nameConfiguration name.
Returns
Configuration override object.
}

Implements LanguageConfigFactoryOverrideInterface.

References LanguageConfigFactoryOverride\getStorage().

Referenced by LanguageConfigFactoryOverride\createConfigObject(), LanguageConfigFactoryOverride\onConfigDelete(), LanguageConfigFactoryOverride\onConfigRename(), and LanguageConfigFactoryOverride\onConfigSave().

Here is the call graph for this function:

Here is the caller graph for this function:

getStorage (   $langcode)

{Returns the storage instance for a particular langcode.

Parameters
string$langcodeLanguage code.
Returns
The storage instance for a particular langcode.
}

Implements LanguageConfigFactoryOverrideInterface.

Referenced by LanguageConfigFactoryOverride\getOverride(), LanguageConfigFactoryOverride\loadOverrides(), and LanguageConfigFactoryOverride\onConfigRename().

Here is the caller graph for this function:

loadOverrides (   $names)

{Returns config overrides.

Parameters
array$namesA list of configuration names that are being loaded.
Returns
array An array keyed by configuration name of override data. Override data contains a nested array structure of overrides.
}

Implements ConfigFactoryOverrideInterface.

References LanguageConfigFactoryOverride\getStorage().

Here is the call graph for this function:

onConfigDelete ( ConfigCrudEvent  $event)

{}

References ConfigCrudEvent\getConfig(), LanguageConfigFactoryOverride\getOverride(), and Drupal\languageManager().

Here is the call graph for this function:

onConfigRename ( ConfigRenameEvent  $event)

{}

References ConfigCrudEvent\getConfig(), ConfigRenameEvent\getOldName(), LanguageConfigFactoryOverride\getOverride(), LanguageConfigFactoryOverride\getStorage(), and Drupal\languageManager().

Here is the call graph for this function:

onConfigSave ( ConfigCrudEvent  $event)

{}

References ConfigFactoryOverrideBase\filterOverride(), ConfigCrudEvent\getConfig(), LanguageConfigFactoryOverride\getOverride(), and Drupal\languageManager().

Here is the call graph for this function:

setLanguage ( LanguageInterface  $language = NULL)

{Sets the language to be used in configuration overrides.

Parameters
\Drupal\Core\Language\LanguageInterface$languageThe language object used to override configuration data.
Returns
$this
}

Implements LanguageConfigFactoryOverrideInterface.

setLanguageFromDefault ( LanguageDefault  $language_default = NULL)

{Sets the language to be used in configuration overrides from the default.

Parameters
\Drupal\Core\Language\LanguageDefault$language_defaultThe default language.
Returns
$this
}

Implements LanguageConfigFactoryOverrideInterface.


The documentation for this class was generated from the following file: