Inheritance diagram for Zend_Db_Table_Row_Abstract:

Public Member Functions
	__construct (array $config=array())

	__get ($columnName)

	__set ($columnName, $value)

	__unset ($columnName)

	__isset ($columnName)

	__sleep ()

	__wakeup ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	init ()

	getTable ()

	setTable (Zend_Db_Table_Abstract $table=null)

	getTableClass ()

	isConnected ()

	isReadOnly ()

	setReadOnly ($flag)

	select ()

	save ()

	delete ()

	getIterator ()

	toArray ()

	setFromArray (array $data)

	refresh ()

	getPrimaryKey ($useDirty=true)

	findDependentRowset ($dependentTable, $ruleKey=null, Zend_Db_Table_Select $select=null)

	findParentRow ($parentTable, $ruleKey=null, Zend_Db_Table_Select $select=null)

	findManyToManyRowset ($matchTable, $intersectionTable, $callerRefRule=null, $matchRefRule=null, Zend_Db_Table_Select $select=null)

	__call ($method, array $args)

Protected Member Functions
	_transformColumn ($columnName)

	_doInsert ()

	_doUpdate ()

	_getTable ()

	_getPrimaryKey ($useDirty=true)

	_getWhereQuery ($useDirty=true)

	_refresh ()

	_insert ()

	_postInsert ()

	_update ()

	_postUpdate ()

	_delete ()

	_postDelete ()

	_prepareReference (Zend_Db_Table_Abstract $dependentTable, Zend_Db_Table_Abstract $parentTable, $ruleKey)

	_getTableFromString ($tableName)

Protected Attributes
	$_data = array()

	$_cleanData = array()

	$_modifiedFields = array()

	$_table = null

	$_connected = true

	$_readOnly = false

	$_tableClass = null

	$_primary

Detailed Description

Definition at line 35 of file Abstract.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( array $config = array() )

Constructor.

Supported params for $config are:-

table = class name or object of type Zend_Db_Table_Abstract
data = values of columns in this row.

Parameters

array $config OPTIONAL Array of user-specified config options.

Returns: void

Exceptions

Zend_Db_Table_Row_Exception

Definition at line 114 of file Abstract.php.

     {
         if (isset($config['table']) && $config['table'] instanceof Zend_Db_Table_Abstract) {
             $this->_table = $config['table'];
             $this->_tableClass = get_class($this->_table);
         } elseif ($this->_tableClass !== null) {
             $this->_table = $this->_getTableFromString($this->_tableClass);
         }
 
         if (isset($config['data'])) {
             if (!is_array($config['data'])) {
                 #require_once 'Zend/Db/Table/Row/Exception.php';
                 throw new Zend_Db_Table_Row_Exception('Data must be an array');
             }
             $this->_data = $config['data'];
         }
         if (isset($config['stored']) && $config['stored'] === true) {
             $this->_cleanData = $this->_data;
         }
 
         if (isset($config['readOnly']) && $config['readOnly'] === true) {
             $this->setReadOnly(true);
         }
 
         // Retrieve primary keys from table schema
         if (($table = $this->_getTable())) {
             $info = $table->info();
             $this->_primary = (array) $info['primary'];
         }
 
         $this->init();
     }

Member Function Documentation

◆ __call()

__call	(		$method,
		array	$args
	)

Turn magic function calls into non-magic function calls to the above methods.

Parameters

string	$method
array	$args	OPTIONAL Zend_Db_Table_Select query modifier

Returns: Zend_Db_Table_Row_Abstract|Zend_Db_Table_Rowset_Abstract

Exceptions

Zend_Db_Table_Row_Exception If an invalid method is called.

Recognize methods for Has-Many cases: findParent<Class>() findParent<Class>By<Rule>() Use the non-greedy pattern repeat modifier e.g. \w+?

Recognize methods for Many-to-Many cases: find<Class1>Via<Class2>() find<Class1>Via<Class2>By<Rule>() find<Class1>Via<Class2>By<Rule1>And<Rule2>() Use the non-greedy pattern repeat modifier e.g. \w+?

Recognize methods for Belongs-To cases: find<Class>() find<Class>By<Rule>() Use the non-greedy pattern repeat modifier e.g. \w+?

