Db/Table/Rowset/Abstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Db
subpackage: Table
version: $Id: Abstract.php 22616 2010-07-17 15:53:16Z ramon $
Classes: Zend_Db_Table_Rowset_Abstract

Description

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 license@zend.com so we can send you a copy immediately.

Zend_Db_Table_Rowset_Abstract
jump to top

Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Db
subpackage: Table
Properties: $_data; $_table; $_connected; $_tableClass; $_rowClass; $_pointer; $_count; $_rows; $_stored; $_readOnly
Methods: __construct; __sleep; __wakeup; init; isConnected; getTable; setTable; getTableClass; rewind; current; key; next; valid; count; seek; offsetExists; offsetGet; offsetSet; offsetUnset; getRow; toArray

Description

Properties

$_connected
jump to class

boolean $_connected = 'true'

Connected is true if we have a reference to a live Zend_Db_Table_Abstract object.

This is false after the Rowset has been deserialized.

Details

$_connected: boolean
visibility: protected
default: true
final: false
static: false

$_count
jump to class

integer $_count = ''

How many data rows there are.

Details

$_count: integer
visibility: protected
default
final: false
static: false

$_data
jump to class

array $_data = 'array'

The original data for each row.

Details

$_data: array
visibility: protected
default: array
final: false
static: false

$_pointer
jump to class

integer $_pointer = '0'

Iterator pointer.

Details

$_pointer: integer
visibility: protected
default: 0
final: false
static: false

$_readOnly
jump to class

boolean $_readOnly = 'false'

Details

$_readOnly: boolean
visibility: protected
default: false
final: false
static: false

$_rowClass
jump to class

string $_rowClass = 'Zend_Db_Table_Row'

Zend_Db_Table_Row_Abstract class name.

Details

$_rowClass: string
visibility: protected
default: Zend_Db_Table_Row
final: false
static: false

$_rows
jump to class

array $_rows = 'array'

Collection of instantiated Zend_Db_Table_Row objects.

Details

$_rows: array
visibility: protected
default: array
final: false
static: false

$_stored
jump to class

boolean $_stored = 'false'

Details

$_stored: boolean
visibility: protected
default: false
final: false
static: false

$_table
jump to class

Zend_Db_Table_Abstract $_table = ''

Zend_Db_Table_Abstract object.

Details

$_table: Zend_Db_Table_Abstract
visibility: protected
default
final: false
static: false

$_tableClass
jump to class

string $_tableClass = ''

Zend_Db_Table_Abstract class name.

Details

$_tableClass: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $config
          )
        
        :

Constructor.

Arguments

$config: array

Details

visibility: public
final: false
static: false

__sleep
jump to class

__sleep(
          
          )
        
        :
        array

Store data, class names, and state in serialized object

Output

array

Details

visibility: public
final: false
static: false

__wakeup
jump to class

__wakeup(
          
          )
        
        :
        void

Setup to do on wakeup.

A de-serialized Rowset should not be assumed to have access to a live database connection, so set _connected = false.

Details

visibility: public
final: false
static: false

count
jump to class

Returns the number of elements in the collection.

Implements Countable::count()

Output

int

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        Zend_Db_Table_Row_Abstract

Return the current element.

Similar to the current() function for arrays in PHP Required by interface Iterator.

Output

Zend_Db_Table_Row_Abstract: current element from the collection

Details

visibility: public
final: false
static: false

getRow
jump to class

getRow(
          int $position, bool $seek
              =
              false
          )
        
        :
        Zend_Db_Table_Row

Returns a Zend_Db_Table_Row from a known position into the Iterator

Arguments

$position: int
the position of the row expected
$seek: bool
wether or not seek the iterator to that position after

Output

Zend_Db_Table_Row

Details

visibility: public
final: false
static: false
throws

getTable
jump to class

getTable(
          
          )
        
        :
        Zend_Db_Table_Abstract

Returns the table object, or null if this is disconnected rowset

Output

Zend_Db_Table_Abstract

Details

visibility: public
final: false
static: false

getTableClass
jump to class

getTableClass(
          
          )
        
        :
        string

Query the class name of the Table object for which this Rowset was created.

Output

string

Details

visibility: public
final: false
static: false

init
jump to class

Initialize object

Called from {@link __construct()} as final step of object instantiation.

Details

visibility: public
final: false
static: false

isConnected
jump to class

isConnected(
          
          )
        
        :
        boolean

Return the connected state of the rowset.

Output

boolean

Details

visibility: public
final: false
static: false

key
jump to class

Return the identifying key of the current element.

