Db/Table/Rowset/Abstract.php

Show:

inherited

Classes
- \Zend_Db_Table_Rowset_Abstract

Table of Contents

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Db
Subpackage: Table
Version: $Id$

\Zend_Db_Table_Rowset_Abstract
jump to top

Package: Zend_Db\Table

Implements
Children: \Zend_Db_Table_Rowset
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

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.

Default valuetrueDetails

Type: boolean

integer $_count

How many data rows there are.

Details

Type: integer

array $_data = array()

The original data for each row.

Default valuearray()Details

Type: array

integer $_pointer = 0

Iterator pointer.

Default value0Details

Type: integer

boolean $_readOnly = false

Default valuefalseDetails

Type: boolean

string $_rowClass = 'Zend_Db_Table_Row'

Zend_Db_Table_Row_Abstract class name.

Default value'Zend_Db_Table_Row'Details

Type: string

array $_rows = array()

Collection of instantiated Zend_Db_Table_Row objects.

Default valuearray()Details

Type: array

boolean $_stored = false

Default valuefalseDetails

Type: boolean

\Zend_Db_Table_Abstract $_table

Zend_Db_Table_Abstract object.

Details

Type: \Zend_Db_Table_Abstract

string $_tableClass

Zend_Db_Table_Abstract class name.

Details

Type: string

Methods

__construct(array $config) : void

Constructor.

Parameters

Name	Type	Description
$config	array

__sleep() : array

Store data, class names, and state in serialized object

Returns

Type	Description
array

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

_loadAndReturnRow( $position) : void

Parameters

Name	Type	Description
$position

count() : int

Returns the number of elements in the collection.

Implements Countable::count()

Returns

Type	Description
int

current() : \Zend_Db_Table_Row_Abstract

Return the current element.

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

Returns

Type	Description
\Zend_Db_Table_Row_Abstract	current element from the collection

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

Returns a Zend_Db_Table_Row from a known position into the Iterator

Parameters

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

Returns

Type	Description
\Zend_Db_Table_Row

Throws

Exception	Description
\Zend_Db_Table_Rowset_Exception

getTable() : \Zend_Db_Table_Abstract

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

Returns

Type	Description
\Zend_Db_Table_Abstract

getTableClass() : string

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

Returns

Type	Description
string

init() : void

Initialize object

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

isConnected() : boolean

Return the connected state of the rowset.

Returns

Type	Description
boolean

key() : int

Return the identifying key of the current element.

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

Returns

Type	Description
int

next() : void

Move forward to next element.

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

offsetExists(string $offset) : boolean

Check if an offset exists Required by the ArrayAccess implementation

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
boolean

offsetGet(string $offset) : \Zend_Db_Table_Row_Abstract

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

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
\Zend_Db_Table_Row_Abstract

offsetSet(string $offset, mixed $value) : void

Does nothing Required by the ArrayAccess implementation

Parameters

Name	Type	Description
$offset	string
$value	mixed

offsetUnset(string $offset) : void

Does nothing Required by the ArrayAccess implementation

Parameters

Name	Type	Description
$offset	string

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.

Returns

Type	Description
\Zend_Db_Table_Rowset_Abstract	Fluent interface.

seek(int $position) : \Zend_Db_Table_Rowset_Abstract

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

Parameters

Name	Type	Description
$position	int	the position to seek to

Returns

Type	Description
\Zend_Db_Table_Rowset_Abstract

Throws

Exception	Description
\Zend_Db_Table_Rowset_Exception

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.

Parameters

Name	Type	Description
$table	\Zend_Db_Table_Abstract

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Db_Table_Row_Exception

toArray() : array

Returns all data as an array.

Updates the $_data property with current row object values.

Returns

Type	Description
array

valid() : bool

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.

Returns

Type	Description
bool	False if there's nothing more to iterate over

Db/Table/Rowset/Abstract.php

\Zend_Db_Table_Rowset_Abstractjump to top

Properties

Methods

\Zend_Db_Table_Rowset_Abstract
jump to top