ArrayHydrator::hydrate() - Code Metrics - Inspection of "Handle php 7.4 typed properties (#33)" - b2pweb/bdf-prime - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 36d135...97e9b8 )

by Sébastien

created 2021-08-30 09:33 UTC

ArrayHydrator::hydrate() A

↳ Parent: ArrayHydrator

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	2
crap	1

<?php

namespace Bdf\Prime\Entity\Hydrator;

use Bdf\Prime\Entity\Hydrator\Exception\InvalidTypeException;
use Bdf\Prime\Entity\ImportableInterface;
use Closure;
use stdClass;

use TypeError;
use function get_class;
use function is_array;
use function method_exists;
use function property_exists;
use function ucfirst;

/**
 * Base hydrator implementation.
 * Works like {@link ArrayHydrator}
 */
class ArrayHydrator implements HydratorInterface
{
    /**
     * Array prefix for protected properties
     */
    const PROTECTED_PREFIX = "\0*\0";

    /**
     * @var array<class-string, callable(object, array)>

     */
    private $hydratorsCache = [];

    /**

     * {@inheritdoc}
     */
    public function hydrate($object, array $data)
    {
        return $this->getHydratorForClass(get_class($object))($object, $data);
    }

    /**

     * {@inheritdoc}
     */
    public function extract($object, array $attributes = [])
    {
        $values = [];
        $attributes = array_flip($attributes);

        $privatePrefix = "\0" . get_class($object) . "\0";
        $privatePrefixLen = strlen($privatePrefix);

        foreach ((array) $object as $name => $property) {

            if (strpos($name, self::PROTECTED_PREFIX) === 0) {
                $name = substr($name, 3);
            } elseif (strpos($name, $privatePrefix) === 0) {

                $name = substr($name, $privatePrefixLen);
            }

            if (!empty($attributes) && !isset($attributes[$name])) {
                continue;
            }

            if ($property instanceof ImportableInterface) {
                $values[$name] = $property->export();
            } else {
                $values[$name] = $property;
            }
        }

        return $values;
    }

    /**
     * Create or retrieve the hydrator callback for the given entity class
     *
     * @param class-string $entityClass The entity class name

     *
     * @return callable(object, array)
     */
    private function getHydratorForClass(string $entityClass): callable

    {
        if (isset($this->hydratorsCache[$entityClass])) {
            return $this->hydratorsCache[$entityClass];
        }

        $hydrator = static function ($object, array $data) {
            foreach ($data as $property => $value) {
                try {
                    if (isset($object->$property) && $object->$property instanceof ImportableInterface && is_array($value)) {
                        $object->$property->import($value);
                    } elseif (method_exists($object, 'set' . ucfirst($property))) {

                        $object->{'set' . ucfirst($property)}($value);
                    } elseif (property_exists($object, $property)) {

                        $object->$property = $value;
                    }
                } catch (TypeError $e) {
                    throw new InvalidTypeException($e);
                }
            }
        };

        if ($entityClass !== stdClass::class) {
            // Bind to access private properties
            // Note: ignore stdClass because all its fields are public
            $hydrator = Closure::bind($hydrator, null, $entityClass);
        }

        return $this->hydratorsCache[$entityClass] = $hydrator;

    }
}


