Db/Table/Row/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 22230 2010-05-21 20:59:18Z ralph $
Classes: Zend_Db_Table_Row_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_Row_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; $_cleanData; $_modifiedFields; $_table; $_connected; $_readOnly; $_tableClass; $_primary
Methods: __construct; _transformColumn; __get; __set; __unset; __isset; __sleep; __wakeup; offsetExists; offsetGet; offsetSet; offsetUnset; init; getTable; setTable; getTableClass; isConnected; isReadOnly; setReadOnly; select; save; _doInsert; _doUpdate; delete; getIterator; toArray; setFromArray; refresh; _getTable; _getPrimaryKey; _getWhereQuery; _refresh; _insert; _postInsert; _update; _postUpdate; _delete; _postDelete; _prepareReference; findDependentRowset; findParentRow; findManyToManyRowset; __call; _getTableFromString

Description

Properties

$_cleanData
jump to class

array $_cleanData = 'array'

This is set to a copy of $_data when the data is fetched from a database, specified as a new tuple in the constructor, or when dirty data is posted to the database with save().

Details

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

$_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

$_data
jump to class

array $_data = 'array'

The data for each column in the row (column_name => value).

The keys must match the physical names of columns in the table for which this row is defined.

Details

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

$_modifiedFields
jump to class

array $_modifiedFields = 'array'

Tracks columns where data has been updated. Allows more specific insert and update operations.

Details

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

$_primary
jump to class

array $_primary = ''

Primary row key(s).

Details

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

$_readOnly
jump to class

boolean $_readOnly = 'false'

A row is marked read only if it contains columns that are not physically represented within the database schema (e.g. evaluated columns/Zend_Db_Expr columns). This can also be passed as a run-time config options as a means of protecting row data.

Details

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

$_table
jump to class

Zend_Db_Table_Abstract $_table = 'null'

Zend_Db_Table_Abstract parent class or instance.

Details

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

$_tableClass
jump to class

string $_tableClass = 'null'

Name of the class of the Zend_Db_Table_Abstract object.

Details

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

Methods

__call
jump to class

__call(
          string $method, array $args
          )
        
        :
        Zend_Db_Table_Row_Abstract|Zend_Db_Table_Rowset_Abstract

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

Arguments

$method: string
$args: array
OPTIONAL Zend_Db_Table_Select query modifier

Output

Zend_Db_Table_Row_Abstract|Zend_Db_Table_Rowset_Abstract

Details

visibility: public
final: false
static: false
throws: If an invalid method is called.

__construct
jump to class

__construct(
          array $config
              =
              array
          )
        
        :
        void

Constructor.

Supported params for $config are:- - table = class name or object of type Zend_Db_Table_Abstract - data = values of columns in this row.

Arguments

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

Details

visibility: public
final: false
static: false
throws

__get
jump to class

__get(
          string $columnName
          )
        
        :
        string

Retrieve row field value

Arguments

$columnName: string
The user-specified column name.

Output

string: The corresponding column value.

Details

visibility: public
final: false
static: false
throws: if the $columnName is not a column in the row.

__isset
jump to class

__isset(
          string $columnName
          )
        
        :
        boolean

Test existence of row field

Arguments

$columnName: string
The column key.

Output

boolean

Details

visibility: public
final: false
static: false

__set
jump to class

__set(
          string $columnName, mixed $value
          )
        
        :
        void

Set row field value

Arguments

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

Details

visibility: public
final: false
static: false
throws

__sleep
jump to class

__sleep(
          
          )
        
        :
        array

Store table, primary key and data in serialized object

Output

array

Details

visibility: public
final: false
static: false

__unset
jump to class

__unset(
          string $columnName
          )
        
        :
        Zend_Db_Table_Row_Abstract

Unset row field value

Arguments

$columnName: string
The column key.

Output

Zend_Db_Table_Row_Abstract

Details

visibility: public
final: false
static: false
throws

__wakeup
jump to class

__wakeup(
          
          )
        
        :
        void

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.

Details

visibility: public
final: false
static: false

_delete
jump to class

_delete(
          
          )
        
        :
        void

Allows pre-delete logic to be applied to row.

Subclasses may override this method.

Details

visibility: protected
final: false
static: false

_doInsert
jump to class

_doInsert(
          
          )
        
        :
        mixed

Output

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

Details

visibility: protected
final: false
static: false

_doUpdate
jump to class

_doUpdate(
          
          )
        
        :
        mixed

Output

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

Details

visibility: protected
final: false
static: false

_getPrimaryKey
jump to class

_getPrimaryKey(
          bool $useDirty
              =
              true
          )
        
        :
        array

Retrieves an associative array of primary keys.

Arguments

$useDirty: bool

Output

array

Details

visibility: protected
final: false
static: false

_getTable
jump to class

_getTable(
          
          )
        
        :
        Zend_Db_Table_Abstract

Retrieves an instance of the parent table.

Output

