Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

Commit

Permalink
Merge branch 'feature/http-request-accessors'
Browse files Browse the repository at this point in the history
  • Loading branch information
@weierophinney
weierophinney committed Jul 25, 2012
51 parents 94e82a8 + 459f1f9 + e0c8424 + 5ef6a39 + 58fd018 + 65e3b0b + d21655a + 1d20fd1 + fe81bc5 + 96fadae + 072c64d + d3c9780 + 9c15ae8 + 66a4342 + 85c9491 + 8ec8384 + 004366f + 55a086d + ac7c7af + f02a226 + 00c4ac3 + 3f52720 + 5508474 + 49ed2f6 + d562686 + 67b42b2 + bdb1dae + 9809630 + 7304e37 + 752a5af + 8181c8f + 53bdac2 + c2f9414 + f6341e9 + 57cde95 + c750616 + 293054e + 7432649 + 63f13f6 + 927c00d + 44e0d4b + bc03833 + 1fd7c61 + de0cb77 + 66e902f + 24354dc + 9f886a2 + 845333c + 96e9a1e + 52fbeb6 + 524367a commit c0ba21c
Show file tree
Hide file tree
Showing 4 changed files with 190 additions and 21 deletions.
28 changes: 20 additions & 8 deletions src/PhpEnvironment/Request.php
View file
Expand Up @@ -294,18 +294,24 @@ public function setServer(ParametersInterface $server)
}

/**
* Return the parameter container responsible for server parameters
* Return the parameter container responsible for server parameters or a single parameter value.
*
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing.
* @see http://www.faqs.org/rfcs/rfc3875.html
* @return ParametersInterface
* @return \Zend\Stdlib\ParametersInterface|mixed
*/
public function getServer()
public function getServer($name = null, $default = null)
{
if ($this->serverParams === null) {
$this->serverParams = new Parameters();
}

return $this->serverParams;
if($name === null){
return $this->serverParams;
}

return $this->serverParams->get($name, $default);
}

/**
Expand All @@ -322,17 +328,23 @@ public function setEnv(ParametersInterface $env)
}

/**
* Return the parameter container responsible for env parameters
* Return the parameter container responsible for env parameters or a single parameter value.
*
* @return ParametersInterface
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing. * @return \Zend\Stdlib\ParametersInterface
* @return \Zend\Stdlib\ParametersInterface|mixed
*/
public function getEnv()
public function getEnv($name = null, $default = null)
{
if ($this->envParams === null) {
$this->envParams = new Parameters();
}

return $this->envParams;
if($name === null){
return $this->envParams;
}

return $this->envParams->get($name, $default);
}

/**
Expand Down
83 changes: 70 additions & 13 deletions src/Request.php
View file
Expand Up @@ -225,17 +225,23 @@ public function setQuery(ParametersInterface $query)
}

/**
* Return the parameter container responsible for query parameters
* Return the parameter container responsible for query parameters or a single query parameter
*
* @return \Zend\Stdlib\ParametersInterface
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing.
* @return \Zend\Stdlib\ParametersInterface|mixed
*/
public function getQuery()
public function getQuery($name = null, $default = null)
{
if ($this->queryParams === null) {
$this->queryParams = new Parameters();
}

return $this->queryParams;
if($name === null){
return $this->queryParams;
}

return $this->queryParams->get($name, $default);
}

/**
Expand All @@ -252,17 +258,23 @@ public function setPost(ParametersInterface $post)
}

/**
* Return the parameter container responsible for post parameters
* Return the parameter container responsible for post parameters or a single post parameter.
*
* @return \Zend\Stdlib\ParametersInterface
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing.
* @return \Zend\Stdlib\ParametersInterface|mixed
*/
public function getPost()
public function getPost($name = null, $default = null)
{
if ($this->postParams === null) {
$this->postParams = new Parameters();
}

return $this->postParams;
if($name === null){
return $this->postParams;
}

return $this->postParams->get($name, $default);
}

/**
Expand Down Expand Up @@ -290,17 +302,62 @@ public function setFiles(ParametersInterface $files)
}

/**
* Return the parameter container responsible for file parameters
* Return the parameter container responsible for file parameters or a single file.
*
* @return ParametersInterface
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing.
* @return ParametersInterface|mixed
*/
public function getFiles()
public function getFiles($name = null, $default = null)
{
if ($this->fileParams === null) {
$this->fileParams = new Parameters();
}

return $this->fileParams;
if($name === null){
return $this->fileParams;
}

return $this->fileParams->get($name, $default);
}

/**
* Return the header container responsible for headers or all headers of a certain name/type
*
* @see \Zend\Http\Headers::get()
* @param string|null $name Header name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the requested header is missing.
* @return \Zend\Http\Headers|bool|\Zend\Http\Header\HeaderInterface|\ArrayIterator
*/
public function getHeaders($name = null, $default = false)
{
if ($this->headers === null || is_string($this->headers)) {
// this is only here for fromString lazy loading
$this->headers = (is_string($this->headers)) ? Headers::fromString($this->headers) : new Headers();
}

if($name === null){
return $this->headers;
}

if($this->headers->has($name)){
return $this->headers->get($name);
}

return $default;
}

