App\Domain\User\Enum\UserStatus

Complexity

Total Complexity

1

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getDisplayName()	0	7	1

<?php

namespace App\Domain\User\Enum;

use App\Common\Trait\EnumToArray;

/**
 * User authentication status.
 */
enum UserStatus: string
{
    use EnumToArray;

    // First letter uppercase and rest lowercase because these names are used as labels in html form as they are
    case Unverified = 'unverified'; // Default after registration
    case Active = 'active'; // Verified via token received in email
    case Locked = 'locked'; // Locked for security reasons, may be reactivated by account holder via email
    case Suspended = 'suspended'; // User suspended, account holder not allowed to login even via email

    // UserStatus::toArray() returns array for dropdown

    /**
     * Get the enum case name that can be displayed by the frontend.
     *
     * @return string
     */
    public function getDisplayName(): string
    {
        return match ($this) {
            self::Unverified => __('Unverified'),
            self::Active => __('Active'),
            self::Locked => __('Locked'),
            self::Suspended => __('Suspended'),
        };
    }
}