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

Add port to Request class. Allow user to supply cURL options. Close #2 

Caller can now supply array of options for use with curl_setopt_array() when calling Request::request()
This commit is contained in:
PJ Dietz 2013-05-26 18:32:26 -04:00
parent 98e04ab63b
commit 8aae07660c
1 changed files with 88 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
src/pjdietz/WellRESTed/Request.php
View File

@ -10,6 +10,7 @@
namespace pjdietz\WellRESTed; namespace pjdietz\WellRESTed;
use pjdietz\WellRESTed\Exceptions\CurlException;
use pjdietz\WellRESTed\Interfaces\RequestInterface; use pjdietz\WellRESTed\Interfaces\RequestInterface;
/** /**
@ -31,8 +32,6 @@ use pjdietz\WellRESTed\Interfaces\RequestInterface;
*/ */
class Request extends Message implements RequestInterface class Request extends Message implements RequestInterface
{ {
// TODO: Include port in the URI
/** /**
* Singleton instance derived from reading info from Apache. * Singleton instance derived from reading info from Apache.
* *
@ -48,6 +47,8 @@ class Request extends Message implements RequestInterface
private $path = '/'; private $path = '/';
/** @var array Array of fragments of the path, delimited by slashes */ /** @var array Array of fragments of the path, delimited by slashes */
private $pathParts; private $pathParts;
/** @var int */
private $port = 80;
/**@var array Associative array of query parameters */ /**@var array Associative array of query parameters */
private $query; private $query;
@ -73,26 +74,6 @@ class Request extends Message implements RequestInterface
// ------------------------------------------------------------------------- // -------------------------------------------------------------------------
// Accessors // Accessors
/**
* Set the URI for the Request. This sets the other members, such as path,
* hostname, etc.
*
* @param string $uri
*/
public function setUri($uri)
{
$parsed = parse_url($uri);
$host = isset($parsed['host']) ? $parsed['host'] : '';
$this->setHostname($host);
$path = isset($parsed['path']) ? $parsed['path'] : '';
$this->setPath($path);
$query = isset($parsed['query']) ? $parsed['query'] : '';
$this->setQuery($query);
}
/** /**
* Return a reference to the singleton instance of the Request derived * Return a reference to the singleton instance of the Request derived
* from the server's information about the request sent to the script. * from the server's information about the request sent to the script.
@ -129,6 +110,51 @@ class Request extends Message implements RequestInterface
$this->hostname = $_SERVER['HTTP_HOST']; $this->hostname = $_SERVER['HTTP_HOST'];
} }
/**
* Return the full URI includeing protocol, hostname, path, and query.
*
* @return array
*/
public function getUri()
{
$uri = strtolower($this->protocol) . '://' . $this->hostname;
if ($this->port !== 80) {
$uri .= ':' . $this->port;
}
$uri .= $this->path;
if ($this->query) {
$uri .= '?' . http_build_query($this->query);
}
return $uri;
}
/**
* Set the URI for the Request. This sets the other members: hostname,
* path, port, and query.
*
* @param string $uri
*/
public function setUri($uri)
{
$parsed = parse_url($uri);
$host = isset($parsed['host']) ? $parsed['host'] : '';
$this->setHostname($host);
$path = isset($parsed['path']) ? $parsed['path'] : '';
$this->setPath($path);
$port = isset($parsed['port']) ? (int)$parsed['port'] : 80;
$this->setPort($port);
$query = isset($parsed['query']) ? $parsed['query'] : '';
$this->setQuery($query);
}
/** /**
* Return the hostname portion of the URI * Return the hostname portion of the URI
* *
@ -218,6 +244,18 @@ class Request extends Message implements RequestInterface
return $this->pathParts; return $this->pathParts;
} }
/** @return int */
public function getPort()
{
return $this->port;
}
/** @param int $port */
public function setPort($port)
{
$this->port = $port;
}
/** /**
* Return an associative array representing the query. * Return an associative array representing the query.
* *
@ -228,8 +266,6 @@ class Request extends Message implements RequestInterface
return $this->query; return $this->query;
} }
// -------------------------------------------------------------------------
/** /**
* Set the query. The value passed can be a query string of key-value pairs * Set the query. The value passed can be a query string of key-value pairs
* joined by ampersands or it can be an associative array. * joined by ampersands or it can be an associative array.
@ -251,67 +287,55 @@ class Request extends Message implements RequestInterface
} }
} }
/** // -------------------------------------------------------------------------
* Return the full URI includeing protocol, hostname, path, and query.
*
* @return array
*/
public function getUri()
{
$uri = strtolower($this->protocol) . '://' . $this->hostname . $this->path;
if ($this->query) {
$uri .= '?' . http_build_query($this->query);
}
return $uri;
}
/** /**
* Make a cURL request out of the instance and return a Response. * Make a cURL request out of the instance and return a Response.
* *
* @param array|null $curlOpts Associative array of options to set using curl_setopt_array before making the request.
* @throws Exceptions\CurlException
* @return Response * @return Response
* @throws exceptions\CurlException
*/ */
public function request() public function request($curlOpts = null)
{ {
$ch = curl_init(); $ch = curl_init();
// Set the URL. $options = array(
curl_setopt($ch, CURLOPT_URL, $this->uri); CURLOPT_URL => $this->getUri(),
CURLOPT_PORT => $this->port,
// Include headers in the response. CURLOPT_HEADER => 1,
curl_setopt($ch, CURLOPT_HEADER, 1); CURLOPT_RETURNTRANSFER => 1,
CURLOPT_HTTPHEADER => $this->getHeaderLines()
// Return the response from curl_exec(). );
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// Set the method. Include the body, if needed. // Set the method. Include the body, if needed.
switch ($this->method) { switch ($this->method) {
case 'GET': case 'GET':
curl_setopt($ch, CURLOPT_HTTPGET, 1); $options[CURLOPT_HTTPGET] = 1;
break; break;
case 'POST': case 'POST':
curl_setopt($ch, CURLOPT_POST, 1); $options[CURLOPT_POST] = 1;
curl_setopt($ch, CURLOPT_POSTFIELDS, $this->body); $options[CURLOPT_POSTFIELDS] = $this->body;
break; break;
case 'PUT': case 'PUT':
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT'); $options[CURLOPT_CUSTOMREQUEST] = 'PUT';
curl_setopt($ch, CURLOPT_POSTFIELDS, $this->body); $options[CURLOPT_POSTFIELDS] = $this->body;
break; break;
default: default:
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $this->method); $options[CURLOPT_CUSTOMREQUEST] = $this->method;
curl_setopt($ch, CURLOPT_POSTFIELDS, $this->body); $options[CURLOPT_POSTFIELDS] = $this->body;
break; break;
} }
// Add headers. // Override cURL options with the user options passed in.
curl_setopt($ch, CURLOPT_HTTPHEADER, $this->headerLines); if ($curlOpts) {
foreach ($curlOpts as $optKey => $optValue) {
$options[$optKey] = $optValue;
}
}
// Set the cURL options.
curl_setopt_array($ch, $options);
// Make the cURL request. // Make the cURL request.
$result = curl_exec($ch); $result = curl_exec($ch);
@ -321,7 +345,7 @@ class Request extends Message implements RequestInterface
$error = curl_error($ch); $error = curl_error($ch);
$errno = curl_errno($ch); $errno = curl_errno($ch);
curl_close($ch); curl_close($ch);
throw new Exceptions\CurlException($error, $errno); throw new CurlException($error, $errno);
} }
// Make a reponse to populate and return with data obtained via cURL. // Make a reponse to populate and return with data obtained via cURL.