Guides
Tutorials
Builds the GraphQL types.
class ApiPlatform\GraphQl\Type\TypeBuilder implements `<a href="/docs/reference/GraphQl/Type/TypeBuilderInterface">ApiPlatform\GraphQl\Type\TypeBuilderInterface</a>`, `<a href="/docs/reference/GraphQl/Type/TypeBuilderEnumInterface">ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface</a>`
{
public __construct(ApiPlatform\GraphQl\Type\TypesContainerInterface $typesContainer, callable $defaultFieldResolver, Psr\Container\ContainerInterface $fieldsBuilderLocator, ApiPlatform\State\Pagination\Pagination $pagination)
public getResourceObjectType(null|string $resourceClass, ApiPlatform\Metadata\Resource\ResourceMetadataCollection $resourceMetadataCollection, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, bool $wrapped, int $depth): GraphQL\Type\Definition\Type
public getNodeInterface(): GraphQL\Type\Definition\InterfaceType
public getResourcePaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, string $resourceClass, 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
public getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type
public isCollection(Symfony\Component\PropertyInfo\Type $type): bool
}class ApiPlatform\GraphQl\Type\TypeBuilder implements `<a href="/docs/reference/GraphQl/Type/TypeBuilderInterface">ApiPlatform\GraphQl\Type\TypeBuilderInterface</a>`, `<a href="/docs/reference/GraphQl/Type/TypeBuilderEnumInterface">ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface</a>`
{
public __construct(ApiPlatform\GraphQl\Type\TypesContainerInterface $typesContainer, callable $defaultFieldResolver, Psr\Container\ContainerInterface $fieldsBuilderLocator, ApiPlatform\State\Pagination\Pagination $pagination)
public getResourceObjectType(null|string $resourceClass, ApiPlatform\Metadata\Resource\ResourceMetadataCollection $resourceMetadataCollection, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, bool $wrapped, int $depth): GraphQL\Type\Definition\Type
public getNodeInterface(): GraphQL\Type\Definition\InterfaceType
public getResourcePaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, string $resourceClass, 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
public getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type
public isCollection(Symfony\Component\PropertyInfo\Type $type): bool
}public __construct(ApiPlatform\GraphQl\Type\TypesContainerInterface $typesContainer, callable $defaultFieldResolver, Psr\Container\ContainerInterface $fieldsBuilderLocator, ApiPlatform\State\Pagination\Pagination $pagination)public __construct(ApiPlatform\GraphQl\Type\TypesContainerInterface $typesContainer, callable $defaultFieldResolver, Psr\Container\ContainerInterface $fieldsBuilderLocator, ApiPlatform\State\Pagination\Pagination $pagination)| typesContainer | ApiPlatform\GraphQl\Type\TypesContainerInterface | |
| defaultFieldResolver | callable | |
| fieldsBuilderLocator | Psr\Container\ContainerInterface | |
| pagination | ApiPlatform\State\Pagination\Pagination |
Gets the object type of the given resource.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\Typepublic getResourceObjectType(null|string $resourceClass, ApiPlatform\Metadata\Resource\ResourceMetadataCollection $resourceMetadataCollection, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, bool $wrapped, int $depth): GraphQL\Type\Definition\Type| resourceClass | string | |
| resourceMetadataCollection | ApiPlatform\Metadata\Resource\ResourceMetadataCollection | |
| operation | ApiPlatform\Metadata\GraphQl\Operation | |
| input | bool | |
| wrapped | bool | |
| depth | int |
GraphQL\Type\Definition\Type
Get the interface type of a node.Get the interface type of a node.
public getNodeInterface(): GraphQL\Type\Definition\InterfaceTypepublic getNodeInterface(): GraphQL\Type\Definition\InterfaceTypeGraphQL\Type\Definition\InterfaceType
Gets the type of a paginated collection of the given resource type.
public getResourcePaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Typepublic getResourcePaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type| resourceType | GraphQL\Type\Definition\Type | |
| resourceClass | string | |
| operation | ApiPlatform\Metadata\GraphQl\Operation |
GraphQL\Type\Definition\Type
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\Typepublic getPaginatedCollectionType(GraphQL\Type\Definition\Type $resourceType, ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type| resourceType | GraphQL\Type\Definition\Type | |
| operation | ApiPlatform\Metadata\GraphQl\Operation |
GraphQL\Type\Definition\Type
public getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Typepublic getEnumType(ApiPlatform\Metadata\GraphQl\Operation $operation): GraphQL\Type\Definition\Type| operation | ApiPlatform\Metadata\GraphQl\Operation |
GraphQL\Type\Definition\Type
Returns true if a type is a collection.Returns true if a type is a collection.
public isCollection(Symfony\Component\PropertyInfo\Type $type): boolpublic isCollection(Symfony\Component\PropertyInfo\Type $type): bool| type | Symfony\Component\PropertyInfo\Type |
bool
