Function_
class Function_ extends AbstractObject implements IdAble
Function represents a resolver provided by a Module.
A function always evaluates against a parent object and is given a set of named arguments.
Properties
| $lastQuery | from AbstractObject |
Methods
No description
Arguments accepted by the function, if any.
The reason this function is deprecated, if any.
A doc string for the function, if any.
A unique identifier for this Function.
The name of the function.
The type returned by the function.
Returns the function with the provided argument
Returns the function updated to use the provided cache policy.
Returns the function with the provided deprecation reason.
Returns the function with the given doc string.
Returns the function with a flag indicating it's a generator.
Returns the function with the given source map.
Details
in
AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
in
AbstractObject at line 19
protected null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
at line 21
array
args()
Arguments accepted by the function, if any.
at line 30
string
deprecated()
The reason this function is deprecated, if any.
at line 39
string
description()
A doc string for the function, if any.
at line 48
AbstractId
id()
A unique identifier for this Function.
at line 57
string
name()
The name of the function.
at line 66
TypeDef
returnType()
The type returned by the function.
at line 75
SourceMap
sourceMap()
The location of this function declaration.
at line 84
Function_
withArg(string $name, TypeDef $typeDef, string|null $description = '', Json|null $defaultValue = null, string|null $defaultPath = '', array|null $ignore = null, SourceMap|null $sourceMap = null, string|null $deprecated = null, string|null $defaultAddress = '')
Returns the function with the provided argument
at line 125
Function_
withCachePolicy(FunctionCachePolicy $policy, string|null $timeToLive = null)
Returns the function updated to use the provided cache policy.
at line 138
Function_
withCheck()
Returns the function with a flag indicating it's a check.
at line 147
Function_
withDeprecated(string|null $reason = null)
Returns the function with the provided deprecation reason.
at line 159
Function_
withDescription(string $description)
Returns the function with the given doc string.
at line 169
Function_
withGenerator()
Returns the function with a flag indicating it's a generator.
at line 178
Function_
withSourceMap(SourceMap $sourceMap)
Returns the function with the given source map.