Definition at line 1119 of file Abstract.php.

     {
         $matches = array();
 
         if (count($args) && $args[0] instanceof Zend_Db_Table_Select) {
             $select = $args[0];
         } else {
             $select = null;
         }
 
         if (preg_match('/^findParent(\w+?)(?:By(\w+))?$/', $method, $matches)) {
             $class    = $matches[1];
             $ruleKey1 = isset($matches[2]) ? $matches[2] : null;
             return $this->findParentRow($class, $ruleKey1, $select);
         }
 
         if (preg_match('/^find(\w+?)Via(\w+?)(?:By(\w+?)(?:And(\w+))?)?$/', $method, $matches)) {
             $class    = $matches[1];
             $viaClass = $matches[2];
             $ruleKey1 = isset($matches[3]) ? $matches[3] : null;
             $ruleKey2 = isset($matches[4]) ? $matches[4] : null;
             return $this->findManyToManyRowset($class, $viaClass, $ruleKey1, $ruleKey2, $select);
         }
 
         if (preg_match('/^find(\w+?)(?:By(\w+))?$/', $method, $matches)) {
             $class    = $matches[1];
             $ruleKey1 = isset($matches[2]) ? $matches[2] : null;
             return $this->findDependentRowset($class, $ruleKey1, $select);
         }
 
         #require_once 'Zend/Db/Table/Row/Exception.php';
         throw new Zend_Db_Table_Row_Exception("Unrecognized method '$method()'");
     }

◆ __get()

__get ( $columnName )

Retrieve row field value

Parameters

string $columnName The user-specified column name.

Returns: string The corresponding column value.

Exceptions

Zend_Db_Table_Row_Exception if the $columnName is not a column in the row.

Definition at line 174 of file Abstract.php.

     {
         $columnName = $this->_transformColumn($columnName);
         if (!array_key_exists($columnName, $this->_data)) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Specified column \"$columnName\" is not in the row");
         }
         return $this->_data[$columnName];
     }

◆ __isset()

__isset ( $columnName )

Test existence of row field

Parameters

string $columnName The column key.

Returns: boolean

Definition at line 231 of file Abstract.php.

     {
         $columnName = $this->_transformColumn($columnName);
         return array_key_exists($columnName, $this->_data);
     }

◆ __set()

__set	(	$columnName,
		$value
	)

Set row field value

Parameters

string	$columnName	The column key.
mixed	$value	The value for the property.

Returns: void

Exceptions

Zend_Db_Table_Row_Exception

Definition at line 192 of file Abstract.php.

     {
         $columnName = $this->_transformColumn($columnName);
         if (!array_key_exists($columnName, $this->_data)) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Specified column \"$columnName\" is not in the row");
         }
         $this->_data[$columnName] = $value;
         $this->_modifiedFields[$columnName] = true;
     }

◆ __sleep()

__sleep ( )

Store table, primary key and data in serialized object

Returns: array

Definition at line 242 of file Abstract.php.

     {
         return array('_tableClass', '_primary', '_data', '_cleanData', '_readOnly' ,'_modifiedFields');
     }

◆ __unset()

__unset ( $columnName )

Unset row field value

Parameters

string $columnName The column key.

Returns: Zend_Db_Table_Row_Abstract

Exceptions

Zend_Db_Table_Row_Exception

Definition at line 210 of file Abstract.php.

     {
         $columnName = $this->_transformColumn($columnName);
         if (!array_key_exists($columnName, $this->_data)) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Specified column \"$columnName\" is not in the row");
         }
         if ($this->isConnected() && in_array($columnName, $this->_table->info('primary'))) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Specified column \"$columnName\" is a primary key and should not be unset");
         }
         unset($this->_data[$columnName]);
         return $this;
     }

◆ __wakeup()

__wakeup ( )

Setup to do on wakeup. A de-serialized Row should not be assumed to have access to a live database connection, so set _connected = false.

Returns: void

Definition at line 254 of file Abstract.php.

     {
         $this->_connected = false;
     }

◆ _delete()

_delete ( )

protected

Allows pre-delete logic to be applied to row. Subclasses may override this method.

Returns: void

Definition at line 829 of file Abstract.php.

830 {

831 }

◆ _doInsert()

_doInsert ( )

protected

Returns: mixed The primary key value(s), as an associative array if the key is compound, or a scalar if the key is single-column.

A read-only row cannot be saved.

Run pre-INSERT logic

Execute the INSERT (this may throw an exception)

Normalize the result to an array indexed by primary key column(s). The table insert() method may return a scalar.

Save the new primary key value in _data. The primary key may have been generated by a sequence or auto-increment mechanism, and this merge should be done before the _postInsert() method is run, so the new values are available for logging, etc.

Run post-INSERT logic

Update the _cleanData to reflect that the data has been inserted.