/**
* Get all headers of a certain name/type.
*
* @see Request::getHeaders()
* @param string|null $name Header name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the requested header is missing.
* @return \Zend\Http\Headers|bool|\Zend\Http\Header\HeaderInterface|\ArrayIterator
*/
public function getHeader($name, $default = false)
{
return $this->getHeaders($name, $default);
}

/**
Expand Down Expand Up @@ -440,4 +497,4 @@ public function toString()
$str .= $this->getContent();
return $str;
}
}
}
52 changes: 52 additions & 0 deletions test/PhpEnvironment/RequestTest.php
View file
Expand Up @@ -11,6 +11,8 @@
namespace ZendTest\Http\PhpEnvironment;

use PHPUnit_Framework_TestCase as TestCase;
use Zend\Http\Headers;
use Zend\Http\Header\GenericHeader;
use Zend\Http\PhpEnvironment\Request;

class RequestTest extends TestCase
Expand Down Expand Up @@ -581,4 +583,54 @@ public function testRequestMapsPhpFies(array $files, array $expectedFiles)
$request = new Request();
$this->assertEquals($expectedFiles, $request->getFiles()->toArray());
}

public function testParameterRetrievalDefaultValue()
{
$request = new Request();
$p = new \Zend\Stdlib\Parameters(array(
'foo' => 'bar'
));
$request->setQuery($p);
$request->setPost($p);
$request->setFiles($p);
$request->setServer($p);
$request->setEnv($p);

$default = 15;
$this->assertSame($default, $request->getQuery('baz', $default));
$this->assertSame($default, $request->getPost('baz', $default));
$this->assertSame($default, $request->getFiles('baz', $default));
$this->assertSame($default, $request->getServer('baz', $default));
$this->assertSame($default, $request->getEnv('baz', $default));
$this->assertSame($default, $request->getHeaders('baz', $default));
$this->assertSame($default, $request->getHeader('baz', $default));
}

public function testRetrievingASingleValueForParameters()
{
$request = new Request();
$p = new \Zend\Stdlib\Parameters(array(
'foo' => 'bar'
));
$request->setQuery($p);
$request->setPost($p);
$request->setFiles($p);
$request->setServer($p);
$request->setEnv($p);

$this->assertSame('bar', $request->getQuery('foo'));
$this->assertSame('bar', $request->getPost('foo'));
$this->assertSame('bar', $request->getFiles('foo'));
$this->assertSame('bar', $request->getServer('foo'));
$this->assertSame('bar', $request->getEnv('foo'));

$headers = new Headers();
$h = new GenericHeader('foo','bar');
$headers->addHeader($h);

$request->setHeaders($headers);
$this->assertSame($headers, $request->getHeaders());
$this->assertSame($h, $request->getHeaders()->get('foo'));
$this->assertSame($h, $request->getHeader('foo'));
}
}
48 changes: 48 additions & 0 deletions test/RequestTest.php
View file
Expand Up @@ -11,6 +11,8 @@
namespace ZendTest\Http;

use Zend\Http\Request;
use Zend\Http\Headers;
use Zend\Http\Header\GenericHeader;

class RequestTest extends \PHPUnit_Framework_TestCase
{
Expand Down Expand Up @@ -45,6 +47,52 @@ public function testRequestAllowsSettingOfParameterContainer()
$this->assertSame($p, $request->getQuery());
$this->assertSame($p, $request->getPost());
$this->assertSame($p, $request->getFiles());

$headers = new Headers();
$request->setHeaders($headers);
$this->assertSame($headers, $request->getHeaders());
}

public function testRetrievingASingleValueForParameters()
{
$request = new Request();
$p = new \Zend\Stdlib\Parameters(array(
'foo' => 'bar'
));
$request->setQuery($p);
$request->setPost($p);
$request->setFiles($p);

$this->assertSame('bar', $request->getQuery('foo'));
$this->assertSame('bar', $request->getPost('foo'));
$this->assertSame('bar', $request->getFiles('foo'));

$headers = new Headers();
$h = new GenericHeader('foo','bar');
$headers->addHeader($h);

$request->setHeaders($headers);
$this->assertSame($headers, $request->getHeaders());
$this->assertSame($h, $request->getHeaders()->get('foo'));
$this->assertSame($h, $request->getHeader('foo'));
}

public function testParameterRetrievalDefaultValue()
{
$request = new Request();
$p = new \Zend\Stdlib\Parameters(array(
'foo' => 'bar'
));
$request->setQuery($p);
$request->setPost($p);
$request->setFiles($p);

$default = 15;
$this->assertSame($default, $request->getQuery('baz', $default));
$this->assertSame($default, $request->getPost('baz', $default));
$this->assertSame($default, $request->getFiles('baz', $default));
$this->assertSame($default, $request->getHeaders('baz', $default));
$this->assertSame($default, $request->getHeader('baz', $default));
}

public function testRequestPersistsRawBody()
Expand Down

0 comments on commit c0ba21c

Please sign in to comment.