dmt-software / insolvency-client

src/Http/GetReportHandler.php

<?php

Missing file doc comment

namespace DMT\Insolvency\Http;

use DMT\Http\Client\RequestHandler;
use DMT\Insolvency\Config;
use DMT\Insolvency\Http\Request\GetReport;
use DMT\Insolvency\Http\Response\GetReportResponse;
use DMT\Insolvency\Http\Response\GetReportResult;
use DMT\Insolvency\Model\Document;
use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Psr7\Request as HttpRequest;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Message\RequestFactoryInterface;

/**
 * Class GetReportHandler
 */

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 GetReportHandler
{
    private Config $config;

Private member variable "config" must be prefixed with an underscore

    private RequestHandler $requestHandler;

Private member variable "requestHandler" must be prefixed with an underscore

    protected RequestFactoryInterface $requestFactory;

    /**

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

     * GetReportHandler constructor.
     *
     * @param RequestHandler $requestHandler

Missing parameter comment

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

     * @param Config $config

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

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

     */
    public function __construct(
        Config $config,
        RequestHandler $requestHandler,
        RequestFactoryInterface $requestFactory
    ) {
        $this->config = $config;
        $this->requestHandler = $requestHandler;
        $this->requestFactory = $requestFactory;
    }

    /**
     * Handle http request.
     *
     * @param GetReport $request

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

Missing parameter comment

     * @return GetReportResponse

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

     * @throws ClientExceptionInterface

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

     */
    public function handle(GetReport $request): GetReportResponse
    {
        $request = new HttpRequest('GET', $this->config->documentUri . $request->reportId, []);

        $httpResponse = $this->requestHandler->handle($request);

        $response = new GetReportResponse();
        $response->result = new GetReportResult();
        $response->result->report = new Document();
        $response->result->report->mime = $httpResponse->getHeaderLine('Content-Type');
        $response->result->report->document = base64_encode($httpResponse->getBody()->getContents());

        return $response;
    }
}