bowlofsoup/normalizer-bundle

Normalizer for objects.

Bowl Of Soup Normalizer

, _(*1)

Installation

composer require bowlofsoup/normalizer-bundle

Add the bundle to your config/bundles.php file, _(*2)

BowlOfSoup\NormalizerBundle\BowlOfSoupNormalizerBundle::class => ['all' => true],

Quick feature overview

• It's a Symfony bundle!
• Normalizes class properties and methods (public, protected, private)
• Can Serialize normalized content
• Works with Symfony and Doctrine as its ORM. Can handle Doctrine proxies
• Circular reference check: Handles circular reference by detecting it and returning content of the objects getId() method
• Object caching: If a getId() method is implemented for an object it will cache the normalized object per normalize command
• Annotation caching, this means speed!
  • The annotations for an object are cached. This means not parsing annotations multiple times for the same object. per flow (per normalize command)
  • In Symfony prod mode, annotations are cached completely (after first run)
• Symfony translations
  • Indicate domain (translation filename) and locale in annotations
  • Does not support formatting with ICU MessageFormat (yet), so no parameters

The main features are described in the documentation., _(*3)

Documentation

Documentation on the usage and all supported options can be found in the wiki., _(*4)

1. What is serialization and normalization?
2. Installation
3. Serializing
   1. Serialize annotations
4. Normalizing
   1. Normalize annotations
5. Translate a value
   1. Translate annotations

Why use this normalizer and not ...

• The Bowl Of Soup Normalizer uses an opt-in mechanism by default. You have to indicate which properties must be normalized
• You can indicate a context group, how is the value to be normalized, in which context?
• It's designed with speed in mind. Not packed with features for which you don't use half of it
• It has proven itself in a complex application with 15.000+ daily end users

Development

The following CI tools can be used to check for code quality before pushing code:, _(*5)

Rector

Rector can be used to automated code upgrades and refactoring. Try a dry-run first!, _(*6)

vendor/bin/rector process --dry-run --no-progress-bar --ansi

PHPStan

PHPStan is a static code analysis tool that focuses on finding errors in the code. Fixing the outcome of PHPStan prevents possible bugs and errors., _(*7)

vendor/bin/phpstan

PHPUnit

Speaks for itself, code should be tested. Run with coverage (output = tests/coverage):, _(*8)

XDEBUG_MODE=coverage php -dzend_extension=xdebug.so vendor/bin/phpunit 

Or without coverage:, _(*9)

vendor/bin/phpunit

Code coverage master:, _(*10)

, _(*11)

Code style fixer

Have php-cs-fixer automatically fix styling., _(*12)

vendor/bin/php-cs-fixer fix