Skip to content

Commit ff8114f

Browse files
author
Witold Wasiczko
committed
Update readme
1 parent 3a73c56 commit ff8114f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,30 @@ This middleware provide framework-agnostic possibility to generate and add to re
1414
```json
1515
{
1616
"require": {
17-
"php-middleware/request-id": "^2.0.0"
17+
"php-middleware/request-id": "^3.0.0"
1818
}
1919
}
2020
```
2121

2222
## Usage
2323

24-
This middleware require in contructor `PhpMiddleware\RequestId\Generator\GeneratorInterface` implementation.
24+
This middleware require in contructor `PhpMiddleware\RequestId\RequestIdProviderFactoryInterface` implementation which
25+
must create a new `RequestIdProviderInterface` object. We provide `RequestIdProvider` default implementation.
2526

2627
```php
27-
$requestIdMiddleware = new PhpMiddleware\LogHttpMessages\RequestIdMiddleware($generator);
28+
$generator = new PhpMiddleware\RequestId\Generator\PhpUniqidGenerator();
29+
$requestIdProvider = new PhpMiddleware\RequestId\RequestIdProviderFactory($generator);
30+
$requestIdMiddleware = new PhpMiddleware\LogHttpMessages\RequestIdMiddleware($requestIdProvider);
2831

2932
$app = new MiddlewareRunner();
3033
$app->add($requestIdMiddleware);
3134
$app->run($request, $response);
3235
```
3336

34-
All middleware constructor options:
37+
All Provider factory constructor options:
3538

3639
* `PhpMiddleware\RequestId\Generator\GeneratorInterface` `$generator` - generator implementation (required)
3740
* `bool|PhpMiddleware\RequestId\OverridePolicy\OverridePolicyInterface` `$allowOverride` (default `true`) - if `true` and request id header exists in incoming request, then value from request header will be used in middleware, using generator will be avoid
38-
* `string` `$responseHeader` (default `X-Request-Id`) - request id will be added to response as header with given name. If it's not string request id will be not added to response
3941
* `string` `$requestHeader` (default `X-Request-Id`) - request header name
4042

4143
How to get request id in my application?

0 commit comments

Comments
 (0)