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

Class: BaseEtvaVncTokensPeer

Source Location: /om/BaseEtvaVncTokensPeer.php

Class Overview


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


Author(s):

Variables

Constants

Methods



Class Details

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

This class was autogenerated by Propel 1.3.0-dev on:

Thu Jun 18 11:27:25 2009




Tags:

abstract:  


[ Top ]


Class Variables

static $instances = array()

[line 52]

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

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




Tags:

var:  EtvaVncTokens[]
access:  public

Type:   array


[ Top ]



Class Methods


static method addInstanceToPool [line 311]

static void addInstanceToPool( $obj, [string $key = null], EtvaVncTokens $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:

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

[ Top ]

static method addSelectColumns [line 164]

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 148]

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. EtvaVncTokensPeer::COLUMN_NAME).

[ Top ]

static method clearInstancePool [line 373]

static void clearInstancePool( )

Clear the instance pool.



Tags:

access:  public


[ Top ]

static method doCount [line 187]

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 doCountJoinAll [line 571]

static int doCountJoinAll( $criteria, [boolean $distinct = false], [ $con = null], [String $join_behavior = Criteria::LEFT_JOIN], Criteria $c)

Returns the number of rows matching criteria, joining all related tables



Tags:

return:  Number of matching rows.
access:  public


Parameters:

Criteria   $c  
boolean   $distinct   Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO   $con  
String   $join_behavior   the type of joins to use, defaults to Criteria::LEFT_JOIN
Criteria   $criteria  

[ Top ]

static method doCountJoinsfGuardUser [line 440]

static int doCountJoinsfGuardUser( $criteria, [boolean $distinct = false], [ $con = null], [String $join_behavior = Criteria::LEFT_JOIN], Criteria $c)

Returns the number of rows matching criteria, joining the related sfGuardUser table



Tags:

return:  Number of matching rows.
access:  public


Parameters:

Criteria   $c  
boolean   $distinct   Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO   $con  
String   $join_behavior   the type of joins to use, defaults to Criteria::LEFT_JOIN
Criteria   $criteria  

[ Top ]

static method doDelete [line 869]

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

Method perform a DELETE on the database, given a EtvaVncTokens 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 EtvaVncTokens 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 839]

static int doDeleteAll( [ $con = null])

Method to DELETE all rows from the vnc_tokens table.



Tags:

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


Parameters:

   $con  

[ Top ]

static method doInsert [line 734]

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

Method perform an INSERT on the database, given a EtvaVncTokens 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 EtvaVncTokens object containing data that is used to create the INSERT statement.
PropelPDO   $con   the PropelPDO connection to use

[ Top ]

static method doSelect [line 258]

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 doSelectJoinAll [line 627]

static array doSelectJoinAll( $c, [PropelPDO $con = null], [String $join_behavior = Criteria::LEFT_JOIN])

Selects a collection of EtvaVncTokens objects pre-filled with all related objects.



Tags:

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


Parameters:

Criteria   $c  
PropelPDO   $con  
String   $join_behavior   the type of joins to use, defaults to Criteria::LEFT_JOIN

[ Top ]

static method doSelectJoinsfGuardUser [line 497]

static array doSelectJoinsfGuardUser( $c, [PropelPDO $con = null], [String $join_behavior = Criteria::LEFT_JOIN])

Selects a collection of EtvaVncTokens objects pre-filled with their sfGuardUser objects.



Tags:

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


Parameters:

Criteria   $c  
PropelPDO   $con  
String   $join_behavior   the type of joins to use, defaults to Criteria::LEFT_JOIN

[ Top ]

static method doSelectOne [line 239]

static EtvaVncTokens 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 275]

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 790]

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

Method perform an UPDATE on the database, given a EtvaVncTokens 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 EtvaVncTokens 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 934]

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

Validates all modified columns of given EtvaVncTokens 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:

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

[ Top ]

static method getFieldNames [line 128]

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 358]

static EtvaVncTokens 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 92]

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 720]

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 388]

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 706]

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 695]

static void getUniqueColumnNames( )



Tags:

access:  public


[ Top ]

static method populateObjects [line 404]

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 331]

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 EtvaVncTokens object or a primary key value.

[ Top ]

static method retrieveByPK [line 974]

static EtvaVncTokens retrieveByPK( string $pk, [ $con = null])

Retrieve a single object by pkey.



Tags:

access:  public


Parameters:

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

[ Top ]

static method retrieveByPKs [line 1001]

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 109]

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.EtvaVncTokens'

[line 23]

A class that can be returned by this peer.


[ Top ]

DATABASE_NAME =  'propel'

[line 17]

the default database name for this class


[ Top ]

DATE =  'vnc_tokens.DATE'

[line 41]

the column name for the DATE field


[ Top ]

ENCTOKEN =  'vnc_tokens.ENCTOKEN'

[line 38]

the column name for the ENCTOKEN field


[ Top ]

NUM_COLUMNS =  5

[line 26]

The total number of columns.


[ Top ]

NUM_LAZY_LOAD_COLUMNS =  0

[line 29]

The number of lazy-loaded columns.


[ Top ]

TABLE_NAME =  'vnc_tokens'

[line 20]

the table name for this class


[ Top ]

TOKEN =  'vnc_tokens.TOKEN'

[line 35]

the column name for the TOKEN field


[ Top ]

USERNAME =  'vnc_tokens.USERNAME'

[line 32]

the column name for the USERNAME field


[ Top ]

USER_ID =  'vnc_tokens.USER_ID'

[line 44]

the column name for the USER_ID field


[ Top ]



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