dmt-software / insolvency-client

src/Soap/Serializer/SoapSerializer.php

<?php

Missing file doc comment

namespace DMT\Insolvency\Soap\Serializer;

use DMT\Insolvency\Client;
use DMT\Insolvency\Config;
use DMT\Insolvency\Soap\Authorization;
use DMT\Insolvency\Soap\Request;
use DMT\Insolvency\Soap\Response;
use DMT\Soap\Serializer\SoapDateHandler;
use DMT\Soap\Serializer\SoapDeserializationVisitorFactory;
use DMT\Soap\Serializer\SoapHeaderEventSubscriber;
use DMT\Soap\Serializer\SoapHeaderInterface;
use DMT\Soap\Serializer\SoapMessageEventSubscriber;
use DMT\Soap\Serializer\SoapNamespaceInterface;
use DMT\Soap\Serializer\SoapSerializationVisitorFactory;
use JMS\Serializer\DeserializationContext;
use JMS\Serializer\EventDispatcher\EventDispatcher;
use JMS\Serializer\Exception\Exception;
use JMS\Serializer\Handler\HandlerRegistry;
use JMS\Serializer\SerializationContext;
use JMS\Serializer\Serializer;
use JMS\Serializer\SerializerBuilder;
use JMS\Serializer\SerializerInterface;
use Metadata\Cache\CacheInterface;

/**
 * Class SoapSerializer
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class SoapSerializer implements SerializerInterface
{
    /** @var Serializer $serializer */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    protected $serializer;

    /**

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

     * SoapSerializer constructor.
     *
     * @param Config $config

Missing parameter comment

Expected 14 spaces after parameter type; 1 found

Doc comment for parameter $config does not match actual variable name $client

     * @param CacheInterface|null $metadataCache

Missing parameter comment

Doc comment for parameter $metadataCache does not match actual variable name $config

     * @param array|null $metadataDirs

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

Doc comment for parameter $metadataDirs does not match actual variable name $metadataCache

     */
    public function __construct(Client $client, Config $config, CacheInterface $metadataCache = null, array $metadataDirs = null)
    {
        $builder = new SerializerBuilder();

        if ($metadataCache) {
            $builder->setMetadataCache($metadataCache);
        }

        if ($metadataDirs) {
            $builder->setMetadataDirs($metadataDirs);
        }

        $this->serializer = $builder
            ->setSerializationVisitor('soap', (new SoapSerializationVisitorFactory())->setSoapVersion(SoapNamespaceInterface::SOAP_1_2))
            ->setDeserializationVisitor('soap', new SoapDeserializationVisitorFactory())
            ->setObjectConstructor(new ClientModelInstantiator($client))
            ->configureHandlers(
                function(HandlerRegistry $registry) {

Expected 1 space after FUNCTION keyword; 0 found

                    $registry->registerSubscribingHandler(new SoapDateHandler());
                }
            )
            ->configureListeners(
                function (EventDispatcher $dispatcher) use ($config) {
                    $dispatcher->addSubscriber(new SoapExceptionEventSubscriber());
                    $dispatcher->addSubscriber(new SoapDateTimeSanitizerEventSubscriber());
                    $dispatcher->addSubscriber(new SoapMessageEventSubscriber());
                    $dispatcher->addSubscriber(new SoapHeaderEventSubscriber($this->getSoapHeader($config)));
                    $dispatcher->addSubscriber(new SoapAddressingEventSubscriber());
                    $dispatcher->addSubscriber(new AddIdentificationUriEventSubscriber($config->documentUri));
                }
            )
            ->build();
    }

    /**
     * Serialize client request.
     *
     * @param Request $data

Missing parameter comment

Expected 19 spaces after parameter type; 1 found

     * @param string $format

Missing parameter comment

Expected 20 spaces after parameter type; 1 found

     * @param SerializationContext|null $context

Missing parameter comment

     * @param string|null $type

Missing parameter comment

Expected 15 spaces after parameter type; 1 found

     *
     * @return string
     * @throws Exception
     */
    public function serialize($data, string $format, ?SerializationContext $context = null, ?string $type = null): string
    {
        return $this->serializer->serialize($data, $format, $context, $type);
    }

    /**
     * Deserialize client response.
     *
     * @param string $data

Missing parameter comment

Expected 22 spaces after parameter type; 1 found

     * @param string $type

Missing parameter comment

Expected 22 spaces after parameter type; 1 found

     * @param string $format

Missing parameter comment

Expected 22 spaces after parameter type; 1 found

     * @param DeserializationContext|null $context

Missing parameter comment

     *
     * @return Response
     * @throws Exception
     */
    public function deserialize(string $data, string $type, string $format, ?DeserializationContext $context = null): Response
    {
        return $this->serializer->deserialize($data, $type, $format, $context);
    }

    /**
     * Get SOAP security header.
     *
     * @param Config $config

Missing parameter comment

     *
     * @return SoapHeaderInterface
     */
    protected function getSoapHeader(Config $config): SoapHeaderInterface
    {
        $header = new Authorization\Security();
        $header->mustUnderstand = 1;
        $header->usernameToken = new Authorization\UsernameToken();
        $header->usernameToken->username = new Authorization\Username($config->user);
        $header->usernameToken->password = new Authorization\Password(
            $config->password,
            'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText'
        );

        return $header;
    }
}