class StubSourceGeneratorPlugin

Same name and namespace in other branches
  1. 11.x core/modules/migrate/tests/src/Unit/MigrateSourceTest.php \Drupal\Tests\migrate\Unit\StubSourceGeneratorPlugin
  2. 10 core/modules/migrate/tests/src/Unit/MigrateSourceTest.php \Drupal\Tests\migrate\Unit\StubSourceGeneratorPlugin
  3. 9 core/modules/migrate/tests/src/Unit/MigrateSourceTest.php \Drupal\Tests\migrate\Unit\StubSourceGeneratorPlugin

Stubbed source plugin with a generator as iterator. Also it overwrites the $skipCount, $cacheCounts and $trackChanges properties.

Hierarchy

Expanded class hierarchy of StubSourceGeneratorPlugin

File

core/modules/migrate/tests/src/Unit/MigrateSourceTest.php, line 503

Namespace

Drupal\Tests\migrate\Unit
View on git.drupalcode.org
View source 
class StubSourceGeneratorPlugin extends StubSourcePlugin {
  
  /**
   * {@inheritdoc}
   */
  protected $skipCount = TRUE;
  
  /**
   * {@inheritdoc}
   */
  protected $cacheCounts = TRUE;
  
  /**
   * {@inheritdoc}
   */
  protected $trackChanges = TRUE;
  
  /**
   * Return the skipCount value.
   */
  public function getSkipCount() {
    return $this->skipCount;
  }
  
  /**
   * Return the cacheCounts value.
   */
  public function getCacheCounts() {
    return $this->cacheCounts;
  }
  
  /**
   * Return the trackChanges value.
   */
  public function getTrackChanges() {
    return $this->trackChanges;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $data = [
      [
        'title' => 'foo',
      ],
      [
        'title' => 'bar',
      ],
      [
        'title' => 'iggy',
      ],
    ];
    foreach ($data as $row) {
      yield $row;
    }
  }

}

Members

Title Modifiers Object type Summary Overriden Title 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
DependencySerializationTrait::__wakeup public function
MessengerTrait::$messenger protected property The messenger. 3
MessengerTrait::messenger public function Gets the messenger. 3
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.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
SourcePluginBase::$cache protected property The backend cache.
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.
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
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.
SourcePluginBase::current public function
SourcePluginBase::doCount protected function Gets the source count checking if the source is countable or using the
iterator_count function.
SourcePluginBase::fetchNextRow protected function Position the iterator to the following row.
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
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
SourcePluginBase::prepareRow public function 3
SourcePluginBase::preRollback public function
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.
SourcePluginBase::__construct public function
StringTranslationTrait::$stringTranslation protected property The string translation service.
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StubSourceGeneratorPlugin::$cacheCounts protected property Whether this instance should cache the source count. Overrides SourcePluginBase::$cacheCounts
StubSourceGeneratorPlugin::$skipCount protected property Whether this instance should not attempt to count the source. Overrides SourcePluginBase::$skipCount
StubSourceGeneratorPlugin::$trackChanges protected property Flags whether to track changes to incoming data. Overrides SourcePluginBase::$trackChanges
StubSourceGeneratorPlugin::getCacheCounts public function Return the cacheCounts value.
StubSourceGeneratorPlugin::getSkipCount public function Return the skipCount value.
StubSourceGeneratorPlugin::getTrackChanges public function Return the trackChanges value.
StubSourceGeneratorPlugin::initializeIterator protected function Initializes the iterator with the source data. Overrides StubSourcePlugin::initializeIterator
StubSourcePlugin::fields public function
StubSourcePlugin::getIds public function
StubSourcePlugin::setModuleHandler public function Helper for setting internal module handler implementation.
StubSourcePlugin::__toString public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.