SchemaBuilder
class SchemaBuilder (View source)
Traits
A class that can be instantiated or replaced via DI
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Retrieves the context for an already stored schema which does not require booting. Useful for getting data from a saved schema at request time.
Boots a schema, persists it, and fetches it
Auto-discovers the schema based on the provided schema key in Silverstripe's configuration layer. Merges the global schema with specifics for this schema key.
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
__construct(SchemaStorageCreator $storeCreator)
No description
SchemaConfig|null
getConfig(string $key)
Retrieves the context for an already stored schema which does not require booting. Useful for getting data from a saved schema at request time.
Returns null when no stored schema can be found.
Schema|null
getSchema(string $key)
Gets a graphql-php Schema instance that can be queried
Schema
build(Schema $schema, bool $clear = false)
Stores a schema and fetches the graphql-php instance
Schema
buildByName(string $key, bool $clear = false)
Boots a schema, persists it, and fetches it
Schema
boot(string $key)
Auto-discovers the schema based on the provided schema key in Silverstripe's configuration layer. Merges the global schema with specifics for this schema key.
An instance can only be booted once to avoid conflicts with further instance level modifications such as addType().
This method should only be used on schemas which have not been stored, and is usually only needed for the process of storing them (through SchemaBuilder->build()).
SchemaStorageCreator
getStoreCreator()
No description
SchemaBuilder
setStoreCreator(SchemaStorageCreator $storeCreator)
No description