Definition at line 448 of file Abstract.php.

     {
         if ($this->_readOnly === true) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception('This row has been marked read-only');
         }
 
         $this->_insert();
 
         $data = array_intersect_key($this->_data, $this->_modifiedFields);
         $primaryKey = $this->_getTable()->insert($data);
 
         if (is_array($primaryKey)) {
             $newPrimaryKey = $primaryKey;
         } else {
             //ZF-6167 Use tempPrimaryKey temporary to avoid that zend encoding fails.
             $tempPrimaryKey = (array) $this->_primary;
             $newPrimaryKey = array(current($tempPrimaryKey) => $primaryKey);
         }
 
         $this->_data = array_merge($this->_data, $newPrimaryKey);
 
         $this->_postInsert();
 
         $this->_refresh();
 
         return $primaryKey;
     }

◆ _doUpdate()

_doUpdate ( )

protected

Returns: mixed The primary key value(s), as an associative array if the key is compound, or a scalar if the key is single-column.

A read-only row cannot be saved.

Get expressions for a WHERE clause based on the primary key value(s).

Run pre-UPDATE logic

Compare the data to the modified fields array to discover which columns have been changed.

Were any of the changed columns part of the primary key?

Execute cascading updates against dependent tables. Do this only if primary key value(s) were changed.

Execute the UPDATE (this may throw an exception) Do this only if data values were changed. Use the $diffData variable, so the UPDATE statement includes SET terms only for data values that changed.

Run post-UPDATE logic. Do this before the _refresh() so the _postUpdate() function can tell the difference between changed data and clean (pre-changed) data.

Refresh the data just in case triggers in the RDBMS changed any columns. Also this resets the _cleanData.

Return the primary key value(s) as an array if the key is compound or a scalar if the key is a scalar.

Definition at line 506 of file Abstract.php.

     {
         if ($this->_readOnly === true) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception('This row has been marked read-only');
         }
 
         $where = $this->_getWhereQuery(false);
 
         $this->_update();
 
         $diffData = array_intersect_key($this->_data, $this->_modifiedFields);
 
         $pkDiffData = array_intersect_key($diffData, array_flip((array)$this->_primary));
 
         if (count($pkDiffData) > 0) {
             $depTables = $this->_getTable()->getDependentTables();
             if (!empty($depTables)) {
                 $pkNew = $this->_getPrimaryKey(true);
                 $pkOld = $this->_getPrimaryKey(false);
                 foreach ($depTables as $tableClass) {
                     $t = $this->_getTableFromString($tableClass);
                     $t->_cascadeUpdate($this->getTableClass(), $pkOld, $pkNew);
                 }
             }
         }
 
         if (count($diffData) > 0) {
             $this->_getTable()->update($diffData, $where);
         }
 
         $this->_postUpdate();
 
         $this->_refresh();
 
         $primaryKey = $this->_getPrimaryKey(true);
         if (count($primaryKey) == 1) {
             return current($primaryKey);
         }
 
         return $primaryKey;
     }

◆ _getPrimaryKey()

_getPrimaryKey ( $useDirty = true )

protected

Retrieves an associative array of primary keys.

Parameters

bool $useDirty

Returns: array

Definition at line 707 of file Abstract.php.

     {
         if (!is_array($this->_primary)) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("The primary key must be set as an array");
         }
 
         $primary = array_flip($this->_primary);
         if ($useDirty) {
             $array = array_intersect_key($this->_data, $primary);
         } else {
             $array = array_intersect_key($this->_cleanData, $primary);
         }
         if (count($primary) != count($array)) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("The specified Table '$this->_tableClass' does not have the same primary key as the Row");
         }
         return $array;
     }

◆ _getTable()

_getTable ( )

protected

Retrieves an instance of the parent table.

Returns: Zend_Db_Table_Abstract

Definition at line 692 of file Abstract.php.

     {
         if (!$this->_connected) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception('Cannot save a Row unless it is connected');
         }
         return $this->_table;
     }

◆ _getTableFromString()

_getTableFromString ( $tableName )

protected

_getTableFromString

Parameters

string $tableName

Returns: Zend_Db_Table_Abstract

Definition at line 1179 of file Abstract.php.

     {
         return Zend_Db_Table_Abstract::getTableFromString($tableName, $this->_table);
     }

◆ _getWhereQuery()

_getWhereQuery ( $useDirty = true )

protected

Constructs where statement for retrieving row(s).

Parameters

bool $useDirty

Returns: array

