Bdf\Prime\Entity\Hydrator\ArrayHydrator

Complexity

Total Complexity

18

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Test Coverage

Coverage

97.06%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	getHydratorForClass()	0	29	10
B	extract()	0	27	7
A	hydrate()	0	3	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)>

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)>.

Expected "arrayclassstringcallableobjectarray" but found "array<class-string, callable(object, array)>" for @var tag in member variable comment

     */
    private $hydratorsCache = [];

    /**

Parameter $object should have a doc-comment as per coding-style.

Parameter $data should have a doc-comment as per coding-style.

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

    /**

Parameter $attributes should have a doc-comment as per coding-style.

Parameter $object should have a doc-comment as per coding-style.

     * {@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) {

A cast statement should not be followed as per the coding-style.

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

Usage of ELSEIF not allowed; use ELSE IF instead

                $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

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

Expected "classstring" but found "class-string" for parameter type

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

Private method name "ArrayHydrator::getHydratorForClass" must be prefixed with an underscore

    {
        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))) {

Usage of ELSEIF not allowed; use ELSE IF instead

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

Usage of ELSEIF not allowed; use ELSE IF instead

                        $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;

Assignments must be the first block of code on a line

    }
}