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

SchemaStorageInterface expects to deal with an instance of this rather than a 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

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public
__construct(array $config = [], SchemaConfig|null $context = null)

No description

public
array
getTypes()

No description

public
array
getEnums()

No description

public
array
getInterfaces()

No description

public
array
getUnions()

No description

public
array
getScalars()

No description

public
getConfig()

No description

public
bool
exists()

No description

public
void
validate()

No description

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();

Parameters

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

No description

Parameters

array $config
SchemaConfig|null $context

array getTypes()

No description

Return Value

array

array getEnums()

No description

Return Value

array

array getInterfaces()

No description

Return Value

array

array getUnions()

No description

Return Value

array

array getScalars()

No description

Return Value

array

SchemaConfig getConfig()

No description

Return Value

SchemaConfig

bool exists()

No description

Return Value

bool

void validate()

No description

Return Value

void

Exceptions

SchemaBuilderException