neutronstars/symfony-normalizer-enum-php

Added Symfony normalizer for the enumeration system designed to be as close to PHP 8.1 for earlier versions.

1.1.0 2021-07-09 20:01 UTC

Requires

• php: ^7.1 | ^8.0
• neutronstars/enum: ^1.4.0
• symfony/serializer: ^4.0 | ^5.0

Requires (Dev)

• phpunit/phpunit: ^6.0 | ^7.0 | ^8.0 | ^9.0

Apache-2.0

• NeutronStars

README

Read the enum php doc:

https://github.com/Neutron-Pro/enum-php

Installation

composer require neutronstars/symfony-normalizer-enum-php

Add doctrine:

composer require neutronstars/doctrine-enum-php-type

https://github.com/Neutron-Pro/doctrine-enum-php-type

Example for serialize an object entity with an enum field:

/**
 * @method static self WAITING()
 * @method static self PUBLISHED()
 */
class MyStringEnum extends \NeutronStars\Enum\Enum {
  public const WAITING   = 'Waiting';
  public const PUBLISHED = 'Published';
}

/**
 * @Entity()
 */
class Post {
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer") 
     * @Groups(["post:details"]) 
     * @var int 
     */
     private $id;
     
     // ... Other field (name, createdAt, updatedAt etc..)
     
     /**
      * For the customs type, please check the doctrine enum type documentation.
      * @ORM\Column(type="my_string_enum")
     *  @Groups(["post:details"]) 
      * @var MyStringEnum 
      */
      private $state;
      
      public function __construct() {
        $this->state = MyStringEnum::WAITING();
      }
      
      // ... All methods implemented.
}

/**
 * @Route("/posts", name="list_post")
 */
class ListPostController {

    /** @var PostRepository PostRepository */
    private $postRepository;
    
    public function __construct(PostRepository $postRepository) {
        $this->postRepository = $postRepository;
    }

    public function __invoke(): JSONResponse
    {
        $serializer = new \Symfony\Component\Serializer\Serializer([
            new \NeutronStars\Symfony\Enum\Normalizer\EnumNormalizer(MyStringEnum::class)
        ], [new \Symfony\Component\Serializer\Encoder\JsonEncode()]);
        
        return new JSONResponse(
            $serializer->normalize(
                $this->postRepository->findAll(),
                null,
                [ 'groups' => ['post:details'] ] 
            )
        );
    }
}