classGenericExecuteResult

Session packages/ztd-query-core/src/GenericExecuteResult.php:23

final class GenericExecuteResult
    implements ExecuteResult

Generic implementation of ExecuteResult.

This implementation handles all result types:

Passthrough: signals that original statement should be executed
Rewritten SELECT: wraps a StatementInterface for fetching
Simulated WRITE: buffers rows and provides iteration
Failure: represents execution failure

Type Aliases§

Row = import from TableDefinition

Methods§

public function __construct(
    bool $passthrough,
    bool $success,
    QueryKind $kind,
    ?StatementInterface $rewrittenStatement = null,
    array<int, Row>|null $bufferedRows = null,
    ?int $rowCountOverride = null,
    bool $resultSet = false,
)

source §

Binds a result to everything it will answer from.

Every way of building one goes through a named constructor, because what a result is depends on which of them was used.

Parameters

`$passthrough`	`bool`
`$success`	`bool`
`$kind`	`QueryKind`
`$rewrittenStatement`	`?StatementInterface`
`$bufferedRows`	`array<int, Row>\|null`
`$rowCountOverride`	`?int`
`$resultSet`	`bool`

Calls 1

new RowSet line 69

public static function passthrough(QueryKind $kind = QueryKind::READ): self

source §

Create a passthrough result (original statement should be executed).

Parameters

$kind QueryKind

Returns

self

Test cases 6

Calls 2

class-const QueryKind::READ() line 77
new self line 79

public static function failure(QueryKind $kind): self

source §

Create a failure result.

Parameters

$kind QueryKind

Returns

self

Test cases 3

Calls 1

new self line 91

public static function fromStatement(
    StatementInterface $statement,
    QueryKind $kind = QueryKind::READ,
): self

source §

Create a result wrapping a rewritten statement (for SELECT queries).

Parameters

`$statement`	`StatementInterface`
`$kind`	`QueryKind`

Returns

self

Test cases 5

Called from 1

static-call ZtdQuery\Session::processExecutedStatement() packages/ztd-query-core/src/Session.php:348

Calls 2

class-const QueryKind::READ() line 101
new self line 103

public static function fromBufferedRows(
    array<int, Row> $rows,
    QueryKind $kind = QueryKind::WRITE_SIMULATED,
    ?int $affectedRowCount = null,
    bool $hasResultSet = false,
): self

source §

Create a result with buffered rows (for simulated WRITE queries).

Parameters

`$rows`	`array<int, Row>`
`$kind`	`QueryKind`
`$affectedRowCount`	`?int`
`$hasResultSet`	`bool`

Returns

self

Test cases 17

Called from 2

Calls 3

class-const QueryKind::WRITE_SIMULATED() line 118
new self line 122
function-call count line 128

public static function fromStatementAndRows(
    StatementInterface $statement,
    array<int, Row> $rows,
    QueryKind $kind = QueryKind::WRITE_SIMULATED,
): self

source §

Create a result with both a statement and buffered rows.

Parameters

`$statement`	`StatementInterface`
`$rows`	`array<int, Row>`
`$kind`	`QueryKind`

Returns

self

Test cases 1

GenericExecuteResultTest::testFromStatementAndRows calls

Calls 3

class-const QueryKind::WRITE_SIMULATED() line 141
new self line 143
function-call count line 149

public function isPassthrough(): bool

source §

{@inheritDoc}

Returns

bool

public function isSuccess(): bool

source §

{@inheritDoc}

Returns

bool

public function kind(): QueryKind

source §

{@inheritDoc}

Returns

QueryKind

public function fetch(): array|false

source §

{@inheritDoc}

Returns

array|false

Calls 2

function-call count line 183
new RowSet line 197

public function fetchAll(): array

source §

{@inheritDoc}

Returns

array

Calls 2

function-call array_slice line 212
function-call count line 213

public function rowCount(): int

source §

{@inheritDoc}

Returns

int

public function hasResultSet(): bool

source §

{@inheritDoc}

Returns

bool

Calls 1

class-const QueryKind::READ() line 246

public function resetBuffer(): void

source §

Reset the buffer index for re-iteration.

Private surface 8§

Implementation details, listed for orientation only.

private bool $passthrough

private bool $success

private QueryKind $kind

private ?StatementInterface $rewrittenStatement

private ?RowSet $bufferedRows

private int $bufferIndex = 0

private ?int $rowCountOverride

private bool $resultSet

Test cases 29§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 21

Other tests reaching this symbol 8

Relations§

Static calls 3