Entry::__get() - Code Metrics - Inspection of "update tests" - directus/directus-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 34e9c0...86221b )

by Welling

created 2016-12-13 18:28 UTC

Entry::__get() A

↳ Parent: Entry

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	2
b	0
f	0
nc	2
nop	1
dl	0
loc	8
ccs	4
cts	4
cp	1
crap	2
rs	9.4285

<?php

/**
 * Directus – <http://getdirectus.com>
 *
 * @link      The canonical repository – <https://github.com/directus/directus>
 * @copyright Copyright 2006-2016 RANGER Studio, LLC – <http://rangerstudio.com>
 * @license   GNU General Public License (v3) – <http://www.gnu.org/copyleft/gpl.html>
 */

namespace Directus\SDK\Response;
use Directus\Util\ArrayUtils;

/**
 * Entry
 *
 * @author Welling Guzmán <[email protected]>
 */
class Entry implements ResponseInterface, \ArrayAccess
{
    /**
     * @var array
     */
    protected $data = null;

    /**
     * @var array
     */
    protected $rawData = null;

    /**
     * @var Entry
     */
    protected $metadata = null;

    /**
     * Entry constructor.
     *
     * @param $data
     */
    public function __construct($data)
    {
        $this->rawData = $data;
        if (!is_array($data)) {
            return;
        }

        // Support API 1.1
        if (isset($data['data']) && is_array($data['data'])) {
            $this->metadata = new static(ArrayUtils::get($data, 'meta', []));
            unset($data['meta']);

            $data = $data['data'];
        }

        foreach($data as $field => $value) {
            if (isset($value['rows']) || (isset($value['data']) && ArrayUtils::isNumericKeys($value['data']))) {
                $this->data[$field] = new EntryCollection($value);
            } else if (is_array($value)) {
                $this->data[$field] = new static($value);
            } else {
                $this->data[$field] = $value;
            }
        }
    }

    /**
     * Get the entry data
     *
     * @return array
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Get the entry metadata
     *
     * @return Entry
     */
    public function getMetaData()
    {
        return $this->metadata;
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 array
     */
    public function getRawData()
    {
        return $this->rawData;
    }

    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->data);
    }

    public function offsetGet($offset)
    {
        return $this->data[$offset];
    }

    public function offsetSet($offset, $value)
    {
        throw new \BadMethodCallException('Entry is read only');
    }

    public function offsetUnset($offset)
    {
        throw new \BadMethodCallException('Entry is read only');
    }

    public function __get($name)
    {
        if (array_key_exists($name, $this->data)) {
            return $this->data[$name];
        }

        throw new \InvalidArgumentException('Invalid property: ' . $name);
    }

    public function __set($name, $value)
    {
        throw new \BadMethodCallException('Entry is read only');
    }

    /**
     * Gets the object representation of this entry
     *
     * @return object
     */
    public function jsonSerialize()
    {
        return (object) [
            'metadata' => $this->getMetaData(),
            'data' => $this->getData()
        ];
    }
}

1		<?php
2
3		/**
4		* Directus – <http://getdirectus.com>
5		*
6		* @link The canonical repository – <https://github.com/directus/directus>
7		* @copyright Copyright 2006-2016 RANGER Studio, LLC – <http://rangerstudio.com>
8		* @license GNU General Public License (v3) – <http://www.gnu.org/copyleft/gpl.html>
9		*/
10
11		namespace Directus\SDK\Response;
12		use Directus\Util\ArrayUtils;
13
14		/**
15		* Entry
16		*
17		* @author Welling Guzmán <[email protected]>
18		*/
19		class Entry implements ResponseInterface, \ArrayAccess
20		{
21		/**
22		* @var array
23		*/
24		protected $data = null;
25
26		/**
27		* @var array
28		*/
29		protected $rawData = null;
30
31		/**
32		* @var Entry
33		*/
34		protected $metadata = null;
35
36		/**
37		* Entry constructor.
38		*
39		* @param $data
40		*/
41	58	public function __construct($data)
42		{
43	58	$this->rawData = $data;
44	58	if (!is_array($data)) {
45	10	return;
46		}
47
48		// Support API 1.1
49	58	if (isset($data['data']) && is_array($data['data'])) {
50	2	$this->metadata = new static(ArrayUtils::get($data, 'meta', []));
51	2	unset($data['meta']);
52
53	2	$data = $data['data'];
54	2	}
55
56	58	foreach($data as $field => $value) {
57	58	if (isset($value['rows']) \|\| (isset($value['data']) && ArrayUtils::isNumericKeys($value['data']))) {
58	14	$this->data[$field] = new EntryCollection($value);
59	58	} else if (is_array($value)) {
60	12	$this->data[$field] = new static($value);
61	12	} else {
62	58	$this->data[$field] = $value;
63		}
64	58	}
65	58	}
66
67		/**
68		* Get the entry data
69		*
70		* @return array
71		*/
72	8	public function getData()
73		{
74	8	return $this->data;
75		}
76
77		/**
78		* Get the entry metadata
79		*
80		* @return Entry
81		*/
82	8	public function getMetaData()
83		{
84	8	return $this->metadata;
		0 ignored issues – show Bug Best Practice introduced 2016-11-17 02:54 UTC by Report Bug Copy Issue Report The return type of `return $this->metadata;` (`Directus\SDK\Response\Entry`) is incompatible with the return type declared by the interface `Directus\SDK\Response\Re...eInterface::getMetaData` of type `array`. 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...
85		}
86
87		/**
88		* @return array
89		*/
90	16	public function getRawData()
91		{
92	16	return $this->rawData;
93		}
94
95	2	public function offsetExists($offset)
96		{
97	2	return array_key_exists($offset, $this->data);
98		}
99
100	4	public function offsetGet($offset)
101		{
102	4	return $this->data[$offset];
103		}
104
105	2	public function offsetSet($offset, $value)
106		{
107	2	throw new \BadMethodCallException('Entry is read only');
108		}
109
110	2	public function offsetUnset($offset)
111		{
112	2	throw new \BadMethodCallException('Entry is read only');
113		}
114
115	4	public function __get($name)
116		{
117	4	if (array_key_exists($name, $this->data)) {
118	2	return $this->data[$name];
119		}
120
121	2	throw new \InvalidArgumentException('Invalid property: ' . $name);
122		}
123
124	2	public function __set($name, $value)
125		{
126	2	throw new \BadMethodCallException('Entry is read only');
127		}
128
129		/**
130		* Gets the object representation of this entry
131		*
132		* @return object
133		*/
134	4	public function jsonSerialize()
135		{
136		return (object) [
137	4	'metadata' => $this->getMetaData(),
138	4	'data' => $this->getData()
139	4	];
140		}
141		}

directus / directus-sdk-php

Push — master ( 34e9c0...86221b )

Entry::__get() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like