You are here

Home » API reference » Recipe 8.2 » Recipe61.php

class Recipe61 in Recipe 8.2

Drupal 6 recipe source from database.

Plugin annotation


@MigrateSource(
  id = "recipe61_recipe",
  source_module = "recipe"
)

Hierarchy

Expanded class hierarchy of Recipe61

1 file declares its use of Recipe61
MigrateRecipe61Test.php in tests/src/Kernel/Migrate/recipe61/MigrateRecipe61Test.php

File

src/Plugin/migrate/source/recipe61/Recipe61.php, line 17

Namespace

Drupal\recipe\Plugin\migrate\source\recipe61
View source 
class Recipe61 extends DrupalSqlBase {

  /**
   * Unit names that changed when the Drupal 7 version was introduced.
   *
   * @var string[]
   */
  const CHANGED_UNITS = [
    'pint' => 'us liquid pint',
    'quart' => 'us liquid quart',
    'gallon' => 'us gallon',
    'tablespoon (metric)' => 'tablespoon',
    'metric tablespoon' => 'tablespoon',
    'teaspoon (metric)' => 'teaspoon',
    'metric teaspoon' => 'teaspoon',
    'millilitre' => 'milliliter',
    'centilitre' => 'centiliter',
    'decilitre' => 'decilitre',
    'litre' => 'liter',
  ];

  /**
   * {@inheritdoc}
   */
  public function query() {
    $query = $this
      ->select('recipe', 'r')
      ->fields('r')
      ->orderBy('r.nid');
    $query
      ->join('node', 'n', 'r.nid = n.nid');
    $query
      ->fields('n', [
      'tnid',
      'language',
    ]);
    $this
      ->handleTranslations($query);
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {

    // Select the ingredient reference data and add it to the row.
    $query = $this
      ->select('recipe_node_ingredient', 'i');
    $query
      ->leftJoin('recipe_unit', 'ru', 'i.unit_id = ru.id');
    $query
      ->fields('i', [
      'quantity',
      'ingredient_id',
      'weight',
      'note',
    ])
      ->fields('ru', [
      'name',
    ])
      ->condition('nid', $row
      ->getSourceProperty('nid'))
      ->orderBy('weight', 'ASC');
    $results = $query
      ->execute();
    $ingredients = [];
    foreach ($results as $result) {

      // Check for updated unit names.
      $result['name'] = strtolower($result['name']);
      $result['unit_key'] = isset(self::CHANGED_UNITS[$result['name']]) ? self::CHANGED_UNITS[$result['name']] : $result['name'];
      $ingredients[] = $result;
    }
    $row
      ->setSourceProperty('ingredients', $ingredients);

    // Make sure we always have a translation set.
    if ($row
      ->getSourceProperty('tnid') == 0) {
      $row
        ->setSourceProperty('tnid', $row
        ->getSourceProperty('nid'));
    }
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'nid' => $this
        ->t('Recipe node ID'),
      'tnid' => $this
        ->t('The translation node ID'),
      'source' => $this
        ->t('Recipe source'),
      'yield' => $this
        ->t('Recipe yield amount'),
      'yield_unit' => $this
        ->t('Units of the recipe yield'),
      'description' => $this
        ->t('Recipe description'),
      'instructions' => $this
        ->t('Recipe instructions'),
      'notes' => $this
        ->t('Recipe notes'),
      'preptime' => $this
        ->t('Recipe preparation time'),
      'cooktime' => $this
        ->t('Recipe cook time'),
      'ingredients' => $this
        ->t('Recipe ingredients, measures, and notes'),
      'language' => $this
        ->t('Node language'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'nid' => [
        'type' => 'integer',
        'alias' => 'r',
      ],
    ];
  }

  /**
   * Adapt our query for translations.
   *
   * @param \Drupal\Core\Database\Query\SelectInterface $query
   *   The generated query.
   */
  protected function handleTranslations(SelectInterface $query) {

    // Check whether or not we want translations.
    if (empty($this->configuration['translations'])) {

      // No translations: Yield untranslated nodes, or default translations.
      $query
        ->where('n.tnid = 0 OR n.tnid = n.nid');
    }
    else {

      // Translations: Yield only non-default translations.
      $query
        ->where('n.tnid <> 0 AND n.tnid <> n.nid');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DrupalSqlBase::$deprecatedProperties protected property 1
DrupalSqlBase::$entityTypeManager protected property The entity type manager.
DrupalSqlBase::$requirements protected property If the source provider is missing.
DrupalSqlBase::$systemData protected property The contents of the system table.
DrupalSqlBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 2
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 3
DrupalSqlBase::getModuleSchemaVersion protected function Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData public function Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists protected function Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet protected function Reads a variable from a source Drupal database.
DrupalSqlBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct 6
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
Recipe61::CHANGED_UNITS constant Unit names that changed when the Drupal 7 version was introduced.
Recipe61::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
Recipe61::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
Recipe61::handleTranslations protected function Adapt our query for translations.
Recipe61::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
Recipe61::query public function Overrides SqlBase::query
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::current public function
SourcePluginBase::doCount protected function Gets the source count checking if the source is countable or using the iterator_count function. 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. 1
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 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::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind public function Rewinds the iterator.
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.
SqlBase::$batch protected property The count of the number of batches run.
SqlBase::$batchSize protected property Number of records to fetch from the database during each batch.
SqlBase::$database protected property The database object. 1
SqlBase::$query protected property The query string.
SqlBase::$state protected property State service for retrieving database info.
SqlBase::count public function Gets the source count. Overrides SourcePluginBase::count 6
SqlBase::fetchNextBatch protected function Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow protected function Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase public function Gets the database connection object. 2
SqlBase::initializeIterator protected function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator 20
SqlBase::mapJoinable protected function Checks if we can join against the map table. 1
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::select protected function Wrapper for database select.
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.