DMT\Insolvency\Client

Complexity

Total Complexity

20

Size/Duplication

Total Lines	287
Duplicated Lines	0 %

Test Coverage

Coverage

83.95%

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	searchReportsSince()	0	9	1
A	getLastUpdate()	0	3	1
A	getCaseWithReports()	0	6	1
A	searchInsolvencyId()	0	7	1
A	searchRemovedSince()	0	6	1
A	getHttpClient()	0	12	3
A	searchNaturalPerson()	0	15	1
A	getCase()	0	6	1
A	__construct()	0	13	1
A	searchModifiedSince()	0	6	1
A	getReport()	0	6	1
A	searchByDate()	0	8	1
A	searchUndertaking()	0	13	1
A	process()	0	7	3
A	getHandler()	0	7	2

<?php

Missing file doc comment

namespace DMT\Insolvency;

use DMT\CommandBus\Validator\ValidationMiddleware;
use DMT\Insolvency\Exception\Exception;
use DMT\Insolvency\Exception\ExceptionMiddleware;
use DMT\Insolvency\Http\GetReportHandler;
use DMT\Insolvency\Http\Middleware\ExceptionMiddleware as HttpExceptionMiddleware;
use DMT\Insolvency\Http\Middleware\SoapActionMiddleware;
use DMT\Insolvency\Http\Request\GetReport;
use DMT\Insolvency\Http\Response\GetReportResponse;
use DMT\Insolvency\Soap\Handler as SoapHandler;
use DMT\Insolvency\Soap\Request;
use DMT\Insolvency\Soap\Request as SoapRequest;
use DMT\Insolvency\Soap\Response;
use DMT\Insolvency\Soap\Serializer\SoapSerializer;
use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Handler\CurlHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use JMS\Serializer\SerializerInterface;
use League\Tactician\CommandBus;
use League\Tactician\Handler\CommandHandlerMiddleware;
use League\Tactician\Handler\CommandNameExtractor\ClassNameExtractor;
use League\Tactician\Handler\Locator\CallableLocator;
use League\Tactician\Handler\MethodNameInflector\HandleInflector;
use League\Tactician\Plugins\LockingMiddleware;

