class SchemaTranscriber (View source)

Persists a graphql schema to a json document consumable by Apollo

Traits

A class that can be instantiated or replaced via DI

Constants

CACHE_FILENAME

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

__construct(Schema $schema, string $name, string $rootDir = null)

SchemaTranscriber constructor.

writeSchemaToFilesystem()

Introspect the schema and persist it to the filesystem

void
removeSchemaFromFilesystem()

No description

writeTypes(string $content)

No description

string
getRootDir()

No description

setRootDir(string $rootDir)

No description

Details

static Injectable create(array ...$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'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(Schema $schema, string $name, string $rootDir = null)

SchemaTranscriber constructor.

Parameters

Schema $schema
string $name
string $rootDir

Storage path for the generated file. Caution: This location may be used by frontend assets relying on GraphQL, e.g. silverstripe/assets.

writeSchemaToFilesystem()

Introspect the schema and persist it to the filesystem

Exceptions

Exception

void removeSchemaFromFilesystem()

Return Value

void

writeTypes(string $content)

Parameters

string $content

string getRootDir()

Return Value

string

SchemaTranscriber setRootDir(string $rootDir)

Parameters

string $rootDir

Return Value

SchemaTranscriber