Merge branch 'release/1.6.6' into v1

CHANGELOG.md

@@ -1,5 +1,9 @@
 # ImageOptimize Changelog
 
+## 1.6.6 - 2019.11.19
+### Added
+* Added a Preferences item to control whether allow limiting the creation of Optimized Image Variants for images by sub-folders
+
 ## 1.6.5 - 2019.11.13
 ### Added
 * Added the ability to choose the sub-folders in an asset volume in which Optimized Image Variants will be created

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.6.5",
+    "version": "1.6.6",
     "keywords": [
         "craft",
         "cms",

docs/docs/Using.md

@@ -4,6 +4,13 @@
 
 To create responsive image variants for all of your images, create an **OptimizedImages** Field and add it to the Asset Volume field layout of the images you want optimized.
 
+ImageOptimize will pre-generate all of the Optimized Image Variants in the Asset Volume, so that this rather intensive step is preflighted, rather than being done at runtime.
+
+You can choose to have the Optimized Image Variants created only for specific sub-folders in an Asset Volume if you like:
+
+![Screenshot](./resources/screenshots/image-optimize-field-volumes.png)
+
+
 Think of each **Optimized Images** field as encapsulating a [srcset](https://cloudfour.com/thinks/responsive-images-101-part-4-srcset-width-descriptors/) for your images. If you need to use more than one `srcset` then you probably need more than one **Optimized Images** field.
 
 **Transform Method** let you choose to use the built-in Craft transforms or a service like [Imgix](https://www.imgix.com/) for the responsive image variants.

src/config.php

@@ -66,6 +66,9 @@
     // Controls whether images scaled down >= 50% should be automatically sharpened
     'autoSharpenScaledImages' => true,
 
+    // Whether to allow limiting the creation of Optimized Image Variants for images by sub-folders
+    'assetVolumeSubFolders' => true,
+
     // The default Image Transform type classes
     'defaultImageTransformTypes' => [
     ],

src/fields/OptimizedImages.php

@@ -305,13 +305,16 @@ public function getSettingsHtml()
         }
         $aspectRatio = ['x' => 2, 'y' => 2, 'custom' => true];
         $aspectRatios[] = $aspectRatio;
+        // Get only the user-editable settings
+        $settings = ImageOptimize::$plugin->getSettings();
 
         // Render the settings template
         try {
             return Craft::$app->getView()->renderTemplate(
                 'image-optimize/_components/fields/OptimizedImages_settings',
                 [
                     'field'        => $this,
+                    'settings'     => $settings,
                     'aspectRatios' => $aspectRatios,
                     'id'           => $id,
                     'name'         => $this->handle,

src/models/Settings.php

@@ -110,6 +110,12 @@ class Settings extends Model
      */
     public $autoSharpenScaledImages = true;
 
+    /**
+     * @var bool Whether to allow limiting the creation of Optimized Image Variants
+     *      for images by sub-folders
+     */
+    public $assetVolumeSubFolders = true;
+
     /**
      * @var ImageTransformInterface[] The default Image Transform type classes
      */
@@ -320,6 +326,7 @@ public function rules()
                     'lowerQualityRetinaImageVariants',
                     'allowUpScaledImageVariants',
                     'autoSharpenScaledImages',
+                    'assetVolumeSubFolders',
                 ],
                 'boolean',
             ],
@@ -362,6 +369,7 @@ public function fields()
             'lowerQualityRetinaImageVariants',
             'allowUpScaledImageVariants',
             'autoSharpenScaledImages',
+            'assetVolumeSubFolders',
         ];
 
         return $fields;

src/templates/_components/fields/OptimizedImages_settings.twig

@@ -23,18 +23,20 @@
 
 <div class="field" id="{{ id }}-fields">
 
-    {% if fieldVolumes is defined and fieldVolumes | length %}
-        {% for fieldVolume in fieldVolumes %}
-            {% set val = field.fieldVolumeSettings[fieldVolume.handle] ?? '*' %}
-            {{ forms.checkboxSelectField({
-                label: "Volume: " ~ fieldVolume.name,
-                instructions: "Create Optimized Image Variants for images in the sub-folders:"|t('image-optimize'),
-                name: "fieldVolumeSettings[" ~ fieldVolume.handle ~ "]",
-                options: fieldVolume.subfolders,
-                showAllOption: true,
-                values: val,
-            }) }}
-        {% endfor %}
+    {% if settings.assetVolumeSubFolders %}
+        {% if fieldVolumes is defined and fieldVolumes | length %}
+            {% for fieldVolume in fieldVolumes %}
+                {% set val = field.fieldVolumeSettings[fieldVolume.handle] ?? '*' %}
+                {{ forms.checkboxSelectField({
+                    label: "Volume: " ~ fieldVolume.name,
+                    instructions: "Create Optimized Image Variants for images in the sub-folders:"|t('image-optimize'),
+                    name: "fieldVolumeSettings[" ~ fieldVolume.handle ~ "]",
+                    options: fieldVolume.subfolders,
+                    showAllOption: true,
+                    values: val,
+                }) }}
+            {% endfor %}
+        {% endif %}
     {% endif %}
 
     {{ forms.checkboxSelectField({

src/templates/settings/_settings.twig

@@ -101,7 +101,15 @@
         'on': settings.autoSharpenScaledImages,
         'warning': configWarning('autoSharpenScaledImages', 'image-optimize')
     }) }}
-
+    <!-- assetVolumeSubFolders -->
+    {{ forms.lightswitchField({
+        label: "Limit by Sub-Folder"|t('image-optimize'),
+        instructions: "Whether to allow limiting the creation of Optimized Image Variants for images by sub-folders."|t('image-optimize'),
+        'id': 'assetVolumeSubFolders',
+        'name': 'assetVolumeSubFolders',
+        'on': settings.assetVolumeSubFolders,
+        'warning': configWarning('assetVolumeSubFolders', 'image-optimize')
+    }) }}
 </div>
 
 {% js %}