ListQueryScaffolder
class ListQueryScaffolder extends QueryScaffolder
Scaffolds a GraphQL query field.
Traits
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
Gets a map of operation identifiers to their classes
QueryScaffolder constructor.
No description
Sets descriptions of arguments [ 'Email' => 'The email of the user' ]
Sets a single arg description
Sets argument defaults [ 'Featured' => true ]
Sets a default for a single arg
Sets operation arguments as required or not [ 'ID' => true ]
Sets an operation argument as required or not
No description
Set to true if this query is a nested field and should not appear in the root query field
No description
No description
No description
No description
No description
No description
No description
Details
in Chainable at line 21
$this
setChainableParent(DataObjectScaffolder|SchemaScaffolder $parent)
Set parent
in Chainable at line 31
DataObjectScaffolder|SchemaScaffolder
end()
in CustomMethods at line 50
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 144
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
in CustomMethods at line 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in Extensible at line 224
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in Extensible at line 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
in Extensible at line 395
array
invokeWithExtensions(string $method, mixed $arguments)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 424
array
extend(string $method, mixed $arguments)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
in Extensible at line 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 508
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
in OperationScaffolder at line 65
bool
getCloneable()
in OperationScaffolder at line 74
$this
setCloneable(bool $cloneable)
in OperationScaffolder at line 84
string
getDescription()
in OperationScaffolder at line 93
OperationScaffolder
setDescription(string $description)
in OperationScaffolder at line 103
static string|null
getClassFromIdentifier(string $name)
in OperationScaffolder at line 114
static string|null
getIdentifier(string|OperationScaffolder $instOrClass)
in OperationScaffolder at line 127
static array
getOperations()
Gets a map of operation identifiers to their classes
in QueryScaffolder at line 34
__construct(string $operationName = null, string $typeName = null, OperationResolver|callable|null $resolver = null, string $class = null)
QueryScaffolder constructor.
in OperationScaffolder at line 172
$this
addArgs(array $argData)
Adds args to the operation
Ex: [ 'MyArg' => 'String!', 'MyOtherArg' => 'Int', 'MyCustomArg' => new InputObjectType([ ]
in OperationScaffolder at line 189
$this
addArg(string $argName, string $typeStr, string $description = null, mixed $defaultValue = null)
in OperationScaffolder at line 206
$this
setArgDescriptions(array $argData)
Sets descriptions of arguments [ 'Email' => 'The email of the user' ]
in OperationScaffolder at line 232
$this
setArgDescription(string $argName, string $description)
Sets a single arg description
in OperationScaffolder at line 245
$this
setArgDefaults(array $argData)
Sets argument defaults [ 'Featured' => true ]
in OperationScaffolder at line 271
$this
setArgDefault(string $argName, mixed $default)
Sets a default for a single arg
in OperationScaffolder at line 284
$this
setArgsRequired(array $argData)
Sets operation arguments as required or not [ 'ID' => true ]
in OperationScaffolder at line 310
OperationScaffolder
setArgRequired(string $argName, boolean $required)
Sets an operation argument as required or not
in OperationScaffolder at line 318
string
getName()
in OperationScaffolder at line 327
$this
setName(string $name)
in OperationScaffolder at line 337
ArrayList
getArgs()
in OperationScaffolder at line 348
$this
setTypeName(string $typeName)
Type name
in QueryScaffolder at line 74
string
getTypeName()
in OperationScaffolder at line 366
$this
removeArg(string $arg)
in OperationScaffolder at line 375
$this
removeArgs(array $args)
in OperationScaffolder at line 385
callable|OperationResolver
getResolver()
in OperationScaffolder at line 395
$this
setResolver(callable|OperationResolver|string $resolver)
at line 128
applyConfig(array $config)
in DataObjectTypeTrait at line 29
string
getDataObjectClass()
in DataObjectTypeTrait at line 52
DataObject
getDataObjectInstance()
in DataObjectTypeTrait at line 65
$this
setDataObjectClass(string $class)
Sets the DataObject name
at line 164
addToManager(Manager $manager)
in QueryScaffolder at line 67
$this
setNested(bool $bool)
Set to true if this query is a nested field and should not appear in the root query field