1. class
  2. Cassandra
  3. \
  4. Rows

Rows

final class Rows implements Iterator, ArrayAccess (View source)

Rows represent a result of statement execution.

Methods

__construct()

No description

int
count()

Returns the number of rows.

void
rewind()

Resets the rows iterator.

mixed
current()

Returns current row.

mixed
key()

Returns current index.

void
next()

Advances the rows iterator by one.

bool
valid()

Returns existence of more rows being available.

bool
offsetExists(TKey $offset)

Returns existence of a given row.

mixed
offsetGet(TKey $offset)

Returns a row at given index.

void
offsetSet(TKey $offset, TValue $value)

Sets a row at given index.

void
offsetUnset(TKey $offset)

Removes a row at given index.

bool
isLastPage()

Check for the last page when paging.

Rows|null
nextPage(float|null $timeout)

Get the next page of results.

Future
nextPageAsync()

Get the next page of results asynchronously.

string
pagingStateToken()

Returns the raw paging state token.

array|null
first()

Get the first row.

Details

at line 1465
__construct()

No description

at line 1475
int count()

Returns the number of rows.

Return Value

int

number of rows

See also

Countable::count

at line 1485
void rewind()

Resets the rows iterator.

Return Value

void

Any returned value is ignored.

See also

Iterator::rewind

at line 1495
mixed current()

Returns current row.

Return Value

mixed

Can return any type.

See also

Iterator::current

at line 1505
mixed key()

Returns current index.

Return Value

mixed

TKey on success, or null on failure.

See also

Iterator::key

at line 1515
void next()

Advances the rows iterator by one.

Return Value

void

Any returned value is ignored.

See also

Iterator::next

at line 1525
bool valid()

Returns existence of more rows being available.

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

See also

Iterator::valid

at line 1537
bool offsetExists(TKey $offset)

Returns existence of a given row.

Parameters

TKey $offset

An offset to check for.

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

See also

ArrayAccess::offsetExists

at line 1549
mixed offsetGet(TKey $offset)

Returns a row at given index.

Parameters

TKey $offset

The offset to retrieve.

Return Value

mixed

Can return all value types.

See also

ArrayAccess::offsetGet

at line 1564
void offsetSet(TKey $offset, TValue $value)

Sets a row at given index.

Parameters

TKey $offset

The offset to assign the value to.

TValue $value

The value to set.

Return Value

void

Exceptions

DomainException

See also

ArrayAccess::offsetSet

at line 1578
void offsetUnset(TKey $offset)

Removes a row at given index.

Parameters

TKey $offset

The offset to unset.

Return Value

void

Exceptions

DomainException

See also

ArrayAccess::offsetUnset

at line 1586
bool isLastPage()

Check for the last page when paging.

Return Value

bool

whether this is the last page or not

at line 1596
Rows|null nextPage(float|null $timeout)

Get the next page of results.

Parameters

float|null $timeout

Return Value

Rows|null

loads and returns next result page

at line 1604
Future nextPageAsync()

Get the next page of results asynchronously.

Return Value

Future

returns future of the next result page

at line 1612
string pagingStateToken()

Returns the raw paging state token.

Return Value

string

at line 1620
array|null first()

Get the first row.

Return Value

array|null

returns first row if any