class StubSourceGeneratorPlugin

Same name in other branches
  1. 8.9.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. 11.x core/modules/migrate/tests/src/Unit/MigrateSourceTest.php \Drupal\Tests\migrate\Unit\StubSourceGeneratorPlugin

Defines a stubbed source plugin with a generator as iterator.

This stub overwrites the $skipCount, $cacheCounts, and $trackChanges properties.

Hierarchy

Expanded class hierarchy of StubSourceGeneratorPlugin

File

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

Namespace

Drupal\Tests\migrate\Unit
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
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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. 2
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. 2
SourcePluginBase::current public function
SourcePluginBase::doCount protected function Gets the source count. 4
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.
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
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. 1
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 4
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 Returns available fields on the source. Overrides MigrateSourceInterface::fields
StubSourcePlugin::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
StubSourcePlugin::setModuleHandler public function Helper for setting internal module handler implementation.
StubSourcePlugin::__toString public function Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface::__toString

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