SchemaConfig
in package
Configuration options for schema construction.
The options accepted by the create method are described in the schema definition docs.
Usage example:
$config = SchemaConfig::create()
->setQuery($myQueryType)
->setTypeLoader($myTypeLoader);
$schema = new Schema($config);
Tags
Table of Contents
- $assumeValid : bool
- $astNode : SchemaDefinitionNode|null
- $description : string|null
- $directives : array<string|int, mixed>|null
- $extensionASTNodes : array<string|int, mixed>
- $mutation : MaybeLazyObjectType
- $query : MaybeLazyObjectType
- $subscription : MaybeLazyObjectType
- $typeLoader : callable|null
- $types : iteratable<string|int, mixed>|callable
- create() : self
- Converts an array of options to instance of SchemaConfig (or just returns empty config when array is not passed).
- getAssumeValid() : bool
- getAstNode() : SchemaDefinitionNode|null
- getDescription() : string|null
- getDirectives() : array<string|int, Directive>|null
- getExtensionASTNodes() : array<string|int, SchemaExtensionNode>
- getMutation() : MaybeLazyObjectType
- getQuery() : MaybeLazyObjectType
- getSubscription() : MaybeLazyObjectType
- getTypeLoader() : callable|null
- getTypes() : array<string|int, mixed>|callable
- setAssumeValid() : self
- setAstNode() : self
- setDescription() : self
- setDirectives() : self
- setExtensionASTNodes() : self
- setMutation() : self
- setQuery() : self
- setSubscription() : self
- setTypeLoader() : self
- setTypes() : self
- assertMaybeLazyObjectType() : void
Properties
$assumeValid
public
bool
$assumeValid
= false
$astNode
public
SchemaDefinitionNode|null
$astNode
= null
$description
public
string|null
$description
= null
$directives
public
array<string|int, mixed>|null
$directives
= null
$extensionASTNodes
public
array<string|int, mixed>
$extensionASTNodes
= []
$mutation
public
MaybeLazyObjectType
$mutation
$query
public
MaybeLazyObjectType
$query
$subscription
public
MaybeLazyObjectType
$subscription
$typeLoader
public
callable|null
$typeLoader
Tags
$types
public
iteratable<string|int, mixed>|callable
$types
= []
Tags
Methods
create()
Converts an array of options to instance of SchemaConfig (or just returns empty config when array is not passed).
public
static create([array<string|int, mixed> $options = [] ]) : self
Parameters
- $options : array<string|int, mixed> = []
Tags
Return values
self —getAssumeValid()
public
getAssumeValid() : bool
Return values
bool —getAstNode()
public
getAstNode() : SchemaDefinitionNode|null
Return values
SchemaDefinitionNode|null —getDescription()
public
getDescription() : string|null
Return values
string|null —getDirectives()
public
getDirectives() : array<string|int, Directive>|null
Return values
array<string|int, Directive>|null —getExtensionASTNodes()
public
getExtensionASTNodes() : array<string|int, SchemaExtensionNode>
Return values
array<string|int, SchemaExtensionNode> —getMutation()
public
getMutation() : MaybeLazyObjectType
Return values
MaybeLazyObjectType —getQuery()
public
getQuery() : MaybeLazyObjectType
Return values
MaybeLazyObjectType —getSubscription()
public
getSubscription() : MaybeLazyObjectType
Return values
MaybeLazyObjectType —getTypeLoader()
public
getTypeLoader() : callable|null
Tags
Return values
callable|null — $typeLoadergetTypes()
public
getTypes() : array<string|int, mixed>|callable
Tags
Return values
array<string|int, mixed>|callable —setAssumeValid()
public
setAssumeValid(bool $assumeValid) : self
Parameters
- $assumeValid : bool
Return values
self —setAstNode()
public
setAstNode(SchemaDefinitionNode|null $astNode) : self
Parameters
- $astNode : SchemaDefinitionNode|null
Return values
self —setDescription()
public
setDescription(string|null $description) : self
Parameters
- $description : string|null
Return values
self —setDirectives()
public
setDirectives(array<string|int, Directive>|null $directives) : self
Parameters
- $directives : array<string|int, Directive>|null
Return values
self —setExtensionASTNodes()
public
setExtensionASTNodes(array<string|int, SchemaExtensionNode> $extensionASTNodes) : self
Parameters
- $extensionASTNodes : array<string|int, SchemaExtensionNode>
Return values
self —setMutation()
public
setMutation(MaybeLazyObjectType $mutation) : self
Parameters
- $mutation : MaybeLazyObjectType
Tags
Return values
self —setQuery()
public
setQuery(MaybeLazyObjectType $query) : self
Parameters
- $query : MaybeLazyObjectType
Tags
Return values
self —setSubscription()
public
setSubscription(MaybeLazyObjectType $subscription) : self
Parameters
- $subscription : MaybeLazyObjectType
Tags
Return values
self —setTypeLoader()
public
setTypeLoader(callable|null $typeLoader) : self
Parameters
- $typeLoader : callable|null
Tags
Return values
self —setTypes()
public
setTypes(array<string|int, mixed>|callable $types) : self
Parameters
- $types : array<string|int, mixed>|callable
Tags
Return values
self —assertMaybeLazyObjectType()
protected
assertMaybeLazyObjectType(mixed $maybeLazyObjectType) : void
Parameters
- $maybeLazyObjectType : mixed
-
Should be MaybeLazyObjectType