class InheritanceUnionBuilder (View source)

A schema-aware services for DataObject model types that creates union types for all the members of an inheritance chain. Can also apply these unions to queries to enforce unions when return types have descendants.

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(Schema $schema)

InheritanceUnionBuilder constructor.

public
createUnions(ModelType $modelType)

No description

public
applyUnionsToQueries(ModelType $modelType)

Changes all queries to use inheritance unions where applicable

public static 
string
unionName(string $modelName, SchemaConfig $schemaConfig)

No description

public static 
string
defaultUnionFormatter(string $modelName)

No description

public
getSchema()

No description

public
setSchema(Schema $schema)

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(Schema $schema)

InheritanceUnionBuilder constructor.

Parameters

Schema $schema

InheritanceUnionBuilder createUnions(ModelType $modelType)

No description

Parameters

ModelType $modelType

Return Value

InheritanceUnionBuilder

Exceptions

ReflectionException
SchemaBuilderException

InheritanceUnionBuilder applyUnionsToQueries(ModelType $modelType)

Changes all queries to use inheritance unions where applicable

Parameters

ModelType $modelType

Return Value

InheritanceUnionBuilder

Exceptions

SchemaBuilderException

static string unionName(string $modelName, SchemaConfig $schemaConfig)

No description

Parameters

string $modelName
SchemaConfig $schemaConfig

Return Value

string

Exceptions

SchemaBuilderException

static string defaultUnionFormatter(string $modelName)

No description

Parameters

string $modelName

Return Value

string

Schema getSchema()

No description

Return Value

Schema

InheritanceUnionBuilder setSchema(Schema $schema)

No description

Parameters

Schema $schema

Return Value

InheritanceUnionBuilder