function SourcePluginBase::getHighWaterField

Same name in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php \Drupal\migrate\Plugin\migrate\source\SourcePluginBase::getHighWaterField()
  2. 8.9.x core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php \Drupal\migrate\Plugin\migrate\source\SourcePluginBase::getHighWaterField()
  3. 11.x core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php \Drupal\migrate\Plugin\migrate\source\SourcePluginBase::getHighWaterField()

Get the name of the field used as the high watermark.

The name of the field qualified with an alias if available.

Return value

string|null The name of the field for the high water mark, or NULL if not set.

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase::initializeIterator()

1 call to SourcePluginBase::getHighWaterField()
SqlBase::initializeIterator in core/modules/migrate/src/Plugin/migrate/source/SqlBase.php
Initializes the iterator with the source data.

File

core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php, line 604

Class

SourcePluginBase
The base class for source plugins.

Namespace

Drupal\migrate\Plugin\migrate\source

Code

protected function getHighWaterField() {
    if (!empty($this->highWaterProperty['name'])) {
        return !empty($this->highWaterProperty['alias']) ? $this->highWaterProperty['alias'] . '.' . $this->highWaterProperty['name'] : $this->highWaterProperty['name'];
    }
    return NULL;
}

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