class InheritanceChain (View source)

Utility class that abstracts away class ancestry computations and creates an inheritance "type" for a DataObject

Traits

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

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 static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
__construct(string $dataObjectClass)

InheritanceChain constructor.

public
array
getAncestralModels()

No description

public
bool
hasAncestors()

No description

public
hideAncestors(array $ancestors)

Hides ancestors by classname, e.g. SiteTree::class

public
array
getDescendantModels()

No description

public
array
getDirectDescendants()

No description

public
bool
hasDescendants()

No description

public
hideDescendants(array $descendants)

No description

public
bool
hasInheritance()

No description

public
array
getInheritance()

No description

public
string
getBaseClass()

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

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(string $dataObjectClass)

InheritanceChain constructor.

Parameters

string $dataObjectClass

Exceptions

SchemaBuilderException

array getAncestralModels()

No description

Return Value

array

bool hasAncestors()

No description

Return Value

bool

InheritanceChain hideAncestors(array $ancestors)

Hides ancestors by classname, e.g. SiteTree::class

Parameters

array $ancestors

Return Value

InheritanceChain

array getDescendantModels()

No description

Return Value

array

Exceptions

ReflectionException

array getDirectDescendants()

No description

Return Value

array

Exceptions

ReflectionException

bool hasDescendants()

No description

Return Value

bool

Exceptions

ReflectionException

InheritanceChain hideDescendants(array $descendants)

No description

Parameters

array $descendants

Return Value

InheritanceChain

bool hasInheritance()

No description

Return Value

bool

Exceptions

ReflectionException

array getInheritance()

No description

Return Value

array

Exceptions

ReflectionException

string getBaseClass()

No description

Return Value

string