CTP SDK : File Core/Request/ClientRequestInterface.php

 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 * @created: 21.01.15, 11:38
 */

namespace Commercetools\Core\Request;

use Commercetools\Core\Model\MapperInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Response\ApiResponseInterface;

/**
 * Interface ClientRequestInterface
 * @package Commercetools\Core\Http
 */
interface ClientRequestInterface
{
    /**
     * @return string
     */
    public function getIdentifier();

    /**
     * @param string $identifier
     * @return $this
     */
    public function setIdentifier($identifier);

    /**
     * @return RequestInterface
     * @internal
     */
    public function httpRequest();

    /**
     * @param ResponseInterface $response
     * @return ApiResponseInterface
     * @internal
     */
    public function buildResponse(ResponseInterface $response);

    /**
     * @param array $result
     * @param Context $context
     * @return mixed
     */
    public function mapResult(array $result, Context $context = null);

    /**
     * @param ApiResponseInterface $response
     * @return mixed
     */
    public function mapResponse(ApiResponseInterface $response);

    /**
     * @param array $data
     * @param Context $context
     * @param MapperInterface $mapper
     * @return mixed
     */
    public function map(array $data, Context $context = null, MapperInterface $mapper = null);

    /**
     * @param ApiResponseInterface|ResponseInterface $response
     * @param MapperInterface $mapper
     * @return mixed
     */
    public function mapFromResponse($response, MapperInterface $mapper = null);
}

Namespaces

Classes

Interfaces

Traits