Zend_Db_Table_Rowset_Abstract Class Reference

Inheritance diagram for Zend_Db_Table_Rowset_Abstract:

Public Member Functions
	__construct (array $config)
	__sleep ()
	__wakeup ()
	init ()
	isConnected ()
	getTable ()
	setTable (Zend_Db_Table_Abstract $table)
	getTableClass ()
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	count ()
	seek ($position)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getRow ($position, $seek=false)
	toArray ()

Protected Member Functions
	_loadAndReturnRow ($position)

Protected Attributes
	$_data = array()
	$_table
	$_connected = true
	$_tableClass
	$_rowClass = 'Zend_Db_Table_Row'
	$_pointer = 0
	$_count
	$_rows = array()
	$_stored = false
	$_readOnly = false

Detailed Description

Definition at line 30 of file Abstract.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$config

)

Constructor.

Parameters

array

$config

Definition at line 105 of file Abstract.php.

    {
        if (isset($config['table'])) {
            $this->_table      = $config['table'];
            $this->_tableClass = get_class($this->_table);
        }
        if (isset($config['rowClass'])) {
            $this->_rowClass   = $config['rowClass'];
        }
        if (!class_exists($this->_rowClass)) {
            #require_once 'Zend/Loader.php';
            Zend_Loader::loadClass($this->_rowClass);
        }
        if (isset($config['data'])) {
            $this->_data       = $config['data'];
        }
        if (isset($config['readOnly'])) {
            $this->_readOnly   = $config['readOnly'];
        }
        if (isset($config['stored'])) {
            $this->_stored     = $config['stored'];
        }

        // set the count of rows
        $this->_count = count($this->_data);

        $this->init();
    }

Member Function Documentation

__sleep()

__sleep

(

)

Store data, class names, and state in serialized object

Returns

array

Definition at line 139 of file Abstract.php.

    {
        return array('_data', '_tableClass', '_rowClass', '_pointer', '_count', '_rows', '_stored',
                     '_readOnly');
    }

__wakeup()

__wakeup

(

)

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.

Returns

void

Definition at line 152 of file Abstract.php.

    {
        $this->_connected = false;
    }

_loadAndReturnRow()

_loadAndReturnRow (   $position )

protected

Definition at line 413 of file Abstract.php.

    {
        if (!isset($this->_data[$position])) {
            #require_once 'Zend/Db/Table/Rowset/Exception.php';
            throw new Zend_Db_Table_Rowset_Exception("Data for provided position does not exist");
        }

        // do we already have a row object for this position?
        if (empty($this->_rows[$position])) {
            $this->_rows[$position] = new $this->_rowClass(
                array(
                    'table'    => $this->_table,
                    'data'     => $this->_data[$position],
                    'stored'   => $this->_stored,
                    'readOnly' => $this->_readOnly
                )
            );

            if ( $this->_table instanceof Zend_Db_Table_Abstract ) {
                $info = $this->_table->info();

                if ( $this->_rows[$position] instanceof Zend_Db_Table_Row_Abstract ) {
                    if ($info['cols'] == array_keys($this->_data[$position])) {
                        $this->_rows[$position]->setTable($this->getTable());
                    }
                }
            } else {
                $this->_rows[$position]->setTable(null);
            }
        }

        // return the row object
        return $this->_rows[$position];
    }

count()

count

(

)

Returns the number of elements in the collection.

Implements Countable::count()

Returns

int

Definition at line 296 of file Abstract.php.

    {
        return $this->_count;
    }

current()

current

(

)

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

Returns

Zend_Db_Table_Row_Abstract current element from the collection

Definition at line 243 of file Abstract.php.

    {
        if ($this->valid() === false) {
            return null;
        }

        // return the row object
        return $this->_loadAndReturnRow($this->_pointer);
    }

getRow()

getRow	(		$position,
			$seek = false
	)

Returns a Zend_Db_Table_Row from a known position into the Iterator

Parameters

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

Returns

Zend_Db_Table_Row

Exceptions

Zend_Db_Table_Rowset_Exception

Definition at line 380 of file Abstract.php.

    {
        try {
            $row = $this->_loadAndReturnRow($position);
        } catch (Zend_Db_Table_Rowset_Exception $e) {
            #require_once 'Zend/Db/Table/Rowset/Exception.php';
            throw new Zend_Db_Table_Rowset_Exception('No row could be found at position ' . (int) $position, 0, $e);
        }

        if ($seek == true) {
            $this->seek($position);
        }

        return $row;
    }

getTable()

getTable

(

)

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

Returns

Zend_Db_Table_Abstract

Definition at line 183 of file Abstract.php.

    {
        return $this->_table;
    }

getTableClass()

getTableClass

(

)

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

Returns

string

Definition at line 218 of file Abstract.php.

    {
        return $this->_tableClass;
    }

