You are here

Home » API reference » Workbench Moderation to Content Moderation 8.2 » ContentEntity.php

class ContentEntity in Workbench Moderation to Content Moderation 8.2

Loads certain fields from all content entities of a specific type.

Plugin annotation


@MigrateSource(
  id = "content_entity",
  deriver = "\Drupal\wbm2cm\Plugin\migrate\source\ContentEntityDeriver",
)

Hierarchy

Expanded class hierarchy of ContentEntity

File

src/Plugin/migrate/source/ContentEntity.php, line 20

Namespace

Drupal\wbm2cm\Plugin\migrate\source
View source 
class ContentEntity extends SourcePluginBase implements ContainerFactoryPluginInterface {

  /**
   * The entity storage handler.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * ContentEntity constructor.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityTypeManagerInterface $entity_type_manager) {

    // Merge in default configuration.
    $configuration += [
      'fields' => [],
      'keys' => [
        'id',
      ],
      'include_translations' => TRUE,
    ];
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->storage = $entity_type_manager
      ->getStorage($this
      ->getDerivativeId());
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container
      ->get('entity_type.manager'));
  }

  /**
   * Streams the available entities.
   *
   * @return \Generator
   */
  protected function load() {
    foreach ($this->storage
      ->getQuery()
      ->execute() as $id) {
      (yield $this->storage
        ->load($id));
    }
  }
  protected function buildRow(ContentEntityInterface $entity) {
    $row = [];
    foreach ($this
      ->fields() as $field) {
      $items = $entity
        ->get($field);
      $property = $items
        ->getFieldDefinition()
        ->getFieldStorageDefinition()
        ->getMainPropertyName();
      $row[$field] = $items->{$property};
    }
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $rows = [];

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    foreach ($this
      ->load() as $entity) {
      array_push($rows, $this
        ->buildRow($entity));
      if ($this->configuration['include_translations']) {
        $languages = array_keys($entity
          ->getTranslationLanguages(FALSE));
        foreach ($languages as $language) {
          $translation = $entity
            ->getTranslation($language);
          array_push($rows, $this
            ->buildRow($translation));
        }
      }
    }
    return new \ArrayIterator($rows);
  }

  /**
   * {@inheritdoc}
   */
  public function __toString() {
    return $this->storage
      ->getEntityType()
      ->getPluralLabel();
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = [];
    $entity_type = $this->storage
      ->getEntityType();
    foreach ($this->configuration['keys'] as $key) {
      $key = $entity_type
        ->getKey($key);
      $fields[$key] = $key;
    }
    return $fields + array_combine($this->configuration['fields'], $this->configuration['fields']);
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $entity_type = $this->storage
      ->getEntityType();

    // Always identify each entity by its ID at least.
    $ids = [
      $entity_type
        ->getKey('id') => [
        'type' => 'integer',
      ],
    ];

    // If the entity type supports revisions, identify each entity by their
    // revision ID as well.
    if ($entity_type
      ->isRevisionable()) {
      $revision = $entity_type
        ->getKey('revision');
      $ids[$revision]['type'] = 'integer';
    }

    // If the entity type supports translations, identify each entity by its
    // language code as well.
    if ($entity_type
      ->isTranslatable()) {
      $langcode = $entity_type
        ->getKey('langcode');
      $ids[$langcode]['type'] = 'string';
    }
    return $ids;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentEntity::$storage protected property The entity storage handler.
ContentEntity::buildRow protected function
ContentEntity::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ContentEntity::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
ContentEntity::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
ContentEntity::initializeIterator protected function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator
ContentEntity::load protected function Streams the available entities. 1
ContentEntity::__construct public function ContentEntity constructor. Overrides SourcePluginBase::__construct
ContentEntity::__toString public function Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface::__toString
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
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::count public function Gets the source count. 4
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::fetchNextRow protected function Position the iterator to the following row. 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::prepareRow public function Adds additional data to the row. Overrides MigrateSourceInterface::prepareRow 50
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.
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.