dmt-software / jms-parameter-bag-handler

src/ParameterBagHandler.php

<?php

namespace DMT\Serializer;

use JMS\Serializer\Context;
use JMS\Serializer\Exception\RuntimeException;
use JMS\Serializer\GraphNavigator;
use JMS\Serializer\Handler\SubscribingHandlerInterface;
use JMS\Serializer\JsonDeserializationVisitor;
use JMS\Serializer\JsonSerializationVisitor;
use JMS\Serializer\VisitorInterface;
use phpDocumentor\Reflection\Types\Object_;

/**
 * Class ParameterBagHandler
 *
 * @package DMT\Serializer
 */
class ParameterBagHandler implements SubscribingHandlerInterface
{
    public static function getSubscribingMethods(): array
    {
        return [
            [
                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
                'format' => 'json',
                'type' => 'ParameterBag',
                'method' => 'serializeParameterBag',
            ],
            [
                'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
                'format' => 'json',
                'type' => 'ParameterBag',
                'method' => 'deserializeParameterBag',
            ],
        ];
    }

    /**
     * @param JsonSerializationVisitor|VisitorInterface $visitor
     * @param ParameterBag|null $data
     * @param array $type
     * @param Context $context
     *
     * @return array|null
     * @throws RuntimeException
     */
    public function serializeParameterBag(
        VisitorInterface $visitor,

The parameter $visitor is not used and could be removed.

        ? ParameterBag $data,
        array $type,

The parameter $type is not used and could be removed.

        Context $context
    ): ? array {
        $result = [];
        if ($data === null) {
            return $context->shouldSerializeNull() ? $result : null;
        }

        foreach ($data as $parameter) {
            if (!$context->shouldSerializeNull() && $parameter->getValue() === null) {

The expression $context->shouldSerializeNull() of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

                continue;
            }
            $result[$parameter->getName()] = $parameter->getValue();
        }

        return count($result) || $context->shouldSerializeNull() ? $result : null;
    }

    /**
     * Deserialize elements into a bag of parameters.
     *
     * @param JsonDeserializationVisitor|VisitorInterface $visitor
     * @param array|null $data
     * @param array $type
     * @param Context $context
     *
     * @return ParameterBag
     * @throws RuntimeException
     */
    public function deserializeParameterBag(
        VisitorInterface $visitor,

The parameter $visitor is not used and could be removed.

        $data,
        array $type,
        Context $context
    ): ParameterBag {
        $result = new ParameterBag();
        if (null === $data) {
            return $result;
        }
        if (!is_iterable($data)) {
            throw new RuntimeException('ParameterBag only excepts an array of parameters');
        }

        /** @var ParameterInterface $parameter */
        $parameterType = $this->getParameterType($type);
        $parameter = unserialize(sprintf('O:%d:"%s":0:{}', strlen($parameterType), $parameterType));

        foreach ($data as $key => $value) {
            if (!$context->shouldSerializeNull() && $value === null) {

The expression $context->shouldSerializeNull() of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

                continue;
            }
            $instance = clone $parameter;
            $instance->setName($key);
            $instance->setValue($value);

            $result[] = $instance;
        }

        return $result;
    }

    /**
     * Get the class name of the object to store in parameter bag.
     *
     * @param array $type
     *
     * @return string The class name for the parameters.
     * @throws RuntimeException
     */
    protected function getParameterType(array $type): string
    {
        if (empty($type['params'])) {
            return Parameter::class;
        }

        $parameterType = $type['params'][0]['name'] ?? $type['params'][0];
        if (!class_exists($parameterType) || !is_subclass_of($parameterType, ParameterInterface::class)) {
            throw new RuntimeException('Parameter(s) must implement ' . ParameterInterface::class);
        }

        return $parameterType;
    }
}