flipbox\craft\scorecard\metrics\AbstractMetric

Complexity

Total Complexity

8

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
	calculateScore()	0	1	?
A	displayName()	0	9	1
A	getVersion()	0	4	1
A	getWeight()	0	4	1
A	getScore()	0	8	2
A	resetScore()	0	5	1
A	setScore()	0	5	1
A	toConfig()	0	9	1

<?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\metrics;

use craft\helpers\StringHelper;
use yii\base\BaseObject;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
abstract class AbstractMetric extends BaseObject implements MetricInterface
{
    /**
     * @var float
     */
    public $weight = 1;

    /**
     * @var string
     */
    public $version = '1.0.0';

    /**
     * @var float
     */
    private $score;

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

    /**
     * @inheritdoc
     * @throws \ReflectionException
     */
    public static function displayName(): string
    {
        return preg_replace(
            '/(?<!^)([A-Z])/',
            ' $0',
            (new \ReflectionClass(static::class))
            ->getShortName()
        );
    }

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

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

    /**
     * @return float
     */
    public function getScore(): float
    {
        if ($this->score === null) {
            $this->score = $this->calculateScore();
        }

        return $this->score * $this->getWeight();
    }

    /**
     * @return $this
     */
    public function resetScore()
    {
        $this->score = null;
        return $this;
    }

    /**
     * @param float|null $score
     * @return $this
     */
    public function setScore(float $score = null)
    {
        $this->score = $score;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function toConfig(): array
    {
        return [
            'class' => static::class,
            'weight' => $this->getWeight(),
            'version' => $this->getVersion(),
            'score' => $this->getScore()
        ];
    }
}