Added support for importing/exporting asset transforms (#90)

Added support for importing/exporting asset transforms
nerds-and-company · Apr 12, 2017 · 4949c64 · 4949c64
1 parent e193c72
commit 4949c64
Show file tree

Hide file tree

Showing 9 changed files with 447 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,5 @@
 ###3.7.0###
+- Added support for importing/exporting Asset Transforms
 - Asset Sources now respect the force option
 
 ###3.6.1###

diff --git a/README.md b/README.md
@@ -66,6 +66,7 @@ Here is a list of all of the data types and their corresponding exclude paramete
 | Data Type | Exlude Parameter |
 | ------------- |-------------|
 | Asset Sources | assetSources |
+| Asset Transforms | assetTransforms |
 | Category Groups | categoryGroups |
 | Element Indexes | elementIndexSettings |
 | Fields | fields |

diff --git a/src/Console/App.php b/src/Console/App.php
@@ -313,6 +313,9 @@ private function _setSchematicComponents()
             'schematic_assetSources' => [
                 'class' => Service\AssetSources::class,
             ],
+            'schematic_assetTransforms' => [
+                'class' => Service\AssetTransforms::class,
+            ],
             'schematic_fields' => [
                 'class' => Service\Fields::class,
             ],

diff --git a/src/Models/Data.php b/src/Models/Data.php
@@ -21,6 +21,7 @@
  *
  * @property array $Locales
  * @property array $assetSources
+ * @property array $assetTransforms
  * @property array $fields
  * @property array $globalSets
  * @property array $plugins
@@ -44,6 +45,7 @@ protected function defineAttributes()
         return [
             'locales' => [AttributeType::Mixed, 'default' => []],
             'assetSources' => [AttributeType::Mixed, 'default' => []],
+            'assetTransforms' => [AttributeType::Mixed, 'default' => []],
             'fields' => [AttributeType::Mixed, 'default' => []],
             'globalSets' => [AttributeType::Mixed, 'default' => []],
             'plugins' => [AttributeType::Mixed, 'default' => []],

diff --git a/src/Services/AssetSources.php b/src/Services/AssetSources.php
@@ -7,7 +7,7 @@
 use Craft\AssetSourceModel;
 
 /**
- * Schematic Assets Service.
+ * Schematic Asset Sources Service.
  *
  * Sync Craft Setups.
  *

diff --git a/src/Services/AssetTransforms.php b/src/Services/AssetTransforms.php
@@ -0,0 +1,152 @@
+<?php
+
+namespace NerdsAndCompany\Schematic\Services;
+
+use Craft\Craft;
+use Craft\AssetTransformModel;
+
+/**
+ * Schematic Asset Transforms Service.
+ *
+ * Sync Craft Setups.
+ *
+ * @author    Nerds & Company
+ * @copyright Copyright (c) 2015-2017, Nerds & Company
+ * @license   MIT
+ *
+ * @see      http://www.nerds.company
+ */
+class AssetTransforms extends Base
+{
+    /**
+     * @return AssetTransformsService
+     */
+    private function getAssetTransformsService()
+    {
+        return Craft::app()->assetTransforms;
+    }
+
+    /**
+     * Export all asset transforms.
+     *
+     * @param AssetTransformModel[] $assetTransforms
+     *
+     * @return array
+     */
+    public function export(array $assetTransforms = [])
+    {
+        Craft::log(Craft::t('Exporting Asset Transforms'));
+
+        $assetTransformDefinitions = [];
+
+        foreach ($assetTransforms as $assetTransform) {
+            $assetTransformDefinitions[$assetTransform->handle] = $this->getAssetTransformDefinition($assetTransform);
+        }
+
+        return $assetTransformDefinitions;
+    }
+
+    /**
+     * @param AssetTransformModel $assetTransform
+     *
+     * @return array
+     */
+    private function getAssetTransformDefinition(AssetTransformModel $assetTransform)
+    {
+        return [
+            'name' => $assetTransform->name,
+            'width' => $assetTransform->width,
+            'height' => $assetTransform->height,
+            'format' => $assetTransform->format,
+            'dimensionChangeTime' => $assetTransform->dimensionChangeTime,
+            'mode' => $assetTransform->mode,
+            'position' => $assetTransform->position,
+            'quality' => $assetTransform->quality,
+        ];
+    }
+
+    /**
+     * Import asset transform definitions.
+     *
+     * @param array $assetTransformDefinitions
+     * @param bool  $force
+     *
+     * @return Result
+     */
+    public function import(array $assetTransformDefinitions, $force = false)
+    {
+        Craft::log(Craft::t('Importing Asset Transforms'));
+
+        $this->resetCraftAssetTransformsServiceCache();
+        $assetTransforms = $this->getAssetTransformsService()->getAllTransforms('handle');
+
+        foreach ($assetTransformDefinitions as $assetTransformHandle => $assetTransformDefinition) {
+            $assetTransform = array_key_exists($assetTransformHandle, $assetTransforms)
+                ? $assetTransforms[$assetTransformHandle]
+                : new AssetTransformModel();
+
+            unset($assetTransforms[$assetTransformHandle]);
+
+            $this->populateAssetTransform($assetTransform, $assetTransformDefinition, $assetTransformHandle);
+
+            if (!$this->getAssetTransformsService()->saveTransform($assetTransform)) { // Save asset transform via craft
+                $this->addErrors($assetTransform->getAllErrors());
+
+                continue;
+            }
+        }
+
+        if ($force) {
+            foreach ($assetTransforms as $assetTransform) {
+                $this->getAssetTransformsService()->deleteTransform($assetTransform->id);
+            }
+        }
+
+        return $this->getResultModel();
+    }
+
+    /**
+     * Populate asset transform.
+     *
+     * @param AssetTransformModel $assetTransform
+     * @param array               $assetTransformDefinition
+     * @param string              $assetTransformHandle
+     *
+     * @return AssetTransformModel
+     */
+    private function populateAssetTransform(AssetTransformModel $assetTransform, array $assetTransformDefinition, $assetTransformHandle)
+    {
+        $assetTransform->setAttributes([
+            'handle' => $assetTransformHandle,
+            'name' => $assetTransformDefinition['name'],
+            'width' => $assetTransformDefinition['width'],
+            'height' => $assetTransformDefinition['height'],
+            'format' => $assetTransformDefinition['format'],
+            'dimensionChangeTime' => $assetTransformDefinition['dimensionChangeTime'],
+            'mode' => $assetTransformDefinition['mode'],
+            'position' => $assetTransformDefinition['position'],
+            'quality' => $assetTransformDefinition['quality'],
+        ]);
+
+        return $assetTransform;
+    }
+
+    /**
+     * Reset craft fields service cache using reflection.
+     */
+    private function resetCraftAssetTransformsServiceCache()
+    {
+        $obj = $this->getAssetTransformsService();
+        $refObject = new \ReflectionObject($obj);
+        if ($refObject->hasProperty('_fetchedAllTransforms')) {
+            $refProperty = $refObject->getProperty('_fetchedAllTransforms');
+            $refProperty->setAccessible(true);
+            $refProperty->setValue($obj, false);
+        }
+        if ($refObject->hasProperty('_transformsByHandle')) {
+            $refProperty = $refObject->getProperty('_transformsByHandle');
+            $refProperty->setAccessible(true);
+            $refProperty->setValue($obj, array());
+        }
+    }
+}
diff --git a/src/Services/Schematic.php b/src/Services/Schematic.php
@@ -28,6 +28,7 @@ class Schematic extends BaseApplication
     protected static $exportableDataTypes = [
         'locales',
         'assetSources',
+        'assetTransforms',
         'fields',
         'plugins',
         'sections',
@@ -127,6 +128,9 @@ private function importDataModel(Data $model, $force)
         $assetSources = $model->getAttribute('assetSources');
         $assetSourcesImportResult = Craft::app()->schematic_assetSources->import($assetSources, $force);
 
+        $assetTransforms = $model->getAttribute('assetTransforms');
+        $assetTransformsImportResult = Craft::app()->schematic_assetTransforms->import($assetTransforms, $force);
+
         $globalSets = $model->getAttribute('globalSets');
         $globalSetsImportResult = Craft::app()->schematic_globalSets->import($globalSets, $force);
 
@@ -162,6 +166,7 @@ private function importDataModel(Data $model, $force)
         $result->consume($pluginImportResult);
         $result->consume($fieldImportResult);
         $result->consume($assetSourcesImportResult);
+        $result->consume($assetTransformsImportResult);
         $result->consume($globalSetsImportResult);
         $result->consume($sectionImportResult);
         $result->consume($categoryGroupImportResult);
@@ -228,6 +233,7 @@ private function exportDataModel($dataTypes = 'all')
         }
 
         $assetSources = Craft::app()->assetSources->getAllSources();
+        $assetTransforms = Craft::app()->assetTransforms->getAllTransforms();
         $categoryGroups = Craft::app()->categories->getAllGroups();
         $tagGroups = Craft::app()->tags->getAllTagGroups();
 
@@ -241,6 +247,10 @@ private function exportDataModel($dataTypes = 'all')
             $export['assetSources'] = Craft::app()->schematic_assetSources->export($assetSources);
         }
 
+        if (in_array('assetTransforms', $dataTypes)) {
+            $export['assetTransforms'] = Craft::app()->schematic_assetTransforms->export($assetTransforms);
+        }
+
         if (in_array('fields', $dataTypes)) {
             $fieldGroups = Craft::app()->fields->getAllGroups();
             $export['fields'] = Craft::app()->schematic_fields->export($fieldGroups);