Definition at line 744 of file Abstract.php.

     {
         $where = array();
         $db = $this->_getTable()->getAdapter();
         $primaryKey = $this->_getPrimaryKey($useDirty);
         $info = $this->_getTable()->info();
         $metadata = $info[Zend_Db_Table_Abstract::METADATA];
 
         // retrieve recently updated row using primary keys
         $where = array();
         foreach ($primaryKey as $column => $value) {
             $tableName = $db->quoteIdentifier($info[Zend_Db_Table_Abstract::NAME], true);
             $type = $metadata[$column]['DATA_TYPE'];
             $columnName = $db->quoteIdentifier($column, true);
             $where[] = $db->quoteInto("{$tableName}.{$columnName} = ?", $value, $type);
         }
         return $where;
     }

◆ _insert()

_insert ( )

protected

Allows pre-insert logic to be applied to row. Subclasses may override this method.

Returns: void

Definition at line 789 of file Abstract.php.

790 {

791 }

◆ _postDelete()

_postDelete ( )

protected

Allows post-delete logic to be applied to row. Subclasses may override this method.

Returns: void

Definition at line 839 of file Abstract.php.

840 {

841 }

◆ _postInsert()

_postInsert ( )

protected

Allows post-insert logic to be applied to row. Subclasses may override this method.

Returns: void

Definition at line 799 of file Abstract.php.

800 {

801 }

◆ _postUpdate()

_postUpdate ( )

protected

Allows post-update logic to be applied to row. Subclasses may override this method.

Returns: void

Definition at line 819 of file Abstract.php.

820 {

821 }

◆ _prepareReference()

_prepareReference	(	Zend_Db_Table_Abstract	$dependentTable,
		Zend_Db_Table_Abstract	$parentTable,
			$ruleKey
	)

protected

Prepares a table reference for lookup.

Ensures all reference keys are set and properly formatted.

Parameters

Zend_Db_Table_Abstract	$dependentTable
Zend_Db_Table_Abstract	$parentTable
string	$ruleKey

Returns: array

Definition at line 853 of file Abstract.php.

     {
         $parentTableName = (get_class($parentTable) === 'Zend_Db_Table') ? $parentTable->getDefinitionConfigName() : get_class($parentTable);
         $map = $dependentTable->getReference($parentTableName, $ruleKey);
 
         if (!isset($map[Zend_Db_Table_Abstract::REF_COLUMNS])) {
             $parentInfo = $parentTable->info();
             $map[Zend_Db_Table_Abstract::REF_COLUMNS] = array_values((array) $parentInfo['primary']);
         }
 
         $map[Zend_Db_Table_Abstract::COLUMNS] = (array) $map[Zend_Db_Table_Abstract::COLUMNS];
         $map[Zend_Db_Table_Abstract::REF_COLUMNS] = (array) $map[Zend_Db_Table_Abstract::REF_COLUMNS];
 
         return $map;
     }

◆ _refresh()

_refresh ( )

protected

Refreshes properties from the database.

Returns: void

Definition at line 768 of file Abstract.php.

     {
         $where = $this->_getWhereQuery();
         $row = $this->_getTable()->fetchRow($where);
 
         if (null === $row) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception('Cannot refresh row as parent is missing');
         }
 
         $this->_data = $row->toArray();
         $this->_cleanData = $this->_data;
         $this->_modifiedFields = array();
     }

◆ _transformColumn()

_transformColumn ( $columnName )

protected

Transform a column name from the user-specified form to the physical form used in the database. You can override this method in a custom Row class to implement column name mappings, for example inflection.

Parameters

string $columnName Column name given.

Returns: string The column name after transformation applied (none by default).

Exceptions

Zend_Db_Table_Row_Exception if the $columnName is not a string.

Definition at line 157 of file Abstract.php.

     {
         if (!is_string($columnName)) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception('Specified column is not a string');
         }
         // Perform no transformation by default
         return $columnName;
     }

◆ _update()

_update ( )

protected

Allows pre-update logic to be applied to row. Subclasses may override this method.

Returns: void

Definition at line 809 of file Abstract.php.

810 {

811 }

◆ delete()

delete ( )

Deletes existing rows.

Returns: int The number of rows deleted.

A read-only row cannot be deleted.

Execute pre-DELETE logic

Execute cascading deletes against dependent tables

Execute the DELETE (this may throw an exception)

Execute post-DELETE logic

Reset all fields to null to indicate that the row is not there

Definition at line 595 of file Abstract.php.

     {
         if ($this->_readOnly === true) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception('This row has been marked read-only');
         }
 
         $where = $this->_getWhereQuery();
 
         $this->_delete();
 
         $depTables = $this->_getTable()->getDependentTables();
         if (!empty($depTables)) {
             $pk = $this->_getPrimaryKey();
             foreach ($depTables as $tableClass) {
                 $t = $this->_getTableFromString($tableClass);
                 $t->_cascadeDelete($this->getTableClass(), $pk);
             }
         }
 
         $result = $this->_getTable()->delete($where);
 
         $this->_postDelete();
 
         $this->_data = array_combine(
             array_keys($this->_data),
             array_fill(0, count($this->_data), null)
         );
 
         return $result;
     }

