Merge branch 'release/1.4.22' into v1

Author: khalwat

CHANGELOG.md

@@ -1,5 +1,10 @@
 # ImageOptimize Changelog
 
+## 1.4.22 - 2018.03.02
+### Changed
+* Using Image Optimize via Twig should have less of a performance hit now, since all placeholder image/color palette generation is disabled
+* Fixed deprecation errors from Craft CMS 3 RC13
+
 ## 1.4.21 - 2018.02.27
 ### Changed
 * Show a warning if people try to add an OptimizedImages field in a Matrix block

README.md

@@ -174,7 +174,7 @@ If you plan to do this manually via the above console commands, you can disable
 
 If you wish to dynamically create Optimized Image Variants in your templates without having to use the Field.
 
-**N.B.:** If you create the Optimized Image Variants in your templates, the image transforms, placeholder images, and color palette extraction will all be done at pageload time. This means you'll miss out on the advantages of using the OptimizedImages field, where all of that computation is done when an Asset is saved.
+**N.B.:** We recommend _against_ using Image Optimize via Twig. If you create the Optimized Image Variants in your templates, the image transforms, placeholder images, and color palette extraction will all be done at pageload time. This means you'll miss out on the advantages of using the OptimizedImages field, where all of that computation is done when an Asset is saved.
 
 To create Optimized Image Variants dynamically in your templates, you can do:
 
@@ -247,7 +247,7 @@ You can create as many Optimized Image Variants as you like, by just including a
 
 The `optimizedImages` object that is returned to you can be used in your templates as described in the *Displaying images on the frontend* section.
 
-**N.B.:** Because they are lengthy operations, by default the generation of the dominant color palette and the generation of the placeholder silhouette are off by default. You can enable them via additional parameters passed down to `craft.imageOptimize.createOptimizedImages`:
+**N.B.:** Because they are lengthy operations, by default the generation of the dominant color palette and the generation of the placeholder silhouette are off. You can enable them via an additional parameter passed down to `craft.imageOptimize.createOptimizedImages`:
 
 ```
 {% set optimzedImages = craft.imageOptimize.createOptimizedImages(
@@ -264,12 +264,11 @@ The `optimizedImages` object that is returned to you can be used in your templat
         },
     ],
     true,
-    true,
 ) %}
 
 ```
 
-The third parameter is the `createColorPalette` setting, the fourth parameter is the `createPlaceholderSilhouettes` setting.
+The third parameter is the `generatePlacholders` setting, which disables generating all placeholders and dominant color palette extraction.
 
 ### Displaying images on the frontend
 

composer.json

@@ -2,7 +2,7 @@
     "name": "nystudio107/craft-imageoptimize",
     "description": "Automatically create & optimize responsive image transforms, using either native Craft transforms or a service like Imgix, with zero template changes.",
     "type": "craft-plugin",
-    "version": "1.4.21",
+    "version": "1.4.22",
     "keywords": [
         "craft",
         "cms",

src/config.php

@@ -46,6 +46,9 @@
     // Should image variant be created on Asset save (aka BeforePageLoad)
     'generateTransformsBeforePageLoad' => true,
 
+    // Set to false to disable all placeholder generation
+    'generatePlacholders' => true,
+
     // Controls whether a dominant color palette should be created for image variants
     // It takes a bit of time, so if you never plan to use it, you can turn it off
     'createColorPalette' => true,

src/models/OptimizedImage.php

@@ -285,6 +285,9 @@ public function placeholderImage()
         $header = 'data:image/jpeg;base64,';
         if (!empty($this->placeholder)) {
             $content = $this->placeholder;
+        } else {
+            // At least return something
+            return $this->defaultPlaceholderImage();
         }
 
         return Template::raw($header . rawurlencode($content));
@@ -337,6 +340,9 @@ public function placeholderSilhouette()
         $header = 'data:image/svg+xml,';
         if (!empty($this->placeholderSvg)) {
             $content = $this->placeholderSvg;
+        } else {
+            // At least return something
+            return $this->defaultPlaceholderImage();
         }
 
         return Template::raw($header . $content);
@@ -484,4 +490,18 @@ protected function getSrcsetFromArray(array $array, bool $dpr = false): string
 
         return $srcset;
     }
