-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
550 additions
and
221 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 Antonio del Olmo | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
The following library allows using `ServerRequestInterface` objects of the [psr/http-message](https://github.com/php-fig/http-message) library as a source for the [cuyz/valinor](https://github.com/cuyz/valinor) library. | ||
|
||
## Installation | ||
|
||
```bash | ||
composer require delolmo/valinor-http-message | ||
``` | ||
|
||
## Example | ||
|
||
```php | ||
|
||
use App\DTO\CustomObject; | ||
use CuyZ\Valinor\Mapper\Source\Source; | ||
use CuyZ\Valinor\MapperBuilder; | ||
use DelOlmo\Valinor\Mapping\Source\ServerRequestSource; | ||
use Psr\Http\Message\ServerRequestInterface; | ||
|
||
final class CustomController | ||
{ | ||
public function execute(ServerRequestInterface $request) | ||
{ | ||
// Create the Source using the new InputSource | ||
$source = Source::iterable(new ServerRequestSource($input)); | ||
|
||
// Create the Mapper, using the desired configuration | ||
$mapper = new MapperBuilder()) | ||
->allowSuperfluousKeys() | ||
->enableFlexibleCasting() | ||
->mapper(); | ||
|
||
// Map the source to whatever object makes sense | ||
$mapped = $mapper->map(CustomObject::class, $source); | ||
|
||
// Apply whatever business logic makes sense from here | ||
// ... | ||
} | ||
} | ||
``` | ||
|
||
## Final notes | ||
|
||
- Versioning of `delolmo/valinor-http-message` will always match `cuyz/valinor` versions. Same goes for PHP versions. | ||
- Although query params and body params should not share the same name in the Request, it should be noted that, from a ServerRequestSource standpoint, query params always take precedence over body params. That is, if there is a query param and a body param sharing the same name, ServerRequestSource will only use the query param's value for mapping purposes. | ||
- Considering that many query and body params are retrieved as strings or arrays, it is interesting to note that `enableFlexibleCasting` should also be configured in the Mapper. See [Enabling flexible casting](https://valinor.cuyz.io/latest/mapping/type-strictness/#enabling-flexible-casting) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.