ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface

Interface implemented to build a GraphQL type.

interface ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface
{
    public getResourceObjectType(null|string $resourceClass, ApiPlatform\Metadata\Resource\ResourceMetadataCollection $resourceMetadataCollection, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, bool $wrapped, int $depth): GraphQL\Type\Definition\ObjectType|GraphQL\Type\Definition\NonNull
    public getNodeInterface(): GraphQL\Type\Definition\InterfaceType
    public getPaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type
    public getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type
    public isCollection(Symfony\Component\PropertyInfo\Type $type): bool
}

interface ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface
{
    public getResourceObjectType(null|string $resourceClass, ApiPlatform\Metadata\Resource\ResourceMetadataCollection $resourceMetadataCollection, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, bool $wrapped, int $depth): GraphQL\Type\Definition\ObjectType|GraphQL\Type\Definition\NonNull
    public getNodeInterface(): GraphQL\Type\Definition\InterfaceType
    public getPaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type
    public getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type
    public isCollection(Symfony\Component\PropertyInfo\Type $type): bool
}

Methods

getResourceObjectType

Gets the object type of the given resource.

public getResourceObjectType(null|string $resourceClass, ApiPlatform\Metadata\Resource\ResourceMetadataCollection $resourceMetadataCollection, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, bool $wrapped, int $depth): GraphQL\Type\Definition\ObjectType|GraphQL\Type\Definition\NonNull

public getResourceObjectType(null|string $resourceClass, ApiPlatform\Metadata\Resource\ResourceMetadataCollection $resourceMetadataCollection, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, bool $wrapped, int $depth): GraphQL\Type\Definition\ObjectType|GraphQL\Type\Definition\NonNull

Parameters

resourceClass	string
resourceMetadataCollection	ApiPlatform\Metadata\Resource\ResourceMetadataCollection
operation	ApiPlatform\Metadata\GraphQl\Operation
input	bool
wrapped	bool
depth	int

Returns

GraphQL\Type\Definition\ObjectType
GraphQL\Type\Definition\NonNull

getNodeInterface

Get the interface type of a node.

public getNodeInterface(): GraphQL\Type\Definition\InterfaceType

public getNodeInterface(): GraphQL\Type\Definition\InterfaceType

Returns

GraphQL\Type\Definition\InterfaceType

getPaginatedCollectionType

Gets the type of a paginated collection of the given resource type.

public getPaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type

public getPaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type

Parameters

resourceType	GraphQL\Type\Definition\Type
operation	ApiPlatform\Metadata\GraphQl\Operation

Returns

GraphQL\Type\Definition\Type

getEnumType

Gets the type corresponding to an enum.

public getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type

public getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type

Parameters

operation

ApiPlatform\Metadata\GraphQl\Operation

Returns

GraphQL\Type\Definition\Type

isCollection

Returns true if a type is a collection.

public isCollection(Symfony\Component\PropertyInfo\Type $type): bool

public isCollection(Symfony\Component\PropertyInfo\Type $type): bool

Parameters

type

Symfony\Component\PropertyInfo\Type

Returns

bool