schema, enum and type. */ class ExpandEnums implements GeneratorAwareInterface { use GeneratorAwareTrait; protected ?string $enumNames; public function __construct(?string $enumNames = null) { $this->enumNames = $enumNames; } public function getEnumNames(): ?string { return $this->enumNames; } /** * Specifies the name of the extension variable where backed enum names will be stored. * Set to null to avoid writing backed enum names. * * Example: * ->setEnumNames('enumNames') yields: * ```yaml * x-enumNames: * - NAME1 * - NAME2 * ``` */ public function setEnumNames(?string $enumNames = null): void { $this->enumNames = $enumNames; } public function __invoke(Analysis $analysis): void { if (!class_exists('\\ReflectionEnum')) { return; } $this->expandContextEnum($analysis); $this->expandSchemaEnum($analysis); } protected function expandContextEnum(Analysis $analysis): void { $schemas = $analysis->getAnnotationsOfType(OA\Schema::class, true); foreach ($schemas as $schema) { if ($schema->_context->is('enum')) { $re = new \ReflectionEnum($schema->_context->fullyQualifiedName($schema->_context->enum) ?? ''); $schema->schema = Generator::isDefault($schema->schema) ? $re->getShortName() : $schema->schema; $schemaType = $schema->type; $enumType = null; if ($re->isBacked()) { $enumType = $re->getBackingType()->getName(); } // no (or invalid) schema type means name $useName = Generator::isDefault($schemaType) || ($enumType && $this->generator->getTypeResolver()->native2spec($enumType) != $schemaType); $schema->enum = array_map(static fn (\ReflectionEnumUnitCase $case): int|string => ($useName || !($case instanceof \ReflectionEnumBackedCase)) ? $case->name : $case->getBackingValue(), $re->getCases()); if ($this->enumNames !== null && !$useName) { $schemaX = Generator::isDefault($schema->x) ? [] : $schema->x; $schemaX[$this->enumNames] = array_map(static fn (\ReflectionEnumUnitCase $case): string => $case->name, $re->getCases()); $schema->x = $schemaX; } $schema->type = $useName ? 'string' : $enumType; $this->generator->getTypeResolver()->mapNativeType($schema, $schemaType); } } } protected function expandSchemaEnum(Analysis $analysis): void { $schemas = $analysis->getAnnotationsOfType([OA\Schema::class, OA\ServerVariable::class]); foreach ($schemas as $schema) { if (Generator::isDefault($schema->enum)) { continue; } if (is_string($schema->enum)) { // might be enum class-string if (is_a($schema->enum, \UnitEnum::class, true)) { $cases = $schema->enum::cases(); } else { throw new OpenApiException("Unexpected enum value, requires specifying the Enum class string: $schema->enum"); } } else { // might be an array of \UnitEnum::class, string, int, etc... assert(is_array($schema->enum)); $cases = []; // transform \UnitEnum into individual cases /** @var string|class-string<\UnitEnum> $enum */ foreach ($schema->enum as $enum) { if (is_string($enum) && function_exists('enum_exists') && enum_exists($enum)) { foreach ($enum::cases() as $case) { $cases[] = $case; } } else { $cases[] = $enum; } } } $enums = []; foreach ($cases as $enum) { $enums[] = is_a($enum, \UnitEnum::class) ? $enum->value ?? $enum->name : $enum; } $schema->enum = $enums; } } }