Implements: Countable | Iterator | Traversable | SeekableIterator | ArrayAccess
This class is a transparent base class for Database_Result and should not be accessed directly.
Database result wrapper. See Results for usage and examples.
Class declared in MODPATH/database/classes/Kohana/Database/Result.php on line 12.
NULL
integer 0
NULL
NULL
NULL
integer 0
Sets the total number of rows and stores the result locally.
mixed
$result
required - Query result string
$sql
required - SQL query mixed
$as_object
= bool FALSE - $as_object array
$params
= NULL - $params voidpublic function __construct($result, $sql, $as_object = false, array $params = null)
{
// Store the result locally
$this->_result = $result;
// Store the SQL locally
$this->_query = $sql;
if (is_object($as_object)) {
// Get the object class name
$as_object = get_class($as_object);
}
// Results as objects or associative arrays
$this->_as_object = $as_object;
if ($params) {
// Object constructor params
$this->_object_params = $params;
}
}Result destruction cleans up all open result sets.
voidabstract public function __destruct();Return all of the rows in the result as an array.
// Indexed array of all rows
$rows = $result->as_array();
// Associative array of rows by "id"
$rows = $result->as_array('id');
// Associative array of rows, "id" => "name"
$rows = $result->as_array('id', 'name');
string
$key
= NULL - Column for associative keys string
$value
= NULL - Column for values arraypublic function as_array($key = null, $value = null)
{
$results = [];
if ($key === null AND $value === null) {
// Indexed rows
foreach ($this as $row) {
$results[] = $row;
}
} elseif ($key === null) {
// Indexed columns
if ($this->_as_object) {
foreach ($this as $row) {
$results[] = $row->$value;
}
} else {
foreach ($this as $row) {
$results[] = $row[$value];
}
}
} elseif ($value === null) {
// Associative rows
if ($this->_as_object) {
foreach ($this as $row) {
$results[$row->$key] = $row;
}
} else {
foreach ($this as $row) {
$results[$row[$key]] = $row;
}
}
} else {
// Associative columns
if ($this->_as_object) {
foreach ($this as $row) {
$results[$row->$key] = $row->$value;
}
} else {
foreach ($this as $row) {
$results[$row[$key]] = $row[$value];
}
}
}
$this->rewind();
return $results;
}Get a cached database result from the current result iterator.
$cachable = serialize($result->cached());
Database_Result_Cachedpublic function cached()
{
return new Database_Result_Cached($this->as_array(), $this->_query, $this->_as_object);
}Implements Countable::count, returns the total number of rows.
echo count($result);
integerpublic function count()
{
return $this->_total_rows;
}Return the named column from the current row.
// Get the "id" value
$id = $result->get('id');
string
$name
required - Column to get mixed
$default
= NULL - Default value if the column does not exist mixedpublic function get($name, $default = null)
{
$row = $this->current();
if ($this->_as_object) {
if (isset($row->$name))
return $row->$name;
}
else {
if (isset($row[$name]))
return $row[$name];
}
return $default;
}Implements Iterator::next, moves to the next row.
next($result);
$thispublic function next()
{
++$this->_current_row;
return $this;
}Implements ArrayAccess::offsetExists, determines if row exists.
if (isset($result[10]))
{
// Row 10 exists
}
int
$offset
required - $offset booleanpublic function offsetExists($offset)
{
return ($offset >= 0 AND $offset < $this->_total_rows);
}Implements ArrayAccess::offsetGet, gets a given row.
$row = $result[10];
int
$offset
required - $offset mixedpublic function offsetGet($offset)
{
if (!$this->seek($offset))
return null;
return $this->current();
}Implements Iterator::key, returns the current row number.
echo key($result);
integerpublic function key()
{
return $this->_current_row;
}Implements ArrayAccess::offsetSet, throws an error.
You cannot modify a database result.
int
$offset
required - $offset mixed
$value
required - $value voidfinal public function offsetSet($offset, $value)
{
throw new Kohana_Exception('Database results are read-only');
}Implements ArrayAccess::offsetUnset, throws an error.
You cannot modify a database result.
int
$offset
required - $offset voidfinal public function offsetUnset($offset)
{
throw new Kohana_Exception('Database results are read-only');
}Implements Iterator::prev, moves to the previous row.
prev($result);
$thispublic function prev()
{
--$this->_current_row;
return $this;
}Implements Iterator::rewind, sets the current row to zero.
rewind($result);
$thispublic function rewind()
{
$this->_current_row = 0;
return $this;
}Implements Iterator::valid, checks if the current row exists.
This method is only used internally.
booleanpublic function valid()
{
return $this->offsetExists($this->_current_row);
}