Implement reviewer comments

Author: dabrt

code_samples/back_office/images/src/Connector/Dam/Handler/WikimediaCommonsHandler.php

@@ -21,34 +21,64 @@ public function search(Query $query, int $offset = 0, int $limit = 20): AssetSea
             . '&sroffset=' . $offset
             . '&srlimit=' . $limit
         ;
-        $response = json_decode(file_get_contents($searchUrl), true);
+
+        $jsonResponse = file_get_contents($searchUrl);
+        if ($jsonResponse === false) {
+            return new AssetSearchResult(0, new AssetCollection([]));
+        }
+
+        $response = json_decode($jsonResponse, true);
+        if (!isset($response['query']['search'])) {
+            return new AssetSearchResult(0, new AssetCollection([]));
+        }
 
         $assets = [];
         foreach ($response['query']['search'] as $result) {
             $identifier = str_replace('File:', '', $result['title']);
-            $assets[] = $this->fetchAsset($identifier);
+            $asset = $this->fetchAsset($identifier);
+            if ($asset) {
+                $assets[] = $asset;
+            }
         }
 
-        return new AssetSearchResult((int) $response['query']['searchinfo']['totalhits'], new AssetCollection($assets));
+        return new AssetSearchResult(
+            (int) ($response['query']['searchinfo']['totalhits'] ?? 0),
+            new AssetCollection($assets)
+        );
     }
 
-    public function fetchAsset(string $id): Asset
+    public function fetchAsset(string $id): ?Asset
     {
-        $metadataUrl = 'https://commons.wikipedia.org/w/api.php?action=query&prop=imageinfo&iiprop=extmetadata&format=json'
+        $metadataUrl = 'https://commons.wikimedia.org/w/api.php?action=query&prop=imageinfo&iiprop=extmetadata&format=json'
             . '&titles=File%3a' . urlencode($id)
         ;
-        $response = json_decode(file_get_contents($metadataUrl), true);
-        $imageInfo = array_values($response['query']['pages'])[0]['imageinfo'][0]['extmetadata'];
+
+        $jsonResponse = file_get_contents($metadataUrl);
+        if ($jsonResponse === false) {
+            return null;
+        }
+
+        $response = json_decode($jsonResponse, true);
+        if (!isset($response['query']['pages'])) {
+            return null;
+        }
+
+        $pageData = array_values($response['query']['pages'])[0] ?? null;
+        if (!isset($pageData['imageinfo'][0]['extmetadata'])) {
+            return null;
+        }
+
+        $imageInfo = $pageData['imageinfo'][0]['extmetadata'];
 
         return new Asset(
             new AssetIdentifier($id),
             new AssetSource('commons'),
             new AssetUri('https://commons.wikimedia.org/w/index.php?title=Special:Redirect/file/' . urlencode($id)),
             new AssetMetadata([
                 'page_url' => "https://commons.wikimedia.org/wiki/File:$id",
-                'author' => array_key_exists('Artist', $imageInfo) ? $imageInfo['Artist']['value'] : null,
-                'license' => array_key_exists('LicenseShortName', $imageInfo) ? $imageInfo['LicenseShortName']['value'] : null,
-                'license_url' => array_key_exists('LicenseUrl', $imageInfo) ? $imageInfo['LicenseUrl']['value'] : null,
+                'author' => $imageInfo['Artist']['value'] ?? null,
+                'license' => $imageInfo['LicenseShortName']['value'] ?? null,
+                'license_url' => $imageInfo['LicenseUrl']['value'] ?? null,
             ])
         );
     }

code_samples/back_office/images/src/Connector/Dam/Transformation/WikimediaCommonsTransformationFactory.php

