• Home
• Zend_Db_Table_Abstract

PHP Class Zend_Db_Table_Abstract

Show file Open project: dbpatch/dbpatch Class Usage Examples

Protected Properties

Property	Type	Description
$_cols	array	The table column names derived from Zend_Db_Adapter_Abstract::describeTable().
$_db	Zend_Db_Adapter_Abstract	Zend_Db_Adapter_Abstract object.
$_defaultDb	Zend_Db_Adapter_Abstract	Default Zend_Db_Adapter_Abstract object.
$_defaultMetadataCache	Zend_Cache_Core	Default cache for information provided by the adapter's describeTable() method.
$_defaultSource
$_defaultValues
$_definition	unknown_type	Optional Zend_Db_Table_Definition object
$_definitionConfigName	string	Optional definition config name used in concrete implementation
$_dependentTables	array	Array elements are not table names; they are class names of classes that extend Zend_Db_Table_Abstract.
$_identity	integer	Note this index is the position of the column in the primary key, not the position of the column in the table. The primary key array is 1-based.
$_metadata	array	Information provided by the adapter's describeTable() method.
$_metadataCache	Zend_Cache_Core	Cache for information provided by the adapter's describeTable() method.
$_metadataCacheInClass	boolean	Flag: whether or not to cache metadata in the class
$_name	string	The table name.
$_primary	mixed	A compound key should be declared as an array. You may declare a single-column primary key as a string.
$_referenceMap	array	This array has one entry per foreign key in the current table. Each key is a mnemonic name for one reference rule. Each value is also an associative array, with the following keys: - columns = array of names of column(s) in the child table. - refTableClass = class name of the parent table. - refColumns = array of names of column(s) in the parent table, in the same order as those in the 'columns' entry. - onDelete = "cascade" means that a delete in the parent table also causes a delete of referencing rows in the child table. - onUpdate = "cascade" means that an update of primary key values in the parent table also causes an update of referencing rows in the child table.
$_rowClass	string	Classname for row
$_rowsetClass	string	Classname for rowset
$_schema	array	The schema name (default null means current schema)
$_sequence	mixed	May be a string, boolean true, or boolean false.

Public Methods

