class EckEntity in Entity Construction Kit (ECK) 8

Same name in this branch

8 src/Entity/EckEntity.php \Drupal\eck\Entity\EckEntity
8 src/Plugin/migrate/source/d7/EckEntity.php \Drupal\eck\Plugin\migrate\source\d7\EckEntity

Drupal 7 ECK Entity source from database.

A base class that gets ECK data from the source database.

Available configuration keys:

entity_type: (optional) The machine name of the ECK entity type.
bundle: (optional) The bundle name - can be a string or an array. If not

declared then all bundles will be retrieved.

For additional configuration keys, refer to the parent classes:

Plugin annotation


@MigrateSource(
  id = "d7_eck_entity",
  source_module = "eck"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
    class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
    class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait, DependencyTrait
    class \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity
    class \Drupal\eck\Plugin\migrate\source\d7\EckEntity

Expanded class hierarchy of EckEntity

File

src/Plugin/migrate/source/d7/EckEntity.php, line 32

Namespace

Drupal\eck\Plugin\migrate\source\d7

View source

class EckEntity extends FieldableEntity {

  /**
   * The Entity Type.
   *
   * @var string
   */
  protected $entityType;

  /**
   * The Bundle.
   *
   * @var string
   */
  protected $bundle;

  /**
   * The ECK Table name.
   *
   * @var string
   */
  protected $eckTable;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, StateInterface $state, EntityTypeManagerInterface $entity_manager) {
    $this->entityType = $configuration['entity_type'] ?? '';
    if (!\is_string($this->entityType)) {
      throw new MigrateException('The entity_type must be a string');
    }
    if (isset($configuration['bundle'])) {
      $this->bundle = $configuration['bundle'];
      if (!\is_string($this->bundle) && !\is_array($this->bundle)) {
        throw new MigrateException('The bundle must be a string or an array');
      }
    }
    $this->eckTable = 'eck_' . $this->entityType;
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $state, $entity_manager);
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $query = $this
      ->select($this->eckTable, 'eck')
      ->fields('eck');
    if (isset($this->bundle)) {
      $query
        ->condition('eck.type', (array) $this->bundle, 'IN');
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $language = $row
      ->getSourceProperty('language');
    $id = $row
      ->getSourceProperty('id');
    $vid = $row
      ->hasSourceProperty('revision_id') ? $row
      ->getSourceProperty('revision_id') : $id;

    // Get Field API field values.
    foreach ($this
      ->getFields($this->entityType, $this->bundle) as $field_name => $field) {

      // Ensure we're using the right language if the entity is translatable.
      $field_language = $field['translatable'] ? $language : NULL;
      $row
        ->setSourceProperty($field_name, $this
        ->getFieldValues($this->entityType, $field_name, $id, $vid, $field_language));
    }
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'id' => $this
        ->t('The primary identifier for the entity'),
      'type' => $this
        ->t('The bundle of the entity'),
      'title' => $this
        ->t('Title'),
      'uid' => $this
        ->t('Author'),
      'created' => $this
        ->t('Created'),
      'changed' => $this
        ->t('Changed'),
      'language' => $this
        ->t('Entity language code'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'id' => [
        'type' => 'integer',
        'alias' => 'eck',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function checkRequirements() {
    $table_name = 'eck_' . $this->entityType;
    if (!$this
      ->getDatabase()
      ->schema()
      ->tableExists($table_name)) {
      throw new RequirementsException("ECK table for '{$this->entityType}' does not exist");
    }
    parent::checkRequirements();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
DrupalSqlBase::$deprecatedProperties	protected	property		1
DrupalSqlBase::$entityTypeManager	protected	property	The entity type manager.
DrupalSqlBase::$requirements	protected	property	If the source provider is missing.
DrupalSqlBase::$systemData	protected	property	The contents of the system table.
DrupalSqlBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
DrupalSqlBase::create	public static	function	Creates an instance of the plugin. Overrides SqlBase::create	3
DrupalSqlBase::getModuleSchemaVersion	protected	function	Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData	public	function	Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists	protected	function	Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet	protected	function	Reads a variable from a source Drupal database.
EckEntity::$bundle	protected	property	The Bundle.
EckEntity::$eckTable	protected	property	The ECK Table name.
EckEntity::$entityType	protected	property	The Entity Type.
EckEntity::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides DrupalSqlBase::checkRequirements
EckEntity::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields	1
EckEntity::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds	1
EckEntity::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
EckEntity::query	public	function	Overrides SqlBase::query	1
EckEntity::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides DrupalSqlBase::__construct
FieldableEntity::getEntityTranslationSourceLanguage	protected	function	Gets an entity source language from the 'entity_translation' table.
FieldableEntity::getFields	protected	function	Returns all non-deleted field instances attached to a specific entity type.
FieldableEntity::getFieldValues	protected	function	Retrieves field values for a single field of a single entity.
FieldableEntity::isEntityTranslatable	protected	function	Checks if an entity type uses Entity Translation.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	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::current	public	function
SourcePluginBase::doCount	protected	function	Gets the source count checking if the source is countable or using the iterator_count function.	1
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.	1
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
SourcePluginBase::key	public	function	Gets the iterator key.
SourcePluginBase::next	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::postRollback	public	function	Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback	public	function	Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind	public	function	Rewinds the iterator.
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.
SqlBase::$state	protected	property	State service for retrieving database info.
SqlBase::count	public	function	Gets the source count. Overrides SourcePluginBase::count	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	20
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.
SqlBase::select	protected	function	Wrapper for database select.
SqlBase::setUpDatabase	protected	function	Gets a connection to the referenced database.
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.	1
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.

You are here