diff --git a/core/lib/Drupal/Core/Cache/ConditionalCacheabilityMetadataBubblingTrait.php b/core/lib/Drupal/Core/Cache/ConditionalCacheabilityMetadataBubblingTrait.php new file mode 100644 index 0000000..8c91eba --- /dev/null +++ b/core/lib/Drupal/Core/Cache/ConditionalCacheabilityMetadataBubblingTrait.php @@ -0,0 +1,32 @@ +renderer->hasRenderContext()) { + $build = []; + CacheableMetadata::createFromObject($object)->applyTo($build); + $this->renderer->render($build); + } + } + +} diff --git a/core/modules/image/src/ImageServiceProvider.php b/core/modules/image/src/ImageServiceProvider.php new file mode 100644 index 0000000..6757aa0 --- /dev/null +++ b/core/modules/image/src/ImageServiceProvider.php @@ -0,0 +1,50 @@ +getParameter('container.modules'); + if (isset($modules['serialization'])) { + // Add an ImageItem normalizer. + $service_definition = new Definition(ImageItemNormalizer::class, [ + new Reference('renderer'), + ]); + // Priority should be higher than + // serializer.normalizer.entity_reference_field_item but lower than + // serializer.normalizer.entity_reference_item.hal. + $service_definition->addTag('normalizer', ['priority' => 9]); + $container->setDefinition('image.normalizer.image_item', $service_definition); + } + if (isset($modules['hal'])) { + // Add an ImageItem normalizer. + $service_definition = new Definition(ImageItemHalNormalizer::class, [ + new Reference('serialization.link_manager'), + new Reference('serializer.entity_resolver'), + new Reference('renderer'), + ]); + // Priority should be higher than + // serializer.normalizer.entity_reference_item.hal which is 10. + // Priority of 20 gives the ability to have other normalizers between this + // one and serializer.normalizer.entity_reference_item.hal. + $service_definition->addTag('normalizer', ['priority' => 20]); + $container->setDefinition('image.normalizer.hal.image_item', $service_definition); + } + } + +} diff --git a/core/modules/image/src/Normalizer/ImageItemHalNormalizer.php b/core/modules/image/src/Normalizer/ImageItemHalNormalizer.php new file mode 100644 index 0000000..96b681b --- /dev/null +++ b/core/modules/image/src/Normalizer/ImageItemHalNormalizer.php @@ -0,0 +1,60 @@ +renderer = $renderer; + } + + /** + * {@inheritdoc} + */ + public function normalize($object, $format = NULL, array $context = []) { + $data = parent::normalize($object, $format, $context); + if (!empty($data['_embedded'])) { + $field_key = array_keys($data['_embedded'])[0]; + $this->decorateWithImageStyles($object, $data['_embedded'][$field_key][0]); + } + return $data; + } + +} diff --git a/core/modules/image/src/Normalizer/ImageItemNormalizer.php b/core/modules/image/src/Normalizer/ImageItemNormalizer.php new file mode 100644 index 0000000..7b2af3d --- /dev/null +++ b/core/modules/image/src/Normalizer/ImageItemNormalizer.php @@ -0,0 +1,53 @@ +renderer = $renderer; + } + + /** + * {@inheritdoc} + */ + public function normalize($field_item, $format = NULL, array $context = []) { + $data = parent::normalize($field_item, $format, $context); + if (!$field_item->isEmpty()) { + $this->decorateWithImageStyles($field_item, $data); + } + + return $data; + } + +} diff --git a/core/modules/image/src/Normalizer/ImageItemNormalizerTrait.php b/core/modules/image/src/Normalizer/ImageItemNormalizerTrait.php new file mode 100644 index 0000000..e28e56b --- /dev/null +++ b/core/modules/image/src/Normalizer/ImageItemNormalizerTrait.php @@ -0,0 +1,42 @@ +target_id)) { + $uri = $image->getFileUri(); + /** @var \Drupal\image\ImageStyleInterface[] $styles */ + $styles = ImageStyle::loadMultiple(); + $normalization['image_styles'] = []; + foreach ($styles as $id => $style) { + $dimensions = ['width' => $item->width, 'height' => $item->height]; + $style->transformDimensions($dimensions, $uri); + $normalization['image_styles'][$id] = [ + 'url' => file_url_transform_relative($style->buildUrl($uri)), + 'height' => empty($dimensions['height']) ? NULL : $dimensions['height'], + 'width' => empty($dimensions['width']) ? NULL : $dimensions['width'], + ]; + $this->bubble($style); + } + } + } + +} diff --git a/core/modules/image/tests/src/Kernel/Normalizer/ImageItemHalNormalizerTest.php b/core/modules/image/tests/src/Kernel/Normalizer/ImageItemHalNormalizerTest.php new file mode 100644 index 0000000..ca0eaa2 --- /dev/null +++ b/core/modules/image/tests/src/Kernel/Normalizer/ImageItemHalNormalizerTest.php @@ -0,0 +1,36 @@ +setCacheContexts(['url.site']); + } + +} diff --git a/core/modules/image/tests/src/Kernel/Normalizer/ImageItemNormalizerTest.php b/core/modules/image/tests/src/Kernel/Normalizer/ImageItemNormalizerTest.php new file mode 100644 index 0000000..774afed --- /dev/null +++ b/core/modules/image/tests/src/Kernel/Normalizer/ImageItemNormalizerTest.php @@ -0,0 +1,23 @@ +serializer = $this->container->get('serializer'); + + $this->installEntitySchema('entity_test'); + $this->installEntitySchema('user'); + $this->installEntitySchema('file'); + $this->installConfig('system'); + $this->installConfig('image'); + $this->installSchema('file', ['file_usage']); + + FieldStorageConfig::create([ + 'entity_type' => 'entity_test', + 'field_name' => 'image_test', + 'type' => 'image', + 'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED, + ])->save(); + FieldConfig::create([ + 'entity_type' => 'entity_test', + 'field_name' => 'image_test', + 'bundle' => 'entity_test', + 'settings' => [ + 'file_extensions' => 'jpg', + ], + ])->save(); + + // Set upscale to TRUE in all image style scale effects. + /** @var \Drupal\image\Entity\ImageStyle $image_style */ + foreach (ImageStyle::loadMultiple() as $image_style) { + foreach ($image_style->getEffects() as $effect) { + $config = $effect->getConfiguration(); + $config['data']['upscale'] = TRUE; + $effect->setConfiguration($config); + } + $image_style->save(); + } + + file_unmanaged_copy(\Drupal::root() . '/core/misc/druplicon.png', 'public://example.jpg'); + $this->image = File::create([ + 'uri' => 'public://example.jpg', + ]); + $this->image->save(); + } + + /** + * Test that the decorator provides additional image style information. + * + * See ImageItemWithStylesNormalizerTrait + * + * @covers ::normalize + */ + public function testNormalize() { + // Create a test entity with the image field set. + $original_entity = EntityTest::create(); + $original_entity->image_test->target_id = $this->image->id(); + $original_entity->image_test->alt = $alt = $this->randomMachineName(); + $original_entity->image_test->title = $title = $this->randomMachineName(); + $original_entity->name->value = $this->randomMachineName(); + $original_entity->save(); + + $entity = clone $original_entity; + $context = new RenderContext(); + $normalization = $this->container->get('renderer') + ->executeInRenderContext($context, function () use ($entity) { + return $this->serializer->normalize($entity, $this->format); + }); + + $normalized_image_styles = $this->getNormalizedImageStyles($normalization); + $this->assertEquals($this->getExpectedCacheability(), $context->pop()); + $expect_dimensions = [ + 'large' => [ + 'width' => '422', + 'height' => '480', + ], + 'medium' => [ + 'width' => '194', + 'height' => '220', + ], + 'thumbnail' => [ + 'width' => '88', + 'height' => '100', + ], + ]; + $this->assertEquals(array_keys($expect_dimensions), array_keys($normalized_image_styles)); + + foreach ($normalized_image_styles as $image_style_id => $image_style_dimensions) { + $this->assertContains("files/styles/$image_style_id/public/example.jpg", $image_style_dimensions['url']); + $this->assertEquals($expect_dimensions[$image_style_id]['height'], $image_style_dimensions['height'], "Style $image_style_id matches height."); + $this->assertEquals($expect_dimensions[$image_style_id]['width'], $image_style_dimensions['width'], "Style $image_style_id matches width."); + } + } + + /** + * Gets normalized image styles from normalized entity. + * + * @param array $normalization + * The normalized entity. + * + * @return array + * The normalized image styles. + */ + abstract protected function getNormalizedImageStyles(array $normalization); + + /** + * Gets the expected bubbled cacheability metadata. + * + * @return \Drupal\Core\Render\BubbleableMetadata + * The expected bubbled cacheability metadata. + */ + protected function getExpectedCacheability() { + $cacheability = new BubbleableMetadata(); + $cache_tags = []; + /** @var \Drupal\image\ImageStyleInterface $image_style */ + foreach (ImageStyle::loadMultiple() as $image_style) { + $cache_tags = Cache::mergeTags($cache_tags, $image_style->getCacheTags()); + } + $cacheability->setCacheTags($cache_tags); + return $cacheability; + } + +}