Method	Description
__construct ( mixed $config = [] ) : void	Constructor.
_cascadeDelete ( string $parentTableClassname, array $primaryKey ) : integer	Called by parent table's class during delete() method.
_cascadeUpdate ( string $parentTableClassname, array $oldPrimaryKey, array $newPrimaryKey ) : integer	Called by a row object for the parent table's class during save() method.
addReference ( string $ruleKey, string | array $columns, string $refTableClass, string | array $refColumns, string $onDelete = null, string $onUpdate = null ) : Zend_Db_Table_Abstract	Add a reference to the reference map
createRow ( array $data = [], string $defaultSource = null ) : Zend_Db_Table_Row_Abstract	Fetches a new blank row (not from the database).
delete ( array | string $where ) : integer	Deletes existing rows.
fetchAll ( string | array | Zend_Db_Table_Select $where = null, string | array $order = null, integer $count = null, integer $offset = null ) : Zend_Db_Table_Rowset_Abstract	Fetches all rows.
fetchNew ( ) : Zend_Db_Table_Row_Abstract	Fetches a new blank row (not from the database).
fetchRow ( string | array | Zend_Db_Table_Select $where = null, string | array $order = null, integer $offset = null ) : Zend_Db_Table_Row_Abstract | null	Fetches one row in an object of type Zend_Db_Table_Row_Abstract, or returns null if no row matches the specified criteria.
find ( ) : Zend_Db_Table_Rowset_Abstract	Fetches rows by primary key. The argument specifies one or more primary key value(s). To find multiple rows by primary key, the argument must be an array.
getAdapter ( ) : Zend_Db_Adapter_Abstract	Gets the Zend_Db_Adapter_Abstract for this particular Zend_Db_Table object.
getDefaultAdapter ( ) : Zend_Db_Adapter_Abstract	Gets the default Zend_Db_Adapter_Abstract for all Zend_Db_Table objects.
getDefaultMetadataCache ( ) : Zend_Cache_Core	Gets the default metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
getDefaultSource ( ) : unknown	returns the default source flag that determines where defaultSources come from
getDefaultValues ( )
getDefinition ( ) : Zend_Db_Table_Definition | null	getDefinition()
getDefinitionConfigName ( ) : string	getDefinitionConfigName()
getDependentTables ( ) : array
getMetadataCache ( ) : Zend_Cache_Core	Gets the metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
getReference ( string $tableClassname, string $ruleKey = null ) : array
getRowClass ( ) : string
getRowsetClass ( ) : string
info ( string $key = null ) : mixed	Returns table information.
init ( ) : void	Initialize object
insert ( array $data ) : mixed	Inserts a new row.
isIdentity ( string $column ) : boolean	Check if the provided column is an identity of the table
metadataCacheInClass ( ) : boolean	Retrieve flag indicating if metadata should be cached for duration of instance
select ( boolean $withFromPart = self::SELECT_WITHOUT_FROM_PART ) : Zend_Db_Table_Select	Returns an instance of a Zend_Db_Table_Select object.
setDefaultAdapter ( mixed $db = null ) : void	Sets the default Zend_Db_Adapter_Abstract for all Zend_Db_Table objects.
setDefaultMetadataCache ( mixed $metadataCache = null ) : void	Sets the default metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
setDefaultSource ( string $defaultSource = self::DEFAULT_NONE ) : Zend_Db_Table_Abstract	set the defaultSource property - this tells the table class where to find default values
setDefaultValues ( array $defaultValues ) : Zend_Db_Table_Abstract	set the default values for the table class
setDefinition ( Zend_Db_Table_Definition $definition ) : Zend_Db_Table_Abstract	setDefinition()
setDefinitionConfigName ( $definitionConfigName ) : Zend_Db_Table_Abstract	setDefinitionConfigName()
setDependentTables ( array $dependentTables ) : Zend_Db_Table_Abstract
setMetadataCacheInClass ( boolean $flag ) : Zend_Db_Table_Abstract	Indicate whether metadata should be cached in the class for the duration of the instance
setOptions ( array $options ) : Zend_Db_Table_Abstract	setOptions()
setReferences ( array $referenceMap ) : Zend_Db_Table_Abstract
setRowClass ( string $classname ) : Zend_Db_Table_Abstract
setRowsetClass ( string $classname ) : Zend_Db_Table_Abstract
update ( array $data, array | string $where ) : integer	Updates existing rows.

Protected Methods

Method	Description
_fetch ( Zend_Db_Table_Select $select ) : array	Support method for fetching rows.
_getCols ( ) : array	Retrieve table columns
_getReferenceMapNormalized ( ) : array	Returns a normalized version of the reference map
_order ( Zend_Db_Table_Select $select, string | array $order ) : Zend_Db_Table_Select	Generate ORDER clause from user-supplied string or array
_setAdapter ( mixed $db ) : Zend_Db_Table_Abstract
_setMetadataCache ( mixed $metadataCache ) : Zend_Db_Table_Abstract	Sets the metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
_setSequence ( mixed $sequence ) : Zend_Db_Table_Adapter_Abstract	Sets the sequence member, which defines the behavior for generating primary key values in new rows.
_setup ( ) : void	Turnkey for initialization of a table object.
_setupAdapter ( mixed $db ) : Zend_Db_Adapter_Abstract
_setupDatabaseAdapter ( ) : void	Initialize database adapter.
_setupMetadata ( ) : boolean	Initializes metadata.
_setupMetadataCache ( mixed $metadataCache ) : Zend_Cache_Core
_setupPrimaryKey ( ) : void	Initialize primary key from metadata.
_setupTableName ( ) : void	Initialize table and schema names.
_where ( Zend_Db_Table_Select $select, string | array $where ) : Zend_Db_Table_Select	Generate WHERE clause from user-supplied string or array

Method Details

Property Details