class VariableMultiRow

Drupal 6/7 multiple variables source from database.

Unlike the variable source plugin, this one returns one row per variable.

Available configuration keys:

• variables: (required) The list of variables to retrieve from the source database. Each variable is retrieved in a separate row.

Example:

plugin: variable_multirow
variables:
  - date_format_long
  - date_format_medium
  - date_format_short

In this example the specified variables are retrieved from the source database one row per variable.

For additional configuration keys, refer to the parent classes.

Plugin annotation

@MigrateSource(
  id = "variable_multirow",
  source_module = "system",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface
      • class \Drupal\migrate\Plugin\migrate\source\SqlBase extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface
        • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase extends \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait
          • class \Drupal\migrate_drupal\Plugin\migrate\source\VariableMultiRow extends \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase

Expanded class hierarchy of VariableMultiRow

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase

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

File

core/modules/migrate_drupal/src/Plugin/migrate/source/VariableMultiRow.php, line 42

Namespace

class VariableMultiRow extends DrupalSqlBase {
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        return $this->select('variable', 'v')
            ->fields('v', [
            'name',
            'value',
        ])
            ->condition('name', (array) $this->configuration['variables'], 'IN');
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'name' => $this->t('Name'),
            'value' => $this->t('Value'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        if ($value = $row->getSourceProperty('value')) {
            $row->setSourceProperty('value', unserialize($value));
        }
        return parent::prepareRow($row);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['name']['type'] = 'string';
        return $ids;
    }

}

Members