lib-model-om
[ class tree: lib-model-om ] [ index: lib-model-om ] [ all elements ]

Class: BaseEtvaNodePeer

Source Location: /om/BaseEtvaNodePeer.php

Class Overview


Base static class for performing query and update operations on the 'node' table.


Author(s):

Variables

Constants

Methods


Child classes:

EtvaNodePeer
Base static class for performing query and update operations on the 'node' table.

Class Details

[line 14]
Base static class for performing query and update operations on the 'node' table.

This class was autogenerated by Propel 1.3.0-dev on:

Thu Jun 25 10:03:35 2009




Tags:

abstract:  


[ Top ]


Class Variables

static $instances = array()

[line 73]

An identiy map to hold any loaded instances of EtvaNode objects.

This must be public so that other peer classes can access this when hydrating from JOIN queries.




Tags:

var:  EtvaNode[]
access:  public

Type:   array


[ Top ]



Class Methods


static method addInstanceToPool [line 346]

static void addInstanceToPool( EtvaNode $obj, [string $key = null], EtvaNode $value)

Adds an object to the instance pool.

Propel keeps cached copies of objects in an instance pool when they are retrieved from the database. In some cases -- especially when you override doSelect*() methods in your stub classes -- you may need to explicitly add objects to the cache in order to ensure that the same objects are always returned by doSelect*() and retrieveByPK*() calls.




Tags:

access:  public


Parameters:

EtvaNode   $value   A EtvaNode object.
string   $key   (optional) key to use for instance map (for performance boost if key was already calculated externally).
EtvaNode   $obj  

[ Top ]

static method addSelectColumns [line 185]

static void addSelectColumns( $criteria)

Add all the columns needed to create a new object.

Note: any columns that were marked with lazyLoad="true" in the XML schema will not be added to the select list and only loaded on demand.




Tags:

throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

criteria   $criteria   object containing the columns to add.

[ Top ]

static method alias [line 169]

static string alias( string $alias, string $column)

Convenience method which changes table.column to alias.column.

Using this method you can maintain SQL abstraction while using column aliases.

  1.         $c->addAlias("alias1"TablePeer::TABLE_NAME);
  2.         $c->addJoin(TablePeer::alias("alias1"TablePeer::PRIMARY_KEY_COLUMN)TablePeer::PRIMARY_KEY_COLUMN);




Tags:

access:  public


Parameters:

string   $alias   The alias for the current table.
string   $column   The column name for current table. (i.e. EtvaNodePeer::COLUMN_NAME).

[ Top ]

static method clearInstancePool [line 408]

static void clearInstancePool( )

Clear the instance pool.



Tags:

access:  public


[ Top ]

static method doCount [line 222]

static int doCount( $criteria, [boolean $distinct = false], [ $con = null])

Returns the number of rows matching criteria.



Tags:

return:  Number of matching rows.
access:  public


Parameters:

Criteria   $criteria  
boolean   $distinct   Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO   $con  

[ Top ]

static method doDelete [line 644]

static int doDelete( mixed $values, [ $con = null])

Method perform a DELETE on the database, given a EtvaNode or Criteria object OR a primary key value.



Tags:

return:  The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows if supported by native driver or if emulated using Propel.
throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

mixed   $values   Criteria or EtvaNode object or primary key or array of primary keys which is used to create the DELETE statement
PropelPDO   $con   the connection to use

[ Top ]

static method doDeleteAll [line 614]

static int doDeleteAll( [ $con = null])

Method to DELETE all rows from the node table.



Tags:

return:  The number of affected rows (if supported by underlying database driver).
access:  public


Parameters:

   $con  

[ Top ]

static method doInsert [line 505]

static mixed doInsert( mixed $values, [ $con = null])

Method perform an INSERT on the database, given a EtvaNode or Criteria object.



Tags:

return:  The new primary key.
throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

mixed   $values   Criteria or EtvaNode object containing data that is used to create the INSERT statement.
PropelPDO   $con   the PropelPDO connection to use

