CraftImageTransform::rules() - Code Metrics - Inspection of "Add model rules" - nystudio107/craft-imageoptimize - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( d502bc...2115be )

by Andrew

created 2018-12-24 20:14 UTC

CraftImageTransform::rules() A

↳ Parent: CraftImageTransform

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php
/**
 * ImageOptimize 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\imagetransforms;

use nystudio107\imageoptimize\ImageOptimize;

use Craft;
use craft\elements\Asset;
use craft\models\AssetTransform;

/**

 * @author    nystudio107

 * @package   ImageOptimize

 * @since     1.0.0

 */

class CraftImageTransform extends ImageTransform
{
    // Static Methods
    // =========================================================================

    /**

     * @inheritdoc
     */

    public static function displayName(): string
    {
        return Craft::t('image-optimize', 'Craft');
    }

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

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

    /**

     * @param Asset               $asset

     * @param AssetTransform|null $transform

     * @param array               $params

     *
     * @return string|null
     */
    public function getTransformUrl(Asset $asset, $transform, array $params = [])
    {
        $generateTransformsBeforePageLoad = $params['generateTransformsBeforePageLoad'] ?? true;
        // Generate the URLs to the optimized images
        $assets = Craft::$app->getAssets();
        $url = $assets->getAssetUrl($asset, $transform, $generateTransformsBeforePageLoad);

        return $url;
    }

    /**

     * @param string              $url

     * @param Asset               $asset

     * @param AssetTransform|null $transform

     * @param array               $params

     *
     * @return string
     */
    public function getWebPUrl(string $url, Asset $asset, $transform, array $params = []): string
    {
        $url = $this->appendExtension($url, '.webp');

        return $url;
    }

    /**

     * @return array
     */
    public function getTransformParams(): array
    {
        $settings = ImageOptimize::$plugin->getSettings();
        // Get our $generateTransformsBeforePageLoad setting
        $generateTransformsBeforePageLoad = $settings->generateTransformsBeforePageLoad ?? true;
        $params = [
            'generateTransformsBeforePageLoad' => $generateTransformsBeforePageLoad,
        ];

        return $params;
    }

    /**

     * @inheritdoc
     */

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

        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.

        return $rules;
    }
}


1			<?php
2			/**
3			* ImageOptimize 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\imagetransforms;
12
13			use nystudio107\imageoptimize\ImageOptimize;
14
15			use Craft;
16			use craft\elements\Asset;
17			use craft\models\AssetTransform;
18
19			/**
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
20			* @author nystudio107
			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 @package tag Loading history... Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2018-09-25 23:18 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 2 spaces but found 4 Loading history...
21			* @package ImageOptimize
			0 ignored issues – show Coding Style introduced 2018-09-25 23:18 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 1 spaces but found 3 Loading history...
22			* @since 1.0.0
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history... Coding Style introduced 2018-09-25 23:18 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 3 spaces but found 5 Loading history...
23			*/
			0 ignored issues – show Coding Style introduced 2018-10-30 00:15 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2018-10-30 00:15 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2018-10-30 00:15 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
24			class CraftImageTransform extends ImageTransform
25			{
26			// Static Methods
27			// =========================================================================
28
29			/**
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
30			* @inheritdoc
31			*/
			0 ignored issues – show Coding Style introduced 2018-12-24 04:09 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
32			public static function displayName(): string
33			{
34			return Craft::t('image-optimize', 'Craft');
35			}
36
37			// Public Properties
38			// =========================================================================
39
40			// Public Methods
41			// =========================================================================
42
43			/**
			0 ignored issues – show Coding Style introduced 2018-12-24 04:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
44			* @param Asset $asset
			0 ignored issues – show Coding Style introduced 2018-10-10 19:34 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
45			* @param AssetTransform\|null $transform
			0 ignored issues – show Coding Style introduced 2018-10-10 19:34 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
46			* @param array $params
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
47			*
48			* @return string\|null
49			*/
50			public function getTransformUrl(Asset $asset, $transform, array $params = [])
51			{
52			$generateTransformsBeforePageLoad = $params['generateTransformsBeforePageLoad'] ?? true;
53			// Generate the URLs to the optimized images
54			$assets = Craft::$app->getAssets();
55			$url = $assets->getAssetUrl($asset, $transform, $generateTransformsBeforePageLoad);
56
57			return $url;
58			}
59
60			/**
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
61			* @param string $url
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
62			* @param Asset $asset
			0 ignored issues – show Coding Style introduced 2018-10-10 19:34 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
63			* @param AssetTransform\|null $transform
			0 ignored issues – show Coding Style introduced 2018-10-10 19:34 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
64			* @param array $params
			0 ignored issues – show Coding Style introduced 2018-10-10 19:34 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
65			*
66			* @return string
67			*/
68			public function getWebPUrl(string $url, Asset $asset, $transform, array $params = []): string
69			{
70			$url = $this->appendExtension($url, '.webp');
71
72			return $url;
73			}
74
75			/**
			0 ignored issues – show Coding Style introduced 2018-09-25 21:32 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
76			* @return array
77			*/
78			public function getTransformParams(): array
79			{
80			$settings = ImageOptimize::$plugin->getSettings();
81			// Get our $generateTransformsBeforePageLoad setting
82			$generateTransformsBeforePageLoad = $settings->generateTransformsBeforePageLoad ?? true;
83			$params = [
84			'generateTransformsBeforePageLoad' => $generateTransformsBeforePageLoad,
85			];
86
87			return $params;
88			}
89
90			/**
			0 ignored issues – show Coding Style introduced 2018-12-24 20:18 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
91			* @inheritdoc
92			*/
			0 ignored issues – show Coding Style introduced 2018-12-24 20:18 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
93			public function rules()
94			{
95			$rules = parent::rules();
96			$rules = array_merge($rules, [
			0 ignored issues – show Coding Style introduced 2018-12-24 20:18 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
97			]);
			0 ignored issues – show Coding Style introduced 2018-12-24 20:18 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
98
99			return $rules;
100			}
101			}
102

nystudio107 / craft-imageoptimize

Push — develop ( d502bc...2115be )

CraftImageTransform::rules() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like