Requirement::isMet() - Code Metrics - bazzline/php_component_requirement - Measure and Improve Code Quality continuously with Scrutinizer

Requirement::isMet() A
last analyzed 2021-06-07 11:24 UTC

↳ Parent: Requirement

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	5
nop	0
dl	0
loc	20
rs	9.2888
c	0
b	0
f	0

<?php

namespace Net\Bazzline\Component\Requirement;

use InvalidArgumentException;
use Net\Bazzline\Component\Lock\RuntimeLock;
use RuntimeException;
use SplObjectStorage;

/**
 * Class Requirement
 *
 * @package Net\Bazzline\Component\Requirement
 * @author stev leibelt <[email protected]>
 * @since 2013-06-25
 */
class Requirement implements RequirementInterface
{
    /** @var \SplObjectStorage|ConditionInterface[]|IsMetInterface[] */
    protected $conditions;

    /** @var \Net\Bazzline\Component\Lock\RuntimeLock */
    protected $lock;

    /** @var bool */
    protected $isDisabled;

    /** @var bool */
    private $returnValueIfIsDisabled;

    /**
     * @author stev leibelt <[email protected]>
     * @since 2013-06-25
     */
    public function __construct()
    {
        $this->conditions   = new SplObjectStorage();
        $this->isDisabled   = false;
        $this->lock         = new RuntimeLock();
        $this->lock->setResource(get_class($this));
        $this->setReturnValueIfIsDisabledToTrue();
    }

    /**
     * Magic call method to keep this class as generic as possible.
     *
     * @param string $methodName - name of the method
     * @param mixed $arguments - value
     * @return $this
     * @throws \InvalidArgumentException
     * @author sleibelt
     * @since 2013-06-25
     */
    public function __call($methodName, $arguments)
    {
        if (count($arguments) != 1) {
            throw new InvalidArgumentException(
                'Only one argument value should be provided.'
            );
        }

        $value = current($arguments);

        foreach ($this->conditions as $condition) {
            $condition->$methodName($value);
        }

        return $this;
    }

    /**
     * Validates if given requirement is met
     *
     * @return boolean
     * @throws \RuntimeException
     */
    public function __invoke()
    {
        return $this->isMet();
    }

    /**
     * {$inheritdoc}
     */
    public function addCondition(ConditionInterface $condition)
    {
        if ($this->lock->isLocked()) {
            throw new RuntimeException(
                'Requirement is locked, no new condition could be added.'
            );
        }

        $this->conditions->attach($condition);

        return $this;
    }

    /**
     * Validates if given requirement is met
     *
     * @return boolean
     * @throws \RuntimeException
     */
    public function isMet()
    {
        if ($this->isDisabled()) {
            return $this->getReturnValueIfIsDisabled();
        } else {
            if ($this->conditions->count() == 0) {
                throw new RuntimeException(
                    'No condition set in this requirement.'
                );
            }

            foreach ($this->conditions as $condition) {
                if (!$condition->isMet()) {
                    return false;
                }
            }

            return true;
        }
    }

    /**
     * {$inheritdoc}
     */
    public function isLocked()
    {
        return $this->lock->isLocked();
    }

    /**
     * {$inheritdoc}
     */
    public function lock()
    {
        $this->lock->acquire();

        return $this;
    }

    /**
     * {$inheritdoc}
     */
    public function isDisabled()
    {
        return $this->isDisabled;
    }

    /**
     * @return $this
     * @author stev leibelt <[email protected]>
     * @since 2013-09-29
     */
    public function disable()
    {
        $this->isDisabled = true;

        return $this;
    }

    /**
     * @return null|ConditionInterface[]
     * @author stev leibelt <[email protected]>
     * @since 2013-09-29
     */
    public function getConditions()
    {
        $conditions = array();

        foreach ($this->conditions as $condition) {
            $conditions[] = $condition;
        }

        return $conditions;
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());
}
    }

    /**
     * @return bool
     * @author stev leibelt <[email protected]>
     * @since 2013-09-29
     */
    protected function getReturnValueIfIsDisabled()
    {
        return $this->isDisabled;
    }

    /**
     * @author stev leibelt <[email protected]>
     * @since 2013-09-29
     */
    protected function setReturnValueIfIsDisabledToFalse()
    {
        $this->returnValueIfIsDisabled = false;
    }

    /**
     * @author stev leibelt <[email protected]>
     * @since 2013-09-29
     */
    protected function setReturnValueIfIsDisabledToTrue()
    {
        $this->returnValueIfIsDisabled = true;
    }
}