@@ -7,19 +7,20 @@
 
 class WikimediaCommonsTransformationFactory implements TransformationFactoryInterface
 {
-    public function build(?string $transformationName = null, array $transformationParameters = []): Transformation
+    public function build(?string $transformationName = null, array $transformationParameters = []): ?Transformation
     {
-        return $this->buildAll()[$transformationName];
+        $transformations = $this->buildAll();
+        return $transformations[$transformationName] ?? null;
     }
 
-    public function buildAll(): iterable
+    public function buildAll(): array
     {
         return [
-            'reference' => new Transformation('reference'),
-            'tiny' => new Transformation('tiny', ['width' => 30]),
-            'small' => new Transformation('small', ['width' => 100]),
-            'medium' => new Transformation('medium', ['width' => 200]),
-            'large' => new Transformation('large', ['width' => 300]),
+            'reference' => new Transformation('reference', []),
+            'tiny' => new Transformation('tiny', ['width' => '30']),
+            'small' => new Transformation('small', ['width' => '100']),
+            'medium' => new Transformation('medium', ['width' => '200']),
+            'large' => new Transformation('large', ['width' => '300']),
         ];
     }
 }

code_samples/back_office/images/templates/themes/standard/commons_asset_view.html.twig

@@ -3,6 +3,10 @@
 {% block asset_preview %}
     {{ parent() }}
     <div>
-        <a href="{{ asset.assetMetadata.page_url }}">Image</a> by {{ asset.assetMetadata.author }} under 
-        <a href="{{ asset.assetMetadata.license_url }}">{{ asset.assetMetadata.license }}</a>.    </div>
+        <a href="{{ asset.assetMetadata.page_url }}">Image</a>
+        {% if asset.assetMetadata.author %} by {{ asset.assetMetadata.author }}{% endif %}
+        {% if asset.assetMetadata.license and asset.assetMetadata.license_url %}
+            under <a href="{{ asset.assetMetadata.license_url }}">{{ asset.assetMetadata.license }}</a>
+        {% endif %}.
+    </div>
 {% endblock %}

docs/content_management/images/add_image_asset_from_dam.md

@@ -110,7 +110,7 @@ Then, in `config\services.yaml`, register the handler as a service:
 
 ### Create transformation factory
 
-The transformation factory transforms image variations coming from Wikimedia Commons to the ones used by [[= product_name =]].
+The transformation factory maps [[= product_name =]]'s image variations to corresponding variations from Wikimedia Commons.
 
 In `src\Connector\Dam\Transformation` folder, create the `WikimediaCommonsTransformationFactory.php` file that resembles the following example:
 
@@ -128,7 +128,7 @@ Then register the transformation factory as a service:
 ### Register variations generator
 
 The variation generator applies map parameters coming from the transformation factory to build a fetch request to the DAM.
-The solution uses the built-in `URLBasedVariationGenerator` class, which adds all the map elements as query parameters of the request.
+The solution uses the built-in `URLBasedVariationGenerator` class, which adds all the map elements as query parameters to the request.
 
 For example, the handler generates the following URL with `new AssetUri()`:
 
@@ -154,16 +154,12 @@ In `templates/bundles/WikimediaCommonsConnector/`, add the `commons_asset_view.h
 [[= include_file('code_samples/back_office/images/templates/themes/standard/commons_asset_view.html.twig') =]]
 ```
 
-Then, register the template in configuration files:
+Then, register the template and a fallback template in configuration files:
 
 ```yaml
 [[= include_file('code_samples/back_office/images/config/packages/views.yaml') =]]
 ```
 
-!!! caution
-
-    As it overrides the parameter, make sure that you define the default template, too.
-
 ### Add Wikimedia Commons connection to DAM configuration
 
 You can now configure a connection with Wikimedia Commons under the `ibexa.system.<scope>.content.dam` key:
@@ -176,4 +172,4 @@ ibexa:
                 dam: [ commons ]
 ```
 
-Once you clear the cache, you can search for images to see whether images from the newly configured DAM are displayed correctly, including their variations.
+Once you clear the cache, you can search for images to see whether images from the newly configured DAM are displayed correctly, including their variations.