class FunctionArg extends AbstractObject implements IdAble

An argument accepted by a function.

This is a specification for an argument at function definition time, not an argument passed at function call time.

Properties

$lastQuery from  AbstractObject

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

string
defaultPath()

Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory

defaultValue()

A default value to use for this argument when not explicitly set by the caller, if any.

string
description()

A doc string for the argument, if any.

id()

A unique identifier for this FunctionArg.

array
ignore()

Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.

string
name()

The name of the argument in lowerCamelCase format.

sourceMap()

The location of this arg declaration.

typeDef()

The type of the argument.

Details

in AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

AbstractClient $client
QueryBuilderChain $queryBuilderChain

in AbstractObject at line 19
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

QueryBuilder $leafQueryBuilder
string $leafKey

Return Value

null|array|string|int|float|bool

at line 21
string defaultPath()

Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory

Return Value

string

at line 30
Json defaultValue()

A default value to use for this argument when not explicitly set by the caller, if any.

Return Value

Json

at line 39
string description()

A doc string for the argument, if any.

Return Value

string

at line 48
AbstractId id()

A unique identifier for this FunctionArg.

Return Value

AbstractId

at line 57
array ignore()

Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.

Return Value

array

at line 66
string name()

The name of the argument in lowerCamelCase format.

Return Value

string

at line 75
SourceMap sourceMap()

The location of this arg declaration.

Return Value

SourceMap

at line 84
TypeDef typeDef()

The type of the argument.

Return Value

TypeDef