References FieldsBuilder
Reference
C
Class

ApiPlatform\GraphQl\Type\FieldsBuilder

Builds the GraphQL fields.

class ApiPlatform\GraphQl\Type\FieldsBuilder implements , `<a href="/docs/main/references/GraphQl/Type/FieldsBuilderEnumInterface">ApiPlatform\GraphQl\Type\FieldsBuilderEnumInterface
{
    public __construct($propertyNameCollectionFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataCollectionFactory, `<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface</a>` $resourceClassResolver, `<a href="/docs/main/references/GraphQl/Type/TypesContainerInterface">ApiPlatform\GraphQl\Type\TypesContainerInterface</a>` $typesContainer, `<a href="/docs/main/references/GraphQl/Type/ContextAwareTypeBuilderInterface">ApiPlatform\GraphQl\Type\ContextAwareTypeBuilderInterface</a>`|`<a href="/docs/main/references/GraphQl/Type/TypeBuilderEnumInterface">ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface</a>`|`<a href="/docs/main/references/GraphQl/Type/TypeBuilderInterface">ApiPlatform\GraphQl\Type\TypeBuilderInterface</a>` $typeBuilder, `<a href="/docs/main/references/GraphQl/Type/TypeConverterInterface">ApiPlatform\GraphQl\Type\TypeConverterInterface</a>` $typeConverter, `<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $itemResolverFactory, null|`<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $collectionResolverFactory, null|`<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $itemMutationResolverFactory, null|`<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $itemSubscriptionResolverFactory, Psr\Container\ContainerInterface $filterLocator, `<a href="/docs/main/references/State/Pagination/Pagination">ApiPlatform\State\Pagination\Pagination $pagination, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter, string $nestingSeparator)
    public getNodeQueryFields(): array
    public getItemQueryFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation, array $configuration): array
    public getCollectionQueryFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation, array $configuration): array
    public getMutationFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation): array
    public getSubscriptionFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation): array
    public getResourceObjectTypeFields(null|string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, int $depth, null|array $ioMetadata): array
    public getEnumFields(string $enumClass): array
    public resolveResourceArgs(array $args, ApiPlatform\Metadata\GraphQl\Operation $operation): array
}

Methods

__construct

public __construct($propertyNameCollectionFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataCollectionFactory, `<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface</a>` $resourceClassResolver, `<a href="/docs/main/references/GraphQl/Type/TypesContainerInterface">ApiPlatform\GraphQl\Type\TypesContainerInterface</a>` $typesContainer, `<a href="/docs/main/references/GraphQl/Type/ContextAwareTypeBuilderInterface">ApiPlatform\GraphQl\Type\ContextAwareTypeBuilderInterface</a>`|`<a href="/docs/main/references/GraphQl/Type/TypeBuilderEnumInterface">ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface</a>`|`<a href="/docs/main/references/GraphQl/Type/TypeBuilderInterface">ApiPlatform\GraphQl\Type\TypeBuilderInterface</a>` $typeBuilder, `<a href="/docs/main/references/GraphQl/Type/TypeConverterInterface">ApiPlatform\GraphQl\Type\TypeConverterInterface</a>` $typeConverter, `<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $itemResolverFactory, null|`<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $collectionResolverFactory, null|`<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $itemMutationResolverFactory, null|`<a href="/docs/main/references/GraphQl/Resolver/Factory/ResolverFactoryInterface">ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface</a>` $itemSubscriptionResolverFactory, Psr\Container\ContainerInterface $filterLocator, `<a href="/docs/main/references/State/Pagination/Pagination">ApiPlatform\State\Pagination\Pagination $pagination, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter, string $nestingSeparator)

Parameters

propertyNameCollectionFactory`ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface`
propertyMetadataFactory`ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface`
resourceMetadataCollectionFactory`ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface`
resourceClassResolver`ApiPlatform\Metadata\ResourceClassResolverInterface`
typesContainer`ApiPlatform\GraphQl\Type\TypesContainerInterface`
typeBuilder`ApiPlatform\GraphQl\Type\ContextAwareTypeBuilderInterface`
`ApiPlatform\GraphQl\Type\TypeBuilderEnumInterface`
`ApiPlatform\GraphQl\Type\TypeBuilderInterface`
typeConverter`ApiPlatform\GraphQl\Type\TypeConverterInterface`
itemResolverFactory`ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface`
collectionResolverFactory`ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface`
itemMutationResolverFactory`ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface`
itemSubscriptionResolverFactory`ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface`
filterLocatorPsr\Container\ContainerInterface
pagination`ApiPlatform\State\Pagination\Pagination`
nameConverterSymfony\Component\Serializer\NameConverter\NameConverterInterface
nestingSeparatorstring

getNodeQueryFields

Gets the fields of a node for a query.Gets the fields of a node for a query.

public getNodeQueryFields(): array

Returns

array

getItemQueryFields

Gets the item query fields of the schema.Gets the item query fields of the schema.

public getItemQueryFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation, array $configuration): array

Parameters

resourceClassstring
operation`ApiPlatform\Metadata\GraphQl\Operation`
configurationarray

Returns

array

getCollectionQueryFields

Gets the collection query fields of the schema.Gets the collection query fields of the schema.

public getCollectionQueryFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation, array $configuration): array

Parameters

resourceClassstring
operation`ApiPlatform\Metadata\GraphQl\Operation`
configurationarray

Returns

array

getMutationFields

Gets the mutation fields of the schema.Gets the mutation fields of the schema.

public getMutationFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation): array

Parameters

resourceClassstring
operation`ApiPlatform\Metadata\GraphQl\Operation`

Returns

array

getSubscriptionFields

Gets the subscription fields of the schema.Gets the subscription fields of the schema.

public getSubscriptionFields(string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation): array

Parameters

resourceClassstring
operation`ApiPlatform\Metadata\GraphQl\Operation`

Returns

array

getResourceObjectTypeFields

Gets the fields of the type of the given resource.Gets the fields of the type of the given resource.

public getResourceObjectTypeFields(null|string $resourceClass, ApiPlatform\Metadata\GraphQl\Operation $operation, bool $input, int $depth, null|array $ioMetadata): array

Parameters

resourceClassstring
operation`ApiPlatform\Metadata\GraphQl\Operation`
inputbool
depthint
ioMetadataarray

Returns

array

getEnumFields

Gets the fields (cases) of the enum.

public getEnumFields(string $enumClass): array

Parameters

enumClassstring

Returns

array

resolveResourceArgs

Resolve the args of a resource by resolving its types.Resolve the args of a resource by resolving its types.

public resolveResourceArgs(array $args, ApiPlatform\Metadata\GraphQl\Operation $operation): array

Parameters

argsarray
operation`ApiPlatform\Metadata\GraphQl\Operation`

Returns

array

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop