Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\responsive_image\Entity;
Chris@0: 
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityBase;
Chris@0: use Drupal\image\Entity\ImageStyle;
Chris@0: use Drupal\responsive_image\ResponsiveImageStyleInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines the responsive image style entity.
Chris@0:  *
Chris@0:  * @ConfigEntityType(
Chris@0:  *   id = "responsive_image_style",
Chris@0:  *   label = @Translation("Responsive image style"),
Chris@17:  *   label_collection = @Translation("Responsive image styles"),
Chris@17:  *   label_singular = @Translation("responsive image style"),
Chris@17:  *   label_plural = @Translation("responsive image styles"),
Chris@17:  *   label_count = @PluralTranslation(
Chris@17:  *     singular = "@count responsive image style",
Chris@17:  *     plural = "@count responsive image styles",
Chris@17:  *   ),
Chris@0:  *   handlers = {
Chris@0:  *     "list_builder" = "Drupal\responsive_image\ResponsiveImageStyleListBuilder",
Chris@0:  *     "form" = {
Chris@0:  *       "edit" = "Drupal\responsive_image\ResponsiveImageStyleForm",
Chris@0:  *       "add" = "Drupal\responsive_image\ResponsiveImageStyleForm",
Chris@0:  *       "delete" = "Drupal\Core\Entity\EntityDeleteForm",
Chris@0:  *       "duplicate" = "Drupal\responsive_image\ResponsiveImageStyleForm"
Chris@0:  *     }
Chris@0:  *   },
Chris@0:  *   admin_permission = "administer responsive images",
Chris@0:  *   config_prefix = "styles",
Chris@0:  *   entity_keys = {
Chris@0:  *     "id" = "id",
Chris@0:  *     "label" = "label"
Chris@0:  *   },
Chris@18:  *   config_export = {
Chris@18:  *     "id",
Chris@18:  *     "label",
Chris@18:  *     "image_style_mappings",
Chris@18:  *     "breakpoint_group",
Chris@18:  *     "fallback_image_style",
Chris@18:  *   },
Chris@0:  *   links = {
Chris@0:  *     "edit-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}",
Chris@0:  *     "duplicate-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}/duplicate",
Chris@0:  *     "delete-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}/delete",
Chris@0:  *     "collection" = "/admin/config/media/responsive-image-style",
Chris@0:  *   }
Chris@0:  * )
Chris@0:  */
Chris@0: class ResponsiveImageStyle extends ConfigEntityBase implements ResponsiveImageStyleInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The responsive image ID (machine name).
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $id;
Chris@0: 
Chris@0:   /**
Chris@0:    * The responsive image label.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $label;
Chris@0: 
Chris@0:   /**
Chris@0:    * The image style mappings.
Chris@0:    *
Chris@0:    * Each image style mapping array contains the following keys:
Chris@0:    *   - image_mapping_type: Either 'image_style' or 'sizes'.
Chris@0:    *   - image_mapping:
Chris@0:    *     - If image_mapping_type is 'image_style', the image style ID (a
Chris@0:    *       string).
Chris@0:    *     - If image_mapping_type is 'sizes', an array with following keys:
Chris@0:    *       - sizes: The value for the 'sizes' attribute.
Chris@0:    *       - sizes_image_styles: The image styles to use for the 'srcset'
Chris@0:    *         attribute.
Chris@0:    *   - breakpoint_id: The breakpoint ID for this image style mapping.
Chris@0:    *   - multiplier: The multiplier for this image style mapping.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $image_style_mappings = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $keyedImageStyleMappings;
Chris@0: 
Chris@0:   /**
Chris@0:    * The responsive image breakpoint group.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $breakpoint_group = '';
Chris@0: 
Chris@0:   /**
Chris@0:    * The fallback image style.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $fallback_image_style = '';
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function __construct(array $values, $entity_type_id = 'responsive_image_style') {
Chris@0:     parent::__construct($values, $entity_type_id);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function addImageStyleMapping($breakpoint_id, $multiplier, array $image_style_mapping) {
Chris@0:     // If there is an existing mapping, overwrite it.
Chris@0:     foreach ($this->image_style_mappings as &$mapping) {
Chris@0:       if ($mapping['breakpoint_id'] === $breakpoint_id && $mapping['multiplier'] === $multiplier) {
Chris@0:         $mapping = [
Chris@0:           'breakpoint_id' => $breakpoint_id,
Chris@0:           'multiplier' => $multiplier,
Chris@0:         ] + $image_style_mapping;
Chris@0:         $this->keyedImageStyleMappings = NULL;
Chris@0:         return $this;
Chris@0:       }
Chris@0:     }
Chris@0:     $this->image_style_mappings[] = [
Chris@0:       'breakpoint_id' => $breakpoint_id,
Chris@0:       'multiplier' => $multiplier,
Chris@0:     ] + $image_style_mapping;
Chris@0:     $this->keyedImageStyleMappings = NULL;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function hasImageStyleMappings() {
Chris@0:     $mappings = $this->getKeyedImageStyleMappings();
Chris@0:     return !empty($mappings);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getKeyedImageStyleMappings() {
Chris@0:     if (!$this->keyedImageStyleMappings) {
Chris@0:       $this->keyedImageStyleMappings = [];
Chris@0:       foreach ($this->image_style_mappings as $mapping) {
Chris@0:         if (!static::isEmptyImageStyleMapping($mapping)) {
Chris@0:           $this->keyedImageStyleMappings[$mapping['breakpoint_id']][$mapping['multiplier']] = $mapping;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:     return $this->keyedImageStyleMappings;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getImageStyleMappings() {
Chris@0:     return $this->image_style_mappings;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setBreakpointGroup($breakpoint_group) {
Chris@0:     // If the breakpoint group is changed then the image style mappings are
Chris@0:     // invalid.
Chris@0:     if ($breakpoint_group !== $this->breakpoint_group) {
Chris@0:       $this->removeImageStyleMappings();
Chris@0:     }
Chris@0:     $this->breakpoint_group = $breakpoint_group;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getBreakpointGroup() {
Chris@0:     return $this->breakpoint_group;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setFallbackImageStyle($fallback_image_style) {
Chris@0:     $this->fallback_image_style = $fallback_image_style;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFallbackImageStyle() {
Chris@0:     return $this->fallback_image_style;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function removeImageStyleMappings() {
Chris@0:     $this->image_style_mappings = [];
Chris@0:     $this->keyedImageStyleMappings = NULL;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function calculateDependencies() {
Chris@0:     parent::calculateDependencies();
Chris@0:     $providers = \Drupal::service('breakpoint.manager')->getGroupProviders($this->breakpoint_group);
Chris@0:     foreach ($providers as $provider => $type) {
Chris@0:       $this->addDependency($type, $provider);
Chris@0:     }
Chris@0:     // Extract all the styles from the image style mappings.
Chris@0:     $styles = ImageStyle::loadMultiple($this->getImageStyleIds());
Chris@0:     array_walk($styles, function ($style) {
Chris@0:       $this->addDependency('config', $style->getConfigDependencyName());
Chris@0:     });
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function isEmptyImageStyleMapping(array $image_style_mapping) {
Chris@0:     if (!empty($image_style_mapping)) {
Chris@0:       switch ($image_style_mapping['image_mapping_type']) {
Chris@0:         case 'sizes':
Chris@0:           // The image style mapping must have a sizes attribute defined and one
Chris@0:           // or more image styles selected.
Chris@0:           if ($image_style_mapping['image_mapping']['sizes'] && $image_style_mapping['image_mapping']['sizes_image_styles']) {
Chris@0:             return FALSE;
Chris@0:           }
Chris@0:           break;
Chris@0:         case 'image_style':
Chris@0:           // The image style mapping must have an image style selected.
Chris@0:           if ($image_style_mapping['image_mapping']) {
Chris@0:             return FALSE;
Chris@0:           }
Chris@0:           break;
Chris@0:       }
Chris@0:     }
Chris@0:     return TRUE;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getImageStyleMapping($breakpoint_id, $multiplier) {
Chris@0:     $map = $this->getKeyedImageStyleMappings();
Chris@0:     if (isset($map[$breakpoint_id][$multiplier])) {
Chris@0:       return $map[$breakpoint_id][$multiplier];
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getImageStyleIds() {
Chris@0:     $image_styles = [$this->getFallbackImageStyle()];
Chris@0:     foreach ($this->getImageStyleMappings() as $image_style_mapping) {
Chris@0:       // Only image styles of non-empty mappings should be loaded.
Chris@0:       if (!$this::isEmptyImageStyleMapping($image_style_mapping)) {
Chris@0:         switch ($image_style_mapping['image_mapping_type']) {
Chris@0:           case 'image_style':
Chris@0:             $image_styles[] = $image_style_mapping['image_mapping'];
Chris@0:             break;
Chris@0:           case 'sizes':
Chris@0:             $image_styles = array_merge($image_styles, $image_style_mapping['image_mapping']['sizes_image_styles']);
Chris@0:             break;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:     return array_values(array_filter(array_unique($image_styles)));
Chris@0:   }
Chris@0: 
Chris@0: }