Code Coverage for /home/travis/build/in6pio/Incipio/src/FrontBundle/Client/ClientInterface.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\Client;
13
14	use FrontBundle\Client\Exception\ClientException;
15	use Psr\Http\Message\RequestInterface;
16	use Psr\Http\Message\ResponseInterface;
17
18	/**
19	* @author Théo FIDRY <theo.fidry@gmail.com>
20	*/
21	interface ClientInterface
22	{
23	/**
24	* Creates and return a new {@see Request} object. All get, head, etc. methods are generated via this method.
25	*
26	* @example
27	* If URL is empty, only the base URL will be used:
28	* ::createRequest('GET')
29	* => http://localhost
30	*
31	* If URI is used, add the base URL to generate the proper URL to request
32	* ::createRequest('GET', '/api/users')
33	* => http://localhost/api/users
34	*
35	* If route name is used, will first generate the URI before applying the base URL; can use parameters
36	* ::createRequest('GET', 'users_cget')
37	* => http://localhost/api/users
38	*
39	* ::createRequest('GET', 'users_get', null, ['parameters' => ['id' => 14]])
40	* => http://localhost/api/users/14
41	*
42	* Can also apply other options
43	* ::createRequest('GET', null, null, ['query' => ['id' => 14, 'filter' => ['order' => ['startAt' => 'desc']]])
44	* => http://localhost/api?id=14&filter[where][name]=john
45	*
46	* Or if you have just one query
47	* ::createRequest('GET', null, null, ['query' => 'filter[where][name]=john')
48	* => http://localhost/api?filter[where][name]=john
49	*
50	* @param string $method HTTP method.
51	* @param string\|null $url URL, URL, URI or route name.
52	* @param string\|null $token API token.
53	* @param array $options Array of request options to apply. can have the keys:
54	* - headers: array
55	* - parameters (route parameters if $url is a route and not an URI)
56	* - body: string\|null
57	*
58	* @return RequestInterface
59	*/
60	public function createRequest($method, $url = null, $token = null, array $options = []);
61
62	/**
63	* Sends a request.
64	*
65	* @param string $method HTTP method
66	* @param string\|null $url URL, URI or route name.
67	* @param string\|null $token API token.
68	* @param array $options Options applied to the request.
69	*
70	* @return ResponseInterface
71	*
72	* @throws ClientException
73	*/
74	public function request($method, $url = null, $token = null, $options = []);
75
76	/**
77	* Sends a single request.
78	*
79	* @param RequestInterface $request Request to send
80	*
81	* @return ResponseInterface
82	*
83	* @throws ClientException
84	*/
85	public function send(RequestInterface $request);
86	}