Back to Dagger

Generator

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

0.20.73.5 KB
Original Source

Generator

class Generator extends AbstractObject implements IdAble

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

Changeset

changes()

The generated changeset from the last run

bool

completed()

Whether the generator complete

string

description()

Return the description of the generator

AbstractId

id()

A unique identifier for this Generator.

bool

isEmpty()

Whether changeset from the last generator run is empty or not

string

name()

Return the fully qualified name of the generator

Module

originalModule()

The original module in which the generator has been defined

array

path()

The path of the generator within its module

Generator

run()

Execute the generator

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 16 Changeset changes()

The generated changeset from the last run

Return Value

| Changeset | |

at line 25 bool completed()

Whether the generator complete

Return Value

| bool | |

at line 34 string description()

Return the description of the generator

Return Value

| string | |

at line 43 AbstractId id()

A unique identifier for this Generator.

Return Value

| AbstractId | |

at line 52 bool isEmpty()

Whether changeset from the last generator run is empty or not

Return Value

| bool | |

at line 61 string name()

Return the fully qualified name of the generator

Return Value

| string | |

at line 70 Module originalModule()

The original module in which the generator has been defined

Return Value

| Module | |

at line 79 array path()

The path of the generator within its module

Return Value

| array | |

at line 88 Generator run()

Execute the generator

Return Value

| Generator | |

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