◆ findDependentRowset()

findDependentRowset	(		$dependentTable,
			$ruleKey = `null`,
		Zend_Db_Table_Select	$select = `null`
	)

Query a dependent table to retrieve rows matching the current row.

Parameters

string \| Zend_Db_Table_Abstract	$dependentTable
	string	OPTIONAL $ruleKey
	Zend_Db_Table_Select	OPTIONAL $select

Returns: Zend_Db_Table_Rowset_Abstract Query result from $dependentTable

Exceptions

Zend_Db_Table_Row_Exception If $dependentTable is not a table or is not loadable.

Definition at line 878 of file Abstract.php.

     {
         $db = $this->_getTable()->getAdapter();
 
         if (is_string($dependentTable)) {
             $dependentTable = $this->_getTableFromString($dependentTable);
         }
 
         if (!$dependentTable instanceof Zend_Db_Table_Abstract) {
             $type = gettype($dependentTable);
             if ($type == 'object') {
                 $type = get_class($dependentTable);
             }
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Dependent table must be a Zend_Db_Table_Abstract, but it is $type");
         }
 
         // even if we are interacting between a table defined in a class and a
         // table via extension, ensure to persist the definition
         if (($tableDefinition = $this->_table->getDefinition()) !== null
             && ($dependentTable->getDefinition() == null)) {
             $dependentTable->setOptions(array(Zend_Db_Table_Abstract::DEFINITION => $tableDefinition));
         }
 
         if ($select === null) {
             $select = $dependentTable->select();
         } else {
             $select->setTable($dependentTable);
         }
 
         $map = $this->_prepareReference($dependentTable, $this->_getTable(), $ruleKey);
 
         for ($i = 0; $i < count($map[Zend_Db_Table_Abstract::COLUMNS]); ++$i) {
             $parentColumnName = $db->foldCase($map[Zend_Db_Table_Abstract::REF_COLUMNS][$i]);
             $value = $this->_data[$parentColumnName];
             // Use adapter from dependent table to ensure correct query construction
             $dependentDb = $dependentTable->getAdapter();
             $dependentColumnName = $dependentDb->foldCase($map[Zend_Db_Table_Abstract::COLUMNS][$i]);
             $dependentColumn = $dependentDb->quoteIdentifier($dependentColumnName, true);
             $dependentInfo = $dependentTable->info();
             $type = $dependentInfo[Zend_Db_Table_Abstract::METADATA][$dependentColumnName]['DATA_TYPE'];
             $select->where("$dependentColumn = ?", $value, $type);
         }
 
         return $dependentTable->fetchAll($select);
     }

◆ findManyToManyRowset()

findManyToManyRowset	(		$matchTable,
			$intersectionTable,
			$callerRefRule = `null`,
			$matchRefRule = `null`,
		Zend_Db_Table_Select	$select = `null`
	)

Parameters

string \| Zend_Db_Table_Abstract	$matchTable
string \| Zend_Db_Table_Abstract	$intersectionTable
	string	OPTIONAL $callerRefRule
	string	OPTIONAL $matchRefRule
	Zend_Db_Table_Select	OPTIONAL $select

Returns: Zend_Db_Table_Rowset_Abstract Query result from $matchTable

Exceptions

Zend_Db_Table_Row_Exception If $matchTable or $intersectionTable is not a table class or is not loadable.

