Back to Dagger

GeneratorGroup

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

0.20.73.2 KB
Original Source

GeneratorGroup

class GeneratorGroup 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(ChangesetsMergeConflict|null $onConflict = null)

The combined changes from the last run of the generators

AbstractId

id()

A unique identifier for this GeneratorGroup.

bool

isEmpty()

Whether the generated changeset from the last run is empty or not

array

list()

Return a list of individual generators and their details

GeneratorGroup

run()

Execute all selected generators

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 20 Changeset changes(ChangesetsMergeConflict|null $onConflict = null)

The combined changes from the last run of the generators

If any conflict occurs, for instance if the same file is modified by multiple generators, or if a file is both modified and deleted, an error is raised and the merge of the changesets will failed.

Set 'continueOnConflicts' flag to force to merge the changes in a 'last write wins' strategy.

Parameters

| ChangesetsMergeConflict|null | $onConflict | |

Return Value

| Changeset | |

at line 32 AbstractId id()

A unique identifier for this GeneratorGroup.

Return Value

| AbstractId | |

at line 41 bool isEmpty()

Whether the generated changeset from the last run is empty or not

Return Value

| bool | |

at line 50 array list()

Return a list of individual generators and their details

Return Value

| array | |

at line 59 GeneratorGroup run()

Execute all selected generators

Return Value

| GeneratorGroup | |

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