Db/Table/Rowset/Abstract.php
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Db
- Subpackage
- Table
- Version
- $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Db_Table_Rowset_Abstract
- Implements
- Children
- \Zend_Db_Table_Rowset
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
boolean $_connected = trueConnected is true if we have a reference to a live Zend_Db_Table_Abstract object.
This is false after the Rowset has been deserialized.
trueDetails- Type
- boolean
integer $_count = How many data rows there are.
- Type
- integer
array $_data = array()The original data for each row.
array()Details- Type
- array
integer $_pointer = 0Iterator pointer.
0Details- Type
- integer
boolean $_readOnly = falsefalseDetails- Type
- boolean
string $_rowClass = 'Zend_Db_Table_Row'Zend_Db_Table_Row_Abstract class name.
'Zend_Db_Table_Row'Details- Type
- string
array $_rows = array()Collection of instantiated Zend_Db_Table_Row objects.
array()Details- Type
- array
boolean $_stored = falsefalseDetails- Type
- boolean
\Zend_Db_Table_Abstract $_table = Zend_Db_Table_Abstract object.
string $_tableClass = Zend_Db_Table_Abstract class name.
- Type
- string
Methods
__construct(array $config) : voidConstructor.
| Name | Type | Description |
|---|---|---|
| $config | array |
__sleep() : arrayStore data, class names, and state in serialized object
| Type | Description |
|---|---|
| array |
__wakeup() : voidSetup to do on wakeup.
A de-serialized Rowset should not be assumed to have access to a live database connection, so set _connected = false.
_loadAndReturnRow( $position) : void| Name | Type | Description |
|---|---|---|
| $position |
count() : intReturns the number of elements in the collection.
Implements Countable::count()
| Type | Description |
|---|---|
| int |
current() : \Zend_Db_Table_Row_AbstractReturn the current element.
Similar to the current() function for arrays in PHP Required by interface Iterator.
| Type | Description |
|---|---|
| \Zend_Db_Table_Row_Abstract | current element from the collection |
getRow(int $position, bool $seek = false) : \Zend_Db_Table_RowReturns a Zend_Db_Table_Row from a known position into the Iterator
| Name | Type | Description |
|---|---|---|
| $position | int | the position of the row expected |
| $seek | bool | wether or not seek the iterator to that position after |
| Type | Description |
|---|---|
| \Zend_Db_Table_Row |
| Exception | Description |
|---|---|
| \Zend_Db_Table_Rowset_Exception |
getTable() : \Zend_Db_Table_AbstractReturns the table object, or null if this is disconnected rowset
| Type | Description |
|---|---|
| \Zend_Db_Table_Abstract |
getTableClass() : stringQuery the class name of the Table object for which this Rowset was created.
| Type | Description |
|---|---|
| string |
isConnected() : booleanReturn the connected state of the rowset.
| Type | Description |
|---|---|
| boolean |
key() : intReturn the identifying key of the current element.
Similar to the key() function for arrays in PHP. Required by interface Iterator.
| Type | Description |
|---|---|
| int |
next() : voidMove forward to next element.
Similar to the next() function for arrays in PHP. Required by interface Iterator.
offsetExists(string $offset) : booleanCheck if an offset exists Required by the ArrayAccess implementation
| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| boolean |
offsetGet(string $offset) : \Zend_Db_Table_Row_AbstractGet the row for the given offset Required by the ArrayAccess implementation
| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| \Zend_Db_Table_Row_Abstract |
offsetSet(string $offset, mixed $value) : voidDoes nothing Required by the ArrayAccess implementation
| Name | Type | Description |
|---|---|---|
| $offset | string | |
| $value | mixed |
offsetUnset(string $offset) : voidDoes nothing Required by the ArrayAccess implementation
| Name | Type | Description |
|---|---|---|
| $offset | string |
rewind() : \Zend_Db_Table_Rowset_AbstractRewind the Iterator to the first element.
Similar to the reset() function for arrays in PHP. Required by interface Iterator.
| Type | Description |
|---|---|
| \Zend_Db_Table_Rowset_Abstract | Fluent interface. |
seek(int $position) : \Zend_Db_Table_Rowset_AbstractTake the Iterator to position $position Required by interface SeekableIterator.
| Name | Type | Description |
|---|---|---|
| $position | int | the position to seek to |
| Type | Description |
|---|---|
| \Zend_Db_Table_Rowset_Abstract |
| Exception | Description |
|---|---|
| \Zend_Db_Table_Rowset_Exception |
setTable(\Zend_Db_Table_Abstract $table) : booleanSet the table object, to re-establish a live connection to the database for a Rowset that has been de-serialized.
| Name | Type | Description |
|---|---|---|
| $table | \Zend_Db_Table_Abstract |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Db_Table_Row_Exception |
toArray() : arrayReturns all data as an array.
Updates the $_data property with current row object values.
| Type | Description |
|---|---|
| array |
valid() : boolCheck if there is a current element after calls to rewind() or next().
Used to check if we've iterated to the end of the collection. Required by interface Iterator.
| Type | Description |
|---|---|
| bool | False if there's nothing more to iterate over |