Definition at line 1001 of file Abstract.php.

     {
         $db = $this->_getTable()->getAdapter();
 
         if (is_string($intersectionTable)) {
             $intersectionTable = $this->_getTableFromString($intersectionTable);
         }
 
         if (!$intersectionTable instanceof Zend_Db_Table_Abstract) {
             $type = gettype($intersectionTable);
             if ($type == 'object') {
                 $type = get_class($intersectionTable);
             }
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Intersection table must be a Zend_Db_Table_Abstract, but it is $type");
         }
 
         // even if we are interacting between a table defined in a class and a
         // table via extension, ensure to persist the definition
         if (($tableDefinition = $this->_table->getDefinition()) !== null
             && ($intersectionTable->getDefinition() == null)) {
             $intersectionTable->setOptions(array(Zend_Db_Table_Abstract::DEFINITION => $tableDefinition));
         }
 
         if (is_string($matchTable)) {
             $matchTable = $this->_getTableFromString($matchTable);
         }
 
         if (! $matchTable instanceof Zend_Db_Table_Abstract) {
             $type = gettype($matchTable);
             if ($type == 'object') {
                 $type = get_class($matchTable);
             }
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Match table must be a Zend_Db_Table_Abstract, but it is $type");
         }
 
         // even if we are interacting between a table defined in a class and a
         // table via extension, ensure to persist the definition
         if (($tableDefinition = $this->_table->getDefinition()) !== null
             && ($matchTable->getDefinition() == null)) {
             $matchTable->setOptions(array(Zend_Db_Table_Abstract::DEFINITION => $tableDefinition));
         }
 
         if ($select === null) {
             $select = $matchTable->select();
         } else {
             $select->setTable($matchTable);
         }
 
         // Use adapter from intersection table to ensure correct query construction
         $interInfo = $intersectionTable->info();
         $interDb   = $intersectionTable->getAdapter();
         $interName = $interInfo['name'];
         $interSchema = isset($interInfo['schema']) ? $interInfo['schema'] : null;
         $matchInfo = $matchTable->info();
         $matchName = $matchInfo['name'];
         $matchSchema = isset($matchInfo['schema']) ? $matchInfo['schema'] : null;
 
         $matchMap = $this->_prepareReference($intersectionTable, $matchTable, $matchRefRule);
 
         for ($i = 0; $i < count($matchMap[Zend_Db_Table_Abstract::COLUMNS]); ++$i) {
             $interCol = $interDb->quoteIdentifier('i' . '.' . $matchMap[Zend_Db_Table_Abstract::COLUMNS][$i], true);
             $matchCol = $interDb->quoteIdentifier('m' . '.' . $matchMap[Zend_Db_Table_Abstract::REF_COLUMNS][$i], true);
             $joinCond[] = "$interCol = $matchCol";
         }
         $joinCond = implode(' AND ', $joinCond);
 
         $select->from(array('i' => $interName), array(), $interSchema)
                ->joinInner(array('m' => $matchName), $joinCond, Zend_Db_Select::SQL_WILDCARD, $matchSchema)
                ->setIntegrityCheck(false);
 
         $callerMap = $this->_prepareReference($intersectionTable, $this->_getTable(), $callerRefRule);
 
         for ($i = 0; $i < count($callerMap[Zend_Db_Table_Abstract::COLUMNS]); ++$i) {
             $callerColumnName = $db->foldCase($callerMap[Zend_Db_Table_Abstract::REF_COLUMNS][$i]);
             $value = $this->_data[$callerColumnName];
             $interColumnName = $interDb->foldCase($callerMap[Zend_Db_Table_Abstract::COLUMNS][$i]);
             $interCol = $interDb->quoteIdentifier("i.$interColumnName", true);
             $interInfo = $intersectionTable->info();
             $type = $interInfo[Zend_Db_Table_Abstract::METADATA][$interColumnName]['DATA_TYPE'];
             $select->where($interDb->quoteInto("$interCol = ?", $value, $type));
         }
 
         $stmt = $select->query();
 
         $config = array(
             'table'    => $matchTable,
             'data'     => $stmt->fetchAll(Zend_Db::FETCH_ASSOC),
             'rowClass' => $matchTable->getRowClass(),
             'readOnly' => false,
             'stored'   => true
         );
 
         $rowsetClass = $matchTable->getRowsetClass();
         if (!class_exists($rowsetClass)) {
             try {
                 #require_once 'Zend/Loader.php';
                 Zend_Loader::loadClass($rowsetClass);
             } catch (Zend_Exception $e) {
                 #require_once 'Zend/Db/Table/Row/Exception.php';
                 throw new Zend_Db_Table_Row_Exception($e->getMessage(), $e->getCode(), $e);
             }
         }
         $rowset = new $rowsetClass($config);
         return $rowset;
     }

◆ findParentRow()

findParentRow	(		$parentTable,
			$ruleKey = `null`,
		Zend_Db_Table_Select	$select = `null`
	)

Query a parent table to retrieve the single row matching the current row.

Parameters

string \| Zend_Db_Table_Abstract	$parentTable
	string	OPTIONAL $ruleKey
	Zend_Db_Table_Select	OPTIONAL $select

Returns: Zend_Db_Table_Row_Abstract Query result from $parentTable

Exceptions

Zend_Db_Table_Row_Exception If $parentTable is not a table or is not loadable.

