Back to Dagger

FunctionCall

docs/static/reference/php/Dagger/FunctionCall.html

0.20.73.6 KB
Original Source

FunctionCall

class FunctionCall extends AbstractObject implements IdAble

An active function call.

Properties

| | $lastQuery | | from AbstractObject |

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

AbstractId

id()

A unique identifier for this FunctionCall.

array

inputArgs()

The argument values the function is being invoked with.

string

name()

The name of the function being called.

Json

parent()

The value of the parent object of the function being called. If the function is top-level to the module, this is always an empty object.

string

parentName()

The name of the parent object of the function being called. If the function is top-level to the module, this is the name of the module.

void

returnError(Error $error)

Return an error from the function.

void

returnValue(Json $value)

Set the return value of the function call to the provided value.

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 19 AbstractId id()

A unique identifier for this FunctionCall.

Return Value

| AbstractId | |

at line 28 array inputArgs()

The argument values the function is being invoked with.

Return Value

| array | |

at line 37 string name()

The name of the function being called.

Return Value

| string | |

at line 46 Json parent()

The value of the parent object of the function being called. If the function is top-level to the module, this is always an empty object.

Return Value

| Json | |

at line 55 string parentName()

The name of the parent object of the function being called. If the function is top-level to the module, this is the name of the module.

Return Value

| string | |

at line 64 void returnError(Error $error)

Return an error from the function.

Parameters

| Error | $error | |

Return Value

| void | |

at line 74 void returnValue(Json $value)

Set the return value of the function call to the provided value.

Parameters

| Json | $value | |

Return Value

| void | |

Generated by Doctum, a API Documentation generator and fork of Sami.