1			<?php
2
3			namespace Net\Bazzline\Component\Requirement;
4
5			use InvalidArgumentException;
6			use Net\Bazzline\Component\Lock\RuntimeLock;
7			use RuntimeException;
8			use SplObjectStorage;
9
10			/**
11			* Class Requirement
12			*
13			* @package Net\Bazzline\Component\Requirement
14			* @author stev leibelt <[email protected]>
15			* @since 2013-06-25
16			*/
17			class Requirement implements RequirementInterface
18			{
19			/** @var \SplObjectStorage\|ConditionInterface[]\|IsMetInterface[] */
20			protected $conditions;
21
22			/** @var \Net\Bazzline\Component\Lock\RuntimeLock */
23			protected $lock;
24
25			/** @var bool */
26			protected $isDisabled;
27
28			/** @var bool */
29			private $returnValueIfIsDisabled;
30
31			/**
32			* @author stev leibelt <[email protected]>
33			* @since 2013-06-25
34			*/
35			public function __construct()
36			{
37			$this->conditions = new SplObjectStorage();
38			$this->isDisabled = false;
39			$this->lock = new RuntimeLock();
40			$this->lock->setResource(get_class($this));
41			$this->setReturnValueIfIsDisabledToTrue();
42			}
43
44			/**
45			* Magic call method to keep this class as generic as possible.
46			*
47			* @param string $methodName - name of the method
48			* @param mixed $arguments - value
49			* @return $this
50			* @throws \InvalidArgumentException
51			* @author sleibelt
52			* @since 2013-06-25
53			*/
54			public function __call($methodName, $arguments)
55			{
56			if (count($arguments) != 1) {
57			throw new InvalidArgumentException(
58			'Only one argument value should be provided.'
59			);
60			}
61
62			$value = current($arguments);
63
64			foreach ($this->conditions as $condition) {
65			$condition->$methodName($value);
66			}
67
68			return $this;
69			}
70
71			/**
72			* Validates if given requirement is met
73			*
74			* @return boolean
75			* @throws \RuntimeException
76			*/
77			public function __invoke()
78			{
79			return $this->isMet();
80			}
81
82			/**
83			* {$inheritdoc}
84			*/
85			public function addCondition(ConditionInterface $condition)
86			{
87			if ($this->lock->isLocked()) {
88			throw new RuntimeException(
89			'Requirement is locked, no new condition could be added.'
90			);
91			}
92
93			$this->conditions->attach($condition);
94
95			return $this;
96			}
97
98			/**
99			* Validates if given requirement is met
100			*
101			* @return boolean
102			* @throws \RuntimeException
103			*/
104			public function isMet()
105			{
106			if ($this->isDisabled()) {
107			return $this->getReturnValueIfIsDisabled();
108			} else {
109			if ($this->conditions->count() == 0) {
110			throw new RuntimeException(
111			'No condition set in this requirement.'
112			);
113			}
114
115			foreach ($this->conditions as $condition) {
116			if (!$condition->isMet()) {
117			return false;
118			}
119			}
120
121			return true;
122			}
123			}
124
125			/**
126			* {$inheritdoc}
127			*/
128			public function isLocked()
129			{
130			return $this->lock->isLocked();
131			}
132
133			/**
134			* {$inheritdoc}
135			*/
136			public function lock()
137			{
138			$this->lock->acquire();
139
140			return $this;
141			}
142
143			/**
144			* {$inheritdoc}
145			*/
146			public function isDisabled()
147			{
148			return $this->isDisabled;
149			}
150
151			/**
152			* @return $this
153			* @author stev leibelt <[email protected]>
154			* @since 2013-09-29
155			*/
156			public function disable()
157			{
158			$this->isDisabled = true;
159
160			return $this;
161			}
162
163			/**
164			* @return null\|ConditionInterface[]
165			* @author stev leibelt <[email protected]>
166			* @since 2013-09-29
167			*/
168			public function getConditions()
169			{
170			$conditions = array();
171
172			foreach ($this->conditions as $condition) {
173			$conditions[] = $condition;
174			}
175
176			return $conditions;
			0 ignored issues – show Bug Best Practice introduced 2015-12-11 12:00 UTC by Report Bug Copy Issue Report The return type of `return $conditions;` (`array`) is incompatible with the return type declared by the interface `Net\Bazzline\Component\R...nterface::getConditions` of type `null\|Net\Bazzline\Compon...nt\ConditionInterface[]`. 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...
177			}
178
179			/**
180			* @return bool
181			* @author stev leibelt <[email protected]>
182			* @since 2013-09-29
183			*/
184			protected function getReturnValueIfIsDisabled()
185			{
186			return $this->isDisabled;
187			}
188
189			/**
190			* @author stev leibelt <[email protected]>
191			* @since 2013-09-29
192			*/
193			protected function setReturnValueIfIsDisabledToFalse()
194			{
195			$this->returnValueIfIsDisabled = false;
196			}
197
198			/**
199			* @author stev leibelt <[email protected]>
200			* @since 2013-09-29
201			*/
202			protected function setReturnValueIfIsDisabledToTrue()
203			{
204			$this->returnValueIfIsDisabled = true;
205			}
206			}
207

bazzline / php_component_requirement

Requirement::isMet() A last analyzed 2021-06-07 11:24 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Requirement::isMet() A
last analyzed 2021-06-07 11:24 UTC