Definition at line 934 of file Abstract.php.

     {
         $db = $this->_getTable()->getAdapter();
 
         if (is_string($parentTable)) {
             $parentTable = $this->_getTableFromString($parentTable);
         }
 
         if (!$parentTable instanceof Zend_Db_Table_Abstract) {
             $type = gettype($parentTable);
             if ($type == 'object') {
                 $type = get_class($parentTable);
             }
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("Parent table must be a Zend_Db_Table_Abstract, but it is $type");
         }
 
         // even if we are interacting between a table defined in a class and a
         // table via extension, ensure to persist the definition
         if (($tableDefinition = $this->_table->getDefinition()) !== null
             && ($parentTable->getDefinition() == null)) {
             $parentTable->setOptions(array(Zend_Db_Table_Abstract::DEFINITION => $tableDefinition));
         }
 
         if ($select === null) {
             $select = $parentTable->select();
         } else {
             $select->setTable($parentTable);
         }
 
         $map = $this->_prepareReference($this->_getTable(), $parentTable, $ruleKey);
 
         // iterate the map, creating the proper wheres
         for ($i = 0; $i < count($map[Zend_Db_Table_Abstract::COLUMNS]); ++$i) {
             $dependentColumnName = $db->foldCase($map[Zend_Db_Table_Abstract::COLUMNS][$i]);
             $value = $this->_data[$dependentColumnName];
             // Use adapter from parent table to ensure correct query construction
             $parentDb = $parentTable->getAdapter();
             $parentColumnName = $parentDb->foldCase($map[Zend_Db_Table_Abstract::REF_COLUMNS][$i]);
             $parentColumn = $parentDb->quoteIdentifier($parentColumnName, true);
             $parentInfo = $parentTable->info();
 
             // determine where part
             $type     = $parentInfo[Zend_Db_Table_Abstract::METADATA][$parentColumnName]['DATA_TYPE'];
             $nullable = $parentInfo[Zend_Db_Table_Abstract::METADATA][$parentColumnName]['NULLABLE'];
             if ($value === null && $nullable == true) {
                 $select->where("$parentColumn IS NULL");
             } elseif ($value === null && $nullable == false) {
                 return null;
             } else {
                 $select->where("$parentColumn = ?", $value, $type);
             }
 
         }
 
         return $parentTable->fetchRow($select);
     }

◆ getIterator()

getIterator ( )

Definition at line 645 of file Abstract.php.

     {
         return new ArrayIterator((array) $this->_data);
     }

◆ getPrimaryKey()

getPrimaryKey ( $useDirty = true )

Retrieves an associative array of primary keys.

Parameters

bool $useDirty

Returns: array

Definition at line 733 of file Abstract.php.

     {
         return $this->_getPrimaryKey($useDirty);
     }

◆ getTable()

getTable ( )

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

Returns: Zend_Db_Table_Abstract|null

Definition at line 322 of file Abstract.php.

     {
         return $this->_table;
     }

◆ getTableClass()

getTableClass ( )

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

Returns: string

Definition at line 375 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 313 of file Abstract.php.

314 {

315 }

◆ isConnected()

isConnected ( )

Test the connected status of the row.

Returns: boolean

Definition at line 385 of file Abstract.php.

     {
         return $this->_connected;
     }

◆ isReadOnly()

isReadOnly ( )

Test the read-only status of the row.

Returns: boolean

Definition at line 395 of file Abstract.php.

     {
         return $this->_readOnly;
     }

◆ offsetExists()

offsetExists ( $offset )

Proxy to __isset Required by the ArrayAccess implementation

Parameters

string $offset

Returns: boolean

Definition at line 266 of file Abstract.php.

     {
         return $this->__isset($offset);
     }

◆ offsetGet()

offsetGet ( $offset )

Proxy to __get Required by the ArrayAccess implementation

Parameters

string $offset

Returns: string

Definition at line 278 of file Abstract.php.

      {
          return $this->__get($offset);
      }

◆ offsetSet()

offsetSet	(	$offset,
		$value
	)

Proxy to __set Required by the ArrayAccess implementation

Parameters

string	$offset
mixed	$value

Definition at line 290 of file Abstract.php.

      {
          $this->__set($offset, $value);
      }

◆ offsetUnset()

offsetUnset ( $offset )

Proxy to __unset Required by the ArrayAccess implementation

Parameters

string $offset

Definition at line 301 of file Abstract.php.

      {
          return $this->__unset($offset);
      }

◆ refresh()

refresh ( )

Refreshes properties from the database.

Returns: void

Definition at line 682 of file Abstract.php.

     {
         return $this->_refresh();
     }

◆ save()

save ( )

Saves the properties to the database.

This performs an intelligent insert/update, and reloads the properties with fresh data from the table on success.

