forked from KnpLabs/php-github-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGithub.HttpClient.HttpClient.html
More file actions
373 lines (373 loc) · 17.6 KB
/
Github.HttpClient.HttpClient.html
File metadata and controls
373 lines (373 loc) · 17.6 KB
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \Github\HttpClient\HttpClient</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/Github.html"><i class="icon-th"></i> Github</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
<span class="label label-info">68</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Instantiated a new http client"><span class="description">Instantiated a new http client</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#delete" title="delete :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>delete()</pre></a></li>
<li class="method public "><a href="#get" title="get :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>get()</pre></a></li>
<li class="method public "><a href="#patch" title="patch :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>patch()</pre></a></li>
<li class="method public "><a href="#post" title="post :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>post()</pre></a></li>
<li class="method public "><a href="#put" title="put :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>put()</pre></a></li>
<li class="method public "><a href="#request" title="request :: Send a request to the server, receive a response,
decode the response and returns an associative array"><span class="description">Send a request to the server, receive a response,
decode the response and returns an associative array</span><pre>request()</pre></a></li>
<li class="method public "><a href="#setHeaders" title="setHeaders :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>setHeaders()</pre></a></li>
<li class="method public "><a href="#setOption" title="setOption :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>setOption()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><a href="#checkApiLimit" title="checkApiLimit :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>checkApiLimit()</pre></a></li>
<li class="method protected "><a href="#decodeResponse" title="decodeResponse :: {@inheritDoc}"><span class="description">{@inheritDoc}</span><pre>decodeResponse()</pre></a></li>
<li class="method protected "><a href="#doRequest" title="doRequest :: Send a request to the server, receive a response"><span class="description">Send a request to the server, receive a response</span><pre>doRequest()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public "><a href="#%24remainingCalls" title="$remainingCalls :: "><span class="description">$remainingCalls</span><pre>$remainingCalls</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24browser" title="$browser :: "><span class="description">$browser</span><pre>$browser</pre></a></li>
<li class="property protected "><a href="#%24headers" title="$headers :: "><span class="description">$headers</span><pre>$headers</pre></a></li>
<li class="property protected "><a href="#%24history" title="$history :: "><span class="description">$history</span><pre>$history</pre></a></li>
<li class="property protected "><a href="#%24options" title="$options :: The http client options"><span class="description">The http client options</span><pre>$options</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CGithub%5CHttpClient%5CHttpClient" id="\Github\HttpClient\HttpClient"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/Github.html">Github</a></li>
<span class="divider">\</span><li><a href="../namespaces/Github.HttpClient.html">HttpClient</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/Github.HttpClient.HttpClient.html">HttpClient</a>
</li>
</ul>
<div href="../classes/Github.HttpClient.HttpClient.html" class="element class">
<p class="short_description">Performs requests on GitHub API. API documentation should be self-explanatory.</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="">Thibault Duplessis <thibault.duplessis at gmail dot com></a></td>
</tr>
<tr>
<th>author</th>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Instantiated a new http client</h2>
<pre>__construct(array $options, Buzz\Browser $browser) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><p>Http client options</p></div>
<div class="subelement argument">
<h4>$browser</h4>
<code>null\Browser</code><p>Buzz client</p></div>
</div></div>
</div>
<a name="delete" id="delete"></a><div class="element clickable method public delete" data-toggle="collapse" data-target=".delete .collapse">
<h2>{@inheritDoc}</h2>
<pre>delete($path, array $parameters, array $options) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$parameters</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code></code>
</div>
</div></div>
</div>
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse">
<h2>{@inheritDoc}</h2>
<pre>get($path, array $parameters, array $options) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$parameters</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code></code>
</div>
</div></div>
</div>
<a name="patch" id="patch"></a><div class="element clickable method public patch" data-toggle="collapse" data-target=".patch .collapse">
<h2>{@inheritDoc}</h2>
<pre>patch($path, array $parameters, array $options) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$parameters</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code></code>
</div>
</div></div>
</div>
<a name="post" id="post"></a><div class="element clickable method public post" data-toggle="collapse" data-target=".post .collapse">
<h2>{@inheritDoc}</h2>
<pre>post($path, array $parameters, array $options) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$parameters</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code></code>
</div>
</div></div>
</div>
<a name="put" id="put"></a><div class="element clickable method public put" data-toggle="collapse" data-target=".put .collapse">
<h2>{@inheritDoc}</h2>
<pre>put($path, array $options) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code></code>
</div>
</div></div>
</div>
<a name="request" id="request"></a><div class="element clickable method public request" data-toggle="collapse" data-target=".request .collapse">
<h2>Send a request to the server, receive a response,
decode the response and returns an associative array</h2>
<pre>request(string $path, array $parameters, string $httpMethod, array $options) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code>string</code><p>Request API path</p></div>
<div class="subelement argument">
<h4>$parameters</h4>
<code>array</code><p>Parameters</p></div>
<div class="subelement argument">
<h4>$httpMethod</h4>
<code>string</code><p>HTTP method to use</p></div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><p>Request options</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Data</div>
</div></div>
</div>
<a name="setHeaders" id="setHeaders"></a><div class="element clickable method public setHeaders" data-toggle="collapse" data-target=".setHeaders .collapse">
<h2>{@inheritDoc}</h2>
<pre>setHeaders(array $headers) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$headers</h4>
<code></code>
</div>
</div></div>
</div>
<a name="setOption" id="setOption"></a><div class="element clickable method public setOption" data-toggle="collapse" data-target=".setOption .collapse">
<h2>{@inheritDoc}</h2>
<pre>setOption($name, $value) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$value</h4>
<code></code>
</div>
</div></div>
</div>
<a name="checkApiLimit" id="checkApiLimit"></a><div class="element clickable method protected checkApiLimit" data-toggle="collapse" data-target=".checkApiLimit .collapse">
<h2>{@inheritDoc}</h2>
<pre>checkApiLimit(Buzz\Message\MessageInterface $response) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$response</h4>
<code></code>
</div>
</div></div>
</div>
<a name="decodeResponse" id="decodeResponse"></a><div class="element clickable method protected decodeResponse" data-toggle="collapse" data-target=".decodeResponse .collapse">
<h2>{@inheritDoc}</h2>
<pre>decodeResponse($response) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$response</h4>
<code></code>
</div>
</div></div>
</div>
<a name="doRequest" id="doRequest"></a><div class="element clickable method protected doRequest" data-toggle="collapse" data-target=".doRequest .collapse">
<h2>Send a request to the server, receive a response</h2>
<pre>doRequest(string $url, array $parameters, string $httpMethod, array $options) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$url</h4>
<code>string</code><p>Request url</p></div>
<div class="subelement argument">
<h4>$parameters</h4>
<code>array</code><p>Parameters</p></div>
<div class="subelement argument">
<h4>$httpMethod</h4>
<code>string</code><p>HTTP method to use</p></div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><p>Request options</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>HTTP response</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24remainingCalls" id="$remainingCalls"> </a><div class="element clickable property public $remainingCalls" data-toggle="collapse" data-target=".$remainingCalls .collapse">
<h2>$remainingCalls</h2>
<pre>$remainingCalls : integer</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24browser" id="$browser"> </a><div class="element clickable property protected $browser" data-toggle="collapse" data-target=".$browser .collapse">
<h2>$browser</h2>
<pre>$browser : \Browser</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24headers" id="$headers"> </a><div class="element clickable property protected $headers" data-toggle="collapse" data-target=".$headers .collapse">
<h2>$headers</h2>
<pre>$headers : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24history" id="$history"> </a><div class="element clickable property protected $history" data-toggle="collapse" data-target=".$history .collapse">
<h2>$history</h2>
<pre>$history : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24options" id="$options"> </a><div class="element clickable property protected $options" data-toggle="collapse" data-target=".$options .collapse">
<h2>The http client options</h2>
<pre>$options : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a6</a> and<br>
generated on 2012-07-15T22:43:06+02:00.<br></footer></div>
</div>
</body>
</html>