ElementMetric::getSettingsValue() - Code Metrics - Inspection of "removing explicit class from query" - flipboxfactory/scorecard - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c52715...2fd9ab )

by Nate

created 2019-01-07 19:11 UTC

ElementMetric::getSettingsValue() A

↳ Parent: ElementMetric

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/scorecard/license
 * @link       https://www.flipboxfactory.com/software/scorecard/
 */

namespace flipbox\scorecard\records;

use Craft;
use craft\helpers\DateTimeHelper;
use craft\helpers\StringHelper;
use flipbox\ember\helpers\ModelHelper;
use flipbox\ember\records\ActiveRecordWithId;
use flipbox\ember\records\traits\ElementAttribute;
use flipbox\scorecard\queries\ElementMetricQuery;
use flipbox\scorecard\helpers\MetricHelper;
use flipbox\scorecard\metrics\SavableMetricInterface;
use flipbox\scorecard\validators\ElementMetricValidator;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 *
 * @property int $parentId
 * @property string $class
 * @property float $score
 * @property float $weight
 * @property string $version
 * @property array|null $settings
 * @property \DateTime $dateCalculated
 */
abstract class ElementMetric extends ActiveRecordWithId implements SavableMetricInterface
{
    use ElementAttribute;

    /**
     * The default score weight
     */
    const WEIGHT = 1;

    /**
     * The default metric version
     */
    const VERSION = '1.0';

    /**
     * The table alias
     */
    const TABLE_ALIAS = 'scorecard_element_metrics';

    /**
     * The Active Query class
     */
    const ACTIVE_QUERY_CLASS = ElementMetricQuery::class;

    /**
     * @inheritdoc
     */
    protected $getterPriorityAttributes = ['elementId', 'score'];

    /**
     * @return float
     */
    abstract protected function calculateScore(): float;

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        $this->setAttribute(
            'settings',
            MetricHelper::resolveSettings(
                $this->getAttribute('settings')
            )
        );

        // Always this class
        $this->class = static::class;

