ElementMetricCollection::resetScore() - Code Metrics - Inspection of "1.0.0-beta.9" - flipboxfactory/scorecard - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 76311f...209ded )

by Nate

created 2019-01-09 18:21 UTC

ElementMetricCollection::resetScore() A

↳ Parent: ElementMetricCollection

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

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

namespace flipbox\craft\scorecard\records;

use flipbox\ember\helpers\ArrayHelper;
use flipbox\craft\scorecard\queries\ElementMetricQuery;
use flipbox\craft\scorecard\helpers\MetricHelper;
use flipbox\craft\scorecard\metrics\MetricInterface;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 *
 * @property ElementMetric[] $children
 */
abstract class ElementMetricCollection extends ElementMetric
{
    /**
     * @return array
     */
    const METRICS = [];

    /**
     * @var MetricInterface[]
     */
    private $metrics;


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

    /**
     * @inheritdoc
     */
    protected function calculateScore(): float
    {
        // Sum of total/weight
        $total = $weights = 0;

        foreach ($this->getMetrics() as $metric) {
            $total += $metric->getScore();
            $weights += $metric->getWeight();
        }

        return $total > 0 ? (float)($total / $weights) : 0;
    }

    /**
     * @inheritdoc
     */
    public function resetScore()
    {
        foreach ($this->getMetrics() as $metric) {
            $metric->resetScore();
        }

        return parent::resetScore();
    }


    /*******************************************
     * METRICS (CHILDREN)
     *******************************************/

    /**
     * @return MetricInterface[]
     */
    public function getMetrics(): array
    {
        if ($this->metrics === null) {
            $this->setMetrics(
                $this->loadMetrics()
            );
        }

        return $this->metrics;
    }

    /**
     * @return array
     */
    protected function loadMetrics(): array
    {
        if ($this->getIsNewRecord()) {
            return (array)static::METRICS;
        }

        return array_filter(array_merge(
            $this->children,
            (array)ArrayHelper::getValue($this->settings, 'metrics', [])
        ));
    }

    /**
     * @param array $metrics
     * @return $this
     */
    public function setMetrics(array $metrics = [])
    {
        $this->metrics = [];

        foreach ($metrics as $metric) {
            if (!$metric instanceof MetricInterface) {
                $metric = $this->createMetric($metric);
            }

            $this->metrics[] = $metric;
        }

        return $this;
    }

    /**
     * @noinspection PhpDocMissingThrowsInspection
     *
     * @param $metric
     * @return MetricInterface
     */
    protected function createMetric($metric): MetricInterface
    {
        if (is_string($metric)) {
            $metric = ['class' => $metric];
        }

        /** Pass along other vars */
        if (is_array($metric)) {
            if (!isset($metric['elementId'])) {
                $metric['element'] = $metric['element'] ?? $this->getElement();
            }

            $metric['dateCalculated'] = $metric['dateCalculated'] ?? $this->dateCalculated;
        }

        /** @noinspection PhpUnhandledExceptionInspection */
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return MetricHelper::create($metric);
    }

    /*******************************************
     * CHILDREN (RECORDS)
     *******************************************/

    /**
     * @return ElementMetricQuery
     */
    public function getChildren(): ElementMetricQuery
    {
        /** @var ElementMetricQuery $query */
        $query = $this->hasMany(
            static::class,
            ['parentId' => 'id']
        );

        // Prep query for children
        $query->class(null)
            ->parentId(':notempty:');

        return $query;
    }

    /*******************************************
     * VALIDATE (CHILD RECORDS)
     *******************************************/

    /**
     * @inheritdoc
     */
    public function beforeValidate()
    {
        $success = true;
        foreach ($this->getMetrics() as $metric) {
            if ($metric instanceof ElementMetric) {
                if (!$metric->validate()) {
                    $success = false;
                }
            }
        }

        return $success ? parent::beforeValidate() : false;
    }

    /*******************************************
     * SAVE (CHILD RECORDS)
     *******************************************/

    /**
     * @inheritdoc
     */
    public function beforeSave($insert)
    {
        /** @var array $metrics */
        $metrics = [];

        foreach ($this->getMetrics() as $metric) {
            if (!$metric instanceof ElementMetric) {
                $metrics[] = $metric->toConfig();
            }
        }

        // Merge into settings
        if (!empty($metrics)) {
            $this->settings = array_filter(array_merge(
                (array)$this->settings,
                [
                    'metrics' => $metrics
                ]
            ));
        }

        return parent::beforeSave($insert);
    }