Zend_Db_Table_Abstract

Details

visibility: protected
final: false
static: false

_getTableFromString
jump to class

_getTableFromString(
          string $tableName
          )
        
        :
        Zend_Db_Table_Abstract

_getTableFromString

Arguments

$tableName: string

Output

Zend_Db_Table_Abstract

Details

visibility: protected
final: false
static: false

_getWhereQuery
jump to class

_getWhereQuery(
          bool $useDirty
              =
              true
          )
        
        :
        array

Constructs where statement for retrieving row(s).

Arguments

$useDirty: bool

Output

array

Details

visibility: protected
final: false
static: false

_insert
jump to class

_insert(
          
          )
        
        :
        void

Allows pre-insert logic to be applied to row.

Subclasses may override this method.

Details

visibility: protected
final: false
static: false

_postDelete
jump to class

_postDelete(
          
          )
        
        :
        void

Allows post-delete logic to be applied to row.

Subclasses may override this method.

Details

visibility: protected
final: false
static: false

_postInsert
jump to class

_postInsert(
          
          )
        
        :
        void

Allows post-insert logic to be applied to row.

Subclasses may override this method.

Details

visibility: protected
final: false
static: false

_postUpdate
jump to class

_postUpdate(
          
          )
        
        :
        void

Allows post-update logic to be applied to row.

Subclasses may override this method.

Details

visibility: protected
final: false
static: false

_prepareReference
jump to class

_prepareReference(
          Zend_Db_Table_Abstract $dependentTable, Zend_Db_Table_Abstract $parentTable, string $ruleKey
          )
        
        :
        array

Prepares a table reference for lookup.

Ensures all reference keys are set and properly formatted.

Arguments

$dependentTable: Zend_Db_Table_Abstract
$parentTable: Zend_Db_Table_Abstract
$ruleKey: string

Output

array

Details

visibility: protected
final: false
static: false

_refresh
jump to class

_refresh(
          
          )
        
        :
        void

Refreshes properties from the database.

Details

visibility: protected
final: false
static: false

_transformColumn
jump to class

_transformColumn(
          string $columnName
          )
        
        :
        string

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.

Arguments

$columnName: string
Column name given.

Output

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

Details

visibility: protected
final: false
static: false
throws: if the $columnName is not a string.

_update
jump to class

_update(
          
          )
        
        :
        void

Allows pre-update logic to be applied to row.

Subclasses may override this method.

Details

visibility: protected
final: false
static: false

delete
jump to class

Deletes existing rows.

Output

int: The number of rows deleted.

Details

visibility: public
final: false
static: false

findDependentRowset
jump to class

findDependentRowset(
          string|Zend_Db_Table_Abstract $dependentTable, string $ruleKey
              =
              null, Zend_Db_Table_Select $select
              =
              null
          )
        
        :
        Zend_Db_Table_Rowset_Abstract

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

Arguments

$dependentTable: stringZend_Db_Table_Abstract
$ruleKey: string
OPTIONAL $ruleKey
$select: Zend_Db_Table_Select
OPTIONAL $select

Output

Zend_Db_Table_Rowset_Abstract: Query result from $dependentTable

Details

visibility: public
final: false
static: false
throws: If $dependentTable is not a table or is not loadable.

findManyToManyRowset
jump to class

findManyToManyRowset(
          string|Zend_Db_Table_Abstract $matchTable, string|Zend_Db_Table_Abstract $intersectionTable, string $callerRefRule
              =
              null, string $matchRefRule
              =
              null, Zend_Db_Table_Select $select
              =
              null
          )
        
        :
        Zend_Db_Table_Rowset_Abstract

Arguments

$matchTable: stringZend_Db_Table_Abstract
$intersectionTable: stringZend_Db_Table_Abstract
$callerRefRule: string
OPTIONAL $callerRefRule
$matchRefRule: string
OPTIONAL $matchRefRule
$select: Zend_Db_Table_Select
OPTIONAL $select

Output

Zend_Db_Table_Rowset_Abstract: Query result from $matchTable

Details

visibility: public
final: false
static: false
throws: If $matchTable or $intersectionTable is not a table class or is not loadable.

findParentRow
jump to class

findParentRow(
          string|Zend_Db_Table_Abstract $parentTable, string $ruleKey
              =
              null, Zend_Db_Table_Select $select
              =
              null
          )
        
        :
        Zend_Db_Table_Row_Abstract

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

Arguments

$parentTable: stringZend_Db_Table_Abstract
$ruleKey: string
OPTIONAL $ruleKey
$select: Zend_Db_Table_Select
OPTIONAL $select

Output

Zend_Db_Table_Row_Abstract: Query result from $parentTable

Details

visibility: public
final: false
static: false
throws: If $parentTable is not a table or is not loadable.

getIterator
jump to class

getIterator(
          
          )
        
        :

Details

visibility: public
final: false
static: false

getTable
jump to class

