Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 namespace Drupal\responsive_image\Entity;
|
Chris@0
|
4
|
Chris@0
|
5 use Drupal\Core\Config\Entity\ConfigEntityBase;
|
Chris@0
|
6 use Drupal\image\Entity\ImageStyle;
|
Chris@0
|
7 use Drupal\responsive_image\ResponsiveImageStyleInterface;
|
Chris@0
|
8
|
Chris@0
|
9 /**
|
Chris@0
|
10 * Defines the responsive image style entity.
|
Chris@0
|
11 *
|
Chris@0
|
12 * @ConfigEntityType(
|
Chris@0
|
13 * id = "responsive_image_style",
|
Chris@0
|
14 * label = @Translation("Responsive image style"),
|
Chris@17
|
15 * label_collection = @Translation("Responsive image styles"),
|
Chris@17
|
16 * label_singular = @Translation("responsive image style"),
|
Chris@17
|
17 * label_plural = @Translation("responsive image styles"),
|
Chris@17
|
18 * label_count = @PluralTranslation(
|
Chris@17
|
19 * singular = "@count responsive image style",
|
Chris@17
|
20 * plural = "@count responsive image styles",
|
Chris@17
|
21 * ),
|
Chris@0
|
22 * handlers = {
|
Chris@0
|
23 * "list_builder" = "Drupal\responsive_image\ResponsiveImageStyleListBuilder",
|
Chris@0
|
24 * "form" = {
|
Chris@0
|
25 * "edit" = "Drupal\responsive_image\ResponsiveImageStyleForm",
|
Chris@0
|
26 * "add" = "Drupal\responsive_image\ResponsiveImageStyleForm",
|
Chris@0
|
27 * "delete" = "Drupal\Core\Entity\EntityDeleteForm",
|
Chris@0
|
28 * "duplicate" = "Drupal\responsive_image\ResponsiveImageStyleForm"
|
Chris@0
|
29 * }
|
Chris@0
|
30 * },
|
Chris@0
|
31 * admin_permission = "administer responsive images",
|
Chris@0
|
32 * config_prefix = "styles",
|
Chris@0
|
33 * entity_keys = {
|
Chris@0
|
34 * "id" = "id",
|
Chris@0
|
35 * "label" = "label"
|
Chris@0
|
36 * },
|
Chris@18
|
37 * config_export = {
|
Chris@18
|
38 * "id",
|
Chris@18
|
39 * "label",
|
Chris@18
|
40 * "image_style_mappings",
|
Chris@18
|
41 * "breakpoint_group",
|
Chris@18
|
42 * "fallback_image_style",
|
Chris@18
|
43 * },
|
Chris@0
|
44 * links = {
|
Chris@0
|
45 * "edit-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}",
|
Chris@0
|
46 * "duplicate-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}/duplicate",
|
Chris@0
|
47 * "delete-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}/delete",
|
Chris@0
|
48 * "collection" = "/admin/config/media/responsive-image-style",
|
Chris@0
|
49 * }
|
Chris@0
|
50 * )
|
Chris@0
|
51 */
|
Chris@0
|
52 class ResponsiveImageStyle extends ConfigEntityBase implements ResponsiveImageStyleInterface {
|
Chris@0
|
53
|
Chris@0
|
54 /**
|
Chris@0
|
55 * The responsive image ID (machine name).
|
Chris@0
|
56 *
|
Chris@0
|
57 * @var string
|
Chris@0
|
58 */
|
Chris@0
|
59 protected $id;
|
Chris@0
|
60
|
Chris@0
|
61 /**
|
Chris@0
|
62 * The responsive image label.
|
Chris@0
|
63 *
|
Chris@0
|
64 * @var string
|
Chris@0
|
65 */
|
Chris@0
|
66 protected $label;
|
Chris@0
|
67
|
Chris@0
|
68 /**
|
Chris@0
|
69 * The image style mappings.
|
Chris@0
|
70 *
|
Chris@0
|
71 * Each image style mapping array contains the following keys:
|
Chris@0
|
72 * - image_mapping_type: Either 'image_style' or 'sizes'.
|
Chris@0
|
73 * - image_mapping:
|
Chris@0
|
74 * - If image_mapping_type is 'image_style', the image style ID (a
|
Chris@0
|
75 * string).
|
Chris@0
|
76 * - If image_mapping_type is 'sizes', an array with following keys:
|
Chris@0
|
77 * - sizes: The value for the 'sizes' attribute.
|
Chris@0
|
78 * - sizes_image_styles: The image styles to use for the 'srcset'
|
Chris@0
|
79 * attribute.
|
Chris@0
|
80 * - breakpoint_id: The breakpoint ID for this image style mapping.
|
Chris@0
|
81 * - multiplier: The multiplier for this image style mapping.
|
Chris@0
|
82 *
|
Chris@0
|
83 * @var array
|
Chris@0
|
84 */
|
Chris@0
|
85 protected $image_style_mappings = [];
|
Chris@0
|
86
|
Chris@0
|
87 /**
|
Chris@0
|
88 * @var array
|
Chris@0
|
89 */
|
Chris@0
|
90 protected $keyedImageStyleMappings;
|
Chris@0
|
91
|
Chris@0
|
92 /**
|
Chris@0
|
93 * The responsive image breakpoint group.
|
Chris@0
|
94 *
|
Chris@0
|
95 * @var string
|
Chris@0
|
96 */
|
Chris@0
|
97 protected $breakpoint_group = '';
|
Chris@0
|
98
|
Chris@0
|
99 /**
|
Chris@0
|
100 * The fallback image style.
|
Chris@0
|
101 *
|
Chris@0
|
102 * @var string
|
Chris@0
|
103 */
|
Chris@0
|
104 protected $fallback_image_style = '';
|
Chris@0
|
105
|
Chris@0
|
106 /**
|
Chris@0
|
107 * {@inheritdoc}
|
Chris@0
|
108 */
|
Chris@0
|
109 public function __construct(array $values, $entity_type_id = 'responsive_image_style') {
|
Chris@0
|
110 parent::__construct($values, $entity_type_id);
|
Chris@0
|
111 }
|
Chris@0
|
112
|
Chris@0
|
113 /**
|
Chris@0
|
114 * {@inheritdoc}
|
Chris@0
|
115 */
|
Chris@0
|
116 public function addImageStyleMapping($breakpoint_id, $multiplier, array $image_style_mapping) {
|
Chris@0
|
117 // If there is an existing mapping, overwrite it.
|
Chris@0
|
118 foreach ($this->image_style_mappings as &$mapping) {
|
Chris@0
|
119 if ($mapping['breakpoint_id'] === $breakpoint_id && $mapping['multiplier'] === $multiplier) {
|
Chris@0
|
120 $mapping = [
|
Chris@0
|
121 'breakpoint_id' => $breakpoint_id,
|
Chris@0
|
122 'multiplier' => $multiplier,
|
Chris@0
|
123 ] + $image_style_mapping;
|
Chris@0
|
124 $this->keyedImageStyleMappings = NULL;
|
Chris@0
|
125 return $this;
|
Chris@0
|
126 }
|
Chris@0
|
127 }
|
Chris@0
|
128 $this->image_style_mappings[] = [
|
Chris@0
|
129 'breakpoint_id' => $breakpoint_id,
|
Chris@0
|
130 'multiplier' => $multiplier,
|
Chris@0
|
131 ] + $image_style_mapping;
|
Chris@0
|
132 $this->keyedImageStyleMappings = NULL;
|
Chris@0
|
133 return $this;
|
Chris@0
|
134 }
|
Chris@0
|
135
|
Chris@0
|
136 /**
|
Chris@0
|
137 * {@inheritdoc}
|
Chris@0
|
138 */
|
Chris@0
|
139 public function hasImageStyleMappings() {
|
Chris@0
|
140 $mappings = $this->getKeyedImageStyleMappings();
|
Chris@0
|
141 return !empty($mappings);
|
Chris@0
|
142 }
|
Chris@0
|
143
|
Chris@0
|
144 /**
|
Chris@0
|
145 * {@inheritdoc}
|
Chris@0
|
146 */
|
Chris@0
|
147 public function getKeyedImageStyleMappings() {
|
Chris@0
|
148 if (!$this->keyedImageStyleMappings) {
|
Chris@0
|
149 $this->keyedImageStyleMappings = [];
|
Chris@0
|
150 foreach ($this->image_style_mappings as $mapping) {
|
Chris@0
|
151 if (!static::isEmptyImageStyleMapping($mapping)) {
|
Chris@0
|
152 $this->keyedImageStyleMappings[$mapping['breakpoint_id']][$mapping['multiplier']] = $mapping;
|
Chris@0
|
153 }
|
Chris@0
|
154 }
|
Chris@0
|
155 }
|
Chris@0
|
156 return $this->keyedImageStyleMappings;
|
Chris@0
|
157 }
|
Chris@0
|
158
|
Chris@0
|
159 /**
|
Chris@0
|
160 * {@inheritdoc}
|
Chris@0
|
161 */
|
Chris@0
|
162 public function getImageStyleMappings() {
|
Chris@0
|
163 return $this->image_style_mappings;
|
Chris@0
|
164 }
|
Chris@0
|
165
|
Chris@0
|
166 /**
|
Chris@0
|
167 * {@inheritdoc}
|
Chris@0
|
168 */
|
Chris@0
|
169 public function setBreakpointGroup($breakpoint_group) {
|
Chris@0
|
170 // If the breakpoint group is changed then the image style mappings are
|
Chris@0
|
171 // invalid.
|
Chris@0
|
172 if ($breakpoint_group !== $this->breakpoint_group) {
|
Chris@0
|
173 $this->removeImageStyleMappings();
|
Chris@0
|
174 }
|
Chris@0
|
175 $this->breakpoint_group = $breakpoint_group;
|
Chris@0
|
176 return $this;
|
Chris@0
|
177 }
|
Chris@0
|
178
|
Chris@0
|
179 /**
|
Chris@0
|
180 * {@inheritdoc}
|
Chris@0
|
181 */
|
Chris@0
|
182 public function getBreakpointGroup() {
|
Chris@0
|
183 return $this->breakpoint_group;
|
Chris@0
|
184 }
|
Chris@0
|
185
|
Chris@0
|
186 /**
|
Chris@0
|
187 * {@inheritdoc}
|
Chris@0
|
188 */
|
Chris@0
|
189 public function setFallbackImageStyle($fallback_image_style) {
|
Chris@0
|
190 $this->fallback_image_style = $fallback_image_style;
|
Chris@0
|
191 return $this;
|
Chris@0
|
192 }
|
Chris@0
|
193
|
Chris@0
|
194 /**
|
Chris@0
|
195 * {@inheritdoc}
|
Chris@0
|
196 */
|
Chris@0
|
197 public function getFallbackImageStyle() {
|
Chris@0
|
198 return $this->fallback_image_style;
|
Chris@0
|
199 }
|
Chris@0
|
200
|
Chris@0
|
201 /**
|
Chris@0
|
202 * {@inheritdoc}
|
Chris@0
|
203 */
|
Chris@0
|
204 public function removeImageStyleMappings() {
|
Chris@0
|
205 $this->image_style_mappings = [];
|
Chris@0
|
206 $this->keyedImageStyleMappings = NULL;
|
Chris@0
|
207 return $this;
|
Chris@0
|
208 }
|
Chris@0
|
209
|
Chris@0
|
210 /**
|
Chris@0
|
211 * {@inheritdoc}
|
Chris@0
|
212 */
|
Chris@0
|
213 public function calculateDependencies() {
|
Chris@0
|
214 parent::calculateDependencies();
|
Chris@0
|
215 $providers = \Drupal::service('breakpoint.manager')->getGroupProviders($this->breakpoint_group);
|
Chris@0
|
216 foreach ($providers as $provider => $type) {
|
Chris@0
|
217 $this->addDependency($type, $provider);
|
Chris@0
|
218 }
|
Chris@0
|
219 // Extract all the styles from the image style mappings.
|
Chris@0
|
220 $styles = ImageStyle::loadMultiple($this->getImageStyleIds());
|
Chris@0
|
221 array_walk($styles, function ($style) {
|
Chris@0
|
222 $this->addDependency('config', $style->getConfigDependencyName());
|
Chris@0
|
223 });
|
Chris@0
|
224 return $this;
|
Chris@0
|
225 }
|
Chris@0
|
226
|
Chris@0
|
227 /**
|
Chris@0
|
228 * {@inheritdoc}
|
Chris@0
|
229 */
|
Chris@0
|
230 public static function isEmptyImageStyleMapping(array $image_style_mapping) {
|
Chris@0
|
231 if (!empty($image_style_mapping)) {
|
Chris@0
|
232 switch ($image_style_mapping['image_mapping_type']) {
|
Chris@0
|
233 case 'sizes':
|
Chris@0
|
234 // The image style mapping must have a sizes attribute defined and one
|
Chris@0
|
235 // or more image styles selected.
|
Chris@0
|
236 if ($image_style_mapping['image_mapping']['sizes'] && $image_style_mapping['image_mapping']['sizes_image_styles']) {
|
Chris@0
|
237 return FALSE;
|
Chris@0
|
238 }
|
Chris@0
|
239 break;
|
Chris@0
|
240 case 'image_style':
|
Chris@0
|
241 // The image style mapping must have an image style selected.
|
Chris@0
|
242 if ($image_style_mapping['image_mapping']) {
|
Chris@0
|
243 return FALSE;
|
Chris@0
|
244 }
|
Chris@0
|
245 break;
|
Chris@0
|
246 }
|
Chris@0
|
247 }
|
Chris@0
|
248 return TRUE;
|
Chris@0
|
249 }
|
Chris@0
|
250
|
Chris@0
|
251 /**
|
Chris@0
|
252 * {@inheritdoc}
|
Chris@0
|
253 */
|
Chris@0
|
254 public function getImageStyleMapping($breakpoint_id, $multiplier) {
|
Chris@0
|
255 $map = $this->getKeyedImageStyleMappings();
|
Chris@0
|
256 if (isset($map[$breakpoint_id][$multiplier])) {
|
Chris@0
|
257 return $map[$breakpoint_id][$multiplier];
|
Chris@0
|
258 }
|
Chris@0
|
259 }
|
Chris@0
|
260
|
Chris@0
|
261 /**
|
Chris@0
|
262 * {@inheritdoc}
|
Chris@0
|
263 */
|
Chris@0
|
264 public function getImageStyleIds() {
|
Chris@0
|
265 $image_styles = [$this->getFallbackImageStyle()];
|
Chris@0
|
266 foreach ($this->getImageStyleMappings() as $image_style_mapping) {
|
Chris@0
|
267 // Only image styles of non-empty mappings should be loaded.
|
Chris@0
|
268 if (!$this::isEmptyImageStyleMapping($image_style_mapping)) {
|
Chris@0
|
269 switch ($image_style_mapping['image_mapping_type']) {
|
Chris@0
|
270 case 'image_style':
|
Chris@0
|
271 $image_styles[] = $image_style_mapping['image_mapping'];
|
Chris@0
|
272 break;
|
Chris@0
|
273 case 'sizes':
|
Chris@0
|
274 $image_styles = array_merge($image_styles, $image_style_mapping['image_mapping']['sizes_image_styles']);
|
Chris@0
|
275 break;
|
Chris@0
|
276 }
|
Chris@0
|
277 }
|
Chris@0
|
278 }
|
Chris@0
|
279 return array_values(array_filter(array_unique($image_styles)));
|
Chris@0
|
280 }
|
Chris@0
|
281
|
Chris@0
|
282 }
|