[Laravel] Model property casting to Enum is not working

[cay89]

API Platform version(s) affected: 4.0.12

Description
I have a model with a status property what I'm trying to cast to Enum:

enum TenantStatus: string
{
    case PENDING = 'pending';
    case ACTIVATION_IN_PROGRESS = 'activation_in_progress';
    case ACTIVE = 'active';
    case RESTRICTED = 'restricted';
    case DELETION_IN_PROGRESS = 'deletion_in_progress';
}

#[ApiResource(...)]
class Tenant extends AbstractModel
{

    // ...

    protected $casts = [
        'status' => TenantStatus::class,
    ];
}

but in the response the status will be []:

If I remove the casting from the model, the status display properly:

Additional Context

I traced the error back to AbstractItemNormalizer. It seems like something is going wrong here somewhere.

ApiPlatform\Serializer\AbstractItemNormalizer::getAttributeValue()

[toitzi]

When you cast something as an enum, Laravel does the transformation for you, but in the database it is still a string, hence it is working when you remove the cast since it is only string.

When you have the cast enabled, the string is automatically converted back to you enum by laravel on read operations. Now API Platform tries to normalize it, but does not know how since there is no backed enum normalizer, see here.

Since Symfony now also comes with a BackedEnumNormalizer, i think it is fine to add it. I will open a PR and we will see.

But in the meantime you can archive this yourself by putting this into your AppServiceProvider:

use Symfony\Component\Serializer\Normalizer\BackedEnumNormalizer;

public function register(): void
{
    $this->app->extend('api_platform_normalizer_list', function (\SplPriorityQueue $list, Application $app) {
        $list->insert($app->make(BackedEnumNormalizer::class), -905);
        return $list;
    });
}