ronildo-sousa/enumer

A simple package to create PHP enum from a json file

v0.0.1 2023-04-16 00:55 UTC

Requires

• php: ^8.1

Requires (Dev)

• laravel/pint: ^1.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-arch: ^2.0

MIT

• Ronildo Sousa

README

Enumer

A simple package to create PHP enum from a Json.

Installation

You can install the package via composer:

composer require ronildo-sousa/enumer

Usage

$json = '{"Hearts": "H", "Diamonds": "D", "Clubs": "C", "Spades": "S"}';

$enumer = new RonildoSousa\Enumer();
$enumer->convertJson(json: $json, file_path: '/Enums/Test.php');

It will create a class like this:

enum Test: string
{
    
   case Hearts = "H";

   case Diamonds = "D";

   case Clubs = "C";

   case Spades = "S";

}

You can change the return type of the enum:

$json = '{"Guest": 1, "Editor": 2, "Admin": 3, "Owner": 4}';

$enumer = new RonildoSousa\Enumer();
$enumer->convertJson(json: $json, file_path: '/Enums/Test.php', returnType: 'int');

It will create a class like this:

enum Test: int
{
    
   case Guest = 1;

   case Editor = 2;

   case Admin = 3;

   case Owner = 4;

}

Testing

composer test

Credits

• Ronildo Sousa
• All Contributors

License

The MIT License (MIT). Please see License File for more information.