MonthlyQuantity::setContext() - Code Metrics - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

MonthlyQuantity::setContext() A
last analyzed 2020-11-24 16:48 UTC

↳ Parent: MonthlyQuantity

Complexity

Conditions	5
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	0
cts	11
cp	0
rs	9.5222
c	0
b	0
f	0
cc	5
nc	2
nop	1
crap	30

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\logic\bill;

use hipanel\modules\finance\forms\BillForm;
use hipanel\modules\finance\models\Bill;
use hipanel\modules\finance\models\Charge;
use hipanel\modules\server\models\Consumption;
use Yii;

/**
 * Class MonthlyQuantity.
 *
 * @author Dmytro Naumenko <[email protected]>
 */
class MonthlyQuantity extends DefaultQuantityFormatter implements ContextAwareQuantityFormatter
{
    /** @var Bill|Charge */
    protected $model;

    /**
     * {@inheritdoc}
     */
    public function format(): string
    {
        $text = Yii::t('hipanel:finance', '{quantity, plural, one{# day} other{# days}}', ['quantity' => $this->getClientValue()]);

        return $text;
    }

    /**
     * {@inheritdoc}
     */
    public function getValue(): string
    {
        return $this->getQuantity()->getQuantity() / $this->getNumberOfDays();
    }

    /**
     * {@inheritdoc}
     */
    public function getClientValue(): string
    {
        return round($this->getQuantity()->getQuantity() * $this->getNumberOfDays());
    }

    /**
     * @return false|string
     */
    protected function getNumberOfDays()
    {
        return date('t', strtotime($this->model->time));
    }

    /**
     * @param $context
     * @return ContextAwareQuantityFormatter
     */
    public function setContext($context): ContextAwareQuantityFormatter
    {
        if (!$context instanceof Bill && !$context instanceof Charge && !$context instanceof BillForm && !$context instanceof Consumption) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            throw new \OutOfBoundsException(sprintf(
                'Context "%s" is not supported by Monthly quantity',
                get_class($context)
            ));
        }

        $this->model = $context;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


MonthlyQuantity::setContext() A
last analyzed 2020-11-24 16:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1			<?php
2			/**
3			* Finance module for HiPanel
4			*
5			* @link https://github.com/hiqdev/hipanel-module-finance
6			* @package hipanel-module-finance
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hipanel\modules\finance\logic\bill;
12
13			use hipanel\modules\finance\forms\BillForm;
14			use hipanel\modules\finance\models\Bill;
15			use hipanel\modules\finance\models\Charge;
16			use hipanel\modules\server\models\Consumption;
17			use Yii;
18
19			/**
20			* Class MonthlyQuantity.
21			*
22			* @author Dmytro Naumenko <[email protected]>
23			*/
24			class MonthlyQuantity extends DefaultQuantityFormatter implements ContextAwareQuantityFormatter
25			{
26			/** @var Bill\|Charge */
27			protected $model;
28
29			/**
30			* {@inheritdoc}
31			*/
32			public function format(): string
33			{
34			$text = Yii::t('hipanel:finance', '{quantity, plural, one{# day} other{# days}}', ['quantity' => $this->getClientValue()]);
35
36			return $text;
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function getValue(): string
43			{
44			return $this->getQuantity()->getQuantity() / $this->getNumberOfDays();
45			}
46
47			/**
48			* {@inheritdoc}
49			*/
50			public function getClientValue(): string
51			{
52			return round($this->getQuantity()->getQuantity() * $this->getNumberOfDays());
53			}
54
55			/**
56			* @return false\|string
57			*/
58			protected function getNumberOfDays()
59			{
60			return date('t', strtotime($this->model->time));
61			}
62
63			/**
64			* @param $context
65			* @return ContextAwareQuantityFormatter
66			*/
67			public function setContext($context): ContextAwareQuantityFormatter
68			{
69			if (!$context instanceof Bill && !$context instanceof Charge && !$context instanceof BillForm && !$context instanceof Consumption) {
			0 ignored issues – show Bug introduced 2018-08-22 13:54 UTC by Report Bug Copy Issue Report The class `hipanel\modules\server\models\Consumption` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
70			throw new \OutOfBoundsException(sprintf(
71			'Context "%s" is not supported by Monthly quantity',
72			get_class($context)
73			));
74			}
75
76			$this->model = $context;
			0 ignored issues – show Documentation Bug introduced 2018-08-23 08:07 UTC by Report Bug Copy Issue Report It seems like `$context` can also be of type `object<hipanel\modules\finance\forms\BillForm>` or `object<hipanel\modules\server\models\Consumption>`. However, the property `$model` is declared as type `object<hipanel\modules\f...\finance\models\Charge>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
77
78			return $this;
			0 ignored issues – show Bug Best Practice introduced 2018-08-15 12:08 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`hipanel\modules\finance\logic\bill\MonthlyQuantity`) is incompatible with the return type declared by the interface `hipanel\modules\finance\...tyFormatter::setContext` of type `self`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
79			}
80			}
81

hiqdev / hipanel-module-finance

MonthlyQuantity::setContext() A last analyzed 2020-11-24 16:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

MonthlyQuantity::setContext() A
last analyzed 2020-11-24 16:48 UTC