Driver::serializeObject() - Code Metrics - Inspection of "Functions that should not be called" - nilportugues/serializer-eloquent-driver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 63c2be...192105 )

unknown

created 2016-01-12 13:42 UTC

Driver::serializeObject() C

↳ Parent: Driver

Complexity

Conditions	7
Paths	7

Size

Total Lines	36
Code Lines	20

Duplication

Lines	16
Ratio	44.44 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	16
loc	36
rs	6.7273
cc	7
eloc	20
nc	7
nop	1

<?php
/**
 * Author: Nil Portugués Calderó <[email protected]>
 * Date: 11/21/15
 * Time: 3:44 PM
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace NilPortugues\Serializer\Drivers\Eloquent;

use NilPortugues\Serializer\Serializer;
use ErrorException;
use Illuminate\Database\Eloquent\Model;
use ReflectionClass;
use ReflectionMethod;

/**
 * Class Driver
 * @package NilPortugues\Laravel5\Serializer
 */
class Driver extends Serializer
{
    /**
     * @var array
     */
    private $forbiddenFunction = [
        'forceDelete',
        'forceFill',
        'delete',
        'newQueryWithoutScopes',
        'newQuery',
        'bootIfNotBooted',
        'boot',
        'bootTraits',
        'clearBootedModels',
        'query',
        'onWriteConnection',
        'delete',
        'forceDelete',
        'performDeleteOnModel',
        'flushEventListeners',
        'push',
        'touchOwners',
        'touch',
        'updateTimestamps',
        'freshTimestamp',
        'freshTimestampString',
        'newQuery',
        'newQueryWithoutScopes',
        'newBaseQueryBuilder',
        'usesTimestamps',
        'reguard',
        'isUnguarded',
        'totallyGuarded',
        'syncOriginal',
        'getConnectionResolver',
        'unsetConnectionResolver',
        'getEventDispatcher',
        'unsetEventDispatcher',
        '__toString',
        '__wakeup',
    ];
    /**
     *
     */
    public function __construct()
    {

    }

    /**
     * @param mixed $value
     *
     * @return mixed|string
     */
    public function serialize($value)
    {
        $this->reset();
        return $this->serializeObject($value);
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());
}
    }

    /**
     * Extract the data from an object.
     *
     * @param mixed $value
     *
     * @return array
     */
    protected function serializeObject($value)
    {
        if ($value instanceof \Illuminate\Database\Eloquent\Collection) {

            $items = [];
            foreach ($value as $v) {
                $items[] = $this->serializeObject($v);
            }

            return [self::MAP_TYPE => 'array', self::SCALAR_VALUE => $items];
        }

        if ($value instanceof \Illuminate\Contracts\Pagination\Paginator) {

            $items = [];
            foreach ($value->items() as $v) {
                $items[] = $this->serializeObject($v);
            }

            return [self::MAP_TYPE => 'array', self::SCALAR_VALUE => $items];
        }

        if (\is_subclass_of($value, Model::class, true)) {

            $stdClass = (object) $value->attributesToArray();
            $data = $this->serializeData($stdClass);
            $data[self::CLASS_IDENTIFIER_KEY] = \get_class($value);

            $methods = $this->getRelationshipAsPropertyName($value, get_class($value), new ReflectionClass($value));

            if (!empty($methods)) {
                $data = \array_merge($data, $methods);
            }

            return $data;
        }

        return parent::serializeObject($value);
    }

    /**
     * @param                 $value
     * @param string          $className
     * @param ReflectionClass $reflection
     *
     * @return array
     */
    protected function getRelationshipAsPropertyName($value, $className, ReflectionClass $reflection)
    {
        $methods = [];
        foreach ($reflection->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
            if (\ltrim($method->class, '\\') === \ltrim($className, '\\')) {
                $name = $method->name;
                $reflectionMethod = $reflection->getMethod($name);

                // Eloquent relations do not include parameters, so we'll be filtering based on this criteria.
                if (0 == $reflectionMethod->getNumberOfParameters()) {
                    try {

                        if (false === in_array($value, $this->forbiddenFunction, true)) {
                            $returned = $reflectionMethod->invoke($value);
                            //All operations (eg: boolean operations) are now filtered out.
                            if (\is_object($returned)) {

                                // Only keep those methods as properties if these are returning Eloquent relations.
                                // But do not run the operation as it is an expensive operation.
                                if (false !== \strpos(\get_class($returned), 'Illuminate\Database\Eloquent\Relations')) {
                                    $items = [];
                                    foreach ($returned->getResults() as $model) {
                                        if (\is_object($model)) {
                                            /** @var Model $model */
                                            $stdClass = (object) $model->getAttributes();
                                            $data = $this->serializeData($stdClass);
                                            $data[self::CLASS_IDENTIFIER_KEY] = \get_class($model);

                                            $items[] = $data;
                                        }
                                    }
                                    if (!empty($items)) {
                                        $methods[$name] = [self::MAP_TYPE => 'array', self::SCALAR_VALUE => $items];
                                    }
                                }
                            }
                        }

                    } catch (ErrorException $e) {
                    }
                }
            }
        }

        return $methods;
    }
} 


