Merge pull request #14 from sorenmalling/task/imageoptions-configuration

TASK: Move imageOptions to configuration
flownative · Aug 12, 2022 · 11dcf30 · 11dcf30
2 parents 1b5a49b + 747f709
commit 11dcf30
Show file tree

Hide file tree

Showing 5 changed files with 104 additions and 19 deletions.
diff --git a/Classes/AssetSource/PixxioAssetSource.php b/Classes/AssetSource/PixxioAssetSource.php
@@ -79,6 +79,11 @@ class PixxioAssetSource implements AssetSourceInterface
      */
     private $apiClientOptions = [];
 
+    /**
+     * @var array
+     */
+    private $imageOptions = [];
+
     /**
      * @var string
      */
@@ -145,6 +150,12 @@ public function __construct(string $assetSourceIdentifier, array $assetSourceOpt
                     }
                     $this->apiClientOptions = $optionValue;
                     break;
+                case 'imageOptions':
+                    if (!is_array($optionValue)) {
+                        throw new \InvalidArgumentException(sprintf('Invalid image options specified for Pixx.io asset source %s', $assetSourceIdentifier), 1591605349);
+                    }
+                    $this->imageOptions = $optionValue;
+                    break;
                 case 'sharedRefreshToken':
                     if (!is_string($optionValue) || empty($optionValue)) {
                         throw new \InvalidArgumentException(sprintf('Invalid shared refresh token specified for Pixx.io asset source %s', $assetSourceIdentifier), 1528806843);
@@ -292,7 +303,8 @@ public function getPixxioClient(): PixxioClient
                 $account->getAccountIdentifier(),
                 $this->apiEndpointUri,
                 $this->apiKey,
-                $this->apiClientOptions
+                $this->apiClientOptions,
+                $this->imageOptions
             );
 
             $this->pixxioClient->authenticate($clientSecret->getRefreshToken());

diff --git a/Classes/Service/PixxioClient.php b/Classes/Service/PixxioClient.php
@@ -70,29 +70,50 @@ final class PixxioClient
      * @param string $apiEndpointUri
      * @param string $apiKey
      * @param array $apiClientOptions
+     * @param array $imageOptions
      */
-    public function __construct(string $apiEndpointUri, string $apiKey, array $apiClientOptions)
+    public function __construct(string $apiEndpointUri, string $apiKey, array $apiClientOptions, array $imageOptions)
     {
         $this->apiEndpointUri = $apiEndpointUri;
         $this->apiKey = $apiKey;
         $this->apiClientOptions = $apiClientOptions;
         $this->guzzleClient = new Client($this->apiClientOptions);
-        $this->imageOptions  = [
-            (object)[
-                'width' => 400,
-                'height' => 400,
-                'quality' => 90
-            ],
-            (object)[
-                'width' => 1500,
-                'height' => 1500,
-                'quality' => 90
-            ],
-            (object)[
-                'sizeMax' => 1920,
-                'quality' => 90
-            ]
+        $this->configureImageOptionsWithFallback($imageOptions);
+    }
+
+    private function configureImageOptionsWithFallback(array $imageOptions): void
+    {
+        $imageOptionsPresets = [
+            'thumbnailUri' =>
+                [
+                    'width' => 400,
+                    'height' => 400,
+                    'quality' => 90
+                ],
+            'previewUri' =>
+                [
+                    'width' => 1500,
+                    'height' => 1500,
+                    'quality' => 90
+                ],
+            'originalUri' =>
+                [
+                    'sizeMax' => 1920,
+                    'quality' => 90
+                ]
         ];
+        foreach ($imageOptionsPresets as $imageOptionPresetKey => $imageOptionPresetConfiguration) {
+            if (isset($imageOptions[$imageOptionPresetKey]) === false) {
+                $this->imageOptions[] = $imageOptionPresetConfiguration;
+                continue;
+            }
+            $imageOption = $imageOptions[$imageOptionPresetKey];
+            if (isset($imageOption['crop']) && $imageOption['crop'] === false && isset($imageOption['height'])) {
+                unset($imageOption['height']);
+                unset($imageOption['crop']);
+            }
+            $this->imageOptions[] = $imageOption;
+        }
     }
 
     /**

diff --git a/Classes/Service/PixxioServiceFactory.php b/Classes/Service/PixxioServiceFactory.php
@@ -43,14 +43,16 @@ class PixxioServiceFactory
      * @param string $apiEndpointUri
      * @param string $apiKey
      * @param array $apiClientOptions
+     * @param array $imageOptions
      * @return PixxioClient
      */
-    public function createForAccount(string $accountIdentifier, string $apiEndpointUri, string $apiKey, array $apiClientOptions)
+    public function createForAccount(string $accountIdentifier, string $apiEndpointUri, string $apiKey, array $apiClientOptions, array $imageOptions)
     {
         $client = new PixxioClient(
             $apiEndpointUri,
             $apiKey,
-            $apiClientOptions
+            $apiClientOptions,
+            $imageOptions
         );
         return $client;
     }

diff --git a/Configuration/Settings.yaml b/Configuration/Settings.yaml
@@ -48,6 +48,23 @@ Neos:
             enable: false
             inUseTag: 'used-by-neos'
 
+          # Image options, are the formats returned for use in the asset properties "thumbnailUri", "previewUri" and "originalUri"
+          # imageOptions parameter are described here: https://tutorial.pixxio.cloud/cgi-bin/api/pixxio-api.pl/documentation/generalInformation/imageOptions
+          # Setting the "crop" parameter, removes the "height" attribute, and creates a non-cropped version
+          imageOptions:
+            thumbnailUri:
+              width: 400
+              height: 400
+              quality: 90
+              crop: false
+            previewUri:
+              width: 1500
+              height: 1500
+              quality: 90
+            originalUri:
+              sizeMax: 1920
+              quality: 90
+
           # The icon for the asset source
           icon: 'resource://Flownative.Pixxio/Public/Icons/PixxioWhite.svg'
 

diff --git a/README.md b/README.md
@@ -119,6 +119,39 @@ Neos:
             'verify': '/path/to/cert.pem'
 ```
 
+## Using ImageOptions parameters for files
+
+Via configuration, you can set what dimensions the returned images must have. The sizes are defined by the following keys:
+ * `thumbnailUri` used in the media browser list
+ * `previewUri` used in the detail page of a asset
+ * `originalUri` used for downloading the asset
+
+The configuration is by default
+
+```yaml
+Media:
+  assetSources:
+    'flownative-pixxio':
+      imageOptions:
+        thumbnailUri:
+          width: 400
+          height: 400
+          quality: 90
+          crop: false
+        previewUri:
+          width: 1500
+          height: 1500
+          quality: 90
+        originalUri:
+          sizeMax: 1920
+          quality: 90
+```
+
+Each imageOptions can be overridden from your own packages configuration, by addressing the specific preset key.
+
+By default, the assets from Pixx.io is returned in a cropped format. When this is the case, a editor can't see if a asset is horizontal or vertical, when looking in the Media Browser list.
+By setting `crop: false` the image will be returned in a not-cropped version, and it's visible for the editor, to see the assets orientation
+
 ## Cleaning up unused assets
 
 Whenever a pixx.io asset is used in Neos, the media file will be copied automatically to the internal Neos asset