Type
class Type implements ConfigurationApplier, SchemaValidator, SignatureProvider, SchemaComponent (View source)
Abstraction for a generic type
Traits
Provides extensions to this object to integrate it with standard config API methods.
A class that can be instantiated or replaced via DI
Allows adding, loading, and sorting of plugins
Properties
| protected | Field[] | $fields |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Translates all the ID and config settings to first class instances
Sorts the before/after of plugins using topological sort
A deterministic representation of everything that gets encoded into the template.
Details
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
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();
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).
PluginConsumer
addPlugin(string $pluginName, array $config = [])
No description
PluginConsumer
removePlugin(string $pluginName)
No description
PluginConsumer
mergePlugins(array $plugins)
No description
PluginConsumer
setPlugins(array $plugins)
No description
PluginConsumer
setDefaultPlugins(array $plugins)
No description
array
getPlugins(bool $inheritDefaults = true)
No description
array
getDefaultPlugins()
No description
bool
hasPlugin(string $identifier)
No description
PluginRegistry
getPluginRegistry()
No description
Generator
loadPlugins()
Translates all the ID and config settings to first class instances
array
getSortedPlugins()
Sorts the before/after of plugins using topological sort
__construct(string $name, array|null $config = null)
No description
mixed
applyConfig(array $config)
No description
string|null
getName()
No description
Type
setName(string $name)
No description
array
getFields()
No description
Type
setFields(array $fields)
No description
Type
addField(string $fieldName, string|array|Field $fieldConfig, callable|null $callback = null)
No description
Type
removeField(string $field)
No description
Field|null
getFieldByName(string $fieldName)
No description
string|null
getDescription()
No description
void
validate()
No description
bool
exists()
No description
setDescription(string|null $description)
No description
array
getInterfaces()
No description
string
getEncodedInterfaces()
No description
Type
setInterfaces(array $interfaces)
No description
Type
addInterface(string $name)
No description
bool
implements(string $interfaceName)
No description
bool
getIsInput()
No description
Type
setIsInput(bool $isInput)
No description
ResolverReference|null
getFieldResolver()
No description
Type
setFieldResolver(array|string|ResolverReference|null $fieldResolver)
No description
string
getSignature()
A deterministic representation of everything that gets encoded into the template.
Used as a cache key. This method will need to be updated if new data is added to the generated code.