class EmptySource

Same name in this branch
  1. 11.x core/modules/migrate_drupal/src/Plugin/migrate/source/EmptySource.php \Drupal\migrate_drupal\Plugin\migrate\source\EmptySource
Same name in other branches
  1. 9 core/modules/migrate_drupal/src/Plugin/migrate/source/EmptySource.php \Drupal\migrate_drupal\Plugin\migrate\source\EmptySource
  2. 9 core/modules/migrate/src/Plugin/migrate/source/EmptySource.php \Drupal\migrate\Plugin\migrate\source\EmptySource
  3. 8.9.x core/modules/migrate_drupal/src/Plugin/migrate/source/EmptySource.php \Drupal\migrate_drupal\Plugin\migrate\source\EmptySource
  4. 8.9.x core/modules/migrate/src/Plugin/migrate/source/EmptySource.php \Drupal\migrate\Plugin\migrate\source\EmptySource
  5. 10 core/modules/migrate_drupal/src/Plugin/migrate/source/EmptySource.php \Drupal\migrate_drupal\Plugin\migrate\source\EmptySource
  6. 10 core/modules/migrate/src/Plugin/migrate/source/EmptySource.php \Drupal\migrate\Plugin\migrate\source\EmptySource

Source returning a row based on the constants provided.

Example:


source:
  plugin: empty
  constants:
    entity_type: user
    field_name: image

This will return a single row containing 'constants/entity_type' and 'constants/field_name' elements, with values of 'user' and 'image', respectively.

For additional configuration keys, refer to the parent class:

Plugin annotation


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

Hierarchy

Expanded class hierarchy of EmptySource

See also

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

1 file declares its use of EmptySource
EmptySource.php in core/modules/migrate_drupal/src/Plugin/migrate/source/EmptySource.php

File

core/modules/migrate/src/Plugin/migrate/source/EmptySource.php, line 30

Namespace

Drupal\migrate\Plugin\migrate\source
View source
class EmptySource extends SourcePluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'id' => $this->t('ID'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function initializeIterator() {
        return new \ArrayIterator([
            [
                'id' => '',
            ],
        ]);
    }
    
    /**
     * Allows class to decide how it will react when it is treated like a string.
     */
    public function __toString() {
        return '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['id']['type'] = 'string';
        return $ids;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function doCount() {
        return 1;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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::__toString public function Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface::__toString
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::$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. 2
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.
SourcePluginBase::__construct public function 4

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