getTable(
          
          )
        
        :
        Zend_Db_Table_Abstract|null

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

Output

Zend_Db_Table_Abstract|null

Details

visibility: public
final: false
static: false

getTableClass
jump to class

getTableClass(
          
          )
        
        :
        string

Query the class name of the Table object for which this Row 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

Test the connected status of the row.

Output

boolean

Details

visibility: public
final: false
static: false

isReadOnly
jump to class

isReadOnly(
          
          )
        
        :
        boolean

Test the read-only status of the row.

Output

boolean

Details

visibility: public
final: false
static: false

offsetExists
jump to class

offsetExists(
          string $offset
          )
        
        :
        boolean

Proxy to __isset Required by the ArrayAccess implementation

Arguments

$offset: string

Output

boolean

Details

visibility: public
final: false
static: false

offsetGet
jump to class

offsetGet(
          string $offset
          )
        
        :
        string

Proxy to __get Required by the ArrayAccess implementation

Arguments

$offset: string

Output

string

Details

visibility: public
final: false
static: false

offsetSet
jump to class

offsetSet(
          string $offset, mixed $value
          )
        
        :

Proxy to __set Required by the ArrayAccess implementation

Arguments

$offset: string
$value: mixed

Details

visibility: public
final: false
static: false

offsetUnset
jump to class

offsetUnset(
          string $offset
          )
        
        :

Proxy to __unset Required by the ArrayAccess implementation

Arguments

$offset: string

Details

visibility: public
final: false
static: false

refresh
jump to class

refresh(
          
          )
        
        :
        void

Refreshes properties from the database.

Details

visibility: public
final: false
static: false

save
jump to class

Saves the properties to the database.

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

Output

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

Details

visibility: public
final: false
static: false

select
jump to class

select(
          
          )
        
        :
        Zend_Db_Table_Select

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

Output

Zend_Db_Table_Select

Details

visibility: public
final: false
static: false

setFromArray
jump to class

setFromArray(
          array $data
          )
        
        :
        Zend_Db_Table_Row_Abstract

Sets all data in the row from an array.

Arguments

$data: array

Output

Zend_Db_Table_Row_Abstract: Provides a fluent interface

Details

visibility: public
final: false
static: false

setReadOnly
jump to class

setReadOnly(
          boolean $flag
          )
        
        :
        boolean

Set the read-only status of the row.

Arguments

$flag: boolean

Output

boolean

Details

visibility: public
final: false
static: false

setTable
jump to class

setTable(
          Zend_Db_Table_Abstract $table
              =
              null
          )
        
        :
        boolean

Set the table object, to re-establish a live connection to the database for a Row 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 the column/value data as an array.

Output

array

Details

visibility: public
final: false
static: false

API Documentation

Db/Table/Row/Abstract.php

Description

Zend_Db_Table_Row_Abstractjump to top

Description

Properties

$_cleanDatajump to class

Details

$_connectedjump to class

Details

$_datajump to class

Details

$_modifiedFieldsjump to class

Details

$_primaryjump to class

Details

$_readOnlyjump to class

Details

$_tablejump to class

Details

$_tableClassjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__sleepjump to class

Output

Details

__unsetjump to class

Arguments

Output

Details

__wakeupjump to class

Details

_deletejump to class

Details

_doInsertjump to class

Output

Details

_doUpdatejump to class

Output

Details

_getPrimaryKeyjump to class

Arguments

Output

Details

_getTablejump to class

Output

Details

_getTableFromStringjump to class

Arguments

Output

Details

_getWhereQueryjump to class

Arguments

Output

Details

_insertjump to class

Details

_postDeletejump to class

Details

_postInsertjump to class

Details

_postUpdatejump to class

Zend_Db_Table_Row_Abstract
jump to top

$_cleanData
jump to class

$_connected
jump to class

$_data
jump to class

$_modifiedFields
jump to class

$_primary
jump to class

$_readOnly
jump to class

$_table
jump to class

$_tableClass
jump to class

__call
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__sleep
jump to class

__unset
jump to class

__wakeup
jump to class

_delete
jump to class

_doInsert
jump to class

_doUpdate
jump to class

_getPrimaryKey
jump to class

_getTable
jump to class

_getTableFromString
jump to class

_getWhereQuery
jump to class

_insert
jump to class

_postDelete
jump to class

_postInsert
jump to class

_postUpdate
jump to class

_prepareReference
jump to class

_refresh
jump to class

_transformColumn
jump to class

_update
jump to class

delete
jump to class

findDependentRowset
jump to class

findManyToManyRowset
jump to class

findParentRow
jump to class

getIterator
jump to class

getTable
jump to class

getTableClass
jump to class

init
jump to class

isConnected
jump to class

isReadOnly
jump to class

offsetExists
jump to class

offsetGet
jump to class

offsetSet
jump to class

offsetUnset
jump to class

refresh
jump to class

save
jump to class

select
jump to class

setFromArray
jump to class