class InheritanceBuilder (View source)

A schema-aware service for DataObject model types that builds out their inheritance chain in an ORM-like way, applying inherited fields and implicitly exposing ancestral types, etc.

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, array $hideAncestors = [])

InheritanceBuilder constructor.

public
void
fillAncestry(ModelType $modelType)

No description

public
void
fillDescendants(ModelType $modelType)

No description

public
bool
isBaseModel(string $class)

No description

public
bool
isLeafModel(string $class)

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, array $hideAncestors = [])

InheritanceBuilder constructor.

Parameters

Schema $schema
array $hideAncestors

void fillAncestry(ModelType $modelType)

No description

Parameters

ModelType $modelType

Return Value

void

Exceptions

SchemaBuilderException

void fillDescendants(ModelType $modelType)

No description

Parameters

ModelType $modelType

Return Value

void

Exceptions

ReflectionException
SchemaBuilderException

bool isBaseModel(string $class)

No description

Parameters

string $class

Return Value

bool

bool isLeafModel(string $class)

No description

Parameters

string $class

Return Value

bool

Exceptions

ReflectionException

Schema getSchema()

No description

Return Value

Schema

InheritanceBuilder setSchema(Schema $schema)

No description

Parameters

Schema $schema

Return Value

InheritanceBuilder