docs/static/reference/php/Dagger/Function_.html
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.
| | $lastQuery | | from AbstractObject |
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
from AbstractObject
null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
from AbstractObject
array
args()
Arguments accepted by the function, if any.
string
The reason this function is deprecated, if any.
string
A doc string for the function, if any.
id()
A unique identifier for this Function.
string
name()
The name of the function.
The type returned by the function.
The location of this function declaration.
string
If this function is provided by a module, the name of the module. Unset otherwise.
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
withCachePolicy(FunctionCachePolicy $policy, string|null $timeToLive = null)
Returns the function updated to use the provided cache policy.
Returns the function with a flag indicating it's a check.
withDeprecated(string|null $reason = null)
Returns the function with the provided deprecation reason.
withDescription(string $description)
Returns the function with the given doc string.
Returns the function with a flag indicating it's a generator.
withSourceMap(SourceMap $sourceMap)
Returns the function with the given source map.
withUp()
Returns the function with a flag indicating it returns a service for dagger up.
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain) No description
| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)No description
| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |
| null|array|string|int|float|bool | |
array args()Arguments accepted by the function, if any.
| array | |
string deprecated()The reason this function is deprecated, if any.
| string | |
string description()A doc string for the function, if any.
| string | |
AbstractId id()A unique identifier for this Function.
| AbstractId | |
string name()The name of the function.
| string | |
TypeDef returnType()The type returned by the function.
| TypeDef | |
SourceMap sourceMap()The location of this function declaration.
| SourceMap | |
string sourceModuleName()If this function is provided by a module, the name of the module. Unset otherwise.
| string | |
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
| string | $name | | | TypeDef | $typeDef | | | string|null | $description | | | Json|null | $defaultValue | | | string|null | $defaultPath | | | array|null | $ignore | | | SourceMap|null | $sourceMap | | | string|null | $deprecated | | | string|null | $defaultAddress | |
| Function_ | |
Function_ withCachePolicy(FunctionCachePolicy $policy, string|null $timeToLive = null)Returns the function updated to use the provided cache policy.
| FunctionCachePolicy | $policy | | | string|null | $timeToLive | |
| Function_ | |
Function_ withCheck()Returns the function with a flag indicating it's a check.
| Function_ | |
Function_ withDeprecated(string|null $reason = null)Returns the function with the provided deprecation reason.
| string|null | $reason | |
| Function_ | |
Function_ withDescription(string $description)Returns the function with the given doc string.
| string | $description | |
| Function_ | |
Function_ withGenerator()Returns the function with a flag indicating it's a generator.
| Function_ | |
Function_ withSourceMap(SourceMap $sourceMap)Returns the function with the given source map.
| SourceMap | $sourceMap | |
| Function_ | |
Function_ withUp()Returns the function with a flag indicating it returns a service for dagger up.
| Function_ | |
Generated by Doctum, a API Documentation generator and fork of Sami.