Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\migrate\Plugin;
Chris@0: 
Chris@0: use Drupal\Component\Plugin\PluginInspectionInterface;
Chris@0: use Drupal\migrate\Row;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines an interface for migrate sources.
Chris@0:  *
Chris@0:  * @see \Drupal\migrate\Plugin\MigratePluginManager
Chris@0:  * @see \Drupal\migrate\Annotation\MigrateSource
Chris@0:  * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
Chris@0:  * @see plugin_api
Chris@0:  *
Chris@0:  * @ingroup migration
Chris@0:  */
Chris@0: interface MigrateSourceInterface extends \Countable, \Iterator, PluginInspectionInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns available fields on the source.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Available fields in the source, keys are the field machine names as used
Chris@0:    *   in field mappings, values are descriptions.
Chris@0:    */
Chris@0:   public function fields();
Chris@0: 
Chris@0:   /**
Chris@0:    * Adds additional data to the row.
Chris@0:    *
Chris@18:    * @param \Drupal\migrate\Row $row
Chris@0:    *   The row object.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   FALSE if this row needs to be skipped.
Chris@0:    */
Chris@0:   public function prepareRow(Row $row);
Chris@0: 
Chris@0:   /**
Chris@0:    * Allows class to decide how it will react when it is treated like a string.
Chris@0:    */
Chris@0:   public function __toString();
Chris@0: 
Chris@0:   /**
Chris@0:    * Defines the source fields uniquely identifying a source row.
Chris@0:    *
Chris@0:    * None of these fields should contain a NULL value. If necessary, use
Chris@0:    * prepareRow() or hook_migrate_prepare_row() to rewrite NULL values to
Chris@0:    * appropriate empty values (such as '' or 0).
Chris@0:    *
Chris@0:    * @return array[]
Chris@0:    *   An associative array of field definitions keyed by field ID. Values are
Chris@0:    *   associative arrays with a structure that contains the field type ('type'
Chris@0:    *   key). The other keys are the field storage settings as they are returned
Chris@12:    *   by FieldStorageDefinitionInterface::getSettings().
Chris@12:    *
Chris@12:    *   Examples:
Chris@12:    *
Chris@12:    *   A composite source primary key that is defined by an integer and a string
Chris@12:    *   might look like this:
Chris@0:    *   @code
Chris@0:    *     return [
Chris@0:    *       'id' => [
Chris@0:    *         'type' => 'integer',
Chris@0:    *         'unsigned' => FALSE,
Chris@0:    *         'size' => 'big',
Chris@0:    *       ],
Chris@0:    *       'version' => [
Chris@0:    *         'type' => 'string',
Chris@0:    *         'max_length' => 64,
Chris@0:    *         'is_ascii' => TRUE,
Chris@0:    *       ],
Chris@0:    *     ];
Chris@0:    *   @endcode
Chris@12:    *
Chris@0:    *   If 'type' points to a field plugin with multiple columns and needs to
Chris@0:    *   refer to a column different than 'value', the key of that column will be
Chris@0:    *   appended as a suffix to the plugin name, separated by dot ('.'). Example:
Chris@0:    *   @code
Chris@0:    *     return [
Chris@0:    *       'format' => [
Chris@0:    *         'type' => 'text.format',
Chris@0:    *       ],
Chris@0:    *     ];
Chris@0:    *   @endcode
Chris@12:    *
Chris@12:    *   Additional custom keys/values that are not part of field storage
Chris@12:    *   definition can be added as shown below. The most common setting
Chris@17:    *   passed along to the ID definition is table 'alias', used by the SqlBase
Chris@17:    *   source plugin in order to distinguish between ambiguous column names -
Chris@17:    *   for example, when a SQL source query joins two tables with the same
Chris@17:    *   column names.
Chris@0:    *   @code
Chris@0:    *     return [
Chris@0:    *       'nid' => [
Chris@0:    *         'type' => 'integer',
Chris@0:    *         'alias' => 'n',
Chris@0:    *       ],
Chris@0:    *     ];
Chris@0:    *   @endcode
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Field\FieldStorageDefinitionInterface::getSettings()
Chris@0:    * @see \Drupal\Core\Field\Plugin\Field\FieldType\IntegerItem
Chris@0:    * @see \Drupal\Core\Field\Plugin\Field\FieldType\StringItem
Chris@0:    * @see \Drupal\text\Plugin\Field\FieldType\TextItem
Chris@0:    * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
Chris@0:    */
Chris@0:   public function getIds();
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the source module providing the source data.
Chris@0:    *
Chris@0:    * @return string|null
Chris@0:    *   The source module or NULL if not found.
Chris@0:    */
Chris@0:   public function getSourceModule();
Chris@0: 
Chris@0: }