dmt-software / webservices-client

src/Factory/AbstractClientBuilder.php

<?php

namespace DMT\WebservicesNl\Client\Factory;

use DMT\CommandBus\Validator\ValidationMiddleware;
use DMT\WebservicesNl\Client\Client;
use DMT\WebservicesNl\Client\Command\Handler\Locator\CommandHandlerResolver;
use DMT\WebservicesNl\Client\Command\Handler\MethodNameInflector\ClassNameWithoutSuffixInflector;
use DMT\WebservicesNl\Client\Command\Middleware\ExceptionMiddleware;
use Doctrine\Common\Annotations\AnnotationException;
use Doctrine\Common\Annotations\AnnotationRegistry;
use JMS\Serializer\Naming\CamelCaseNamingStrategy;
use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
use JMS\Serializer\Naming\SerializedNameAnnotationStrategy;
use League\Tactician\CommandBus;
use League\Tactician\Handler\CommandHandlerMiddleware;
use League\Tactician\Handler\CommandNameExtractor\ClassNameExtractor;
use League\Tactician\Handler\Locator\CallableLocator;
use League\Tactician\Plugins\LockingMiddleware;

/**
 * Class AbstractClientBuilder
 *
 * @package DMT\WebservicesNl\Client
 */
abstract class AbstractClientBuilder
{
    /**
     * @var string
     */
    protected $endpoint;

    /**
     * @var PropertyNamingStrategyInterface
     */
    protected $namingStrategy;

    /**
     * @var string
     */
    protected $serializerFormat;

    /**
     * ClientBuilder constructor.
     * @param string|null $serializerFormat
     */
    final public function __construct(string $serializerFormat = null)
    {
        AnnotationRegistry::registerUniqueLoader('class_exists');

The function Doctrine\Common\Annotations\AnnotationRegistry::registerUniqueLoader() has been deprecated: this method is deprecated and will be removed in doctrine/annotations 2.0

        $this->namingStrategy = new SerializedNameAnnotationStrategy(new CamelCaseNamingStrategy());
        $this->serializerFormat = $serializerFormat;
    }

    /**
     * @param string|null $serializerFormat
     * @return AbstractClientBuilder
     */
    public static function create(string $serializerFormat = null): self
    {
        return new static($serializerFormat);
    }

    /**
     * Build the webservices client.
     *
     * @return Client
     * @throws AnnotationException
     */
    public function build(): Client
    {
        return new Client(
            new CommandBus(
                [
                    new LockingMiddleware(),
                    new ExceptionMiddleware(),
                    new ValidationMiddleware(),
                    new CommandHandlerMiddleware(
                        new ClassNameExtractor(),
                        new CallableLocator($this->getCommandResolver()),
                        new ClassNameWithoutSuffixInflector('Request')
                    )
                ]
            )
        );
    }

    /**
     * Set endpoint for SOAP service.
     *
     * @param string $endpoint
     *
     * @return AbstractClientBuilder
     */
    public function setServiceEndpoint(string $endpoint): AbstractClientBuilder
    {
        if (!filter_var($endpoint, FILTER_VALIDATE_URL) || parse_url($endpoint, PHP_URL_SCHEME) !== 'https') {
            throw new \InvalidArgumentException('Incorrect endpoint given');
        }

        $this->endpoint = $endpoint;

        return $this;
    }

    /**
     * Set the authentication.
     *
     * @param array $credentials
     *
     * @return AbstractClientBuilder
     * @throws \InvalidArgumentException
     */
    abstract public function setAuthentication(array $credentials): AbstractClientBuilder;

    /**
     * Get a configured command resolver for the requested endpoint.
     *
     * @return CommandHandlerResolver
     */
    abstract protected function getCommandResolver(): CommandHandlerResolver;
}