1. class
  2. Civi
  3. \
  4. Api4
  5. \
  6. Generic
  7. \
  8. Result

Result

class Result extends ArrayObject

Container for api results.

Properties

string $entity
string $action
int $version Api version

Methods

array|null
first()

Return first result.

array|null
last()

Return last result.

array|null
itemAt(int $index)

No description

$this
indexBy(string $key)

Re-index the results array (which by default is non-associative)

int
count()

Returns the number of results

array
column($name)

Reduce each result to one field

Details

at line 54
array|null first()

Return first result.

Return Value

array|null

at line 65
array|null last()

Return last result.

Return Value

array|null

at line 74
array|null itemAt(int $index)

Parameters

int $index

Return Value

array|null

at line 91
$this indexBy(string $key)

Re-index the results array (which by default is non-associative)

Drops any item from the results that does not contain the specified key

Parameters

string $key

Return Value

$this

Exceptions

API_Exception

at line 113
int count()

Returns the number of results

Return Value

int

at line 127
array column($name)

Reduce each result to one field

Parameters

$name

Return Value

array