+
+    /**
+     * Return a default placeholder image
+     *
+     * @return \Twig_Markup
+     */
+    protected function defaultPlaceholderImage(): \Twig_Markup
+    {
+        $width = 1;
+        $height = 1;
+        $color = '#CCC';
+
+        return Template::raw(ImageOptimize::$plugin->placeholder->generatePlaceholderBox($width, $height, $color));
+    }
 }

src/models/Settings.php

@@ -63,6 +63,11 @@ class Settings extends Model
      */
     public $generateTransformsBeforePageLoad = true;
 
+    /**
+     * @var bool Set to false to disable all placeholder generation
+     */
+    public $generatePlacholders = true;
+
     /**
      * @var bool Controls whether a dominant color palette should be created
      *      for image variants It takes a bit of time, so if you never plan to

src/services/OptimizedImages.php

@@ -152,26 +152,28 @@ public function populateOptimizedImageModel(Asset $asset, $variants, OptimizedIm
     protected function generatePlaceholders(Asset $element, OptimizedImage $model, $aspectRatio)
     {
         $settings = ImageOptimize::$plugin->getSettings();
-        $placeholder = ImageOptimize::$plugin->placeholder;
-        if ($element->focalPoint) {
-            $position = $element->getFocalPoint();
-        } else {
-            $position = 'center-center';
-        }
-        $tempPath = $placeholder->createTempPlaceholderImage($element, $aspectRatio, $position);
-        if (!empty($tempPath)) {
-            // Generate our placeholder image
-            $model->placeholder = $placeholder->generatePlaceholderImage($tempPath, $aspectRatio, $position);
-            // Generate the color palette for the image
-            if ($settings->createColorPalette) {
-                $model->colorPalette = $placeholder->generateColorPalette($tempPath);
+        if ($settings->generatePlacholders) {
+            $placeholder = ImageOptimize::$plugin->placeholder;
+            if ($element->focalPoint) {
+                $position = $element->getFocalPoint();
+            } else {
+                $position = 'center-center';
             }
-            // Generate the Potrace SVG
-            if ($settings->createPlaceholderSilhouettes) {
-                $model->placeholderSvg = $placeholder->generatePlaceholderSvg($tempPath);
+            $tempPath = $placeholder->createTempPlaceholderImage($element, $aspectRatio, $position);
+            if (!empty($tempPath)) {
+                // Generate our placeholder image
+                $model->placeholder = $placeholder->generatePlaceholderImage($tempPath, $aspectRatio, $position);
+                // Generate the color palette for the image
+                if ($settings->createColorPalette) {
+                    $model->colorPalette = $placeholder->generateColorPalette($tempPath);
+                }
+                // Generate the Potrace SVG
+                if ($settings->createPlaceholderSilhouettes) {
+                    $model->placeholderSvg = $placeholder->generatePlaceholderSvg($tempPath);
+                }
+                // Get rid of our placeholder image
+                @unlink($tempPath);
             }
-            // Get rid of our placeholder image
-            @unlink($tempPath);
         }
     }
 

src/variables/ImageOptimizeVariable.php

@@ -43,21 +43,18 @@ public function placeholderBox($width, $height, $color = null)
     /**
      * @param Asset $asset
      * @param array $variants
-     * @param bool  $createColorPalette
-     * @param bool  $createPlaceholderSilhouettes
+     * @param bool  $generatePlacholders
      *
      * @return OptimizedImage|null
      */
     public function createOptimizedImages(
         Asset $asset,
         $variants = null,
-        $createColorPalette = false,
-        $createPlaceholderSilhouettes = false
+        $generatePlacholders = false
     ) {
         // Override our settings for lengthy operations, since we're doing this via Twig
         $settings = ImageOptimize::$plugin->getSettings();
-        $settings->createColorPalette = $createColorPalette;
-        $settings->createPlaceholderSilhouettes = $createPlaceholderSilhouettes;
+        $settings->generatePlacholders = $generatePlacholders;
 
         return ImageOptimize::$plugin->optimizedImages->createOptimizedImages($asset, $variants);
     }