1		<?php
2
3		namespace Bdf\Prime\Entity\Hydrator;
4
5		use Bdf\Prime\Entity\Hydrator\Exception\InvalidTypeException;
6		use Bdf\Prime\Entity\ImportableInterface;
7		use Closure;
8		use stdClass;
9
10		use TypeError;
11		use function get_class;
12		use function is_array;
13		use function method_exists;
14		use function property_exists;
15		use function ucfirst;
16
17		/**
18		* Base hydrator implementation.
19		* Works like {@link ArrayHydrator}
20		*/
21		class ArrayHydrator implements HydratorInterface
22		{
23		/**
24		* Array prefix for protected properties
25		*/
26		const PROTECTED_PREFIX = "\0*\0";
27
28		/**
29		* @var array<class-string, callable(object, array)>
		0 ignored issues – show Documentation Bug introduced 2021-08-13 15:02 UTC by Report Bug Copy Issue Report The doc comment `array<class-string, callable(object, array)>` at position `2` could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string, callable(object, array)>. Loading history... introduced 2021-08-13 15:02 UTC by Report Bug Copy Issue Report Expected "arrayclassstringcallableobjectarray" but found "array<class-string, callable(object, array)>" for @var tag in member variable comment Loading history...
30		*/
31		private $hydratorsCache = [];
32
33		/**
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Parameter `$object` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Parameter `$data` should have a doc-comment as per coding-style. Loading history...
34		* {@inheritdoc}
35		*/
36	519	public function hydrate($object, array $data)
37		{
38	519	return $this->getHydratorForClass(get_class($object))($object, $data);
39		}
40
41		/**
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Parameter `$attributes` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Parameter `$object` should have a doc-comment as per coding-style. Loading history...
42		* {@inheritdoc}
43		*/
44	13	public function extract($object, array $attributes = [])
45		{
46	13	$values = [];
47	13	$attributes = array_flip($attributes);
48
49	13	$privatePrefix = "\0" . get_class($object) . "\0";
50	13	$privatePrefixLen = strlen($privatePrefix);
51
52	13	foreach ((array) $object as $name => $property) {
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report A `cast` statement should not be followed as per the coding-style. Loading history...
53	13	if (strpos($name, self::PROTECTED_PREFIX) === 0) {
54	2	$name = substr($name, 3);
55	13	} elseif (strpos($name, $privatePrefix) === 0) {
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Usage of ELSEIF not allowed; use ELSE IF instead Loading history...
56	2	$name = substr($name, $privatePrefixLen);
57		}
58
59	13	if (!empty($attributes) && !isset($attributes[$name])) {
60	3	continue;
61		}
62
63	13	if ($property instanceof ImportableInterface) {
64	6	$values[$name] = $property->export();
65		} else {
66	13	$values[$name] = $property;
67		}
68		}
69
70	13	return $values;
71		}
72
73		/**
74		* Create or retrieve the hydrator callback for the given entity class
75		*
76		* @param class-string $entityClass The entity class name
		0 ignored issues – show Documentation Bug introduced 2021-08-13 15:02 UTC by Report Bug Copy Issue Report The doc comment `class-string` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string. Loading history... introduced 2021-08-13 15:02 UTC by Report Bug Copy Issue Report Expected "classstring" but found "class-string" for parameter type Loading history...
77		*
78		* @return callable(object, array)
79		*/
80	519	private function getHydratorForClass(string $entityClass): callable
		0 ignored issues – show Coding Style introduced 2021-08-13 15:02 UTC by Report Bug Copy Issue Report Private method name "ArrayHydrator::getHydratorForClass" must be prefixed with an underscore Loading history...
81		{
82	519	if (isset($this->hydratorsCache[$entityClass])) {
83	490	return $this->hydratorsCache[$entityClass];
84		}
85
86		$hydrator = static function ($object, array $data) {
87	519	foreach ($data as $property => $value) {
88		try {
89	519	if (isset($object->$property) && $object->$property instanceof ImportableInterface && is_array($value)) {
90	41	$object->$property->import($value);
91	518	} elseif (method_exists($object, 'set' . ucfirst($property))) {
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Usage of ELSEIF not allowed; use ELSE IF instead Loading history...
92	94	$object->{'set' . ucfirst($property)}($value);
93	511	} elseif (property_exists($object, $property)) {
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Usage of ELSEIF not allowed; use ELSE IF instead Loading history...
94	519	$object->$property = $value;
95		}
96		} catch (TypeError $e) {
97	519	throw new InvalidTypeException($e);
98		}
99		}
100	519	};
101
102	86	if ($entityClass !== stdClass::class) {
103		// Bind to access private properties
104		// Note: ignore stdClass because all its fields are public
105	85	$hydrator = Closure::bind($hydrator, null, $entityClass);
106		}
107
108	86	return $this->hydratorsCache[$entityClass] = $hydrator;
		0 ignored issues – show Coding Style introduced 2021-08-13 15:02 UTC by Report Bug Copy Issue Report Assignments must be the first block of code on a line Loading history...
109		}
110		}
111

b2pweb / bdf-prime

Push — master ( 36d135...97e9b8 )

ArrayHydrator::hydrate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like