+
+ {{this.config.translations.preview_alternate_text_override}}
+
+
+
+
+
+
+
+
+ {{this.config.translations.preview_caption_override}}
+
+
+
+
+
+
{{this.config.translations.preview_tags}}
diff --git a/frontend/src/main.js b/frontend/src/main.js
index b547cbb9..ad96f5b8 100644
--- a/frontend/src/main.js
+++ b/frontend/src/main.js
@@ -35,6 +35,8 @@ const initInteractionsVue = (el) => {
'type': 'type',
'altText': 'altText',
'caption': 'caption',
+ 'altTextOverride': 'altTextOverride',
+ 'captionOverride': 'captionOverride',
'tags': 'tags[]',
'cropSettings': 'cropSettings',
'source': 'source',
@@ -63,6 +65,8 @@ const initInteractionsVue = (el) => {
alternateText: '',
caption: '',
watermarkText: '',
+ altTextOverride: '',
+ captionOverride: '',
tags: [],
size: '',
variations: {},
diff --git a/frontend/src/scss/ngremotemedia.scss b/frontend/src/scss/ngremotemedia.scss
index 04193443..b0210a07 100644
--- a/frontend/src/scss/ngremotemedia.scss
+++ b/frontend/src/scss/ngremotemedia.scss
@@ -143,7 +143,7 @@
color: #737373;
}
- input.media-alttext, input.media-caption, input.media-watermarktext, input.media-css-class {
+ input.media-alttext, input.media-caption, input.media-alttext-override, input.media-caption-override, input.media-watermarktext, input.media-css-class {
width: 100%;
border-radius: 0;
border: 1px solid #e4e4e4;
diff --git a/lib/API/ProviderInterface.php b/lib/API/ProviderInterface.php
index 96e5beb6..e3d91d04 100644
--- a/lib/API/ProviderInterface.php
+++ b/lib/API/ProviderInterface.php
@@ -21,6 +21,9 @@
use Netgen\RemoteMedia\Exception\RemoteResourceLocationNotFoundException;
use Netgen\RemoteMedia\Exception\RemoteResourceNotFoundException;
+/**
+ * @method string generateLocationHtmlTag(RemoteResourceLocation $location, array $htmlAttributes = [], bool $forceVideo = false, bool $useThumbnail = false) Generates the HTML tag for the resource of the location, using alt text and caption overrides of the location. Not implementing it is deprecated since 3.1, it will be added to the interface in 4.0.
+ */
interface ProviderInterface
{
public function getIdentifier(): string;
@@ -155,6 +158,14 @@ public function buildVideoThumbnailRawVariation(RemoteResource $resource, array
public function generateHtmlTag(RemoteResource $resource, array $htmlAttributes = [], bool $forceVideo = false, bool $useThumbnail = false): string;
+ /*
+ * Generates the HTML tag for the resource of the location, using alt text and caption overrides of the location.
+ *
+ * Will be added to the interface in 4.0, see the @method annotation of the interface.
+ *
+ * public function generateLocationHtmlTag(RemoteResourceLocation $location, array $htmlAttributes = [], bool $forceVideo = false, bool $useThumbnail = false): string;
+ */
+
public function generateVariationHtmlTag(
RemoteResourceLocation $location,
string $variationGroup,
diff --git a/lib/API/Values/RemoteResourceLocation.php b/lib/API/Values/RemoteResourceLocation.php
index 201068c1..d51fc8e3 100644
--- a/lib/API/Values/RemoteResourceLocation.php
+++ b/lib/API/Values/RemoteResourceLocation.php
@@ -6,6 +6,8 @@
use Netgen\RemoteMedia\Exception\CropSettingsNotFoundException;
+use function trim;
+
class RemoteResourceLocation
{
use TimestampableTrait;
@@ -16,7 +18,12 @@ public function __construct(
private array $cropSettings = [],
private ?string $watermarkText = null,
private ?int $id = null,
- ) {}
+ private ?string $altTextOverride = null,
+ private ?string $captionOverride = null,
+ ) {
+ $this->setAltTextOverride($altTextOverride);
+ $this->setCaptionOverride($captionOverride);
+ }
public function getId(): ?int
{
@@ -84,12 +91,71 @@ public function setWatermarkText(?string $waterMarkText): self
return $this;
}
+ /**
+ * Alt text local to this location which takes precedence over the alt text of the remote resource.
+ */
+ public function getAltTextOverride(): ?string
+ {
+ return $this->altTextOverride;
+ }
+
+ /**
+ * Empty (or whitespace only) value removes the override, so the alt text of the remote resource is used.
+ */
+ public function setAltTextOverride(?string $altTextOverride): self
+ {
+ $this->altTextOverride = self::normalizeOverride($altTextOverride);
+
+ return $this;
+ }
+
+ /**
+ * Caption local to this location which takes precedence over the caption of the remote resource.
+ */
+ public function getCaptionOverride(): ?string
+ {
+ return $this->captionOverride;
+ }
+
+ /**
+ * Empty (or whitespace only) value removes the override, so the caption of the remote resource is used.
+ */
+ public function setCaptionOverride(?string $captionOverride): self
+ {
+ $this->captionOverride = self::normalizeOverride($captionOverride);
+
+ return $this;
+ }
+
+ /**
+ * Alt text for this location: local override if set, otherwise the alt text of the remote resource.
+ */
+ public function getAltText(): ?string
+ {
+ return $this->altTextOverride ?? $this->remoteResource->getAltText();
+ }
+
+ /**
+ * Caption for this location: local override if set, otherwise the caption of the remote resource.
+ */
+ public function getCaption(): ?string
+ {
+ return $this->captionOverride ?? $this->remoteResource->getCaption();
+ }
+
public function refresh(self $remoteResourceLocation): self
{
$this->setSource($remoteResourceLocation->getSource());
$this->setCropSettings($remoteResourceLocation->getCropSettings());
$this->setWatermarkText($remoteResourceLocation->getWatermarkText());
+ $this->setAltTextOverride($remoteResourceLocation->getAltTextOverride());
+ $this->setCaptionOverride($remoteResourceLocation->getCaptionOverride());
return $this;
}
+
+ private static function normalizeOverride(?string $value): ?string
+ {
+ return $value === null || trim($value) === '' ? null : $value;
+ }
}
diff --git a/lib/Core/AbstractProvider.php b/lib/Core/AbstractProvider.php
index 79cb17ae..78897c80 100644
--- a/lib/Core/AbstractProvider.php
+++ b/lib/Core/AbstractProvider.php
@@ -23,6 +23,8 @@
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
+use function in_array;
+
abstract class AbstractProvider implements ProviderInterface
{
protected ObjectRepository $resourceRepository;
@@ -239,13 +241,20 @@ public function loadNamedRemoteResourceLocation(string $name): RemoteResourceLoc
$source = $this->namedRemoteResourceLocations[$name]['source'] ?? 'named_remote_resource_location_' . $name;
$watermarkText = $this->namedRemoteResourceLocations[$name]['watermark_text'] ?? null;
+ $altTextOverride = $this->namedRemoteResourceLocations[$name]['alt_text'] ?? null;
+ $captionOverride = $this->namedRemoteResourceLocations[$name]['caption'] ?? null;
try {
$location = $this->loadLocationBySource($source);
- if ($location->getWatermarkText() !== $watermarkText) {
- $location->setWatermarkText($watermarkText);
+ $originalValues = [$location->getWatermarkText(), $location->getAltTextOverride(), $location->getCaptionOverride()];
+
+ $location
+ ->setWatermarkText($watermarkText)
+ ->setAltTextOverride($altTextOverride)
+ ->setCaptionOverride($captionOverride);
+ if ($originalValues !== [$location->getWatermarkText(), $location->getAltTextOverride(), $location->getCaptionOverride()]) {
$this->storeLocation($location);
}
@@ -263,7 +272,13 @@ public function loadNamedRemoteResourceLocation(string $name): RemoteResourceLoc
$this->store($resource);
}
- $location = new RemoteResourceLocation($resource, $source, [], $watermarkText);
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ source: $source,
+ watermarkText: $watermarkText,
+ altTextOverride: $altTextOverride,
+ captionOverride: $captionOverride,
+ );
$this->storeLocation($location);
return $location;
@@ -324,6 +339,17 @@ public function generateHtmlTag(RemoteResource $resource, array $htmlAttributes
return $this->generateRawVariationHtmlTag($resource, [], $htmlAttributes, $forceVideo, $useThumbnail);
}
+ public function generateLocationHtmlTag(RemoteResourceLocation $location, array $htmlAttributes = [], bool $forceVideo = false, bool $useThumbnail = false): string
+ {
+ return $this->generateRawVariationHtmlTag(
+ $location->getRemoteResource(),
+ [],
+ $this->applyLocationOverrides($location, $htmlAttributes, $useThumbnail),
+ $forceVideo,
+ $useThumbnail,
+ );
+ }
+
public function generateVariationHtmlTag(
RemoteResourceLocation $location,
string $variationGroup,
@@ -339,7 +365,13 @@ public function generateVariationHtmlTag(
$variationName,
);
- return $this->generateRawVariationHtmlTag($location->getRemoteResource(), $transformations, $htmlAttributes, $forceVideo, $useThumbnail);
+ return $this->generateRawVariationHtmlTag(
+ $location->getRemoteResource(),
+ $transformations,
+ $this->applyLocationOverrides($location, $htmlAttributes, $useThumbnail),
+ $forceVideo,
+ $useThumbnail,
+ );
}
public function generateRawVariationHtmlTag(
@@ -420,4 +452,30 @@ private function loadLocationBySource(string $source): RemoteResourceLocation
throw new RemoteResourceLocationNotFoundException(0);
}
+
+ /**
+ * Location overrides take precedence over alt text and caption of the remote resource, but not over explicitly
+ * provided attributes. Only tags rendered as an image (images and thumbnails) get them, as in generatePictureTag()
+ * and generateVideoThumbnailTag().
+ */
+ private function applyLocationOverrides(RemoteResourceLocation $location, array $htmlAttributes, bool $useThumbnail): array
+ {
+ $type = $location->getRemoteResource()->getType();
+ $isRenderedAsImage = $type === RemoteResource::TYPE_IMAGE
+ || ($useThumbnail && in_array($type, [RemoteResource::TYPE_VIDEO, RemoteResource::TYPE_AUDIO], true));
+
+ if (!$isRenderedAsImage) {
+ return $htmlAttributes;
+ }
+
+ if (!($htmlAttributes['alt'] ?? null) && $location->getAltTextOverride() !== null) {
+ $htmlAttributes['alt'] = $location->getAltTextOverride();
+ }
+
+ if (!($htmlAttributes['title'] ?? null) && $location->getCaptionOverride() !== null) {
+ $htmlAttributes['title'] = $location->getCaptionOverride();
+ }
+
+ return $htmlAttributes;
+ }
}
diff --git a/lib/Core/Provider/Cloudinary/CloudinaryProvider.php b/lib/Core/Provider/Cloudinary/CloudinaryProvider.php
index 54bc892f..c9867b28 100644
--- a/lib/Core/Provider/Cloudinary/CloudinaryProvider.php
+++ b/lib/Core/Provider/Cloudinary/CloudinaryProvider.php
@@ -239,6 +239,8 @@ public function authenticateRemoteResourceLocation(RemoteResourceLocation $locat
cropSettings: $location->getCropSettings(),
watermarkText: $location->getWatermarkText(),
id: $location->getId(),
+ altTextOverride: $location->getAltTextOverride(),
+ captionOverride: $location->getCaptionOverride(),
);
}
diff --git a/lib/Form/DataTransformer/RemoteMediaTransformer.php b/lib/Form/DataTransformer/RemoteMediaTransformer.php
index 20f431a1..0eb8f729 100644
--- a/lib/Form/DataTransformer/RemoteMediaTransformer.php
+++ b/lib/Form/DataTransformer/RemoteMediaTransformer.php
@@ -34,6 +34,8 @@ public function transform($value)
'cropSettings' => $this->service->resolveCropSettingsString($value),
'source' => $value->getSource(),
'watermarkText' => $value->getWatermarkText(),
+ 'altTextOverride' => $value->getAltTextOverride(),
+ 'captionOverride' => $value->getCaptionOverride(),
];
}
@@ -83,6 +85,8 @@ public function reverseTransform($value)
$remoteResourceLocation->setSource($value['source'] ?? null);
$remoteResourceLocation->setWatermarkText($value['watermarkText'] ?? null);
+ $remoteResourceLocation->setAltTextOverride($value['altTextOverride'] ?? null);
+ $remoteResourceLocation->setCaptionOverride($value['captionOverride'] ?? null);
$remoteResourceLocation->setCropSettings(
$this->service->resolveCropSettings($value['cropSettings'] ?? null),
diff --git a/lib/Form/Type/RemoteMediaType.php b/lib/Form/Type/RemoteMediaType.php
index f29279f5..2c8c09ae 100644
--- a/lib/Form/Type/RemoteMediaType.php
+++ b/lib/Form/Type/RemoteMediaType.php
@@ -52,6 +52,8 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
->add('type', HiddenType::class)
->add('altText', HiddenType::class, ['required' => false])
->add('caption', HiddenType::class, ['required' => false])
+ ->add('altTextOverride', HiddenType::class, ['required' => false])
+ ->add('captionOverride', HiddenType::class, ['required' => false])
->add('watermarkText', HiddenType::class, ['required' => false])
->add(
'tags',
diff --git a/lib/Service/RemoteResourceService.php b/lib/Service/RemoteResourceService.php
index f89923c5..2d084048 100644
--- a/lib/Service/RemoteResourceService.php
+++ b/lib/Service/RemoteResourceService.php
@@ -23,6 +23,8 @@ public function handleLocationUpdate(RemoteResourceLocation $remoteResourceLocat
{
$remoteResourceLocation->setSource($data['source'] ?? null);
$remoteResourceLocation->setWatermarkText($data['watermarkText'] ?? null);
+ $remoteResourceLocation->setAltTextOverride($data['altTextOverride'] ?? null);
+ $remoteResourceLocation->setCaptionOverride($data['captionOverride'] ?? null);
$remoteResourceLocation->setCropSettings(
$this->resolveCropSettings($data['cropSettings'] ?? null),
);
diff --git a/migrations/Doctrine/Version030100.php b/migrations/Doctrine/Version030100.php
new file mode 100644
index 00000000..a69c0d6f
--- /dev/null
+++ b/migrations/Doctrine/Version030100.php
@@ -0,0 +1,36 @@
+abortIf($this->connection->getDatabasePlatform()->getName() !== 'mysql', 'Migration can only be executed safely on MySQL.');
+
+ $this->addSql(
+ <<<'EOT'
+ ALTER TABLE ngrm_remote_resource_location ADD alt_text_override TEXT DEFAULT NULL, ADD caption_override TEXT DEFAULT NULL
+ EOT
+ );
+ }
+
+ /**
+ * Drops the overrides stored in the columns.
+ */
+ public function down(Schema $schema): void
+ {
+ $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'mysql', 'Migration can only be executed safely on MySQL.');
+
+ $this->addSql(
+ <<<'EOT'
+ ALTER TABLE ngrm_remote_resource_location DROP alt_text_override, DROP caption_override
+ EOT
+ );
+ }
+}
diff --git a/tests/bundle/Controller/Location/SelectedImageTest.php b/tests/bundle/Controller/Location/SelectedImageTest.php
index 4a2c363f..8e2e1ade 100644
--- a/tests/bundle/Controller/Location/SelectedImageTest.php
+++ b/tests/bundle/Controller/Location/SelectedImageTest.php
@@ -168,6 +168,7 @@ private function getRemoteResourceLocation(RemoteResource $remoteResource): Remo
cropSettings: [new CropSettings('testVariation')],
watermarkText: 'watermarkText',
id: 1,
+ altTextOverride: 'altTextOverride',
);
}
@@ -209,6 +210,8 @@ private function getExpectedJsonResponse(?string $type = 'type', ?string $browse
'alternateText' => 'altText',
'caption' => 'caption',
'watermarkText' => 'watermarkText',
+ 'altTextOverride' => 'altTextOverride',
+ 'captionOverride' => null,
'tags' => ['test'],
'size' => 0,
'variations' => [
diff --git a/tests/bundle/DependencyInjection/ConfigurationTest.php b/tests/bundle/DependencyInjection/ConfigurationTest.php
index 6ae28c92..2b17abce 100644
--- a/tests/bundle/DependencyInjection/ConfigurationTest.php
+++ b/tests/bundle/DependencyInjection/ConfigurationTest.php
@@ -85,6 +85,8 @@ public function testCompleteConfigurationIsOkAndValid(): void
'resource_remote_id' => 'upload|image|folder/test_resource',
'source' => 'test_resource',
'watermark_text' => 'Netgen',
+ 'alt_text' => 'Netgen logo',
+ 'caption' => 'Netgen caption',
],
'test_location2' => [
'resource_remote_id' => 'upload|image|folder/test_resource2',
diff --git a/tests/bundle/DependencyInjection/NetgenRemoteMediaExtensionTest.php b/tests/bundle/DependencyInjection/NetgenRemoteMediaExtensionTest.php
index b2e2925b..9237b246 100644
--- a/tests/bundle/DependencyInjection/NetgenRemoteMediaExtensionTest.php
+++ b/tests/bundle/DependencyInjection/NetgenRemoteMediaExtensionTest.php
@@ -43,6 +43,8 @@ public function testItSetsValidContainerParameters(): void
'resource_remote_id' => 'my_resource_id',
'source' => 'named_my_resource_location',
'watermark_text' => 'Netgen.io',
+ 'alt_text' => 'Netgen logo',
+ 'caption' => null,
],
],
);
@@ -152,6 +154,7 @@ protected function getMinimalConfiguration(): array
'resource_remote_id' => 'my_resource_id',
'source' => 'named_my_resource_location',
'watermark_text' => 'Netgen.io',
+ 'alt_text' => 'Netgen logo',
],
],
],
diff --git a/tests/bundle/Templating/Twig/Runtime/RemoteMediaRuntimeTest.php b/tests/bundle/Templating/Twig/Runtime/RemoteMediaRuntimeTest.php
index 1e271388..1e2fa431 100644
--- a/tests/bundle/Templating/Twig/Runtime/RemoteMediaRuntimeTest.php
+++ b/tests/bundle/Templating/Twig/Runtime/RemoteMediaRuntimeTest.php
@@ -11,6 +11,7 @@
use Netgen\RemoteMedia\API\Values\RemoteResource;
use Netgen\RemoteMedia\API\Values\RemoteResourceLocation;
use Netgen\RemoteMedia\API\Values\RemoteResourceVariation;
+use Netgen\RemoteMedia\Core\AbstractProvider;
use Netgen\RemoteMedia\Core\Provider\Cloudinary\CloudinaryProvider;
use Netgen\RemoteMedia\Core\Resolver\Variation as VariationResolver;
use Netgen\RemoteMedia\Core\Transformation\Registry;
@@ -23,6 +24,12 @@
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\NullLogger;
+use function json_encode;
+use function restore_error_handler;
+use function set_error_handler;
+
+use const E_USER_DEPRECATED;
+
#[CoversClass(RemoteMediaRuntime::class)]
final class RemoteMediaRuntimeTest extends AbstractTestCase
{
@@ -765,4 +772,107 @@ public function testHasFolderScopedUploads(): void
self::assertTrue((new RemoteMediaRuntime($provider, $variationResolver, CloudinaryProvider::FOLDER_MODE_DYNAMIC, true))->hasFolderScopedUploads());
self::assertFalse((new RemoteMediaRuntime($provider, $variationResolver, CloudinaryProvider::FOLDER_MODE_DYNAMIC, false))->hasFolderScopedUploads());
}
+
+ public function testGetRemoteResourceLocationHtmlTag(): void
+ {
+ $location = new RemoteResourceLocation(
+ remoteResource: new RemoteResource(
+ remoteId: 'upload|image|test_image.jpg',
+ type: 'image',
+ url: 'https://cloudinary.com/test/upload/image/test_image.jpg',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e12',
+ ),
+ altTextOverride: 'Local alt text',
+ );
+
+ $provider = $this->createMock(AbstractProvider::class);
+ $provider
+ ->expects(self::once())
+ ->method('generateLocationHtmlTag')
+ ->with($location, ['class' => 'test'], false, false)
+ ->willReturn('![Local alt text]()
');
+
+ $runtime = new RemoteMediaRuntime($provider, new VariationResolver(new Registry(), null, []));
+
+ self::assertSame(
+ '![Local alt text]()
',
+ $runtime->getRemoteResourceLocationHtmlTag($location, ['class' => 'test']),
+ );
+ }
+
+ public function testGetRemoteResourceLocationHtmlTagWithProviderWithoutMethod(): void
+ {
+ $resource = new RemoteResource(
+ remoteId: 'upload|image|test_image.jpg',
+ type: 'image',
+ url: 'https://cloudinary.com/test/upload/image/test_image.jpg',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e12',
+ altText: 'Cloud alt text',
+ caption: 'Cloud caption',
+ );
+
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ altTextOverride: 'Local alt text',
+ captionOverride: 'Local caption',
+ );
+
+ $this->providerMock
+ ->expects(self::once())
+ ->method('generateHtmlTag')
+ ->with($resource, ['class' => 'test', 'alt' => 'Local alt text', 'title' => 'Local caption'], false, false)
+ ->willReturn('![Local alt text]( "Local caption")
');
+
+ $deprecations = [];
+ set_error_handler(static function (int $level, string $message) use (&$deprecations): bool {
+ $deprecations[] = $message;
+
+ return true;
+ }, E_USER_DEPRECATED);
+
+ try {
+ $tag = $this->runtime->getRemoteResourceLocationHtmlTag($location, ['class' => 'test']);
+ } finally {
+ restore_error_handler();
+ }
+
+ self::assertSame('![Local alt text]( "Local caption")
', $tag);
+ self::assertCount(1, $deprecations);
+ self::assertStringContainsString('generateLocationHtmlTag()', $deprecations[0]);
+ }
+
+ public function testGetRemoteResourceLocationHtmlTagWithProviderWithoutMethodKeepsExplicitAttributes(): void
+ {
+ $resource = new RemoteResource(
+ remoteId: 'upload|video|test_video',
+ type: 'video',
+ url: 'https://cloudinary.com/test/upload/video/test_video',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e12',
+ );
+
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ altTextOverride: 'Local alt text',
+ captionOverride: 'Local caption',
+ );
+
+ $this->providerMock
+ ->expects(self::exactly(2))
+ ->method('generateHtmlTag')
+ ->willReturnCallback(static fn (RemoteResource $resource, array $htmlAttributes): string => json_encode($htmlAttributes));
+
+ set_error_handler(static fn (): bool => true, E_USER_DEPRECATED);
+
+ try {
+ // video without thumbnail is not rendered as an image, so the overrides are not used
+ self::assertSame('[]', $this->runtime->getRemoteResourceLocationHtmlTag($location));
+ // explicit attributes win over the overrides
+ self::assertSame(
+ '{"alt":"Explicit alt","title":"Local caption"}',
+ $this->runtime->getRemoteResourceLocationHtmlTag($location, ['alt' => 'Explicit alt'], false, true),
+ );
+ } finally {
+ restore_error_handler();
+ }
+ }
}
diff --git a/tests/lib/API/Values/RemoteResourceLocationTest.php b/tests/lib/API/Values/RemoteResourceLocationTest.php
index b66b604b..6522e6d1 100644
--- a/tests/lib/API/Values/RemoteResourceLocationTest.php
+++ b/tests/lib/API/Values/RemoteResourceLocationTest.php
@@ -210,6 +210,8 @@ public function testRefresh(): void
],
'My watermark',
324,
+ 'My alt text',
+ 'My caption',
);
$new = new RemoteResourceLocation(
@@ -220,6 +222,7 @@ public function testRefresh(): void
],
'My new watermark',
56453,
+ 'My new alt text',
);
$expected = new RemoteResourceLocation(
@@ -229,8 +232,67 @@ public function testRefresh(): void
new CropSettings('medium', 112, 97, 1200, 800),
],
'My new watermark',
+ altTextOverride: 'My new alt text',
);
self::assertRemoteResourceLocationSame($expected, $original->refresh($new));
}
+
+ public function testOverridesTakePrecedenceOverResourceValues(): void
+ {
+ $resource = new RemoteResource(
+ remoteId: 'test_remote_id',
+ type: 'image',
+ url: 'https://cloudinary.com/test/upload/image/test_remote_id',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e29',
+ altText: 'Cloud alt text',
+ caption: 'Cloud caption',
+ );
+
+ $location = new RemoteResourceLocation($resource);
+
+ self::assertNull($location->getAltTextOverride());
+ self::assertNull($location->getCaptionOverride());
+ self::assertSame('Cloud alt text', $location->getAltText());
+ self::assertSame('Cloud caption', $location->getCaption());
+
+ $location
+ ->setAltTextOverride('Local alt text')
+ ->setCaptionOverride('Local caption');
+
+ self::assertSame('Local alt text', $location->getAltText());
+ self::assertSame('Local caption', $location->getCaption());
+ self::assertSame('Cloud alt text', $resource->getAltText());
+ self::assertSame('Cloud caption', $resource->getCaption());
+ }
+
+ public function testEmptyOverridesFallBackToResourceValues(): void
+ {
+ $resource = new RemoteResource(
+ remoteId: 'test_remote_id',
+ type: 'image',
+ url: 'https://cloudinary.com/test/upload/image/test_remote_id',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e29',
+ altText: 'Cloud alt text',
+ caption: 'Cloud caption',
+ );
+
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ altTextOverride: '',
+ captionOverride: " \n ",
+ );
+
+ self::assertNull($location->getAltTextOverride());
+ self::assertNull($location->getCaptionOverride());
+ self::assertSame('Cloud alt text', $location->getAltText());
+ self::assertSame('Cloud caption', $location->getCaption());
+
+ $location
+ ->setAltTextOverride('Local alt text')
+ ->setAltTextOverride(' ');
+
+ self::assertNull($location->getAltTextOverride());
+ self::assertSame('Cloud alt text', $location->getAltText());
+ }
}
diff --git a/tests/lib/AbstractTestCase.php b/tests/lib/AbstractTestCase.php
index 9732da12..0740655c 100644
--- a/tests/lib/AbstractTestCase.php
+++ b/tests/lib/AbstractTestCase.php
@@ -197,6 +197,16 @@ public static function assertRemoteResourceLocationSame(RemoteResourceLocation $
$expected->getWatermarkText(),
$actual->getWatermarkText(),
);
+
+ self::assertSame(
+ $expected->getAltTextOverride(),
+ $actual->getAltTextOverride(),
+ );
+
+ self::assertSame(
+ $expected->getCaptionOverride(),
+ $actual->getCaptionOverride(),
+ );
}
public static function assertRemoteResourceVariationSame(RemoteResourceVariation $expected, RemoteResourceVariation $actual): void
diff --git a/tests/lib/Core/AbstractProviderTest.php b/tests/lib/Core/AbstractProviderTest.php
index e68724cb..5598b459 100644
--- a/tests/lib/Core/AbstractProviderTest.php
+++ b/tests/lib/Core/AbstractProviderTest.php
@@ -120,6 +120,8 @@ protected function setUp(): void
'test_image_location2' => [
'resource_remote_id' => 'upload|image|media/images/test_image2.jpg',
'watermark_text' => 'This is some watermark',
+ 'alt_text' => 'Named alt text',
+ 'caption' => '',
],
];
@@ -933,6 +935,73 @@ public function testLoadExistingNamedRemoteResourceLocationWithNewWatermark(): v
);
}
+ public function testLoadExistingNamedRemoteResourceLocationWithNewAltText(): void
+ {
+ $resource = new RemoteResource(
+ remoteId: 'upload|image|media/images/test_image2.jpg',
+ type: 'image',
+ url: 'https://cloudinary.com/upload/image/media/images/test_image2.jpg',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e29',
+ altText: 'Cloud alt text',
+ );
+
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ source: 'named_remote_resource_location_test_image_location2',
+ watermarkText: 'This is some watermark',
+ captionOverride: 'Caption removed from config',
+ );
+
+ $this->locationRepository
+ ->expects(self::once())
+ ->method('findOneBy')
+ ->with(['source' => 'named_remote_resource_location_test_image_location2'])
+ ->willReturn($location);
+
+ $this->entityManager
+ ->expects(self::once())
+ ->method('persist')
+ ->with($location);
+
+ $this->entityManager
+ ->expects(self::once())
+ ->method('flush');
+
+ $loadedLocation = $this->provider->loadNamedRemoteResourceLocation('test_image_location2');
+
+ self::assertSame('Named alt text', $loadedLocation->getAltText());
+ self::assertNull($loadedLocation->getCaptionOverride());
+ }
+
+ public function testLoadExistingNamedRemoteResourceLocationWithUnchangedConfig(): void
+ {
+ $resource = new RemoteResource(
+ remoteId: 'upload|image|media/images/test_image2.jpg',
+ type: 'image',
+ url: 'https://cloudinary.com/upload/image/media/images/test_image2.jpg',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e29',
+ );
+
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ source: 'named_remote_resource_location_test_image_location2',
+ watermarkText: 'This is some watermark',
+ altTextOverride: 'Named alt text',
+ );
+
+ $this->locationRepository
+ ->expects(self::once())
+ ->method('findOneBy')
+ ->with(['source' => 'named_remote_resource_location_test_image_location2'])
+ ->willReturn($location);
+
+ $this->entityManager
+ ->expects(self::never())
+ ->method('persist');
+
+ self::assertSame($location, $this->provider->loadNamedRemoteResourceLocation('test_image_location2'));
+ }
+
public function testLoadNewNamedRemoteResourceLocationWithExistingResource(): void
{
$resource = new RemoteResource(
@@ -957,7 +1026,12 @@ public function testLoadNewNamedRemoteResourceLocationWithExistingResource(): vo
->with(['remoteId' => 'upload|image|media/images/test_image2.jpg'])
->willReturn($resource);
- $location = new RemoteResourceLocation($resource, 'named_remote_resource_location_test_image_location2', [], 'This is some watermark');
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ source: 'named_remote_resource_location_test_image_location2',
+ watermarkText: 'This is some watermark',
+ altTextOverride: 'Named alt text',
+ );
$this->entityManager
->expects(self::once())
@@ -1423,6 +1497,134 @@ public function testGenerateVariationHtmlTagThumbnail(): void
);
}
+ public function testGenerateLocationHtmlTagUsesOverrides(): void
+ {
+ $resource = new RemoteResource(
+ remoteId: 'image.jpg',
+ type: 'image',
+ url: 'https://cloudinary.com/upload/image/image.jpg',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e12',
+ altText: 'Cloud alt text',
+ caption: 'Cloud caption',
+ );
+
+ $location = new RemoteResourceLocation(
+ remoteResource: $resource,
+ altTextOverride: 'Local alt text',
+ captionOverride: 'Local caption',
+ );
+
+ $tag = '
';
+
+ $this->provider
+ ->expects(self::once())
+ ->method('getIdentifier')
+ ->willReturn('cloudinary');
+
+ $this->formatHandler
+ ->expects(self::once())
+ ->method('process')
+ ->with(['mp4'])
+ ->willReturn(['fetch_format' => 'mp4']);
+
+ $this->provider
+ ->expects(self::once())
+ ->method('generateVideoThumbnailTag')
+ ->with($resource, [['fetch_format' => 'mp4']], ['alt' => 'Local alt text'])
+ ->willReturn($tag);
+
+ self::assertSame(
+ $tag,
+ $this->provider->generateVariationHtmlTag($location, 'article', 'mp4', [], false, true),
+ );
+ }
+
public function testGenerateRawVariationHtmlTagAudio(): void
{
$resource = new RemoteResource(
diff --git a/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php b/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php
index c6c2092e..38868363 100644
--- a/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php
+++ b/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php
@@ -212,6 +212,60 @@ public function testReverseTransformWithExistingLocation(): void
);
}
+ public function testReverseTransformWithOverridesDoesNotUpdateRemote(): void
+ {
+ $data = [
+ 'locationId' => 5,
+ 'remoteId' => 'upload|image|media/images/example.jpg',
+ 'type' => 'image',
+ 'altText' => 'Cloud alt text',
+ 'caption' => 'Cloud caption',
+ 'tags' => ['tag1'],
+ 'cropSettings' => null,
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => ' ',
+ ];
+
+ $location = new RemoteResourceLocation(
+ remoteResource: new RemoteResource(
+ remoteId: 'upload|image|media/images/example.jpg',
+ type: 'image',
+ url: 'https://cloudinary.com/test/upload/image/media/images/example.jpg',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e29',
+ name: 'example.jpg',
+ altText: 'Cloud alt text',
+ caption: 'Cloud caption',
+ tags: ['tag1'],
+ ),
+ id: 5,
+ captionOverride: 'Old local caption',
+ );
+
+ $this->providerMock
+ ->expects(self::once())
+ ->method('loadByRemoteId')
+ ->with('upload|image|media/images/example.jpg')
+ ->willReturn($location->getRemoteResource());
+
+ $this->providerMock
+ ->expects(self::once())
+ ->method('loadLocation')
+ ->with(5)
+ ->willReturn($location);
+
+ $this->providerMock
+ ->expects(self::never())
+ ->method('updateOnRemote');
+
+ $result = $this->dataTransformer->reverseTransform($data);
+
+ self::assertSame('Local alt text', $result->getAltTextOverride());
+ self::assertNull($result->getCaptionOverride());
+ self::assertSame('Local alt text', $result->getAltText());
+ self::assertSame('Cloud caption', $result->getCaption());
+ self::assertSame('Cloud alt text', $result->getRemoteResource()->getAltText());
+ }
+
public function testReverseTransformWithResourceNotExistingOnRemoteAnymore(): void
{
$data = [
@@ -437,6 +491,8 @@ public static function transformDataProvider(): iterable
'cropSettings' => '{"hero_image":{"x":10,"y":20,"w":1920,"h":1080}}',
'source' => null,
'watermarkText' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
],
],
[
@@ -450,6 +506,8 @@ public static function transformDataProvider(): iterable
),
source: 'my_source',
watermarkText: 'This is a watermark',
+ altTextOverride: 'Local alt text',
+ captionOverride: 'Local caption',
),
[
'locationId' => null,
@@ -461,6 +519,8 @@ public static function transformDataProvider(): iterable
'cropSettings' => '[]',
'source' => 'my_source',
'watermarkText' => 'This is a watermark',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
],
],
];
diff --git a/tests/lib/Form/Type/RemoteMediaTypeTest.php b/tests/lib/Form/Type/RemoteMediaTypeTest.php
index e77e6bf2..3faee9bb 100644
--- a/tests/lib/Form/Type/RemoteMediaTypeTest.php
+++ b/tests/lib/Form/Type/RemoteMediaTypeTest.php
@@ -129,6 +129,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => '{"hero_image": {"x": 10, "y": 20, "w": 1920, "h": 1080}}',
'source' => null,
'watermarkText' => 'This is a watermark',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
],
[],
[
@@ -141,6 +143,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => '{"hero_image": {"x": 10, "y": 20, "w": 1920, "h": 1080}}',
'source' => null,
'watermarkText' => 'This is a watermark',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
],
new RemoteResourceLocation(
remoteResource: new RemoteResource(
@@ -155,6 +159,8 @@ public static function submitDataProvider(): iterable
new CropSettings('hero_image', 10, 20, 1920, 1080),
],
watermarkText: 'This is a watermark',
+ altTextOverride: 'Local alt text',
+ captionOverride: 'Local caption',
),
[
'locationId' => null,
@@ -162,6 +168,8 @@ public static function submitDataProvider(): iterable
'type' => 'image',
'altText' => 'Test alt text',
'caption' => 'Test caption',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
'watermarkText' => 'This is a watermark',
'tags' => ['example', 'image', 'test'],
'cropSettings' => '{"hero_image": {"x": 10, "y": 20, "w": 1920, "h": 1080}}',
@@ -202,6 +210,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => null,
'source' => 'Test source',
'watermarkText' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
],
new RemoteResourceLocation(
new RemoteResource(
@@ -219,6 +229,8 @@ public static function submitDataProvider(): iterable
'type' => 'image',
'altText' => null,
'caption' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
'watermarkText' => null,
'tags' => [],
'cropSettings' => null,
@@ -268,6 +280,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => null,
'source' => 'Test source',
'watermarkText' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
],
new RemoteResourceLocation(
new RemoteResource(
@@ -285,6 +299,8 @@ public static function submitDataProvider(): iterable
'type' => 'image',
'altText' => null,
'caption' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
'watermarkText' => null,
'tags' => [],
'cropSettings' => null,
';
+
+ $this->provider
+ ->expects(self::once())
+ ->method('getIdentifier')
+ ->willReturn('cloudinary');
+
+ $this->formatHandler
+ ->expects(self::once())
+ ->method('process')
+ ->with(['mp4'])
+ ->willReturn(['fetch_format' => 'mp4']);
+
+ $this->provider
+ ->expects(self::once())
+ ->method('generateVideoThumbnailTag')
+ ->with($resource, [['fetch_format' => 'mp4']], ['alt' => 'Local alt text'])
+ ->willReturn($tag);
+
+ self::assertSame(
+ $tag,
+ $this->provider->generateVariationHtmlTag($location, 'article', 'mp4', [], false, true),
+ );
+ }
+
public function testGenerateRawVariationHtmlTagAudio(): void
{
$resource = new RemoteResource(
diff --git a/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php b/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php
index c6c2092e..38868363 100644
--- a/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php
+++ b/tests/lib/Form/DataTransformer/RemoteMediaTransformerTest.php
@@ -212,6 +212,60 @@ public function testReverseTransformWithExistingLocation(): void
);
}
+ public function testReverseTransformWithOverridesDoesNotUpdateRemote(): void
+ {
+ $data = [
+ 'locationId' => 5,
+ 'remoteId' => 'upload|image|media/images/example.jpg',
+ 'type' => 'image',
+ 'altText' => 'Cloud alt text',
+ 'caption' => 'Cloud caption',
+ 'tags' => ['tag1'],
+ 'cropSettings' => null,
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => ' ',
+ ];
+
+ $location = new RemoteResourceLocation(
+ remoteResource: new RemoteResource(
+ remoteId: 'upload|image|media/images/example.jpg',
+ type: 'image',
+ url: 'https://cloudinary.com/test/upload/image/media/images/example.jpg',
+ md5: 'e522f43cf89aa0afd03387c37e2b6e29',
+ name: 'example.jpg',
+ altText: 'Cloud alt text',
+ caption: 'Cloud caption',
+ tags: ['tag1'],
+ ),
+ id: 5,
+ captionOverride: 'Old local caption',
+ );
+
+ $this->providerMock
+ ->expects(self::once())
+ ->method('loadByRemoteId')
+ ->with('upload|image|media/images/example.jpg')
+ ->willReturn($location->getRemoteResource());
+
+ $this->providerMock
+ ->expects(self::once())
+ ->method('loadLocation')
+ ->with(5)
+ ->willReturn($location);
+
+ $this->providerMock
+ ->expects(self::never())
+ ->method('updateOnRemote');
+
+ $result = $this->dataTransformer->reverseTransform($data);
+
+ self::assertSame('Local alt text', $result->getAltTextOverride());
+ self::assertNull($result->getCaptionOverride());
+ self::assertSame('Local alt text', $result->getAltText());
+ self::assertSame('Cloud caption', $result->getCaption());
+ self::assertSame('Cloud alt text', $result->getRemoteResource()->getAltText());
+ }
+
public function testReverseTransformWithResourceNotExistingOnRemoteAnymore(): void
{
$data = [
@@ -437,6 +491,8 @@ public static function transformDataProvider(): iterable
'cropSettings' => '{"hero_image":{"x":10,"y":20,"w":1920,"h":1080}}',
'source' => null,
'watermarkText' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
],
],
[
@@ -450,6 +506,8 @@ public static function transformDataProvider(): iterable
),
source: 'my_source',
watermarkText: 'This is a watermark',
+ altTextOverride: 'Local alt text',
+ captionOverride: 'Local caption',
),
[
'locationId' => null,
@@ -461,6 +519,8 @@ public static function transformDataProvider(): iterable
'cropSettings' => '[]',
'source' => 'my_source',
'watermarkText' => 'This is a watermark',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
],
],
];
diff --git a/tests/lib/Form/Type/RemoteMediaTypeTest.php b/tests/lib/Form/Type/RemoteMediaTypeTest.php
index e77e6bf2..3faee9bb 100644
--- a/tests/lib/Form/Type/RemoteMediaTypeTest.php
+++ b/tests/lib/Form/Type/RemoteMediaTypeTest.php
@@ -129,6 +129,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => '{"hero_image": {"x": 10, "y": 20, "w": 1920, "h": 1080}}',
'source' => null,
'watermarkText' => 'This is a watermark',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
],
[],
[
@@ -141,6 +143,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => '{"hero_image": {"x": 10, "y": 20, "w": 1920, "h": 1080}}',
'source' => null,
'watermarkText' => 'This is a watermark',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
],
new RemoteResourceLocation(
remoteResource: new RemoteResource(
@@ -155,6 +159,8 @@ public static function submitDataProvider(): iterable
new CropSettings('hero_image', 10, 20, 1920, 1080),
],
watermarkText: 'This is a watermark',
+ altTextOverride: 'Local alt text',
+ captionOverride: 'Local caption',
),
[
'locationId' => null,
@@ -162,6 +168,8 @@ public static function submitDataProvider(): iterable
'type' => 'image',
'altText' => 'Test alt text',
'caption' => 'Test caption',
+ 'altTextOverride' => 'Local alt text',
+ 'captionOverride' => 'Local caption',
'watermarkText' => 'This is a watermark',
'tags' => ['example', 'image', 'test'],
'cropSettings' => '{"hero_image": {"x": 10, "y": 20, "w": 1920, "h": 1080}}',
@@ -202,6 +210,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => null,
'source' => 'Test source',
'watermarkText' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
],
new RemoteResourceLocation(
new RemoteResource(
@@ -219,6 +229,8 @@ public static function submitDataProvider(): iterable
'type' => 'image',
'altText' => null,
'caption' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
'watermarkText' => null,
'tags' => [],
'cropSettings' => null,
@@ -268,6 +280,8 @@ public static function submitDataProvider(): iterable
'cropSettings' => null,
'source' => 'Test source',
'watermarkText' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
],
new RemoteResourceLocation(
new RemoteResource(
@@ -285,6 +299,8 @@ public static function submitDataProvider(): iterable
'type' => 'image',
'altText' => null,
'caption' => null,
+ 'altTextOverride' => null,
+ 'captionOverride' => null,
'watermarkText' => null,
'tags' => [],
'cropSettings' => null,