OptimizedImages::volumeHasField() - Code Metrics - Inspection of "Initial sub-folder work" - nystudio107/craft-imageoptimize - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( ec503a...b34520 )

by Andrew

created 2019-11-13 08:10 UTC

OptimizedImages::volumeHasField() A

↳ Parent: OptimizedImages

Complexity

Conditions	5
Paths	2

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	8
c	0
b	0
f	0
dl	0
loc	16
rs	9.6111
cc	5
nc	2
nop	2

<?php
/**
 * Image Optimize plugin for Craft CMS 3.x
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

 * @copyright Copyright (c) 2017 nystudio107

 */


namespace nystudio107\imageoptimize\fields;

use nystudio107\imageoptimize\fields\OptimizedImages as OptimizedImagesField;
use nystudio107\imageoptimize\gql\types\generators\OptimizedImagesGenerator;
use nystudio107\imageoptimize\assetbundles\optimizedimagesfield\OptimizedImagesFieldAsset;
use nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\models\OptimizedImage;

use Craft;
use craft\base\ElementInterface;
use craft\base\Field;
use craft\base\Volume;
use craft\elements\Asset;
use craft\fields\Matrix;
use craft\helpers\Json;
use craft\models\FieldLayout;
use craft\validators\ArrayValidator;

use yii\base\InvalidConfigException;
use yii\db\Exception;
use yii\db\Schema;

use verbb\supertable\fields\SuperTableField;
filter:
    dependency_paths: ["lib/*"]

/** @noinspection MissingPropertyAnnotationsInspection */


/**

 * @author    nystudio107

 * @package   ImageOptimize

 * @since     1.2.0

 */

class OptimizedImages extends Field
{
    // Constants
    // =========================================================================

    const DEFAULT_ASPECT_RATIOS = [
        ['x' => 16, 'y' => 9],
    ];
    const DEFAULT_IMAGE_VARIANTS = [
        [
            'width'          => 1200,
            'useAspectRatio' => true,
            'aspectRatioX'   => 16.0,
            'aspectRatioY'   => 9.0,
            'retinaSizes'    => ['1'],
            'quality'        => 82,
            'format'         => 'jpg',
        ],
    ];

    // Public Properties
    // =========================================================================

    /**

     * @var array
     */
    public $ignoreFilesOfType = [];

    /**

     * @var bool
     */
    public $displayOptimizedImageVariants = true;

    /**

     * @var bool
     */
    public $displayDominantColorPalette = true;

    /**

     * @var bool
     */
    public $displayLazyLoadPlaceholderImages = true;

    /**

     * @var array
     */
    public $variants = [];

    // Private Properties
    // =========================================================================

    /**

     * @var array
     */
    private $aspectRatios = [];


    // Static Methods
    // =========================================================================

    /**

     * @inheritdoc
     */
    public function __construct(array $config = [])
    {
        // Unset any deprecated properties
        if (!empty($config)) {
            unset($config['transformMethod'], $config['imgixDomain']);
        }
        parent::__construct($config);
    }

    // Public Methods
    // =========================================================================

    /**

     * @inheritdoc
     */

    public static function displayName(): string
    {
        return 'OptimizedImages';
    }

    /**

     * @inheritdoc
     */

    public function init()
    {
        parent::init();

        // Handle cases where the plugin has been uninstalled
        if (ImageOptimize::$plugin !== null) {
            $settings = ImageOptimize::$plugin->getSettings();
            if ($settings) {

                if (empty($this->variants)) {
                    $this->variants = $settings->defaultVariants;
                }
                $this->aspectRatios = $settings->defaultAspectRatios;
            }
        }
        // If the user has deleted all default aspect ratios, provide a fallback
        if (empty($this->aspectRatios)) {
            $this->aspectRatios = self::DEFAULT_ASPECT_RATIOS;
        }
        // If the user has deleted all default variants, provide a fallback
        if (empty($this->variants)) {
            $this->variants = self::DEFAULT_IMAGE_VARIANTS;
        }
    }

    /**

     * @inheritdoc
     */