/**
 * Class Client
 */

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 Client
{
    /** @var Config $config */

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

    /** @var SerializerInterface|null $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;

    /** @var CommandBus $commandBus */

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

    /**
     * Client constructor.
     *
     * @param Config $config

Missing parameter comment

Expected 19 spaces after parameter type; 1 found

     * @param SerializerInterface|null $serializer

Missing parameter comment

     */
    public function __construct(Config $config, SerializerInterface $serializer = null)
    {
        $this->config = $config;
        $this->serializer = $serializer ?? new SoapSerializer($this, $config);

        $this->commandBus = new CommandBus([

The opening parenthesis of a multi-line function call should be the last content on the line.

            new LockingMiddleware(),
            new ExceptionMiddleware(),
            new ValidationMiddleware(),
            new CommandHandlerMiddleware(
                new ClassNameExtractor(),
                new CallableLocator([$this, 'getHandler']),
                new HandleInflector()
            )
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Search for publications of a specific insolvency.
     *
     * @param string $insolvencyID the insolvency identification.

Expected 6 spaces after parameter type; 1 found

     * @param string|null $court the count (number) where the insolvency is registered.

Expected 8 spaces after parameter name; 1 found

     *
     * @return Response|Response\SearchInsolvencyIDResponse
     * @throws Exception
     */
    public function searchInsolvencyId(string $insolvencyID, string $court = null): Response\SearchInsolvencyIDResponse
    {
        $request = new Request\SearchInsolvencyID();
        $request->insolvencyID = $insolvencyID;
        $request->court = $court;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\SearchInsolvencyIDResponse.

    }

    /**
     * Search for publications for a person.
     *
     * @param \DateTime|null $dateOfBirth the date of birth of the person.
     * @param string|null $prefix the surname prefix.

Expected 4 spaces after parameter type; 1 found

Expected 6 spaces after parameter name; 1 found

     * @param string|null $surname the surname of the person.

Expected 4 spaces after parameter type; 1 found

Expected 5 spaces after parameter name; 1 found

     * @param int|null $houseNumber the house number of the person's address.

Expected 7 spaces after parameter type; 1 found

     * @param string|null $postalCode the postcode of the person's address.

Expected 4 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 1 found

     *
     * @return Response|Response\SearchNaturalPersonResponse
     * @throws Exception
     */
    public function searchNaturalPerson(
        \DateTime $dateOfBirth = null,
        string $prefix = null,
        string $surname = null,
        int $houseNumber = null,
        string $postalCode = null
    ): Response\SearchNaturalPersonResponse {
        $request = new Request\SearchNaturalPerson();
        $request->dateOfBirth = $dateOfBirth;
        $request->prefix = $prefix;
        $request->surname = $surname;
        $request->houseNumber = $houseNumber;
        $request->postalCode = $postalCode;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\SearchNaturalPersonResponse.

    }

    /**
     * Search for publications of an undertaking.
     *
     * @param string|null $name the name of the undertaking.

Expected 17 spaces after parameter name; 1 found

     * @param string|null $commercialRegisterID the chamber of commerce number.
     * @param string|null $postalCode the postcode of the undertaking's address.

Expected 11 spaces after parameter name; 1 found

     * @param int|null $houseNumber the house number of the undertaking' address.

Expected 4 spaces after parameter type; 1 found

Expected 10 spaces after parameter name; 1 found

     *
     * @return Response|Response\SearchUndertakingResponse
     * @throws Exception
     */
    public function searchUndertaking(
        string $name = null,
        string $commercialRegisterID = null,
        string $postalCode = null,
        int $houseNumber = null
    ): Response\SearchUndertakingResponse {
        $request = new Request\SearchUndertaking();
        $request->name = $name;
        $request->commercialRegisterID = $commercialRegisterID;
        $request->postalCode = $postalCode;
        $request->houseNumber = $houseNumber;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\SearchUndertakingResponse.

    }

    /**
     * Get insolvency case.
     *
     * @param string $publicationNumber the publication number of the case.
     *
     * @return Response|Response\GetCaseResponse
     * @throws Exception
     */
    public function getCase(string $publicationNumber): Response\GetCaseResponse
    {
        $request = new Request\GetCase();
        $request->publicationNumber = $publicationNumber;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\GetCaseResponse.

    }

    /**
     * Get insolvency case with references to its reports.
     *
     * @param string $publicationNumber the publication number of the case.
     *
     * @return Response|Response\GetCaseWithReportsResponse
     * @throws Exception
     */
    public function getCaseWithReports(string $publicationNumber): Response\GetCaseWithReportsResponse
    {
        $request = new Request\GetCaseWithReports();
        $request->publicationNumber = $publicationNumber;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\GetCaseWithReportsResponse.

    }

    /**
     * Get a report for an insolvency.
     *
     * @param string $reportId the report identification number.
     *
     * @return GetReportResponse
     * @throws Exception
     */
    public function getReport(string $reportId): GetReportResponse
    {
        $request = new GetReport();
        $request->reportId = $reportId;

        return $this->process($request);

The expression return $this->process($request) could return the type DMT\Insolvency\Soap\Response which is incompatible with the type-hinted return DMT\Insolvency\Http\Response\GetReportResponse. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get the date when the latest publication is added.
     *
     * @return Response|Response\GetLastUpdateResponse
     * @throws Exception
     */
    public function getLastUpdate(): Response\GetLastUpdateResponse
    {
        return $this->process(new Request\GetLastUpdate());

The expression return $this->process(new DMT\Insolvency\Soap\Request\GetLastUpdate()) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\GetLastUpdateResponse.

    }

    /**
     * Search for publications of a specific date.
     *
     * @param \DateTime $date tne date of the publications to look up.

Expected 3 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     * @param string $court the court (number) where the publications are registered.

Expected 6 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 1 found

     * @param string|null $pubType the type of publication.
     *
     * @return Response|Response\SearchByDateResponse
     * @throws Exception
     */
    public function searchByDate(\DateTime $date, string $court, string $pubType = null): Response\SearchByDateResponse
    {
        $request = new Request\SearchByDate();
        $request->date = $date;
        $request->court = $court;
        $request->pubType = $pubType;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\SearchByDateResponse.

    }

    /**
     * Search for publications of the last mutated/added insolvencies for data replication.
     *
     * @param \DateTime $modifyDate the modified date since.
     *
     * @return Response|Response\SearchModifiedSinceResponse
     * @throws Exception
     */
    public function searchModifiedSince(\DateTime $modifyDate): Response\SearchModifiedSinceResponse
    {
        $request = new Request\SearchModifiedSince();
        $request->modifyDate = $modifyDate;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\SearchModifiedSinceResponse.

    }

    /**
     * Search for removed publications for data replication.
     *
     * @param \DateTime $modifyDate the modified date since.
     *
     * @return Response|Response\SearchRemovedSinceResponse
     * @throws Exception
     */
    public function searchRemovedSince(\DateTime $modifyDate): Response\SearchRemovedSinceResponse
    {
        $request = new Request\SearchRemovedSince();
        $request->modifyDate = $modifyDate;

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\SearchRemovedSinceResponse.

    }

    /**
     * Search for added and modified reposts in a given time period.
     *
     * @param \DateTime $datetimeFrom the start date.

Expected 6 spaces after parameter type; 1 found

     * @param \DateTime|null $datetimeTo the end date.

Expected 3 spaces after parameter name; 1 found

     *
     * @return Response|Response\SearchReportsSinceResponse
     * @throws Exception
     */
    public function searchReportsSince(
        \DateTime $datetimeFrom,
        \DateTime $datetimeTo = null
    ): Response\SearchReportsSinceResponse {
        $request = new Request\SearchReportsSince();
        $request->datetimeFrom = $datetimeFrom;
        $request->datetimeTo = $datetimeTo ?? new \DateTime();

        return $this->process($request);

The expression return $this->process($request) returns the type DMT\Insolvency\Http\Response\GetReportResponse which is incompatible with the type-hinted return DMT\Insolvency\Soap\Response\SearchReportsSinceResponse.

    }

    /**

Missing short description in doc comment

     * @param string $request

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 4 spaces but found 1

     * @return SoapHandler|object

Tag @return cannot be grouped with parameter tags in a doc comment

Tag value for @return tag indented incorrectly; expected 3 spaces but found 1

     * @internal

Tag @internal cannot be grouped with parameter tags in a doc comment

     */
    public function getHandler(string $request)
    {
        if (is_a($request, SoapRequest::class, true)) {
            return new SoapHandler($this->getHttpClient(), $this->serializer);

It seems like $this->serializer can also be of type null; however, parameter $serializer of DMT\Insolvency\Soap\Handler::__construct() does only seem to accept JMS\Serializer\SerializerInterface, maybe add an additional type check?

        }

        return new GetReportHandler($this->getHttpClient(false));
    }

    /**
     * Process a request.
     *
     * @param Request|GetReport $request

Missing parameter comment

     *
     * @return Response|GetReportResponse
     * @throws Exception
     */
    protected function process($request)
    {
        if (!$request instanceof Request && !$request instanceof GetReport) {

$request is always a sub-type of DMT\Insolvency\Http\Request\GetReport.

            throw new \TypeError('Invalid request');
        }

        return $this->commandBus->handle($request);
    }

    /**
     * Get http client.
     *
     * @param bool $forSoap

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return HttpClient

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function getHttpClient(bool $forSoap = true): HttpClient
    {
        $stack = HandlerStack::create(new CurlHandler());
        $stack->push(Middleware::mapResponse(new HttpExceptionMiddleware()));

        if ($forSoap) {
            $stack->push(Middleware::mapRequest(new SoapActionMiddleware()));
        }

        return new HttpClient([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'base_uri' => $forSoap ? $this->config->endPoint : $this->config->documentUri,
            'handler' => $stack,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }
}