class StorableSchema implements SchemaValidator (View source)

A readonly value object that represents a schema in its final consumable state. It knows nothing about models or operations, plugins, or all the abstractions surrounding how the schema gets defined

{@link SchemaStorageInterface} expects to deal with an instance of this rather than a {@link Schema} instance, which is more of a sandbox whose state cannot be trusted at any given time.

Traits

A class that can be instantiated or replaced via DI

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(array $config = [], SchemaConfig|null $context = null)

No description

array
getTypes()

No description

array
getEnums()

No description

array
getInterfaces()

No description

array
getUnions()

No description

array
getScalars()

No description

getConfig()

No description

bool
exists()

No description

void
validate()

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(array $config = [], SchemaConfig|null $context = null)

Parameters

array $config
SchemaConfig|null $context

array getTypes()

Return Value

array

array getEnums()

Return Value

array

array getInterfaces()

Return Value

array

array getUnions()

Return Value

array

array getScalars()

Return Value

array

SchemaConfig getConfig()

Return Value

SchemaConfig

bool exists()

Return Value

bool

void validate()

Return Value

void

Exceptions

SchemaBuilderException