        // Defaults
        if ($this->getIsNewRecord()) {
            $this->weight = $this->weight ?: static::WEIGHT;
            $this->version = $this->version ?: static::VERSION;
            $this->dateCalculated = $this->dateCalculated ?: DateTimeHelper::currentUTCDateTime();
        }
    }

    /**
     * @inheritdoc
     */
    public static function find()
    {
        /** @noinspection PhpUnhandledExceptionInspection */
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return Craft::createObject(
            static::ACTIVE_QUERY_CLASS,
            [
                get_called_class(),
                [
                    'class' => static::class
                ]
            ]
        );
    }

    /**
     * @inheritdoc
     */
    public static function instantiate($row)
    {
        $class = $row['class'] ?? static::class;
        return new $class;
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return array_merge(
            parent::rules(),
            $this->elementRules(),
            [
                [
                    [
                        'class'
                    ],
                    ElementMetricValidator::class
                ],
                [
                    [
                        'parentId',
                    ],
                    'number',
                    'integerOnly' => true
                ],
                [
                    [
                        'score',
                        'weight',
                    ],
                    'number'
                ],
                [
                    [
                        'elementId',
                        'class',
                        'weight',
                        'version',
                    ],
                    'required'
                ],
                [
                    [
                        'class',
                        'settings',
                        'score',
                        'weight',
                        'version',
                        'dateCalculated'
                    ],
                    'safe',
                    'on' => [
                        ModelHelper::SCENARIO_DEFAULT
                    ]
                ]
            ]
        );
    }


    /*******************************************
     * METRIC INTERFACE
     *******************************************/

    /**
     * @inheritdoc
     * @throws \ReflectionException
     */
    public static function displayName(): string
    {
        return StringHelper::titleize(
            (new \ReflectionClass(static::class))
                ->getShortName()
        );
    }

    /**
     * @inheritdoc
     */
    public function getWeight(): float
    {
        return (float)$this->getAttribute('weight');
    }

    /**
     * @inheritdoc
     */
    public function getVersion(): string
    {
        return (string)$this->getAttribute('version');
    }

    /**
     * @inheritdoc
     */
    public function getScore(): float
    {
        if ($this->getAttribute('score') === null) {
            $this->setAttribute('score', $this->calculateScore() * $this->getWeight());
        }

        return (float)$this->getAttribute('score');
    }


    /*******************************************
     * SETTINGS
     *******************************************/

    /**
     * @param string $attribute
     * @return mixed
     */
    public function getSettingsValue(string $attribute)
    {
        return $this->settings[$attribute] ?? null;
    }

    /**
     * @param string $attribute
     * @param $value
     * @return $this
     */
    public function setSettingsValue(string $attribute, $value)
    {
        $settings = MetricHelper::resolveSettings(
            $this->getAttribute('settings')
        );
        $settings[$attribute] = $value;
        $this->setAttribute('settings', $settings);

        return $this;
    }


    /*******************************************
     * CONFIGURATION
     *******************************************/

    /**
     * @return array
     */
    public function toConfig(): array
    {
        return $this->toArray();
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/scorecard/license
6			* @link https://www.flipboxfactory.com/software/scorecard/
7			*/
8
9			namespace flipbox\scorecard\records;
10
11			use Craft;
12			use craft\helpers\DateTimeHelper;
13			use craft\helpers\StringHelper;
14			use flipbox\ember\helpers\ModelHelper;
15			use flipbox\ember\records\ActiveRecordWithId;
16			use flipbox\ember\records\traits\ElementAttribute;
17			use flipbox\scorecard\queries\ElementMetricQuery;
18			use flipbox\scorecard\helpers\MetricHelper;
19			use flipbox\scorecard\metrics\SavableMetricInterface;
20			use flipbox\scorecard\validators\ElementMetricValidator;
21
22			/**
23			* @author Flipbox Factory <[email protected]>
24			* @since 1.0.0
25			*
26			* @property int $parentId
27			* @property string $class
28			* @property float $score
29			* @property float $weight
30			* @property string $version
31			* @property array\|null $settings
32			* @property \DateTime $dateCalculated
33			*/
34			abstract class ElementMetric extends ActiveRecordWithId implements SavableMetricInterface
35			{
36			use ElementAttribute;
37
38			/**
39			* The default score weight
40			*/
41			const WEIGHT = 1;
42
43			/**
44			* The default metric version
45			*/
46			const VERSION = '1.0';
47
48			/**
49			* The table alias
50			*/
51			const TABLE_ALIAS = 'scorecard_element_metrics';
52
53			/**
54			* The Active Query class
55			*/
56			const ACTIVE_QUERY_CLASS = ElementMetricQuery::class;
57
58			/**
59			* @inheritdoc
60			*/
61			protected $getterPriorityAttributes = ['elementId', 'score'];
62
63			/**
64			* @return float
65			*/
66			abstract protected function calculateScore(): float;
67
68			/**
69			* @inheritdoc
70			*/
71			public function init()
72			{
73			parent::init();
74
75			$this->setAttribute(
76			'settings',
77			MetricHelper::resolveSettings(
78			$this->getAttribute('settings')
79			)
80			);
81
82			// Always this class
83			$this->class = static::class;
84
85			// Defaults
86			if ($this->getIsNewRecord()) {
87			$this->weight = $this->weight ?: static::WEIGHT;
88			$this->version = $this->version ?: static::VERSION;
89			$this->dateCalculated = $this->dateCalculated ?: DateTimeHelper::currentUTCDateTime();
90			}
91			}
92
93			/**
94			* @inheritdoc
95			*/
96			public static function find()
97			{
98			/** @noinspection PhpUnhandledExceptionInspection */
99			/** @noinspection PhpIncompatibleReturnTypeInspection */
100			return Craft::createObject(
101			static::ACTIVE_QUERY_CLASS,
102			[
103			get_called_class(),
104			[
105			'class' => static::class
106			]
107			]
108			);
109			}
110
111			/**
112			* @inheritdoc
113			*/
114			public static function instantiate($row)
115			{
116			$class = $row['class'] ?? static::class;
117			return new $class;
118			}
119
120			/**
121			* @inheritdoc
122			*/
123			public function rules()
124			{
125			return array_merge(
126			parent::rules(),
127			$this->elementRules(),
128			[
129			[
130			[
131			'class'
132			],
133			ElementMetricValidator::class
134			],
135			[
136			[
137			'parentId',
138			],
139			'number',
140			'integerOnly' => true
141			],
142			[
143			[
144			'score',
145			'weight',
146			],
147			'number'
148			],
149			[
150			[
151			'elementId',
152			'class',
153			'weight',
154			'version',
155			],
156			'required'
157			],
158			[
159			[
160			'class',
161			'settings',
162			'score',
163			'weight',
164			'version',
165			'dateCalculated'
166			],
167			'safe',
168			'on' => [
169			ModelHelper::SCENARIO_DEFAULT
170			]
171			]
172			]
173			);
174			}
175
176
177			/*******************************************
178			* METRIC INTERFACE
179			*******************************************/
180
181			/**
182			* @inheritdoc
183			* @throws \ReflectionException
184			*/
185			public static function displayName(): string
186			{
187			return StringHelper::titleize(
188			(new \ReflectionClass(static::class))
189			->getShortName()
190			);
191			}
192
193			/**
194			* @inheritdoc
195			*/
196			public function getWeight(): float
197			{
198			return (float)$this->getAttribute('weight');
199			}
200
201			/**
202			* @inheritdoc
203			*/
204			public function getVersion(): string
205			{
206			return (string)$this->getAttribute('version');
207			}
208
209			/**
210			* @inheritdoc
211			*/
212			public function getScore(): float
213			{
214			if ($this->getAttribute('score') === null) {
215			$this->setAttribute('score', $this->calculateScore() * $this->getWeight());
216			}
217
218			return (float)$this->getAttribute('score');
219			}
220
221
222			/*******************************************
223			* SETTINGS
224			*******************************************/
225
226			/**
227			* @param string $attribute
228			* @return mixed
229			*/
230			public function getSettingsValue(string $attribute)
231			{
232			return $this->settings[$attribute] ?? null;
233			}
234
235			/**
236			* @param string $attribute
237			* @param $value
238			* @return $this
239			*/
240			public function setSettingsValue(string $attribute, $value)
241			{
242			$settings = MetricHelper::resolveSettings(
243			$this->getAttribute('settings')
244			);
245			$settings[$attribute] = $value;
246			$this->setAttribute('settings', $settings);
247
248			return $this;
249			}
250
251
252			/*******************************************
253			* CONFIGURATION
254			*******************************************/
255
256			/**
257			* @return array
258			*/
259			public function toConfig(): array
260			{
261			return $this->toArray();
262			}
263			}
264

flipboxfactory / scorecard

Push — master ( c52715...2fd9ab )

ElementMetric::getSettingsValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like