1	<?php
2
3	/**
4	* VuFind HTTP service interface definition.
5	*
6	* PHP version 7
7	*
8	* Copyright (C) Villanova University 2010.
9	*
10	* This program is free software; you can redistribute it and/or modify
11	* it under the terms of the GNU General Public License version 2,
12	* as published by the Free Software Foundation.
13	*
14	* This program is distributed in the hope that it will be useful,
15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17	* GNU General Public License for more details.
18	*
19	* You should have received a copy of the GNU General Public License
20	* along with this program; if not, write to the Free Software
21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22	*
23	* @category VuFind
24	* @package  Http
25	* @author   David Maus <maus@hab.de>
26	* @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27	* @link     https://vufind.org/wiki/development
28	*/
29	namespace VuFindHttp;
30
31	/**
32	* VuFind HTTP service interface definition.
33	*
34	* @category VuFind
35	* @package  Http
36	* @author   David Maus <maus@hab.de>
37	* @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
38	* @link     https://vufind.org/wiki/development
39	*/
40	interface HttpServiceInterface
41	{
42	/**
43	* Proxify an existing client.
44	*
45	* Returns the client given as argument with appropriate proxy setup.
46	*
47	* @param \Laminas\Http\Client $client  HTTP client
48	* @param array                $options ZF2 ProxyAdapter options
49	*
50	* @return \Laminas\Http\Client
51	*/
52	public function proxify(\Laminas\Http\Client $client, array $options = []);
53
54	/**
55	* Perform a GET request.
56	*
57	* @param string $url     Request URL
58	* @param array  $params  Request parameters
59	* @param float  $timeout Request timeout in seconds
60	* @param array  $headers Request headers
61	*
62	* @return \Laminas\Http\Response
63	*/
64	public function get($url, array $params = [], $timeout = null,
65	array $headers = []
66	);
67
68	/**
69	* Perform a POST request.
70	*
71	* @param string $url     Request URL
72	* @param mixed  $body    Request body document
73	* @param string $type    Request body content type
74	* @param float  $timeout Request timeout in seconds
75	* @param array  $headers Request http-headers
76	*
77	* @return \Laminas\Http\Response
78	*/
79	public function post($url, $body = null, $type = 'application/octet-stream',
80	$timeout = null, array $headers = []
81	);
82
83	/**
84	* Post form data.
85	*
86	* @param string $url     Request URL
87	* @param array  $params  Form data
88	* @param float  $timeout Request timeout in seconds
89	*
90	* @return \Laminas\Http\Response
91	*/
92	public function postForm($url, array $params = [], $timeout = null);
93
94	/**
95	* Return a new proxy client.
96	*
97	* @param string $url     Target URL
98	* @param string $method  Request method
99	* @param float  $timeout Request timeout in seconds
100	*
101	* @return \Laminas\Http\Client
102	*/
103	public function createClient($url = null,
104	$method = \Laminas\Http\Request::METHOD_GET, $timeout = null
105	);
106	}