Result
extends BaseResult
in package
Result for Postgre
Table of Contents
- $connID : resource|object
- Connection ID
- $currentRow : int
- Current Row index
- $customResultObject : array<string|int, mixed>
- Custom Result Object
- $resultArray : array<string|int, array<string|int, mixed>>
- Result Array
- $resultID : resource|object|bool
- Result ID
- $resultObject : array<string|int, object>
- Result Object
- $rowData : array<string|int, mixed>|null
- Row data
- $numRows : int|null
- The number of records in the query result
- __construct() : mixed
- Constructor
- dataSeek() : mixed
- Moves the internal pointer to the desired offset. This is called internally before fetching results to make sure the result set starts at zero.
- freeResult() : void
- Frees the current result.
- getCustomResultObject() : mixed
- Returns the results as an array of custom objects.
- getCustomRowObject() : mixed
- Returns a row as a custom class instance.
- getFieldCount() : int
- Gets the number of fields in the result set.
- getFieldData() : array<string|int, mixed>
- Generates an array of objects representing field meta-data.
- getFieldNames() : array<string|int, mixed>
- Generates an array of column names in the result set.
- getFirstRow() : mixed
- Returns the "first" row of the current results.
- getLastRow() : mixed
- Returns the "last" row of the current results.
- getNextRow() : mixed
- Returns the "next" row of the current results.
- getNumRows() : int
- Returns the number of rows in the resultID (i.e., PostgreSQL query result resource)
- getPreviousRow() : mixed
- Returns the "previous" row of the current results.
- getResult() : array<string|int, mixed>
- Retrieve the results of the query. Typically an array of individual data rows, which can be either an 'array', an 'object', or a custom class name.
- getResultArray() : array<string|int, mixed>
- Returns the results as an array of arrays.
- getResultObject() : array<string|int, mixed>
- Returns the results as an array of objects.
- getRow() : mixed
- Wrapper object to return a row as either an array, an object, or a custom class.
- getRowArray() : mixed
- Returns a single row from the results as an array.
- getRowObject() : mixed
- Returns a single row from the results as an object.
- getUnbufferedRow() : mixed
- Returns an unbuffered row and move the pointer to the next row.
- setRow() : mixed
- Assigns an item into a particular column slot.
- fetchAssoc() : mixed
- Returns the result set as an array.
- fetchObject() : object|bool|Entity
- Returns the result set as an object.
Properties
$connID
Connection ID
public
resource|object
$connID
$currentRow
Current Row index
public
int
$currentRow
= 0
$customResultObject
Custom Result Object
public
array<string|int, mixed>
$customResultObject
= []
$resultArray
Result Array
public
array<string|int, array<string|int, mixed>>
$resultArray
= []
$resultID
Result ID
public
resource|object|bool
$resultID
$resultObject
Result Object
public
array<string|int, object>
$resultObject
= []
$rowData
Row data
public
array<string|int, mixed>|null
$rowData
$numRows
The number of records in the query result
protected
int|null
$numRows
= null
Methods
__construct()
Constructor
public
__construct(object|resource &$connID, object|resource &$resultID) : mixed
Parameters
- $connID : object|resource
- $resultID : object|resource
Return values
mixed —dataSeek()
Moves the internal pointer to the desired offset. This is called internally before fetching results to make sure the result set starts at zero.
public
dataSeek(int $n) : mixed
Parameters
- $n : int
Return values
mixed —freeResult()
Frees the current result.
public
freeResult() : void
Return values
void —getCustomResultObject()
Returns the results as an array of custom objects.
public
getCustomResultObject(string $className) : mixed
Parameters
- $className : string
-
The name of the class to use.
Return values
mixed —getCustomRowObject()
Returns a row as a custom class instance.
public
getCustomRowObject(int $n, string $className) : mixed
If row doesn't exists, returns null.
Parameters
- $n : int
- $className : string
Return values
mixed —getFieldCount()
Gets the number of fields in the result set.
public
getFieldCount() : int
Return values
int —getFieldData()
Generates an array of objects representing field meta-data.
public
getFieldData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFieldNames()
Generates an array of column names in the result set.
public
getFieldNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFirstRow()
Returns the "first" row of the current results.
public
getFirstRow([string $type = 'object' ]) : mixed
Parameters
- $type : string = 'object'
Return values
mixed —getLastRow()
Returns the "last" row of the current results.
public
getLastRow([string $type = 'object' ]) : mixed
Parameters
- $type : string = 'object'
Return values
mixed —getNextRow()
Returns the "next" row of the current results.
public
getNextRow([string $type = 'object' ]) : mixed
Parameters
- $type : string = 'object'
Return values
mixed —getNumRows()
Returns the number of rows in the resultID (i.e., PostgreSQL query result resource)
public
getNumRows() : int
Return values
int —The number of rows in the query result
getPreviousRow()
Returns the "previous" row of the current results.
public
getPreviousRow([string $type = 'object' ]) : mixed
Parameters
- $type : string = 'object'
Return values
mixed —getResult()
Retrieve the results of the query. Typically an array of individual data rows, which can be either an 'array', an 'object', or a custom class name.
public
getResult([string $type = 'object' ]) : array<string|int, mixed>
Parameters
- $type : string = 'object'
-
The row type. Either 'array', 'object', or a class name to use
Return values
array<string|int, mixed> —getResultArray()
Returns the results as an array of arrays.
public
getResultArray() : array<string|int, mixed>
If no results, an empty array is returned.
Return values
array<string|int, mixed> —getResultObject()
Returns the results as an array of objects.
public
getResultObject() : array<string|int, mixed>
If no results, an empty array is returned.
Return values
array<string|int, mixed> —getRow()
Wrapper object to return a row as either an array, an object, or a custom class.
public
getRow(mixed $n[, string $type = 'object' ]) : mixed
If row doesn't exist, returns null.
Parameters
- $n : mixed
-
The index of the results to return
- $type : string = 'object'
-
The type of result object. 'array', 'object' or class name.
Return values
mixed —getRowArray()
Returns a single row from the results as an array.
public
getRowArray(int $n) : mixed
If row doesn't exist, returns null.
Parameters
- $n : int
Return values
mixed —getRowObject()
Returns a single row from the results as an object.
public
getRowObject(int $n) : mixed
If row doesn't exist, returns null.
Parameters
- $n : int
Return values
mixed —getUnbufferedRow()
Returns an unbuffered row and move the pointer to the next row.
public
getUnbufferedRow([string $type = 'object' ]) : mixed
Parameters
- $type : string = 'object'
Return values
mixed —setRow()
Assigns an item into a particular column slot.
public
setRow(mixed $key[, mixed $value = null ]) : mixed
Parameters
- $key : mixed
- $value : mixed = null
Return values
mixed —fetchAssoc()
Returns the result set as an array.
protected
fetchAssoc() : mixed
Overridden by driver classes.
Return values
mixed —fetchObject()
Returns the result set as an object.
protected
fetchObject([string $className = 'stdClass' ]) : object|bool|Entity
Overridden by child classes.
Parameters
- $className : string = 'stdClass'