Field
class Field implements ConfigurationApplier, SchemaValidator, SignatureProvider, SchemaComponent, PluginValidator (View source)
An abstraction of a field that appears on a Type abstraction
Traits
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
Negotiates a variety of syntax that can appear in a field name definition.
No description
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();
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 = [])
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|string $config = [])
Field constructor.
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)
No description
Field
addArg(string $argName, null $config, callable|null $callback = null)
No description
Field
setArgs(array $args)
No description
bool
isList()
No description
bool
isRequired()
No description
void
validate()
No description
Field
setType($type, bool $required = false)
No description
Field
setTypeAsModel(string $modelTypeDef)
No description
string|null
getTypeAsModel()
No description
string|null
getName()
No description
Field
setName(string $name)
No description
string|null
getType()
No description
array
getArgs()
No description
EncodedType
getEncodedType()
No description
string
getNamedType()
Gets the name of the type, ignoring any nonNull/listOf wrappers
Field
setNamedType(string $name)
[MyType!]! becomes [MyNewType!]!
EncodedResolver
getEncodedResolver(string|null $typeName = null)
No description
string|null
getDescription()
No description
Field
setDescription(string|null $description)
No description
ResolverReference|null
getResolver()
No description
Field
setResolver(array|string|ResolverReference|null $resolver)
No description
array|null
getResolverContext()
No description
Field
setResolverContext(array|null $resolverContext)
No description
Field
addResolverContext(string $key, $value)
No description
Field
addResolverMiddleware(array|string|ResolverReference|null $resolver, array|null $context = null)
No description
Field
addResolverAfterware(array|string|ResolverReference|null $resolver, array|null $context = null)
No description
array
getResolverMiddlewares()
No description
array
getResolverAfterwares()
No description
string
getSignature()
No description
void
validatePlugin(string $pluginName, $plugin)
No description