Drupal 8  8.0.2
ConfigFactoryInterface Interface Reference
Inheritance diagram for ConfigFactoryInterface:

Public Member Functions

 get ($name)
 
 getEditable ($name)
 
 loadMultiple (array $names)
 
 reset ($name=NULL)
 
 rename ($old_name, $new_name)
 
 getCacheKeys ()
 
 clearStaticCache ()
 
 listAll ($prefix= '')
 
 addOverride (ConfigFactoryOverrideInterface $config_factory_override)
 

Detailed Description

Defines the interface for a configuration object factory.

Member Function Documentation

addOverride ( ConfigFactoryOverrideInterface  $config_factory_override)

Adds config factory override services.

Parameters
\Drupal\Core\Config\ConfigFactoryOverrideInterface$config_factory_overrideThe config factory override service to add. It is added at the end of the priority list (lower priority relative to existing ones).

Implemented in ConfigFactory.

clearStaticCache ( )

Clears the config factory static cache.

Returns
$this

Implemented in ConfigFactory.

get (   $name)

Returns an immutable configuration object for a given name.

Parameters
string$nameThe name of the configuration object to construct.
Returns
A configuration object.

Implemented in ConfigFactory.

Referenced by DiffFormatter\__construct(), SysLog\__construct(), AutomatedCron\__construct(), UpdateFetcher\__construct(), ForumBreadcrumbBuilderBase\__construct(), FinishResponseSubscriber\__construct(), UpdateManager\__construct(), AjaxResponseAttachmentsProcessor\__construct(), UpdateProcessor\__construct(), HtmlResponseAttachmentsProcessor\__construct(), and ViewsData\__construct().

Here is the caller graph for this function:

getCacheKeys ( )

The cache keys associated with the state of the config factory.

All state information that can influence the result of a get() should be included. Typically, this includes a key for each override added via addOverride(). This allows external code to maintain caches of configuration data in addition to or instead of caches maintained by the factory.

Returns
array An array of strings, used to generate a cache ID.

Implemented in ConfigFactory.

getEditable (   $name)

Returns an mutable configuration object for a given name.

Should not be used for config that will have runtime effects. Therefore it is always loaded override free.

Parameters
string$nameThe name of the configuration object to construct.
Returns
A configuration object.

Implemented in ConfigFactory.

Referenced by Config\__construct().

Here is the caller graph for this function:

listAll (   $prefix = '')

Gets configuration object names starting with a given prefix.

See Also
::listAll()
Parameters
string$prefix(optional) The prefix to search for. If omitted, all configuration object names that exist are returned.
Returns
array An array containing matching configuration object names.

Implemented in ConfigFactory.

loadMultiple ( array  $names)

Returns a list of configuration objects for the given names.

This will pre-load all requested configuration objects does not create new configuration objects. This method always return immutable objects. ConfigFactoryInterface::getEditable() should be used to retrieve mutable configuration objects, one by one.

Parameters
array$namesList of names of configuration objects.
Returns
[] List of successfully loaded configuration objects, keyed by name.

Implemented in ConfigFactory.

rename (   $old_name,
  $new_name 
)

Renames a configuration object using the storage.

Parameters
string$old_nameThe old name of the configuration object.
string$new_nameThe new name of the configuration object.
Returns
$this

Implemented in ConfigFactory.

reset (   $name = NULL)

Resets and re-initializes configuration objects. Internal use only.

Parameters
string | null$name(optional) The name of the configuration object to reset. If omitted, all configuration objects are reset.
Returns
$this

Implemented in ConfigFactory.


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