Similar to the key() function for arrays in PHP. Required by interface Iterator.

Output

int

Details

visibility: public
final: false
static: false

next
jump to class

Move forward to next element.

Similar to the next() function for arrays in PHP. Required by interface Iterator.

Details

visibility: public
final: false
static: false

offsetExists
jump to class

offsetExists(
          string $offset
          )
        
        :
        boolean

Check if an offset exists Required by the ArrayAccess implementation

Arguments

$offset: string

Output

boolean

Details

visibility: public
final: false
static: false

offsetGet
jump to class

offsetGet(
          string $offset
          )
        
        :
        Zend_Db_Table_Row_Abstract

Get the row for the given offset Required by the ArrayAccess implementation

Arguments

$offset: string

Output

Zend_Db_Table_Row_Abstract

Details

visibility: public
final: false
static: false

offsetSet
jump to class

offsetSet(
          string $offset, mixed $value
          )
        
        :

Does nothing Required by the ArrayAccess implementation

Arguments

$offset: string
$value: mixed

Details

visibility: public
final: false
static: false

offsetUnset
jump to class

offsetUnset(
          string $offset
          )
        
        :

Does nothing Required by the ArrayAccess implementation

Arguments

$offset: string

Details

visibility: public
final: false
static: false

rewind
jump to class

rewind(
          
          )
        
        :
        Zend_Db_Table_Rowset_Abstract

Rewind the Iterator to the first element.

Similar to the reset() function for arrays in PHP. Required by interface Iterator.

Output

Zend_Db_Table_Rowset_Abstract: Fluent interface.

Details

visibility: public
final: false
static: false

seek
jump to class

seek(
          int $position
          )
        
        :
        Zend_Db_Table_Rowset_Abstract

Take the Iterator to position $position Required by interface SeekableIterator.

Arguments

$position: int
the position to seek to

Output

Zend_Db_Table_Rowset_Abstract

Details

visibility: public
final: false
static: false
throws

setTable
jump to class

setTable(
          Zend_Db_Table_Abstract $table
          )
        
        :
        boolean

Set the table object, to re-establish a live connection to the database for a Rowset that has been de-serialized.

Arguments

$table: Zend_Db_Table_Abstract

Output

boolean

Details

visibility: public
final: false
static: false
throws

toArray
jump to class

toArray(
          
          )
        
        :
        array

Returns all data as an array.

Updates the $_data property with current row object values.

Output

array

Details

visibility: public
final: false
static: false

valid
jump to class

Check 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.

Output

bool: False if there's nothing more to iterate over

Details

visibility: public
final: false
static: false

API Documentation

Db/Table/Rowset/Abstract.php

Description

Zend_Db_Table_Rowset_Abstractjump to top

Description

Properties

$_connectedjump to class

Details

$_countjump to class

Details

$_datajump to class

Details

$_pointerjump to class

Details

$_readOnlyjump to class

Details

$_rowClassjump to class

Details

$_rowsjump to class

Details

$_storedjump to class

Details

$_tablejump to class

Details

$_tableClassjump to class

Details

Methods

__constructjump to class

Arguments

Details

__sleepjump to class

Output

Details

__wakeupjump to class

Details

countjump to class

Output

Details

currentjump to class

Output

Details

getRowjump to class

Arguments

Output

Details

getTablejump to class

Output

Details

getTableClassjump to class

Output

Details

initjump to class

Details

isConnectedjump to class

Output

Details

keyjump to class

Output

Details

nextjump to class

Details

offsetExistsjump to class

Arguments

Output

Details

offsetGetjump to class

Arguments

Output

Details

offsetSetjump to class

Arguments

Details

offsetUnsetjump to class

Arguments

Details

rewindjump to class

Output

Details

seekjump to class

Arguments

Zend_Db_Table_Rowset_Abstract
jump to top

$_connected
jump to class

$_count
jump to class

$_data
jump to class

$_pointer
jump to class

$_readOnly
jump to class

$_rowClass
jump to class

$_rows
jump to class

$_stored
jump to class

$_table
jump to class

$_tableClass
jump to class

__construct
jump to class

__sleep
jump to class

__wakeup
jump to class

count
jump to class

current
jump to class

getRow
jump to class

getTable
jump to class

getTableClass
jump to class

init
jump to class

isConnected
jump to class

key
jump to class

next
jump to class

offsetExists
jump to class

offsetGet
jump to class

offsetSet
jump to class

offsetUnset
jump to class

rewind
jump to class

seek
jump to class

setTable
jump to class

toArray
jump to class

valid
jump to class