MapIterator - Code Metrics - Inspection of "Merge branch 'feature/small-improvements'" - spaark/composite-utils - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 79f24a...4b5497 )

by Emily

created 2017-03-19 14:34 UTC

MapIterator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	25
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	2
lcom	0
cbo	1
dl	0
loc	25
ccs	4
cts	4
cp	1
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
	getCurrent()	1	?
A	current()	4	1
A	key()	4	1

<?php
/**
 * This file is part of the Composite Utils package.
 *
 * (c) Emily Shepherd <[email protected]>
 *
 * For the full copyright and license information, please view the
 * LICENSE.md file that was distributed with this source code.
 *
 * @package spaark/composite-utils
 * @author Emily Shepherd <[email protected]>
 * @license MIT
 */

namespace Spaark\CompositeUtils\Model\Collection\Map;

use Spaark\CompositeUtils\Traits\AutoConstructTrait;

/**
 * Abstract Iterator for Map datatypes
 *
 * @generic KeyType
 * @generic ValueType
 */
abstract class MapIterator implements \Iterator
{
    /**
     * Returns the current pair in the Map
     *
     * @return Pair<KeyType, ValueType>

     */
    abstract protected function getCurrent() : Pair;

    /**
     * {@inheritDoc}
     */
    public function current()
    {
        return $this->getCurrent()->value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * {@inheritDoc}
     */
    public function key()
    {
        return $this->getCurrent()->key;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }
}


1		<?php
2		/**
3		* This file is part of the Composite Utils package.
4		*
5		* (c) Emily Shepherd <[email protected]>
6		*
7		* For the full copyright and license information, please view the
8		* LICENSE.md file that was distributed with this source code.
9		*
10		* @package spaark/composite-utils
11		* @author Emily Shepherd <[email protected]>
12		* @license MIT
13		*/
14
15		namespace Spaark\CompositeUtils\Model\Collection\Map;
16
17		use Spaark\CompositeUtils\Traits\AutoConstructTrait;
18
19		/**
20		* Abstract Iterator for Map datatypes
21		*
22		* @generic KeyType
23		* @generic ValueType
24		*/
25		abstract class MapIterator implements \Iterator
26		{
27		/**
28		* Returns the current pair in the Map
29		*
30		* @return Pair<KeyType, ValueType>
		0 ignored issues – show Documentation introduced 2017-02-15 22:55 UTC by Report Bug Copy Issue Report The doc-type `Pair<KeyType,` could not be parsed: Expected "\|" or "end of type", but got "<" at position 4. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
31		*/
32		abstract protected function getCurrent() : Pair;
33
34		/**
35		* {@inheritDoc}
36		*/
37	11	public function current()
38		{
39	11	return $this->getCurrent()->value;
		0 ignored issues – show Documentation introduced 2017-03-19 14:36 UTC by Report Bug Copy Issue Report The property `$value` is declared protected in `Spaark\CompositeUtils\Model\Collection\Map\Pair`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
40		}
41
42		/**
43		* {@inheritDoc}
44		*/
45	9	public function key()
46		{
47	9	return $this->getCurrent()->key;
		0 ignored issues – show Documentation introduced 2017-03-19 14:36 UTC by Report Bug Copy Issue Report The property `$key` is declared protected in `Spaark\CompositeUtils\Model\Collection\Map\Pair`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Bug Best Practice introduced 2017-03-19 14:36 UTC by Report Bug Copy Issue Report The return type of `return $this->getCurrent()->key;` (`Spaark\CompositeUtils\Model\Collection\Map\KeyType`) is incompatible with the return type declared by the interface `Iterator::key` of type `integer\|double\|string\|boolean`. 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...
48		}
49		}
50

spaark / composite-utils

Push — master ( 79f24a...4b5497 )

MapIterator A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like