Skip to content

Commit 493146e

Browse files
mpscholtenmpscholten
authored
Merge pull request #12 from mpscholten/psr7
Added Psr7 integration
2 parents 6a43376 + f3ce868 commit 493146e

12 files changed

+421
-95
lines changed

‎README.md

+51-2
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,16 @@ Install via composer
7070
composer require mpscholten/request-parser
7171
```
7272

73-
If you're using the `symfony/http-foundation` `Request`, you just need to import a trait into your controller. If you're using some other `Request` abstraction (or maybe just plain old `$_GET` and friends), [check out this example](https://github.com/mpscholten/request-parser/blob/master/examples/not-symfony.php).
7473

75-
The following example asumes you're using the symfony `Request`:
74+
**Integrations:**
75+
76+
- If you're using `symfony/http-foundation`, [click here](#symfony-httpfoundation).
77+
- If you're using a Psr7 `ServerRequestInterface` implementation, [click here](#psr7).
78+
- If you're using some other `Request` abstraction (or maybe just plain old `$_GET` and friends), [check out this example](https://github.com/mpscholten/request-parser/blob/master/examples/not-symfony.php).
79+
80+
#### Symfony HttpFoundation
81+
82+
The following example assumes you're using the symfony `Request`:
7683

7784
```php
7885
class MyController
@@ -112,6 +119,48 @@ be handled by your application to show an error message.
112119