[ Top ]

static method doSelect [line 293]

static array doSelect( $criteria, [ $con = null])

Method to do selects.



Tags:

return:  Array of selected Objects
throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

Criteria   $criteria   The Criteria object used to build the SELECT statement.
PropelPDO   $con  

[ Top ]

static method doSelectOne [line 274]

static EtvaNode doSelectOne( $criteria, [ $con = null])

Method to select one object from the DB.



Tags:

throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

Criteria   $criteria   object used to create the SELECT statement.
PropelPDO   $con  

[ Top ]

static method doSelectStmt [line 310]

static PDOStatement doSelectStmt( $criteria, [ $con = null])

Prepares the Criteria object and uses the parent doSelect() method to execute a PDOStatement.

Use this method directly if you want to work with an executed statement durirectly (for example to perform your own object hydration).




Tags:

return:  The executed PDOStatement object.
see:  BasePeer::doSelect()
throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

Criteria   $criteria   The Criteria object used to build the SELECT statement.
PropelPDO   $con   The connection to use

[ Top ]

static method doUpdate [line 565]

static int doUpdate( mixed $values, [ $con = null])

Method perform an UPDATE on the database, given a EtvaNode or Criteria object.



Tags:

return:  The number of affected rows (if supported by underlying database driver).
throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

mixed   $values   Criteria or EtvaNode object containing data that is used to create the UPDATE statement.
PropelPDO   $con   The connection to use (specify PropelPDO connection object to exert more control over transactions).

[ Top ]

static method doValidate [line 709]

static mixed doValidate( EtvaNode $obj, [mixed $cols = null])

Validates all modified columns of given EtvaNode object.

If parameter $columns is either a single column name or an array of column names than only those columns are validated.

NOTICE: This does not apply to primary or foreign keys for now.




Tags:

return:  TRUE if all columns are valid or the error message of the first invalid column.
access:  public


Parameters:

EtvaNode   $obj   The object to validate.
mixed   $cols   Column name or array of column names.

[ Top ]

static method getFieldNames [line 149]

static array getFieldNames( [string $type = BasePeer::TYPE_PHPNAME])

Returns an array of field names.



Tags:

return:  A list of field names
access:  public


Parameters:

string   $type   The type of fieldnames to return: One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM

[ Top ]

static method getInstanceFromPool [line 393]

static EtvaNode getInstanceFromPool( string $key)

Retrieves a string version of the primary key from the DB resultset row that can be used to uniquely identify a row in this table.

For tables with a single-column primary key, that simple pkey value will be returned. For tables with a multi-column primary key, a serialize()d version of the primary key will be returned.




Tags:

return:  Found object or NULL if 1) no instance exists for specified key or 2) instance pooling has been disabled.
see:  getPrimaryKeyHash()
access:  public


Parameters:

string   $key   The key (@see getPrimaryKeyHash()) for this instance.

[ Top ]

static method getMapBuilder [line 113]

static MapBuilder getMapBuilder( )

Get a (singleton) instance of the MapBuilder for this peer class.



Tags:

return:  The map builder for this peer
access:  public


[ Top ]

static method getOMClass [line 491]

static string getOMClass( )

The class that the Peer will make instances of.

This uses a dot-path notation which is tranalted into a path relative to a location on the PHP include_path. (e.g. path.to.MyClass -> 'path/to/MyClass.php')




Tags:

return:  path.to.ClassName
access:  public


[ Top ]

static method getPrimaryKeyHashFromRow [line 423]

static string getPrimaryKeyHashFromRow( array $row, [int $startcol = 0])

Retrieves a string version of the primary key from the DB resultset row that can be used to uniquely identify a row in this table.

For tables with a single-column primary key, that simple pkey value will be returned. For tables with a multi-column primary key, a serialize()d version of the primary key will be returned.




Tags:

return:  A string version of PK or NULL if the components of primary key in result array are all null.
access:  public


Parameters:

