Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/invis1ble/symfony-serializer-extension
A useful set of additional (de)normalizers for symfony/serializer
https://github.com/invis1ble/symfony-serializer-extension
denormalizer deserializer extension normalizer psr serializer symfony uri uriinterface
Last synced: 2 months ago
JSON representation
A useful set of additional (de)normalizers for symfony/serializer
- Host: GitHub
- URL: https://github.com/invis1ble/symfony-serializer-extension
- Owner: Invis1ble
- License: mit
- Created: 2024-06-02T20:51:04.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T14:06:36.000Z (7 months ago)
- Last Synced: 2024-09-29T17:21:30.436Z (3 months ago)
- Topics: denormalizer, deserializer, extension, normalizer, psr, serializer, symfony, uri, uriinterface
- Language: PHP
- Homepage:
- Size: 60.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Symfony Serializer Extension
============================
[](https://codecov.io/gh/Invis1ble/symfony-serializer-extension)
[](https://packagist.org/packages/Invis1ble/symfony-serializer-extension)
[](./LICENSE)
A useful set of additional (de)normalizers for [symfony/serializer](https://github.com/symfony/serializer):
- `UriNormalizer` for normalizing objects implementing `Psr\Http\Message\UriInterface`
Installation
------------
To install this package, you can use Composer:
```sh
composer require invis1ble/symfony-serializer-extension
```
or just add it as a dependency in your `composer.json` file:
```json
{
"require": {
"invis1ble/symfony-serializer-extension": "^1.0"
}
}
```
After adding the above line, run the following command to install the package:
```sh
composer install
```
Usage
-----------
Currently implemented `UriNormalizer` only.
This normalizer is designed for normalizing `Uri` objects implementing the `Psr\Http\Message\UriInterface`.
Read the official [documentation for the Serializer](https://symfony.com/doc/current/components/serializer.html#usage) component to use normalizers.
```php
use Invis1ble\SymfonySerializerExtension\Normalizer\UriNormalizer;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Serializer;
$encoders = [new XmlEncoder(), new JsonEncoder()];
$normalizers = [new UriNormalizer($uriFactory)];
$serializer = new Serializer($normalizers, $encoders);
```
Development
-----------
### Getting started
1. If not already done, [install Docker Compose](https://docs.docker.com/compose/install/) (v2.10+)
2. Run `docker compose build --no-cache` to build fresh images
3. Run `docker compose up -d --wait` to start the Docker containers
4. Run `docker compose exec php composer install` to install dependencies
5. Run `docker compose down --remove-orphans` to stop the Docker containers.
### Check for Coding Standards violations
Run PHP_CodeSniffer checks:
```sh
docker compose exec -it php bin/php_codesniffer
```
Run PHP-CS-Fixer checks:
```sh
docker compose exec -it php bin/php-cs-fixer
```
Run Rector checks:
```sh
docker compose exec -it php bin/rector
```
Testing
-------
To run Unit tests during development
```sh
docker compose exec php vendor/bin/phpunit
```
To run with coverage
```sh
XDEBUG_MODE=coverage docker compose up -d --wait
docker compose exec php vendor/bin/phpunit --coverage-clover var/log/coverage-clover.xml
```
License
-------
[The MIT License](./LICENSE)