Code Coverage for /home/travis/build/in6pio/Incipio/src/FrontBundle/Controller/ApiControllerInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/*
4	* This file is part of the Incipio package.
5	*
6	* (c) Théo FIDRY <theo.fidry@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	namespace FrontBundle\Controller;
13
14	use GuzzleHttp\Exception\RequestException;
15	use GuzzleHttp\Exception\TransferException;
16	use Psr\Http\Message\RequestInterface;
17	use Symfony\Component\HttpFoundation\Request;
18	use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
19	use Symfony\Component\Serializer\Exception\UnexpectedValueException;
20
21	/**
22	* Interface registering all controller methods that should be refactoring into a base controller to provide helpers
23	* and avoid duplicating code and that are specific to this application, i.e. methods that are not in {@see
24	* Symfony\Bundle\FrameworkBundle\Controller\Controller} or which differs from it.
25	*
26	* @author Théo FIDRY <theo.fidry@gmail.com>
27	*/
28	interface ApiControllerInterface
29	{
30	/**
31	* Generates a URL from the given parameters.
32	*
33	* If the `id` key of parameters passed has an URI as a value, its ID is automatically extracted from it. This is
34	* done my assuming that the ID is the last member of the URI and that and URI begins by `/`.
35	*
36	* @param string $route The name of the route
37	* @param array $parameters An array of parameters
38	* @param bool\|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
39	*
40	* @return string The generated URL
41	*
42	* @see UrlGeneratorInterface
43	*/
44	public function generateUrl($route, $parameters = [], $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH);
45
46	/**
47	* Decodes a JSON string into PHP data.
48	*
49	* @param string $data Data to decode
50	* @param array $context options that decoders have access to.
51	*
52	* @return array
53	*
54	* @throws UnexpectedValueException
55	*/
56	public function decode($data, array $context = []);
57
58	/**
59	* Send a GET request for the client and decode its response body.
60	*
61	* @see FrontBundle\Client\ApiClientInterface::createRequest()
62	*
63	* @param string $method HTTP method
64	* @param string\|null $url URL, URI or route name.
65	* @param Request\|RequestInterface\|string\|null $token API token. If request, will look into the session
66	* for the API token.
67	* @param array $options Options applied to the request.
68	*
69	* @return RequestInterface
70	*/
71	public function createRequest($method, $url = null, $token = null, $options = []);
72
73	/**
74	* Send a GET request for the client and decode its response body.
75	*
76	* @see FrontBundle\Client\ApiClientInterface::request()
77	* @see $this::decode
78	*
79	* @param string $method HTTP method
80	* @param string\|null $url URL, URI or route name.
81	* @param Request\|RequestInterface\|string\|null $token API token. If request, will look into the session
82	* for the API token.
83	* @param array $options Options applied to the request.
84	* @param bool $wholeCollection If set to true, will consider the response is a
85	* paginated collection and will go through all pages
86	* to return the complete list of entities. This
87	* parameters is ignored if the response is not a
88	* collection.
89	*
90	* @return array
91	*
92	* @throws \LogicException When the handler does not populate a response
93	* @throws RequestException When an error is encountered
94	*/
95	public function requestAndDecode($method, $url = null, $token = null, $options = [], $wholeCollection = false);
96
97	/**
98	* Sends a single request and decode its response body.
99	*
100	* @see FrontBundle\Client\ApiClientInterface::send()
101	* @see $this::decode
102	*
103	* @param RequestInterface $request Request to send
104	* @param bool $wholeCollection If set to true, will consider the response is a paginated
105	* collection and will go through all pages to return the complete list of
106	* entities. This parameters is ignored if the response is not a
107	* collection.
108	*
109	* @return array
110	*
111	* @throws \LogicException When the handler does not populate a response
112	* @throws RequestException When an error is encountered
113	* @throws UnexpectedValueException
114	*/
115	public function sendAndDecode(RequestInterface $request, $wholeCollection = false);
116
117	/**
118	* Handle Guzzle exceptions. Assumes the exception was thrown while sending a request to the API. For more
119	* information regarding Guzzle exceptions, refer to {@link * http://guzzle.readthedocs.org/en/latest/quickstart.html#exceptions}.
120	*
121	* @param TransferException $exception
122	*/
123	public function handleGuzzleException(TransferException $exception);
124	}