array   $row   PropelPDO resultset row.
int   $startcol   The 0-based offset for reading from the resultset row.

[ Top ]

static method getTableMap [line 477]

static TableMap getTableMap( )

Returns the TableMap related to this peer.

This method is not needed for general use but a specific application could have a need.




Tags:

throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


[ Top ]

static method getUniqueColumnNames [line 466]

static void getUniqueColumnNames( )



Tags:

access:  public


[ Top ]

static method populateObjects [line 439]

static void populateObjects( $stmt)

The returned array will contain objects of the default type or objects that inherit from the default.



Tags:

throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

PDOStatement   $stmt  

[ Top ]

static method removeInstanceFromPool [line 366]

static void removeInstanceFromPool( mixed $value)

Removes an object from the instance pool.

Propel keeps cached copies of objects in an instance pool when they are retrieved from the database. In some cases -- especially when you override doDelete methods in your stub classes -- you may need to explicitly remove objects from the cache in order to prevent returning objects that no longer exist.




Tags:

access:  public


Parameters:

mixed   $value   A EtvaNode object or a primary key value.

[ Top ]

static method retrieveByPK [line 749]

static EtvaNode retrieveByPK( int $pk, [ $con = null])

Retrieve a single object by pkey.



Tags:

access:  public


Parameters:

int   $pk   the primary key.
PropelPDO   $con   the connection to use

[ Top ]

static method retrieveByPKs [line 776]

static void retrieveByPKs( array $pks, [ $con = null])

Retrieve multiple objects by pkey.



Tags:

throws:  PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.
access:  public


Parameters:

array   $pks   List of primary keys
PropelPDO   $con   the connection to use

[ Top ]

static method translateFieldName [line 130]

static string translateFieldName( string $name, string $fromType, string $toType)

Translates a fieldname to another type



Tags:

return:  translated name of the field.
throws:  PropelException - if the specified name could not be found in the fieldname mappings.
access:  public


Parameters:

string   $name   field name
string   $fromType   One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM
string   $toType   One of the class type constants

[ Top ]


Class Constants

CLASS_DEFAULT =  'lib.model.EtvaNode'

[line 23]

A class that can be returned by this peer.


[ Top ]

CPUTOTAL =  'node.CPUTOTAL'

[line 44]

the column name for the CPUTOTAL field


[ Top ]

CREATED_AT =  'node.CREATED_AT'

[line 62]

the column name for the CREATED_AT field


[ Top ]

DATABASE_NAME =  'propel'

[line 17]

the default database name for this class


[ Top ]

ID =  'node.ID'

[line 32]

the column name for the ID field


[ Top ]

IP =  'node.IP'

[line 47]

the column name for the IP field


[ Top ]

MEMFREE =  'node.MEMFREE'

[line 41]

the column name for the MEMFREE field


[ Top ]

MEMTOTAL =  'node.MEMTOTAL'

[line 38]

the column name for the MEMTOTAL field


[ Top ]

NAME =  'node.NAME'

[line 35]

the column name for the NAME field


[ Top ]

NETWORK_CARDS =  'node.NETWORK_CARDS'

[line 56]

the column name for the NETWORK_CARDS field


[ Top ]

NUM_COLUMNS =  12

[line 26]

The total number of columns.


[ Top ]

NUM_LAZY_LOAD_COLUMNS =  0

[line 29]

The number of lazy-loaded columns.


[ Top ]

PORT =  'node.PORT'

[line 50]

the column name for the PORT field


[ Top ]

STATE =  'node.STATE'

[line 59]

the column name for the STATE field


[ Top ]

TABLE_NAME =  'node'

[line 20]

the table name for this class


[ Top ]

UID =  'node.UID'

[line 53]

the column name for the UID field


[ Top ]

UPDATED_AT =  'node.UPDATED_AT'

[line 65]

the column name for the UPDATED_AT field


[ Top ]



Documentation generated on Mon, 29 Jun 2009 15:10:14 +0100 by phpDocumentor 1.4.2