    /**
     * @inheritdoc
     */
    public function afterSave($insert, $changedAttributes)
    {
        /** @var ElementMetric[] $metrics */
        $children = [];

        foreach ($this->getMetrics() as $metric) {
            if ($metric instanceof ElementMetric) {
                $children[] = $metric;
            }
        }

        if (!empty($children)) {
            $success = true;
            foreach ($children as $child) {
                $child->parentId = $this->id;

                if (!$child->save()) {
                    $success = false;
                }
            }

            if (!$success) {
                $this->addError('children', 'Unable to save children');
            }
        }

        return parent::afterSave($insert, $changedAttributes);
    }
}


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\craft\scorecard\records;
10
11			use flipbox\ember\helpers\ArrayHelper;
12			use flipbox\craft\scorecard\queries\ElementMetricQuery;
13			use flipbox\craft\scorecard\helpers\MetricHelper;
14			use flipbox\craft\scorecard\metrics\MetricInterface;
15
16			/**
17			* @author Flipbox Factory <[email protected]>
18			* @since 1.0.0
19			*
20			* @property ElementMetric[] $children
21			*/
22			abstract class ElementMetricCollection extends ElementMetric
23			{
24			/**
25			* @return array
26			*/
27			const METRICS = [];
28
29			/**
30			* @var MetricInterface[]
31			*/
32			private $metrics;
33
34
35			/*******************************************
36			* METRIC INTERFACE
37			*******************************************/
38
39			/**
40			* @inheritdoc
41			*/
42			protected function calculateScore(): float
43			{
44			// Sum of total/weight
45			$total = $weights = 0;
46
47			foreach ($this->getMetrics() as $metric) {
48			$total += $metric->getScore();
49			$weights += $metric->getWeight();
50			}
51
52			return $total > 0 ? (float)($total / $weights) : 0;
53			}
54
55			/**
56			* @inheritdoc
57			*/
58			public function resetScore()
59			{
60			foreach ($this->getMetrics() as $metric) {
61			$metric->resetScore();
62			}
63
64			return parent::resetScore();
65			}
66
67
68			/*******************************************
69			* METRICS (CHILDREN)
70			*******************************************/
71
72			/**
73			* @return MetricInterface[]
74			*/
75			public function getMetrics(): array
76			{
77			if ($this->metrics === null) {
78			$this->setMetrics(
79			$this->loadMetrics()
80			);
81			}
82
83			return $this->metrics;
84			}
85
86			/**
87			* @return array
88			*/
89			protected function loadMetrics(): array
90			{
91			if ($this->getIsNewRecord()) {
92			return (array)static::METRICS;
93			}
94
95			return array_filter(array_merge(
96			$this->children,
97			(array)ArrayHelper::getValue($this->settings, 'metrics', [])
98			));
99			}
100
101			/**
102			* @param array $metrics
103			* @return $this
104			*/
105			public function setMetrics(array $metrics = [])
106			{
107			$this->metrics = [];
108
109			foreach ($metrics as $metric) {
110			if (!$metric instanceof MetricInterface) {
111			$metric = $this->createMetric($metric);
112			}
113
114			$this->metrics[] = $metric;
115			}
116
117			return $this;
118			}
119
120			/**
121			* @noinspection PhpDocMissingThrowsInspection
122			*
123			* @param $metric
124			* @return MetricInterface
125			*/
126			protected function createMetric($metric): MetricInterface
127			{
128			if (is_string($metric)) {
129			$metric = ['class' => $metric];
130			}
131
132			/** Pass along other vars */
133			if (is_array($metric)) {
134			if (!isset($metric['elementId'])) {
135			$metric['element'] = $metric['element'] ?? $this->getElement();
136			}
137
138			$metric['dateCalculated'] = $metric['dateCalculated'] ?? $this->dateCalculated;
139			}
140
141			/** @noinspection PhpUnhandledExceptionInspection */
142			/** @noinspection PhpIncompatibleReturnTypeInspection */
143			return MetricHelper::create($metric);
144			}
145
146			/*******************************************
147			* CHILDREN (RECORDS)
148			*******************************************/
149
150			/**
151			* @return ElementMetricQuery
152			*/
153			public function getChildren(): ElementMetricQuery
154			{
155			/** @var ElementMetricQuery $query */
156			$query = $this->hasMany(
157			static::class,
158			['parentId' => 'id']
159			);
160
161			// Prep query for children
162			$query->class(null)
163			->parentId(':notempty:');
164
165			return $query;
166			}
167
168			/*******************************************
169			* VALIDATE (CHILD RECORDS)
170			*******************************************/
171
172			/**
173			* @inheritdoc
174			*/
175			public function beforeValidate()
176			{
177			$success = true;
178			foreach ($this->getMetrics() as $metric) {
179			if ($metric instanceof ElementMetric) {
180			if (!$metric->validate()) {
181			$success = false;
182			}
183			}
184			}
185
186			return $success ? parent::beforeValidate() : false;
187			}
188
189			/*******************************************
190			* SAVE (CHILD RECORDS)
191			*******************************************/
192
193			/**
194			* @inheritdoc
195			*/
196			public function beforeSave($insert)
197			{
198			/** @var array $metrics */
199			$metrics = [];
200
201			foreach ($this->getMetrics() as $metric) {
202			if (!$metric instanceof ElementMetric) {
203			$metrics[] = $metric->toConfig();
204			}
205			}
206
207			// Merge into settings
208			if (!empty($metrics)) {
209			$this->settings = array_filter(array_merge(
210			(array)$this->settings,
211			[
212			'metrics' => $metrics
213			]
214			));
215			}
216
217			return parent::beforeSave($insert);
218			}
219
220			/**
221			* @inheritdoc
222			*/
223			public function afterSave($insert, $changedAttributes)
224			{
225			/** @var ElementMetric[] $metrics */
226			$children = [];
227
228			foreach ($this->getMetrics() as $metric) {
229			if ($metric instanceof ElementMetric) {
230			$children[] = $metric;
231			}
232			}
233
234			if (!empty($children)) {
235			$success = true;
236			foreach ($children as $child) {
237			$child->parentId = $this->id;
238
239			if (!$child->save()) {
240			$success = false;
241			}
242			}
243
244			if (!$success) {
245			$this->addError('children', 'Unable to save children');
246			}
247			}
248
249			return parent::afterSave($insert, $changedAttributes);
250			}
251			}
252

flipboxfactory / scorecard

Push — master ( 76311f...209ded )

ElementMetricCollection::resetScore() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like