class InterfaceBuilder (View source)

A schema-aware service for DataObject model types that emulates class inheritance by capturing groups of common fields into interfaces and applying one or many interfaces to concrete model types. Also creates a "base" interface for fields common to all DataObjects (i.e. "extends DataObject" pattern)

Traits

A class that can be instantiated or replaced via DI

Constants

BASE_INTERFACE_NAME

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 = [])

InterfaceBuilderTest constructor.

public
createInterfaces(ModelType $modelType, array $interfaceStack = [])

No description

public
applyBaseInterface()

No description

public
applyInterfacesToQueries(ModelType $type)

No description

public
getSchema()

No description

public
setSchema(Schema $schema)

No description

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

No description

public static 
string
defaultInterfaceFormatter(string $modelName)

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 = [])

InterfaceBuilderTest constructor.

Parameters

Schema $schema
array $hideAncestors

InterfaceBuilder createInterfaces(ModelType $modelType, array $interfaceStack = [])

No description

Parameters

ModelType $modelType
array $interfaceStack

Return Value

InterfaceBuilder

Exceptions

ReflectionException
SchemaBuilderException

InterfaceBuilder applyBaseInterface()

No description

Return Value

InterfaceBuilder

Exceptions

SchemaBuilderException

InterfaceBuilder applyInterfacesToQueries(ModelType $type)

No description

Parameters

ModelType $type

Return Value

InterfaceBuilder

Exceptions

ReflectionException
SchemaBuilderException

Schema getSchema()

No description

Return Value

Schema

InterfaceBuilder setSchema(Schema $schema)

No description

Parameters

Schema $schema

Return Value

InterfaceBuilder

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

No description

Parameters

string $modelName
SchemaConfig $schemaConfig

Return Value

string

Exceptions

SchemaBuilderException

static string defaultInterfaceFormatter(string $modelName)

No description

Parameters

string $modelName

Return Value

string