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\migrate\Plugin\migrate\source\ConfigEntity
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 | Modifiers | Object type | Summary |
---|---|---|---|
ConfigEntity::fields | public | function | Returns available fields on the source. |
ConfigEntity::getIds | public | function | Defines the source fields uniquely identifying a source row. |
ConfigEntity::prepareRow | public | function | Adds additional data to the row. |
ConfigEntity::query | public | function | Prepares query object to retrieve data from the source database. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.