abstract class FieldableEntity in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity
Base class for D7 source plugins which need to collect field values from the Field API.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements MigrateSourceInterface
- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface, RequirementsInterface uses DependencyTrait
- class \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface, RequirementsInterface uses DependencyTrait
- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements MigrateSourceInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of FieldableEntity
3 files declare their use of FieldableEntity
- Comment.php in core/
modules/ comment/ src/ Plugin/ migrate/ source/ d7/ Comment.php - Contains \Drupal\comment\Plugin\migrate\source\d7\Comment.
- Node.php in core/
modules/ node/ src/ Plugin/ migrate/ source/ d7/ Node.php - Contains \Drupal\node\Plugin\migrate\source\d7\Node.
- User.php in core/
modules/ user/ src/ Plugin/ migrate/ source/ d7/ User.php - Contains \Drupal\user\Plugin\migrate\source\d7\User.
File
- core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ source/ d7/ FieldableEntity.php, line 16 - Contains \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity.
Namespace
Drupal\migrate_drupal\Plugin\migrate\source\d7View source
abstract class FieldableEntity extends DrupalSqlBase {
/**
* Returns all non-deleted field instances attached to a specific entity type.
*
* @param string $entity_type
* The entity type ID.
* @param string|NULL $bundle
* (optional) The bundle.
*
* @return array[]
* The field instances, keyed by field name.
*/
protected function getFields($entity_type, $bundle = NULL) {
return $this
->select('field_config_instance', 'fci')
->fields('fci')
->condition('entity_type', $entity_type)
->condition('bundle', isset($bundle) ? $bundle : $entity_type)
->condition('deleted', 0)
->execute()
->fetchAllAssoc('field_name');
}
/**
* Retrieves field values for a single field of a single entity.
*
* @param string $entity_type
* The entity type.
* @param string $field
* The field name.
* @param int $entity_id
* The entity ID.
* @param int|null $revision_id
* (optional) The entity revision ID.
*
* @return array
* The raw field values, keyed by delta.
*
* @todo Support multilingual field values.
*/
protected function getFieldValues($entity_type, $field, $entity_id, $revision_id = NULL) {
$table = (isset($revision_id) ? 'field_revision_' : 'field_data_') . $field;
$query = $this
->select($table, 't')
->fields('t')
->condition('entity_type', $entity_type)
->condition('entity_id', $entity_id)
->condition('deleted', 0);
if (isset($revision_id)) {
$query
->condition('revision_id', $revision_id);
}
$values = [];
foreach ($query
->execute() as $row) {
foreach ($row as $key => $value) {
$delta = $row['delta'];
if (strpos($key, $field) === 0) {
$column = substr($key, strlen($field) + 1);
$values[$delta][$column] = $value;
}
}
}
return $values;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | 1 |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
DrupalSqlBase:: |
protected | property | The entity manager. | |
DrupalSqlBase:: |
protected | property | If the source provider is missing. | |
DrupalSqlBase:: |
protected | property | The contents of the system table. | |
DrupalSqlBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
1 |
DrupalSqlBase:: |
public | function |
Checks if requirements for this plugin are OK. Overrides RequirementsInterface:: |
|
DrupalSqlBase:: |
public static | function |
Creates an instance of the plugin. Overrides SqlBase:: |
|
DrupalSqlBase:: |
protected | function | Get a module schema_version value in the source installation. | |
DrupalSqlBase:: |
public | function | Retrieves all system data information from origin system. | |
DrupalSqlBase:: |
protected | function | Check to see if a given module is enabled in the source installation. | |
DrupalSqlBase:: |
protected | function | Read a variable from a Drupal database. | |
DrupalSqlBase:: |
public | function |
Constructs a Drupal\Component\Plugin\PluginBase object. Overrides SqlBase:: |
1 |
FieldableEntity:: |
protected | function | Returns all non-deleted field instances attached to a specific entity type. | |
FieldableEntity:: |
protected | function | Retrieves field values for a single field of a single entity. | |
MigrateSourceInterface:: |
public | function | Returns available fields on the source. | 64 |
MigrateSourceInterface:: |
public | function | Defines the source fields uniquely identifying a source row. None of these fields should contain a NULL value - if necessary, use prepareRow() or hook_migrate_prepare_row() to rewrite NULL values to appropriate empty values (such as '' or 0). | 64 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | Whether this instance should cache the source count. | |
SourcePluginBase:: |
protected | property | Key to use for caching counts. | |
SourcePluginBase:: |
protected | property | The current row from the query | |
SourcePluginBase:: |
protected | property | The primary key of the current row | |
SourcePluginBase:: |
protected | property | The name and type of the highwater property in the source. | |
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | By default, next() will directly read the map row and add it to the data row. A source plugin implementation may do this itself (in particular, the SQL source can incorporate the map table into the query) - if so, it should set this TRUE so we… | |
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | The high water mark at the beginning of the import operation. | |
SourcePluginBase:: |
protected | property | Whether this instance should not attempt to count the source. | |
SourcePluginBase:: |
protected | property | If TRUE, we will maintain hashed source rows to determine whether incoming data has changed. | |
SourcePluginBase:: |
protected | function | Check if the incoming data is newer than what we've previously imported. | |
SourcePluginBase:: |
public | function | ||
SourcePluginBase:: |
protected | function | Get the cache object. | |
SourcePluginBase:: |
public | function | Getter for currentSourceIds data member. | |
SourcePluginBase:: |
protected | function | Returns the iterator that will yield the row arrays to be processed. | |
SourcePluginBase:: |
protected | function | Get the module handler. | |
SourcePluginBase:: |
public | function | Get the iterator key. | |
SourcePluginBase:: |
public | function | The migration iterates over rows returned by the source plugin. This method determines the next row which will be processed and imported into the system. | |
SourcePluginBase:: |
public | function |
Add additional data to the row. Overrides MigrateSourceInterface:: |
33 |
SourcePluginBase:: |
public | function | Rewind the iterator. | |
SourcePluginBase:: |
protected | function | Check if the incoming row has changed since our last import. | |
SourcePluginBase:: |
public | function | Whether the iterator is currently valid. | |
SqlBase:: |
protected | property | 1 | |
SqlBase:: |
protected | property | 59 | |
SqlBase:: |
protected | property | State service for retrieving database info. | |
SqlBase:: |
public | function |
Get the source count. Overrides SourcePluginBase:: |
4 |
SqlBase:: |
public | function | Get the database connection object. | 1 |
SqlBase:: |
protected | function |
Implementation of MigrateSource::performRewind(). Overrides SourcePluginBase:: |
18 |
SqlBase:: |
protected | function | Check if we can join against the map table. | 1 |
SqlBase:: |
protected | function | A helper for adding tags and metadata to the query. | |
SqlBase:: |
abstract public | function | 59 | |
SqlBase:: |
protected | function | Wrapper for database select. | |
SqlBase:: |
protected | function | Get a connection to the referenced database, adding the connection if necessary. | |
SqlBase:: |
public | function |
Print the query string when the object is used a string. Overrides MigrateSourceInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |