class ConfigEntity
Drupal configuration source from database.
Available configuration keys:
- collections: (optional) The collection of configuration storage to retrieve from the source - can be a string or an array. If omitted, configuration objects of all available collections are retrieved.
- names: (optional) Names of configuration objects to retrieve from the source - can be a string or an array. If omitted, all available configuration objects are retrieved.
Examples:
source:
plugin: config_entity
names:
- node.type.article
- node.type.page
In this example configuration objects of article and page content types are retrieved from the source database.
source:
plugin: config_entity
collections: language.fr
names:
- node.type.article
- node.type.page
In this example configuration objects are filtered by language.fr collection. As a result, French versions of specified configuration objects are retrieved from the source database.
For additional configuration keys, refer to the parent classes.
Attributes
#[MigrateSource('config_entity')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase extends \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\source\SqlBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- class \Drupal\migrate\Plugin\migrate\source\ConfigEntity implements \Drupal\migrate\Plugin\migrate\source\SqlBase
- class \Drupal\migrate\Plugin\migrate\source\SqlBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase extends \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of ConfigEntity
See also
\Drupal\migrate\Plugin\migrate\source\SqlBase
\Drupal\migrate\Plugin\migrate\source\SourcePluginBase
File
-
core/
modules/ migrate/ src/ Plugin/ migrate/ source/ ConfigEntity.php, line 52
Namespace
Drupal\migrate\Plugin\migrate\sourceView source
class ConfigEntity extends SqlBase {
/**
* {@inheritdoc}
*/
public function query() {
$query = $this->select('config', 'c')
->fields('c', [
'collection',
'name',
'data',
]);
if (!empty($this->configuration['collections'])) {
$query->condition('collection', (array) $this->configuration['collections'], 'IN');
}
if (!empty($this->configuration['names'])) {
$query->condition('name', (array) $this->configuration['names'], 'IN');
}
return $query;
}
/**
* {@inheritdoc}
*/
public function prepareRow(Row $row) {
$row->setSourceProperty('data', unserialize($row->getSourceProperty('data')));
return parent::prepareRow($row);
}
/**
* {@inheritdoc}
*/
public function fields() {
return [
'collection' => $this->t('The config object collection.'),
'name' => $this->t('The config object name.'),
'data' => $this->t('Serialized configuration object data.'),
];
}
/**
* {@inheritdoc}
*/
public function getIds() {
$ids['collection']['type'] = 'string';
$ids['name']['type'] = 'string';
return $ids;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
ConfigEntity::fields | public | function | Returns available fields on the source. | Overrides MigrateSourceInterface::fields | ||
ConfigEntity::getIds | public | function | Defines the source fields uniquely identifying a source row. | Overrides MigrateSourceInterface::getIds | ||
ConfigEntity::prepareRow | public | function | Adds additional data to the row. | Overrides SourcePluginBase::prepareRow | ||
ConfigEntity::query | public | function | Prepares query object to retrieve data from the source database. | Overrides SqlBase::query | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__wakeup | public | function | 3 | |||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
MigrateSourceInterface::NOT_COUNTABLE | constant | Indicates that the source is not countable. | ||||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
SourcePluginBase::$cache | protected | property | The backend cache. | |||
SourcePluginBase::$cacheCounts | protected | property | Whether this instance should cache the source count. | 1 | ||
SourcePluginBase::$cacheKey | protected | property | Key to use for caching counts. | |||
SourcePluginBase::$currentRow | protected | property | The current row from the query. | |||
SourcePluginBase::$currentSourceIds | protected | property | The primary key of the current row. | |||
SourcePluginBase::$highWaterProperty | protected | property | Information on the property used as the high-water mark. | |||
SourcePluginBase::$highWaterStorage | protected | property | The key-value storage for the high-water value. | |||
SourcePluginBase::$idMap | protected | property | The migration ID map. | |||
SourcePluginBase::$iterator | protected | property | The iterator to iterate over the source rows. | |||
SourcePluginBase::$mapRowAdded | protected | property | Flags whether source plugin will read the map row and add to data row. | |||
SourcePluginBase::$migration | protected | property | The entity migration object. | |||
SourcePluginBase::$moduleHandler | protected | property | The module handler service. | 2 | ||
SourcePluginBase::$originalHighWater | protected | property | The high water mark at the beginning of the import operation. | |||
SourcePluginBase::$skipCount | protected | property | Whether this instance should not attempt to count the source. | 1 | ||
SourcePluginBase::$trackChanges | protected | property | Flags whether to track changes to incoming data. | 1 | ||
SourcePluginBase::aboveHighWater | protected | function | Check if the incoming data is newer than what we've previously imported. | |||
SourcePluginBase::count | public | function | Gets the source count. | 3 | ||
SourcePluginBase::current | public | function | ||||
SourcePluginBase::getCache | protected | function | Gets the cache object. | |||
SourcePluginBase::getCurrentIds | public | function | Gets the currentSourceIds data member. | |||
SourcePluginBase::getHighWater | protected | function | The current value of the high water mark. | |||
SourcePluginBase::getHighWaterField | protected | function | Get the name of the field used as the high watermark. | |||
SourcePluginBase::getHighWaterProperty | protected | function | Get information on the property used as the high watermark. | |||
SourcePluginBase::getHighWaterStorage | protected | function | Get the high water storage object. | |||
SourcePluginBase::getIterator | protected | function | Returns the iterator that will yield the row arrays to be processed. | |||
SourcePluginBase::getModuleHandler | protected | function | Gets the module handler. | |||
SourcePluginBase::getSourceModule | public | function | Gets the source module providing the source data. | Overrides MigrateSourceInterface::getSourceModule | 1 | |
SourcePluginBase::key | public | function | Gets the iterator key. | |||
SourcePluginBase::next | public | function | ||||
SourcePluginBase::postRollback | public | function | Performs post-rollback tasks. | Overrides RollbackAwareInterface::postRollback | ||
SourcePluginBase::preRollback | public | function | Performs pre-rollback tasks. | Overrides RollbackAwareInterface::preRollback | ||
SourcePluginBase::rowChanged | protected | function | Checks if the incoming row has changed since our last import. | |||
SourcePluginBase::saveHighWater | protected | function | Save the new high water mark. | |||
SourcePluginBase::valid | public | function | Checks whether the iterator is currently valid. | |||
SqlBase::$batch | protected | property | The count of the number of batches run. | |||
SqlBase::$batchSize | protected | property | Number of records to fetch from the database during each batch. | |||
SqlBase::$database | protected | property | The database object. | 1 | ||
SqlBase::$query | protected | property | The query string. | 85 | ||
SqlBase::$state | protected | property | State service for retrieving database info. | |||
SqlBase::checkRequirements | public | function | Checks if requirements for this plugin are OK. | Overrides RequirementsInterface::checkRequirements | 1 | |
SqlBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 1 | |
SqlBase::doCount | protected | function | Gets the source count using countQuery(). | Overrides SourcePluginBase::doCount | 6 | |
SqlBase::fetchNextBatch | protected | function | Prepares query for the next set of data from the source database. | |||
SqlBase::fetchNextRow | protected | function | Position the iterator to the following row. | Overrides SourcePluginBase::fetchNextRow | ||
SqlBase::getDatabase | public | function | Gets the database connection object. | 2 | ||
SqlBase::initializeIterator | protected | function | Initializes the iterator with the source data. | Overrides SourcePluginBase::initializeIterator | 18 | |
SqlBase::mapJoinable | protected | function | Checks if we can join against the map table. | 1 | ||
SqlBase::prepareQuery | protected | function | Adds tags and metadata to the query. | 1 | ||
SqlBase::rewind | public | function | Rewinds the iterator. | Overrides SourcePluginBase::rewind | ||
SqlBase::select | protected | function | Wrapper for database select. | |||
SqlBase::setUpDatabase | protected | function | Gets a connection to the referenced database. | |||
SqlBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides SourcePluginBase::__construct | 3 | |
SqlBase::__sleep | public | function | Overrides DependencySerializationTrait::__sleep | |||
SqlBase::__toString | public | function | Prints the query string when the object is used as a string. | Overrides MigrateSourceInterface::__toString | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.