Skip to content

Commit

Permalink
Fixed inline docs for Interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelJ2324 committed Mar 15, 2017
1 parent 675ac6b commit c83d4ef
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
28 changes: 14 additions & 14 deletions src/Request/RequestInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ interface RequestInterface
/**
* Set the HTTP Method the Request object will use
* @param string $type
* @return $this
* @return self
*/
public function setMethod($type);

Expand All @@ -20,7 +20,7 @@ public function getMethod();
/**
* Set the Body to Request
* @param mixed
* @return $this
* @return self
*/
public function setBody($array);

Expand All @@ -34,15 +34,15 @@ public function getBody();
* Add a File to the Request for Upload
* @param $bodyKey
* @param $fullFilePath
* @return $this
* @return self
*/
public function addFile($bodyKey,$fullFilePath);

/**
* Add a Header to the Request Headers property
* @param string - Header Name
* @param string - Header Value
* @return $this
* @return self
*/
public function addHeader($name, $value);

Expand All @@ -56,14 +56,14 @@ public function addHeaders(array $headers);
/**
* Sets the Headers property on the Request object
* @param array $headers
* @return $this
* @return self
*/
public function setHeaders(array $headers);

/**
* Remove a Header from the Request Object
* @param $name
* @return $this
* @return self
*/
public function removeHeader($name);

Expand All @@ -77,21 +77,21 @@ public function getHeaders();
* Add a cURL Option to the Request
* @param $option
* @param $value
* @return $this
* @return self
*/
public function addOption($option,$value);

/**
* Append multiple cURL Options to the Request
* @param array $options
* @return $this
* @return self
*/
public function addOptions(array $options);

/**
* Set the cURL Options on the Request
* @param array $options
* @return $this
* @return self
*/
public function setOptions(array $options);

Expand All @@ -104,14 +104,14 @@ public function getOptions();
/**
* Remove a cURL Option from the Request
* @param $name string
* @return $this
* @return self
*/
public function removeOption($name);

/**
* Set the URL on the Request Object
* @param string $url
* @return $this
* @return self
*/
public function setURL($url);

Expand All @@ -123,7 +123,7 @@ public function getURL();

/**
* Execute the Curl Request. Before sending, Headers are added to the Curl Object
* @return $this
* @return self
*/
public function send();

Expand All @@ -141,13 +141,13 @@ public function getResponse();

/**
* Close the cURL Resource
* @return $this
* @return self
*/
public function close();

/**
* Close and Restart the cURL Resource
* @return $this
* @return self
*/
public function reset();

Expand Down
10 changes: 5 additions & 5 deletions src/Response/ResponseInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ interface ResponseInterface
/**
* Set the Request Object that the Response is extracted from
* @param RequestInterface $Request
* @return mixed
* @return self
*/
public function setRequest(RequestInterface $Request);

/**
* Get the current configured Request Object
* @return mixed
* @return RequestInterface
*/
public function getRequest();

/**
* Extract the Response information from the Request Object
* @return mixed
* @return bool
*/
public function extract();

Expand All @@ -33,13 +33,13 @@ public function getStatus();

/**
* Get the Response Body
* @return string
* @return mixed
*/
public function getBody();

/**
* Get the Response Headers
* @return string
* @return mixed
*/
public function getHeaders();

Expand Down

0 comments on commit c83d4ef

Please sign in to comment.