init()

init

(

)

Initialize object

Called from __construct() as final step of object instantiation.

Returns

void

Definition at line 164 of file Abstract.php.

    {
    }

isConnected()

isConnected

(

)

Return the connected state of the rowset.

Returns

boolean

Definition at line 173 of file Abstract.php.

    {
        return $this->_connected;
    }

key()

key

(

)

Return the identifying key of the current element. Similar to the key() function for arrays in PHP. Required by interface Iterator.

Returns

int

Definition at line 260 of file Abstract.php.

    {
        return $this->_pointer;
    }

next()

next

(

)

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

Returns

void

Definition at line 272 of file Abstract.php.

    {
        ++$this->_pointer;
    }

offsetExists()

offsetExists

(

$offset

)

Check if an offset exists Required by the ArrayAccess implementation

Parameters

string

$offset

Returns

boolean

Definition at line 327 of file Abstract.php.

    {
        return isset($this->_data[(int) $offset]);
    }

offsetGet()

offsetGet

(

$offset

)

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

Parameters

string

$offset

Returns

Zend_Db_Table_Row_Abstract

Definition at line 339 of file Abstract.php.

    {
        $offset = (int) $offset;
        if ($offset < 0 || $offset >= $this->_count) {
            #require_once 'Zend/Db/Table/Rowset/Exception.php';
            throw new Zend_Db_Table_Rowset_Exception("Illegal index $offset");
        }
        $this->_pointer = $offset;

        return $this->current();
    }

offsetSet()

offsetSet	(		$offset,
			$value
	)

Does nothing Required by the ArrayAccess implementation

Parameters

string	$offset
mixed	$value

Definition at line 358 of file Abstract.php.

    {
    }

offsetUnset()

offsetUnset

(

$offset

)

Does nothing Required by the ArrayAccess implementation

Parameters

string

$offset

Definition at line 368 of file Abstract.php.

    {
    }

rewind()

rewind

(

)

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

Returns

Zend_Db_Table_Rowset_Abstract Fluent interface.

Definition at line 230 of file Abstract.php.

    {
        $this->_pointer = 0;
        return $this;
    }

seek()

seek

(

$position

)

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

Parameters

int

$position

the position to seek to

Returns

Zend_Db_Table_Rowset_Abstract

Exceptions

Zend_Db_Table_Rowset_Exception

Definition at line 309 of file Abstract.php.

    {
        $position = (int) $position;
        if ($position < 0 || $position >= $this->_count) {
            #require_once 'Zend/Db/Table/Rowset/Exception.php';
            throw new Zend_Db_Table_Rowset_Exception("Illegal index $position");
        }
        $this->_pointer = $position;
        return $this;
    }

setTable()

setTable

(

Zend_Db_Table_Abstract

$table

)

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

Parameters

Zend_Db_Table_Abstract

$table

Returns

boolean

Exceptions

Zend_Db_Table_Row_Exception

Definition at line 196 of file Abstract.php.

    {
        $this->_table = $table;
        $this->_connected = false;
        // @todo This works only if we have iterated through
        // the result set once to instantiate the rows.
        foreach ($this as $row) {
            $connected = $row->setTable($table);
            if ($connected == true) {
                $this->_connected = true;
            }
        }
        $this->rewind();
        return $this->_connected;
    }

toArray()

toArray

(

)

Returns all data as an array.

Updates the $_data property with current row object values.

Returns

array

Definition at line 403 of file Abstract.php.

    {
        // @todo This works only if we have iterated through
        // the result set once to instantiate the rows.
        foreach ($this->_rows as $i => $row) {
            $this->_data[$i] = $row->toArray();
        }
        return $this->_data;
    }

valid()

valid

(

)

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

bool False if there's nothing more to iterate over

Definition at line 284 of file Abstract.php.

    {
        return $this->_pointer >= 0 && $this->_pointer < $this->_count;
    }

Field Documentation

$_connected

$_connected = true

protected

Definition at line 53 of file Abstract.php.

$_count

$_count

protected

Definition at line 81 of file Abstract.php.

$_data

$_data = array()

protected

Definition at line 37 of file Abstract.php.

$_pointer

$_pointer = 0

protected

Definition at line 74 of file Abstract.php.

$_readOnly

$_readOnly = false

protected

Definition at line 98 of file Abstract.php.

$_rowClass

$_rowClass = 'Zend_Db_Table_Row'

protected

Definition at line 67 of file Abstract.php.

$_rows

$_rows = array()

protected

Definition at line 88 of file Abstract.php.

$_stored

$_stored = false

protected

Definition at line 93 of file Abstract.php.

$_table

$_table

protected

Definition at line 44 of file Abstract.php.

$_tableClass

$_tableClass

protected

Definition at line 60 of file Abstract.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Db/Table/Rowset/Abstract.php