Returns: mixed The primary key value(s), as an associative array if the key is compound, or a scalar if the key is single-column.

If the _cleanData array is empty, this is an INSERT of a new row. Otherwise it is an UPDATE.

Definition at line 430 of file Abstract.php.

     {
         if (empty($this->_cleanData)) {
             return $this->_doInsert();
         } else {
             return $this->_doUpdate();
         }
     }

◆ select()

select ( )

Returns an instance of the parent table's Zend_Db_Table_Select object.

Returns: Zend_Db_Table_Select

Definition at line 416 of file Abstract.php.

     {
         return $this->getTable()->select();
     }

◆ setFromArray()

setFromArray ( array $data )

Sets all data in the row from an array.

Parameters

array $data

Returns: Zend_Db_Table_Row_Abstract Provides a fluent interface

Definition at line 666 of file Abstract.php.

     {
         $data = array_intersect_key($data, $this->_data);
 
         foreach ($data as $columnName => $value) {
             $this->__set($columnName, $value);
         }
 
         return $this;
     }

◆ setReadOnly()

setReadOnly ( $flag )

Set the read-only status of the row.

Parameters

boolean $flag

Returns: boolean

Definition at line 406 of file Abstract.php.

     {
         $this->_readOnly = (bool) $flag;
     }

◆ setTable()

setTable ( Zend_Db_Table_Abstract $table = null )

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

Parameters

Zend_Db_Table_Abstract $table

Returns: boolean

Exceptions

Zend_Db_Table_Row_Exception

Definition at line 335 of file Abstract.php.

     {
         if ($table == null) {
             $this->_table = null;
             $this->_connected = false;
             return false;
         }
 
         $tableClass = get_class($table);
         if (! $table instanceof $this->_tableClass) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("The specified Table is of class $tableClass, expecting class to be instance of $this->_tableClass");
         }
 
         $this->_table = $table;
         $this->_tableClass = $tableClass;
 
         $info = $this->_table->info();
 
         if ($info['cols'] != array_keys($this->_data)) {
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception('The specified Table does not have the same columns as the Row');
         }
 
         if (! array_intersect((array) $this->_primary, $info['primary']) == (array) $this->_primary) {
 
             #require_once 'Zend/Db/Table/Row/Exception.php';
             throw new Zend_Db_Table_Row_Exception("The specified Table '$tableClass' does not have the same primary key as the Row");
         }
 
         $this->_connected = true;
         return true;
     }

◆ toArray()

toArray ( )

Returns the column/value data as an array.

Returns: array

Definition at line 655 of file Abstract.php.

     {
         return (array)$this->_data;
     }

Field Documentation

◆ $_cleanData

$_cleanData = array()

protected

Definition at line 54 of file Abstract.php.

◆ $_connected

$_connected = true

protected

Definition at line 78 of file Abstract.php.

◆ $_data

$_data = array()

protected

Definition at line 45 of file Abstract.php.

◆ $_modifiedFields

$_modifiedFields = array()

protected

Definition at line 62 of file Abstract.php.

◆ $_primary

$_primary

protected

Definition at line 101 of file Abstract.php.

◆ $_readOnly

$_readOnly = false

protected

Definition at line 87 of file Abstract.php.

◆ $_table

$_table = null

protected

Definition at line 69 of file Abstract.php.

◆ $_tableClass

$_tableClass = null

protected

Definition at line 94 of file Abstract.php.

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

vendor/magento/zendframework1/library/Zend/Db/Table/Row/Abstract.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ __get()

◆ __isset()

◆ __set()

◆ __sleep()

◆ __unset()

◆ __wakeup()

◆ _delete()

◆ _doInsert()

◆ _doUpdate()

◆ _getPrimaryKey()

◆ _getTable()

◆ _getTableFromString()

◆ _getWhereQuery()

◆ _insert()

◆ _postDelete()

◆ _postInsert()

◆ _postUpdate()

◆ _prepareReference()

◆ _refresh()

◆ _transformColumn()

◆ _update()

◆ delete()

◆ findDependentRowset()

◆ findManyToManyRowset()

◆ findParentRow()

◆ getIterator()

◆ getPrimaryKey()

◆ getTable()

◆ getTableClass()

◆ init()

◆ isConnected()

◆ isReadOnly()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ refresh()

◆ save()

◆ select()

◆ setFromArray()

◆ setReadOnly()

◆ setTable()

◆ toArray()

Field Documentation

◆ $_cleanData

◆ $_connected

◆ $_data

◆ $_modifiedFields

◆ $_primary

◆ $_readOnly

◆ $_table

◆ $_tableClass