ModelField
class ModelField extends Field (View source)
A field that appears on model type
Traits
Used for a variety of classes that rely on SchemaModelInterface
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows adding, loading, and sorting of plugins
Constants
| DEFAULT_TYPE |
|
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Translates all the ID and config settings to first class instances
Sorts the before/after of plugins using topological sort
ModelField constructor.
Negotiates a variety of syntax that can appear in a field name definition.
No description
No description
No description
No description
No description
For nested field definitions Blog: fields: Comments: fields: Author: fields: Name: String
No description
No description
No description
No description
Details
static Injectable
create(array ...$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'); $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).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
PluginConsumer
addPlugin(string $pluginName, array $config = [])
PluginConsumer
removePlugin(string $pluginName)
PluginConsumer
mergePlugins(array $plugins)
PluginConsumer
setPlugins(array $plugins)
PluginConsumer
setDefaultPlugins(array $plugins)
array
getPlugins(bool $inheritDefaults = true)
array
getDefaultPlugins()
bool
hasPlugin(string $identifier)
PluginRegistry
getPluginRegistry()
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|string $config, SchemaModelInterface $model)
ModelField constructor.
in
Field at line 125
static array
parseName(string $def)
Negotiates a variety of syntax that can appear in a field name definition.
fieldName fieldName(arg1: String!, arg2: Int) fieldName(arg1: String! = "foo")
mixed
applyConfig(array $config)
in
Field at line 209
Field
addArg(string $argName, null $config, callable|null $callback = null)
in
Field at line 224
Field
setArgs(array $args)
in
Field at line 254
bool
isList()
in
Field at line 262
bool
isRequired()
in
Field at line 270
void
validate()
in
Field at line 285
Field
setType($type, bool $required = false)
in
Field at line 309
Field
setTypeAsModel(string $modelTypeDef)
in
Field at line 319
string|null
getTypeAsModel()
in
Field at line 327
string|null
getName()
in
Field at line 336
Field
setName(string $name)
in
Field at line 345
string|null
getType()
in
Field at line 353
array
getArgs()
in
Field at line 362
EncodedType
getEncodedType()
in
Field at line 379
string
getNamedType()
Gets the name of the type, ignoring any nonNull/listOf wrappers
in
Field at line 390
Field
setNamedType(string $name)
[MyType!]! becomes [MyNewType!]!
in
Field at line 402
EncodedResolver
getEncodedResolver(string|null $typeName = null)
in
Field at line 425
string|null
getDescription()
in
Field at line 434
Field
setDescription(string|null $description)
in
Field at line 443
ResolverReference|null
getResolver()
in
Field at line 452
Field
setResolver(array|string|ResolverReference|null $resolver)
in
Field at line 468
array|null
getResolverContext()
in
Field at line 477
Field
setResolverContext(array|null $resolverContext)
in
Field at line 488
Field
addResolverContext(string $key, $value)
in
Field at line 500
Field
addResolverMiddleware(array|string|ResolverReference|null $resolver, array|null $context = null)
in
Field at line 510
Field
addResolverAfterware(array|string|ResolverReference|null $resolver, array|null $context = null)
in
Field at line 518
array
getResolverMiddlewares()
in
Field at line 526
array
getResolverAfterwares()
string
getSignature()
void
validatePlugin(string $pluginName, $plugin)
SchemaModelInterface
getModel()
ModelAware
setModel(SchemaModelInterface $model)
ModelType|null
getModelType()
For nested field definitions Blog: fields: Comments: fields: Author: fields: Name: String