class ImageStyleMappings

Same name and namespace in other branches
  1. 9 core/modules/responsive_image/src/Plugin/migrate/process/ImageStyleMappings.php \Drupal\responsive_image\Plugin\migrate\process\ImageStyleMappings
  2. 11.x core/modules/responsive_image/src/Plugin/migrate/process/ImageStyleMappings.php \Drupal\responsive_image\Plugin\migrate\process\ImageStyleMappings

Transforms image style mappings.

Hierarchy

Expanded class hierarchy of ImageStyleMappings

File

core/modules/responsive_image/src/Plugin/migrate/process/ImageStyleMappings.php, line 14

Namespace

Drupal\responsive_image\Plugin\migrate\process
View 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
ImageStyleMappings::getMultiplierSettings protected function Extracts multiplier settings based on its type.
ImageStyleMappings::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.