Clientbase
/
wellrested
mirror of https://github.com/basemaster/wellrested.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update phpdoc for Client

This commit is contained in:
PJ Dietz 2014-07-26 11:59:46 -04:00
parent 4db7c8da7d
commit 60eaabadd5
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/pjdietz/WellRESTed/Client.php
View File

@ -22,6 +22,14 @@ class Client
/** @var array cURL options */ /** @var array cURL options */
private $curlOpts; private $curlOpts;
/**
* Create a new client.
*
* You may optionally provide an array of cURL options to use by default.
* Options passed in the requset method will override these.
*
* @param array $curlOpts Optional array of cURL options
*/
public function __construct(array $curlOpts = null) { public function __construct(array $curlOpts = null) {
if (is_array($curlOpts)) { if (is_array($curlOpts)) {
$this->curlOpts = $curlOpts; $this->curlOpts = $curlOpts;
@ -34,7 +42,7 @@ class Client
* Make an HTTP request and return a Response. * Make an HTTP request and return a Response.
* *
* @param RequestInterface $rqst * @param RequestInterface $rqst
* @param array $curlOpts Option array of cURL options * @param array $curlOpts Optional array of cURL options
* @throws \pjdietz\WellRESTed\Exceptions\CurlException * @throws \pjdietz\WellRESTed\Exceptions\CurlException
* @return ResponseInterface * @return ResponseInterface
*/ */