class ImageStyleMappings
Transforms image style mappings.
Plugin annotation
@MigrateProcessPlugin(
  id = "image_style_mappings"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\migrate\ProcessPluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\responsive_image\Plugin\migrate\process\ImageStyleMappings extends \Drupal\migrate\ProcessPluginBase
 
 
- class \Drupal\migrate\ProcessPluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of ImageStyleMappings
File
- 
              core/modules/ responsive_image/ src/ Plugin/ migrate/ process/ ImageStyleMappings.php, line 17 
Namespace
Drupal\responsive_image\Plugin\migrate\processView source
class ImageStyleMappings extends ProcessPluginBase {
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!is_array($value)) {
      throw new MigrateException('Input should be an array');
    }
    [$mappings, $breakpoint_group] = $value;
    $new_value = [];
    foreach ($mappings as $mapping_id => $mapping) {
      // The id is in the key with the form
      // "breakpoints.theme.my_theme_id.image_style_machine_name". We want the
      // identifier after the last period.
      preg_match('/\\.([a-z0-9_]+)$/', $mapping_id, $matches);
      foreach ($mapping as $multiplier => $multiplier_settings) {
        if ($multiplier_settings['mapping_type'] == '_none') {
          continue;
        }
        $image_style = [
          'breakpoint_id' => $breakpoint_group . '.' . $matches[1],
          'multiplier' => $multiplier,
          'image_mapping_type' => $multiplier_settings['mapping_type'],
          'image_mapping' => $this->getMultiplierSettings($multiplier_settings),
        ];
        $new_value[] = $image_style;
      }
    }
    return $new_value;
  }
  
  /**
   * Extracts multiplier settings based on its type.
   *
   * @param array[] $multiplier_settings
   *   The multiplier settings.
   *
   * @return array
   *   The multiplier settings.
   */
  protected function getMultiplierSettings(array $multiplier_settings) {
    $settings = [];
    if ($multiplier_settings['mapping_type'] == 'image_style') {
      $settings = $multiplier_settings['image_style'];
    }
    elseif ($multiplier_settings['mapping_type'] == 'sizes') {
      $settings = [
        'sizes' => $multiplier_settings['sizes'],
        'sizes_image_styles' => array_values($multiplier_settings['sizes_image_styles']),
      ];
    }
    return $settings;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| ImageStyleMappings::getMultiplierSettings | protected | function | Extracts multiplier settings based on its type. | ||
| ImageStyleMappings::transform | public | function | Performs the associated process. | Overrides ProcessPluginBase::transform | |
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| 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 | 2 | 
| 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. | ||
| PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 85 | |
| ProcessPluginBase::multiple | public | function | Indicates whether the returned value requires multiple handling. | Overrides MigrateProcessInterface::multiple | 3 | 
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