1		<?php
2		/**
3		* Author: Nil Portugués Calderó <[email protected]>
4		* Date: 11/21/15
5		* Time: 3:44 PM
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace NilPortugues\Serializer\Drivers\Eloquent;
12
13		use NilPortugues\Serializer\Serializer;
14		use ErrorException;
15		use Illuminate\Database\Eloquent\Model;
16		use ReflectionClass;
17		use ReflectionMethod;
18
19		/**
20		* Class Driver
21		* @package NilPortugues\Laravel5\Serializer
22		*/
23		class Driver extends Serializer
24		{
25		/**
26		* @var array
27		*/
28		private $forbiddenFunction = [
29		'forceDelete',
30		'forceFill',
31		'delete',
32		'newQueryWithoutScopes',
33		'newQuery',
34		'bootIfNotBooted',
35		'boot',
36		'bootTraits',
37		'clearBootedModels',
38		'query',
39		'onWriteConnection',
40		'delete',
41		'forceDelete',
42		'performDeleteOnModel',
43		'flushEventListeners',
44		'push',
45		'touchOwners',
46		'touch',
47		'updateTimestamps',
48		'freshTimestamp',
49		'freshTimestampString',
50		'newQuery',
51		'newQueryWithoutScopes',
52		'newBaseQueryBuilder',
53		'usesTimestamps',
54		'reguard',
55		'isUnguarded',
56		'totallyGuarded',
57		'syncOriginal',
58		'getConnectionResolver',
59		'unsetConnectionResolver',
60		'getEventDispatcher',
61		'unsetEventDispatcher',
62		'__toString',
63		'__wakeup',
64		];
65		/**
66		*
67		*/
68		public function __construct()
69		{
70
71		}
72
73		/**
74		* @param mixed $value
75		*
76		* @return mixed\|string
77		*/
78		public function serialize($value)
79		{
80		$this->reset();
81		return $this->serializeObject($value);
		0 ignored issues – show Bug Best Practice introduced 2015-11-22 12:25 UTC by Report Bug Copy Issue Report The return type of `return $this->serializeObject($value);` (`array`) is incompatible with the return type of the parent method `NilPortugues\Serializer\Serializer::serialize` of type `string`. 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...
82		}
83
84		/**
85		* Extract the data from an object.
86		*
87		* @param mixed $value
88		*
89		* @return array
90		*/
91		protected function serializeObject($value)
92		{
93	View Code Duplication	if ($value instanceof \Illuminate\Database\Eloquent\Collection) {
		0 ignored issues – show Duplication introduced 2015-11-22 12:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94		$items = [];
95		foreach ($value as $v) {
96		$items[] = $this->serializeObject($v);
97		}
98
99		return [self::MAP_TYPE => 'array', self::SCALAR_VALUE => $items];
100		}
101
102	View Code Duplication	if ($value instanceof \Illuminate\Contracts\Pagination\Paginator) {
		0 ignored issues – show Duplication introduced 2015-11-22 12:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
103		$items = [];
104		foreach ($value->items() as $v) {
105		$items[] = $this->serializeObject($v);
106		}
107
108		return [self::MAP_TYPE => 'array', self::SCALAR_VALUE => $items];
109		}
110
111		if (\is_subclass_of($value, Model::class, true)) {
		0 ignored issues – show Bug introduced 2015-11-22 12:25 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `\Illuminate\Database\Eloquent\Model::class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
112		$stdClass = (object) $value->attributesToArray();
113		$data = $this->serializeData($stdClass);
114		$data[self::CLASS_IDENTIFIER_KEY] = \get_class($value);
115
116		$methods = $this->getRelationshipAsPropertyName($value, get_class($value), new ReflectionClass($value));
117
118		if (!empty($methods)) {
119		$data = \array_merge($data, $methods);
120		}
121
122		return $data;
123		}
124
125		return parent::serializeObject($value);
126		}
127
128		/**
129		* @param $value
130		* @param string $className
131		* @param ReflectionClass $reflection
132		*
133		* @return array
134		*/
135		protected function getRelationshipAsPropertyName($value, $className, ReflectionClass $reflection)
136		{
137		$methods = [];
138		foreach ($reflection->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
139		if (\ltrim($method->class, '\\') === \ltrim($className, '\\')) {
140		$name = $method->name;
141		$reflectionMethod = $reflection->getMethod($name);
142
143		// Eloquent relations do not include parameters, so we'll be filtering based on this criteria.
144		if (0 == $reflectionMethod->getNumberOfParameters()) {
145		try {
146
147		if (false === in_array($value, $this->forbiddenFunction, true)) {
148		$returned = $reflectionMethod->invoke($value);
149		//All operations (eg: boolean operations) are now filtered out.
150		if (\is_object($returned)) {
151
152		// Only keep those methods as properties if these are returning Eloquent relations.
153		// But do not run the operation as it is an expensive operation.
154		if (false !== \strpos(\get_class($returned), 'Illuminate\Database\Eloquent\Relations')) {
155		$items = [];
156		foreach ($returned->getResults() as $model) {
157		if (\is_object($model)) {
158		/** @var Model $model */
159		$stdClass = (object) $model->getAttributes();
160		$data = $this->serializeData($stdClass);
161		$data[self::CLASS_IDENTIFIER_KEY] = \get_class($model);
162
163		$items[] = $data;
164		}
165		}
166		if (!empty($items)) {
167		$methods[$name] = [self::MAP_TYPE => 'array', self::SCALAR_VALUE => $items];
168		}
169		}
170		}
171		}
172
173		} catch (ErrorException $e) {
174		}
175		}
176		}
177		}
178
179		return $methods;
180		}
181		}
182

nilportugues / serializer-eloquent-driver

Push — master ( 63c2be...192105 )

Driver::serializeObject() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like