    public function rules()
    {
        $rules = parent::rules();
        $rules = array_merge($rules, [

            [
                [
                    'displayOptimizedImageVariants',
                    'displayDominantColorPalette',
                    'displayLazyLoadPlaceholderImages',
                ],
                'boolean',
            ],
            [
                [
                    'ignoreFilesOfType',
                    'variants',
                ],
                ArrayValidator::class
            ],
        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.

        return $rules;
    }

    /**

     * @inheritdoc
     * @since 1.6.2

     */

    public function getContentGqlType()
    {
        $typeArray = OptimizedImagesGenerator::generateTypes($this);

        return [
            'name' => $this->handle,
            'description' => 'Optimized Images field',
            'type' => array_shift($typeArray),
        ];
    }

    /**

     * @inheritdoc
     */

    public function afterElementSave(ElementInterface $asset, bool $isNew)
    {
        parent::afterElementSave($asset, $isNew);
        // Update our OptimizedImages Field data now that the Asset has been saved
        if ($asset !== null && $asset instanceof Asset && $asset->id !== null) {
            // If the scenario is Asset::SCENARIO_FILEOPS or Asset::SCENARIO_ESSENTIALS treat it as a new asset
            $scenario = $asset->getScenario();
            if ($isNew || $scenario === Asset::SCENARIO_FILEOPS || $asset->propagating) {
                /**
                 * If this is a newly uploaded/created Asset, we can save the variants
                 * via a queue job to prevent it from blocking
                 */
                ImageOptimize::$plugin->optimizedImages->resaveAsset($asset->id);
            } else {
                /**
                 * If it's not a newly uploaded/created Asset, they may have edited
                 * the image with the ImageEditor, so we need to update the variants
                 * immediately, so the AssetSelectorHud displays the new images
                 */
                try {
                    ImageOptimize::$plugin->optimizedImages->updateOptimizedImageFieldData($this, $asset);
                } catch (Exception $e) {
                    Craft::error($e->getMessage(), __METHOD__);
                }
            }
        }
    }

    /**

     * @inheritdoc
     */

    public function normalizeValue($value, ElementInterface $asset = null)
    {
        // If we're passed in a string, assume it's JSON-encoded, and decode it
        if (\is_string($value) && !empty($value)) {
            $value = Json::decodeIfJson($value);
        }
        // If we're passed in an array, make a model from it
        if (\is_array($value)) {
            // Create a new OptimizedImage model and populate it
            $model = new OptimizedImage($value);
        } elseif ($value instanceof OptimizedImage) {
            $model = $value;
        } else {
            // Just create a new empty model
            $model = new OptimizedImage(null);
        }

        return $model;
    }

    /**

     * @inheritdoc
     */

    public function getContentColumnType(): string
    {
        return Schema::TYPE_TEXT;
    }

    /**

     * @inheritdoc
     */

    public function getSettingsHtml()
    {
        $namespace = Craft::$app->getView()->getNamespace();
        if (strpos($namespace, Matrix::class) !== false || strpos($namespace, SuperTableField::class) !== false) {
            // Render an error template, since the field only works when attached to an Asset
            try {
                return Craft::$app->getView()->renderTemplate(
                    'image-optimize/_components/fields/OptimizedImages_error',
                    [
                    ]
                );
            } catch (\Twig\Error\LoaderError $e) {
                Craft::error($e->getMessage(), __METHOD__);
            } catch (\yii\base\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        try {
            $reflect = new \ReflectionClass($this);
            $thisId = $reflect->getShortName();
        } catch (\ReflectionException $e) {
            Craft::error($e->getMessage(), __METHOD__);
            $thisId = 0;
        }
        $id = Craft::$app->getView()->formatInputId($thisId);
        $namespacedId = Craft::$app->getView()->namespaceInputId($id);
        $namespacePrefix = Craft::$app->getView()->namespaceInputName($thisId);
        Craft::$app->getView()->registerJs('new Craft.OptimizedImagesInput('.

            '"'.$namespacedId.'", '.
            '"'.$namespacePrefix.'"'.
            ');');
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.

        // Prep our aspect ratios
        $aspectRatios = [];
        $index = 1;
        foreach ($this->aspectRatios as $aspectRatio) {
            if ($index % 6 === 0) {
                $aspectRatio['break'] = true;
            }
            $aspectRatios[] = $aspectRatio;
            $index++;
        }
        $aspectRatio = ['x' => 2, 'y' => 2, 'custom' => true];
        $aspectRatios[] = $aspectRatio;

        // Render the settings template
        try {
            return Craft::$app->getView()->renderTemplate(
                'image-optimize/_components/fields/OptimizedImages_settings',
                [
                    'field'        => $this,
                    'aspectRatios' => $aspectRatios,
                    'id'           => $id,
                    'name'         => $this->handle,
                    'namespace'    => $namespacedId,
                    'fieldVolumes' => $this->getFieldVolumeInfo($this->handle),
                ]
            );
        } catch (\Twig\Error\LoaderError $e) {
            Craft::error($e->getMessage(), __METHOD__);
        } catch (\yii\base\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return '';
    }

    /**

     * @inheritdoc
     */

    public function getInputHtml($value, ElementInterface $element = null): string
    {
        if ($element !== null && $element instanceof Asset && $this->handle !== null) {
            /** @var Asset $element */

            // Register our asset bundle
            try {
                Craft::$app->getView()->registerAssetBundle(OptimizedImagesFieldAsset::class);
            } catch (InvalidConfigException $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }

            // Get our id and namespace
            $id = Craft::$app->getView()->formatInputId($this->handle);
            $nameSpaceId = Craft::$app->getView()->namespaceInputId($id);

            // Variables to pass down to our field JavaScript to let it namespace properly
            $jsonVars = [
                'id'        => $id,
                'name'      => $this->handle,
                'namespace' => $nameSpaceId,
                'prefix'    => Craft::$app->getView()->namespaceInputId(''),
            ];
            $jsonVars = Json::encode($jsonVars);
            $view = Craft::$app->getView();
            $view->registerJs("$('#{$nameSpaceId}-field').ImageOptimizeOptimizedImages(".$jsonVars.");");

            $settings = ImageOptimize::$plugin->getSettings();

            // Render the input template
            try {
                return Craft::$app->getView()->renderTemplate(
                    'image-optimize/_components/fields/OptimizedImages_input',
                    [
                        'name'        => $this->handle,
                        'value'       => $value,
                        'variants'    => $this->variants,
                        'field'       => $this,
                        'settings'    => $settings,
                        'elementId'   => $element->id,
                        'format'      => $element->getExtension(),
                        'id'          => $id,
                        'nameSpaceId' => $nameSpaceId,
                    ]
                );
            } catch (\Twig\Error\LoaderError $e) {
                Craft::error($e->getMessage(), __METHOD__);
            } catch (\yii\base\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        // Render an error template, since the field only works when attached to an Asset
        try {
            return Craft::$app->getView()->renderTemplate(
                'image-optimize/_components/fields/OptimizedImages_error',
                [
                ]
            );
        } catch (\Twig\Error\LoaderError $e) {
            Craft::error($e->getMessage(), __METHOD__);
        } catch (\yii\base\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return '';
    }

    // Protected Methods
    // =========================================================================

    /**
     * Returns an array of asset volumes and their sub-folders
     *
     * @param string|null $fieldHandle

     *
     * @return array
     * @throws InvalidConfigException
     */
    protected function getFieldVolumeInfo($fieldHandle): array
    {
        $result = [];
        if ($fieldHandle !== null) {
            $volumes = Craft::$app->getVolumes()->getAllVolumes();
            $assets = Craft::$app->getAssets();
            foreach ($volumes as $volume) {
                if (is_subclass_of($volume, Volume::class)) {
                    /** @var Volume $volume */

                    if ($this->volumeHasField($volume, $fieldHandle)) {
                        $tree = $assets->getFolderTreeByVolumeIds([$volume->id]);
                        $result[] = [
                            'name' => $volume->name,
                            'handle' => $volume->handle,
                            'subfolders' => $this->assembleSourceList($tree),
                        ];
                    }
                }
            }
        }

        return $result;
    }

    /**
     * See if the passed $volume has an OptimizedImagesField with the handle $fieldHandle
     *
     * @param Volume $volume

     *
     * @param string $fieldHandle

     *
     * @return bool
     * @throws InvalidConfigException
     */
    protected function volumeHasField(Volume $volume, string $fieldHandle): bool
    {
        $result = false;
        /** @var FieldLayout $fieldLayout */

        $fieldLayout = $volume->getFieldLayout();
        // Loop through the fields in the layout to see if there is an OptimizedImages field
        if ($fieldLayout) {

            $fields = $fieldLayout->getFields();
            foreach ($fields as $field) {
                if ($field instanceof OptimizedImagesField && $field->handle === $fieldHandle) {
                    $result = true;
                }
            }
        }

        return $result;
    }

    /**
     * Transforms an asset folder tree into a source list.
     *
     * @param array $folders

     * @param bool  $includeNestedFolders

     *
     * @return array
     */
    protected function assembleSourceList(array $folders, bool $includeNestedFolders = true): array
    {
        $sources = [];

        foreach ($folders as $folder) {
            $children = $folder->getChildren();
            foreach ($children as $child) {
                $sources[$child->uid] = $child->name;
            }
        }

        return $sources;
    }
}


1			<?php
2			/**
3			* Image Optimize plugin for Craft CMS 3.x
4			*
5			* Automatically optimize images after they've been transformed
6			*
7			* @link https://nystudio107.com
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @copyright Copyright (c) 2017 nystudio107
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
9			*/
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\imageoptimize\fields;
12
13			use nystudio107\imageoptimize\fields\OptimizedImages as OptimizedImagesField;
14			use nystudio107\imageoptimize\gql\types\generators\OptimizedImagesGenerator;
15			use nystudio107\imageoptimize\assetbundles\optimizedimagesfield\OptimizedImagesFieldAsset;
16			use nystudio107\imageoptimize\ImageOptimize;
17			use nystudio107\imageoptimize\models\OptimizedImage;
18
19			use Craft;
20			use craft\base\ElementInterface;
21			use craft\base\Field;
22			use craft\base\Volume;
23			use craft\elements\Asset;
24			use craft\fields\Matrix;
25			use craft\helpers\Json;
26			use craft\models\FieldLayout;
27			use craft\validators\ArrayValidator;
28
29			use yii\base\InvalidConfigException;
30			use yii\db\Exception;
31			use yii\db\Schema;
32
33			use verbb\supertable\fields\SuperTableField;
			0 ignored issues – show Bug introduced 2018-09-27 16:39 UTC by Report Bug Copy Issue Report The type `verbb\supertable\fields\SuperTableField` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
34
35			/** @noinspection MissingPropertyAnnotationsInspection */
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...

nystudio107 / craft-imageoptimize

Push — develop ( ec503a...b34520 )

OptimizedImages::volumeHasField() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like