Fix broken ReflectionUnionTypes

[fabio-ivona]

Summary

This PR addresses issue #1129 , fixing exceptions thrown when a union type is present both in return type and parameter types

In php 8 ReflectionType class is subclassed by ReflectionUnionType , which is missing getName() and isBuiltin() methods. This code changes aim at defining an intermediary function that:

• handles ReflectionUnionTypes by splitting them in an array of ReflectionNamedTypes.
• handles single ReflectionNamedTypes, wrapping them in an array in order to handle the same data type

protected function extractReflectionTypes(\ReflectionType $reflection_type)
{
    if($reflection_type instanceof \ReflectionUnionType){
        foreach ($reflection_type->getTypes() as $named_type){
            if($named_type->getName()==='null'){
                continue;
            }

            $types[] = $this->getReflectionNamedType($named_type);
        }
    }else{
        $types[] = $this->getReflectionNamedType($reflection_type);
    }

    return $types;
}

the getReflectionNamedType() function wraps the old code for extracting the parameter name and adding \\ in case of builtin type:

protected function getReflectionNamedType(\ReflectionNamedType $paramType): string
{
    $parameterName = $paramType->getName();
    if (!$paramType->isBuiltin()) {
        $parameterName = '\\' . $parameterName;
    }

    return $parameterName;
}

These two functions are used to convert the two subclasses of ReflectionTypes to their respective dockblock strings

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Checklist

• Existing tests have been adapted and/or new tests have been added
• Add a CHANGELOG.md entry
• Update the README.md (no changes needed)
• Code style has been fixed via composer fix-style

[mfn]

@def-studio first quick look looks good! you mentioned in the issue assistance with tests => let me ask you first, did you check out the existing ones? Especially the ModelsCommand has lots of them, please see https://github.com/barryvdh/laravel-ide-helper/tree/master/tests/Console/ModelsCommand

[fabio-ivona]

@def-studio first quick look looks good! you mentioned in the issue assistance with tests => let me ask you first, did you check out the existing ones? Especially the ModelsCommand has lots of them, please see https://github.com/barryvdh/laravel-ide-helper/tree/master/tests/Console/ModelsCommand

Just checking it, will update code soon (or ask for clarifications if needed 😇 )

[fabio-ivona]

@mfn I've added a new test directory tests/Console/ModelsCommand/UnionTypes which tests a model with some use cases:

union types in parameters:

public function scopeWithUnionTypeParameter(Builder $query, string|int $bar): Builder
{
    return $query->where('foo', $bar);
}

nullable union type in parameters:

public function scopeWithNullableUnionTypeParameter(Builder $query, null|string|int $bar): Builder
{
    return $query->where('foo', $bar);
}

union type in return type:

public function withUnionTypeReturn(): HasMany|UnionTypeModel
{
    return $this->hasMany(UnionTypeModel::class);
}

nullable union type in return type:

public function getFooAttribute(): string|int|null
{
    return $this->getAttribute('foo');
}

[mfn]

LGTM 😄