Sf4 / Api

src/Response/ResponseInterface.php

<?php
/**
 * Created by PhpStorm.
 * User: siim
 * Date: 17.01.19
 * Time: 8:05
 */

namespace Sf4\Api\Response;

use Sf4\Api\Dto\DtoInterface;
use Sf4\Api\Dto\Traits\DtoTraitInterface;
use Sf4\Api\Request\RequestTraitInterface;
use Sf4\Api\RequestHandler\RequestHandlerInterface;
use Sf4\Api\Utils\Traits\TranslatorTraitInterface;
use Symfony\Component\HttpFoundation\JsonResponse;

interface ResponseInterface extends DtoTraitInterface, RequestTraitInterface, TranslatorTraitInterface
{
    public const HEADERS = [
        'accept' => 'application/json',
        'Content-Type' => 'application/json'
    ];

    /**
     * @return JsonResponse
     */
    public function getJsonResponse(): JsonResponse;

    /**
     * @return DtoInterface
     */
    public function getResponseDto(): DtoInterface;

    /**
     * @param DtoInterface $data
     */
    public function setResponseDto(DtoInterface $data): void;

    /**
     * @return int
     */
    public function getResponseStatus(): int;

    /**
     * @param int $status
     */
    public function setResponseStatus($status): void;

    /**
     * @return array
     */
    public function getResponseHeaders(): array;

    /**
     * @param array $headers
     */
    public function setResponseHeaders(array $headers): void;

    public function init();

    /**
     * @param $id
     * @param array $parameters
     * @param null $domain

Are you sure the doc-type for parameter $domain is correct as it would always require null to be passed?

     * @param null $locale

Are you sure the doc-type for parameter $locale is correct as it would always require null to be passed?

     * @return string
     */
    public function translate($id, array $parameters = array(), $domain = null, $locale = null): string;

    /**
     * @param JsonResponse $jsonResponse
     */
    public function setJsonResponse(JsonResponse $jsonResponse);

    /**
     * @return RequestHandlerInterface|null
     */
    public function getRequestHandler(): ?RequestHandlerInterface;
}