class MigrateSourceWithAnnotationsMultipleProviders

A migration source plugin with annotations and multiple providers.

This plugin exists to test backwards compatibility of source plugin discovery for plugin classes using annotations. This class has an additional provider, because it extends a plugin in migrate_drupal. This class and its annotation should remain until annotation support is completely removed.

Plugin annotation


@MigrateSource(
  id = "annotated_multiple_providers",
  source_module = "migrate"
)

Hierarchy

Expanded class hierarchy of MigrateSourceWithAnnotationsMultipleProviders

File

core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotationsMultipleProviders.php, line 22

Namespace

Drupal\migrate_source_annotation_bc_test\Plugin\migrate\source
View source
class MigrateSourceWithAnnotationsMultipleProviders extends EmptySource {
    
    /**
     * {@inheritdoc}
     */
    public function __toString() {
        return 'Annotated multiple providers';
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
EmptySource::$entityTypeManager protected property The entity type manager.
EmptySource::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EmptySource::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EmptySource::doCount protected function Gets the source count. Overrides SourcePluginBase::doCount
EmptySource::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
EmptySource::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
EmptySource::initializeIterator public function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator
EmptySource::__construct public function Overrides SourcePluginBase::__construct
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
MigrateSourceWithAnnotationsMultipleProviders::__toString public function Allows class to decide how it will react when it is treated like a string. Overrides EmptySource::__toString
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 7
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3
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. 3
SourcePluginBase::current public function
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 49
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.

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