113120
Take a look at [the examples](https://github.com/mpscholten/request-parser/tree/master/examples).
114121

122+
#### Psr7
123+
124+
The following example assumes you're using the Psr7 `ServerRequestInterface`:
125+
126+
```php
127+
class MyController
128+
{
129+
use \MPScholten\RequestParser\Psr7\ControllerHelperTrait;
130+
131+
public function __construct(ServerRequestInterface $request)
132+
{
133+
$this->initRequestParser($request);
134+
}
135+
}
136+
```
137+
138+
Then you can use the library like this:
139+
```php
140+
class MyController
141+
{
142+
use \MPScholten\RequestParser\Psr7\ControllerHelperTrait;
143+
144+
public function __construct(ServerRequestInterface $request)
145+
{
146+
$this->initRequestParser($request);
147+
}
148+
149+
public function myAction()
150+
{
151+
$someParameter = $this->queryParameter('someParameter')->string()->required();
152+
}
153+
}
154+
```
155+
156+
When doing `GET /MyController/myAction?someParameter=example`, the `$someParameter` variable will contain the string `"example"`.
157+
158+
You might wonder what happens when we leave out the `?someParameter` part, like `GET /MyController/myAction`. In this case the
159+
`$this->queryParameter('someParameter')->string()->required()` will throw a `NotFoundException`. This exception can
160+
be handled by your application to show an error message.
161+
162+
Take a look at [the examples](https://github.com/mpscholten/request-parser/tree/master/examples).
163+
115164
#### Optional Parameters
116165

117166
To make the `someParameter` optional, we can just replace `required()` with `defaultsTo($someDefaultValue)`:

‎composer.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
"require": {},
1111
"require-dev": {
1212
"phpunit/phpunit": "3.7.*",
13-
"symfony/http-foundation": "3.1.*"
13+
"symfony/http-foundation": "3.1.*",
14+
"symfony/psr-http-message-bridge": "^0.2.0",
15+
"zendframework/zend-diactoros": "^1.3"
1416
},
1517
"autoload": {
1618
"psr-4": {"MPScholten\\RequestParser\\": "src/"}

‎examples/not-symfony.php

+41-20
Original file line numberDiff line numberDiff line change
@@ -12,45 +12,60 @@
1212

1313
require __DIR__ . '/../vendor/autoload.php';
1414

15-
trait CustomControllerHelperTrait
15+
class CustomRequestParserFactory implements \MPScholten\RequestParser\RequestParserFactory
1616
{
17-
private $queryParser;
18-
private $bodyParser;
17+
/**
18+
* @var array
19+
*/
20+
private $request;
21+
private $exceptionFactory;
22+
23+
public function __construct(array $request, $exceptionFactory)
24+
{
25+
$this->request = $request;
26+
$this->exceptionFactory = $exceptionFactory;
27+
}
1928

20-
protected final function initRequestParser()
29+
public function createQueryParser()
2130
{
22-
$this->queryParser = new MPScholten\RequestParser\RequestParser(
31+
return new MPScholten\RequestParser\RequestParser(
2332
function ($parameterName) {
24-
if (isset($_GET[$parameterName])) {
25-
return $_GET[$parameterName];
33+
if (isset($this->request[$parameterName])) {
34+
return $this->request[$parameterName];
2635
}
2736

2837
return null;
2938
},
30-
null
39+
$this->exceptionFactory
3140
);
32-
$this->bodyParser = new MPScholten\RequestParser\RequestParser(
41+
}
42+
43+
public function createBodyParser()
44+
{
45+
return new MPScholten\RequestParser\RequestParser(
3346
function ($parameterName) {
34-
if (isset($_POST[$parameterName])) {
35-
return $_POST[$parameterName];
47+
if (isset($this->request[$parameterName])) {
48+
return $this->request[$parameterName];
3649
}
3750

3851
return null;
3952
},
40-
null
53+
$this->exceptionFactory
4154
);
4255
}
56+
}
4357

44-
protected function queryParameter($name)
45-
{
46-
return $this->queryParser->get($name);
47-
}
58+
trait CustomControllerHelperTrait
59+
{
60+
use \MPScholten\RequestParser\BaseControllerHelperTrait;
4861

49-
protected function bodyParameter($name)
62+
/**
63+
* Will be called during the `initRequestParser()` call in `MyController`
64+
*/
65+
protected final function createRequestParserFactory($request, $exceptionFactory)
5066
{
51-
return $this->bodyParser->get($name);
67+
return new CustomRequestParserFactory($request, $exceptionFactory);
5268
}
53-
5469
}
5570

5671
class MyController
@@ -59,7 +74,13 @@ class MyController
5974

6075
public function __construct()
6176
{
62-
$this->initRequestParser();
77+
if ($_SERVER['REQUEST_METHOD'] === 'GET') {
78+
$request = $_GET;
79+
} else {
80+
$request = $_POST;
81+
}
82+
83+
$this->initRequestParser($request);
6384
}
6485

6586
public function hello()

‎examples/psr7.php

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<?php
2+
3+
// This example shows how to use this library with the Psr7 `ServerRequestInterface`
4+
// To try out this example do the following:
5+
// - Install dependencies: `composer install`
6+
// - Start webserver: `cd examples && php -S localhost:8080`
7+
// - Open in browser:
8+
// | http://localhost:8080/psr7.php?action=hello
9+
// | http://localhost:8080/psr7.php?action=hello&name=yourname
10+
// | http://localhost:8080/psr7.php?action=helloWithDefault
11+
// | http://localhost:8080/psr7.php?action=json&payload={%22a%22:1}
12+
13+
require __DIR__ . '/../vendor/autoload.php';
14+
15+
use MPScholten\RequestParser\Psr7\ControllerHelperTrait;
16+
use Psr\Http\Message\ServerRequestInterface;
17+
use Symfony\Bridge\PsrHttpMessage\Factory\DiactorosFactory;
18+
use Symfony\Component\HttpFoundation\Request;
19+
20+
$symfonyRequest = Request::createFromGlobals();
21+
$psr7Factory = new DiactorosFactory();
22+
$request = $psr7Factory->createRequest($symfonyRequest);
23+
24+
class MyController
25+
{
26+
use ControllerHelperTrait;
27+
28+
public function __construct(ServerRequestInterface $request)
29+
{
30+
$this->initRequestParser($request);
31+
}
32+
33+
public function hello()
34+
{
35+
$name = $this->queryParameter('name')->string()->required();
36+
37+
return "Hello $name";
38+
}
39+
40+
public function helloWithDefault()
41+
{
42+
$name = $this->queryParameter('name')->string()->defaultsTo('unknown');
43+
44+
return "Hello $name";
45+
}
46+
47+
public function json()
48+
{
49+
$payload = $this->queryParameter('payload')->json()->required();
50+
51+
return print_r($payload, true);
52+
}
53+
}
54+
55+
$controller = new MyController($request);
56+
$action = $request->getQueryParams()['action'];
57+
58+
try {
59+
echo $controller->$action();
60+
} catch (\MPScholten\RequestParser\NotFoundException $e) {
61+
echo $e->getMessage();
62+
}

‎src/BaseControllerHelperTrait.php

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php
2+
3+
namespace MPScholten\RequestParser;
4+
5+
trait BaseControllerHelperTrait
6+
{
7+
/**
8+
* @var RequestParser
9+
*/
10+
private $queryParser;
11+
12+
/**
13+
* @var RequestParser
14+
*/
15+
private $bodyParser;
16+
17+
protected final function initRequestParser($request, callable $exceptionFactory = null)
18+
{
19+
/** @var $requestParserFactory RequestParserFactory */
20+
$requestParserFactory = $this->createRequestParserFactory($request, $exceptionFactory);
21+
$this->queryParser = $requestParserFactory->createQueryParser();
22+
$this->bodyParser = $requestParserFactory->createBodyParser();
23+
}
24+
25+
/**
26+
* Use this method to access the query parameters of the request.
27+
*
28+
* $page = $this->queryParameter('page')->int()->defaultsTo(0)
29+
*
30+
* @param string $name
31+
* @return TypeParser
32+
*/
33+
protected function queryParameter($name)
34+
{
35+
return $this->queryParser->get($name);
36+
}
37+
38+
/**
39+
* Use this method to access the body parameters of the request (e.g. $_POST).
40+
*
41+
* $password = $this->bodyParameter('password')->string()->required()
42+
*
43+
* @param string $name
44+
* @return TypeParser
45+
*/
46+
protected function bodyParameter($name)
47+
{
48+
return $this->bodyParser->get($name);
49+
}
50+
}

‎src/Psr7/ControllerHelperTrait.php

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
namespace MPScholten\RequestParser\Psr7;
4+
5+
use MPScholten\RequestParser\BaseControllerHelperTrait;
6+
7+
trait ControllerHelperTrait
8+
{
9+
use BaseControllerHelperTrait;
10+
11+
protected final function createRequestParserFactory($request, $exceptionFactory)
12+
{
13+
return new Psr7RequestParserFactory($request, $exceptionFactory);
14+
}
15+
}

‎src/Psr7/Psr7RequestParserFactory.php

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<?php
2+
3+
namespace MPScholten\RequestParser\Psr7;
4+
5+
use MPScholten\RequestParser\RequestParser;
6+
use MPScholten\RequestParser\RequestParserFactory;
7+
use Psr\Http\Message\ServerRequestInterface;
8+
9+
class Psr7RequestParserFactory implements RequestParserFactory
10+
{
11+
private $request;
12+
private $exceptionFactory;
13+
14+
public function __construct(ServerRequestInterface $request, $exceptionFactory = null)
15+
{
16+
$this->request = $request;
17+
$this->exceptionFactory = $exceptionFactory;
18+
}
19+
20+
public function createQueryParser()
21+
{
22+
$query = $this->request->getQueryParams();
23+
24+
$readParameter = function ($name) use ($query) {
25+
if (!isset($query[$name])) {
26+
return null;
27+
}
28+
29+
return $query[$name];
30+
};
31+
32+
return new RequestParser($readParameter, $this->exceptionFactory);
33+
}
34+
35+
public function createBodyParser()
36+
{
37+
$body = $this->request->getParsedBody();
38+
39+
$readParameter = function ($name) use ($body) {
40+
if (!isset($body[$name])) {
41+
return null;
42+
}
43+
44+
return $body[$name];
45+
};
46+
47+
return new RequestParser($readParameter, $this->exceptionFactory);
48+
}
49+
}

‎src/RequestParserFactory.php

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
namespace MPScholten\RequestParser;
4+
5+
interface RequestParserFactory
6+
{
7+
/**
8+
* @return RequestParser
9+
*/
10+
public function createQueryParser();
11+
12+
/**
13+
* @return RequestParser
14+
*/
15+
public function createBodyParser();
16+
}

0 commit comments

Comments
 (0)