class StubSourcePlugin in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/migrate/tests/src/Unit/MigrateSourceTest.php \Drupal\Tests\migrate\Unit\StubSourcePlugin
Stubbed source plugin for testing base class implementations.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements MigrateSourceInterface
- class \Drupal\Tests\migrate\Unit\StubSourcePlugin
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements MigrateSourceInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of StubSourcePlugin
File
- core/
modules/ migrate/ tests/ src/ Unit/ MigrateSourceTest.php, line 391 - Contains \Drupal\Tests\migrate\Unit\MigrateSourceTest.
Namespace
Drupal\Tests\migrate\UnitView source
class StubSourcePlugin extends SourcePluginBase {
/**
* Helper for setting internal module handler implementation.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
*/
function setModuleHandler(ModuleHandlerInterface $module_handler) {
$this->moduleHandler = $module_handler;
}
/**
* {@inheritdoc}
*/
public function fields() {
return [];
}
/**
* {@inheritdoc}
*/
public function __toString() {
return '';
}
/**
* {@inheritdoc}
*/
public function getIds() {
return [];
}
/**
* {@inheritdoc}
*/
protected function initializeIterator() {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | Whether this instance should cache the source count. | |
SourcePluginBase:: |
protected | property | Key to use for caching counts. | |
SourcePluginBase:: |
protected | property | The current row from the query | |
SourcePluginBase:: |
protected | property | The primary key of the current row | |
SourcePluginBase:: |
protected | property | The name and type of the highwater property in the source. | |
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | By default, next() will directly read the map row and add it to the data row. A source plugin implementation may do this itself (in particular, the SQL source can incorporate the map table into the query) - if so, it should set this TRUE so we… | |
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | ||
SourcePluginBase:: |
protected | property | The high water mark at the beginning of the import operation. | |
SourcePluginBase:: |
protected | property | Whether this instance should not attempt to count the source. | |
SourcePluginBase:: |
protected | property | If TRUE, we will maintain hashed source rows to determine whether incoming data has changed. | |
SourcePluginBase:: |
protected | function | Check if the incoming data is newer than what we've previously imported. | |
SourcePluginBase:: |
public | function | Get the source count. | 3 |
SourcePluginBase:: |
public | function | ||
SourcePluginBase:: |
protected | function | Get the cache object. | |
SourcePluginBase:: |
public | function | Getter for currentSourceIds data member. | |
SourcePluginBase:: |
protected | function | Returns the iterator that will yield the row arrays to be processed. | |
SourcePluginBase:: |
protected | function | Get the module handler. | |
SourcePluginBase:: |
public | function | Get the iterator key. | |
SourcePluginBase:: |
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:: |
public | function |
Add additional data to the row. Overrides MigrateSourceInterface:: |
33 |
SourcePluginBase:: |
public | function | Rewind the iterator. | |
SourcePluginBase:: |
protected | function | Check if the incoming row has changed since our last import. | |
SourcePluginBase:: |
public | function | Whether the iterator is currently valid. | |
SourcePluginBase:: |
public | function |
Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
3 |
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
StubSourcePlugin:: |
public | function |
Returns available fields on the source. Overrides MigrateSourceInterface:: |
|
StubSourcePlugin:: |
public | function |
Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface:: |
|
StubSourcePlugin:: |
protected | function |
Initializes the iterator with the source data. Overrides SourcePluginBase:: |
|
StubSourcePlugin:: |
function | Helper for setting internal module handler implementation. | ||
StubSourcePlugin:: |
public | function |
Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface:: |