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

Class: BaseEtvaVncToken

Source Location: /om/BaseEtvaVncToken.php

Class Overview

BaseObject
   |
   --BaseEtvaVncToken

Base class that represents a row from the 'vnc_token' table.


Author(s):

Variables

Constants

Methods


Child classes:

EtvaVncToken
Base class that represents a row from the 'vnc_token' table.

Class Details

[line 14]
Base class that represents a row from the 'vnc_token' 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 $peer =

[line 25]

The Peer class.

Instance provides a convenient way of calling static methods on a class that calling code may not be able to identify.




Tags:

access:  protected

Type:   EtvaVncTokenPeer


[ Top ]

$alreadyInSave =  false

[line 67]

Flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.



Tags:

access:  protected

Type:   boolean


[ Top ]

$alreadyInValidation =  false

[line 74]

Flag to prevent endless validation loop, if this object is referenced by another object which falls in this transaction.



Tags:

access:  protected

Type:   boolean


[ Top ]

$asfGuardUser =

[line 60]



Tags:

access:  protected

Type:   sfGuardUser


[ Top ]

$created_at =

[line 55]

The value for the created_at field.



Tags:

access:  protected

Type:   string


[ Top ]

$enctoken =

[line 43]

The value for the enctoken field.



Tags:

access:  protected

Type:   string


[ Top ]

$token =

[line 37]

The value for the token field.



Tags:

access:  protected

Type:   string


[ Top ]

$username =

[line 31]

The value for the username field.



Tags:

access:  protected

Type:   string


[ Top ]

$user_id =

[line 49]

The value for the user_id field.



Tags:

access:  protected

Type:   int


[ Top ]

$validationFailures = array()

[line 581]

Array of ValidationFailed objects.



Tags:

var:  ValidationFailed[]
access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 80]

BaseEtvaVncToken __construct( )

Initializes internal state of BaseEtvaVncToken object.



Tags:

see:  applyDefaults()
access:  public


[ Top ]

method applyDefaultValues [line 92]

void applyDefaultValues( )

Applies default values to this object.

This method should be called from the object's constructor (or equivalent initialization method).




Tags:

see:  BaseEtvaVncToken::__construct()
access:  public


[ Top ]

method buildCriteria [line 810]

Criteria buildCriteria( )

Build a Criteria object containing the values of all modified columns in this object.



Tags:

return:  The Criteria object containing all modified values.
access:  public


[ Top ]

method buildPkeyCriteria [line 831]

Criteria buildPkeyCriteria( )

Builds a Criteria object containing the primary key for this object.

Unlike buildCriteria() this method includes the primary key values regardless of whether or not they have been modified.




Tags:

return:  The Criteria object containing value(s) for primary key(s).
access:  public


[ Top ]

method clearAllReferences [line 986]

void clearAllReferences( [boolean $deep = false])

Resets all collections of referencing foreign keys.

This method is a user-space workaround for PHP's inability to garbage collect objects with circular references. This is currently necessary when using Propel in certain daemon or large-volumne/high-memory operations.




Tags:

access:  public


Parameters:

boolean   $deep   Whether to also clear the references on all associated objects.

[ Top ]

method copy [line 900]

EtvaVncToken copy( [boolean $deepCopy = false])

Makes a copy of this object that will be inserted as a new row in table when saved.

It creates a new object filling in the simple attributes, but skipping any primary keys that are defined for the table.

If desired, this method can also make copies of all associated (fkey referrers) objects.




Tags:

return:  Clone of current object.
throws:  PropelException
access:  public


Parameters:

boolean   $deepCopy   Whether to also copy all rows that refer (by fkey) to the current row.

[ Top ]

method copyInto [line 870]

void copyInto( object $copyObj, [boolean $deepCopy = false])

Sets contents of passed object to values from current object.

If desired, this method can also make copies of all associated (fkey referrers) objects.




Tags:

throws:  PropelException
access:  public


Parameters:

object   $copyObj   An object of EtvaVncToken (or compatible) type.
boolean   $deepCopy   Whether to also copy all rows that refer (by fkey) to the current row.

[ Top ]

method delete [line 431]

void delete( [ $con = null])

Removes this object from datastore and sets delete attribute.



Tags:

see:  BaseObject::isDeleted()
see:  BaseObject::setDeleted()
throws:  PropelException
access:  public


Parameters:

PropelPDO   $con  

[ Top ]

method doSave [line 536]

int doSave( $con)

Performs the work of inserting or updating the row in the database.

If the object is new, it inserts it; otherwise an update is performed. All related objects are also updated in this method.




Tags:

return:  The number of rows affected by this insert/update and any referring fk objects' save() operations.
see:  BaseEtvaVncToken::save()
throws:  PropelException
access:  protected


Parameters:

PropelPDO   $con  

[ Top ]

method doValidate [line 628]

mixed doValidate( [array $columns = null])

This function performs the validation work for complex object models.

In addition to checking the current object, all related objects will also be validated. If all pass then

  1. true
is returned; otherwise an aggreagated array of ValidationFailed objects will be returned.




Tags:

return:  
  1. true
if all validations pass; array of
  1. ValidationFailed
objets otherwise.
access:  protected


Parameters:

array   $columns   Array of column names to validate.

[ Top ]

method ensureConsistency [line 373]

void ensureConsistency( )

Checks and repairs the internal consistency of the object.

This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.

You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.




Tags:

throws:  PropelException
access:  public


[ Top ]

method fromArray [line 794]

void fromArray( array $arr, [string $keyType = BasePeer::TYPE_PHPNAME])

Populates the object using an array.

This is particularly useful when populating an object from one of the request arrays (e.g. $_POST). This method goes through the column names, checking to see whether a matching key exists in populated array. If so the setByName() method is called for that column.

You can specify the key type of the array by additionally passing one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. The default key type is the column's phpname (e.g. 'AuthorId')




Tags:

access:  public


Parameters:

array   $arr   An array to populate the object from.
string   $keyType   The type of keys the array uses.

[ Top ]

method getByName [line 670]

mixed getByName( string $name, [string $type = BasePeer::TYPE_PHPNAME])

Retrieves a field from the object by name passed in as a string.



Tags:

return:  Value of field.
access:  public


Parameters:

string   $name   name
string   $type   The type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM

[ Top ]

method getByPosition [line 684]

mixed getByPosition( int $pos)

Retrieves a field from the object by Position as specified in the xml schema.

Zero-based.




Tags:

return:  Value of field at $pos
access:  public


Parameters:

int   $pos   position in xml schema

[ Top ]

method getCreatedAt [line 145]

mixed getCreatedAt( [string $format = 'Y-m-d H:i:s'])

Get the [optionally formatted] temporal [created_at] column value.



Tags:

return:  Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
throws:  PropelException - if unable to parse/validate the date/time value.
access:  public


Parameters:

string   $format   The date/time format string (either date()-style or strftime()-style). If format is NULL, then the raw DateTime object will be returned.

[ Top ]

method getEnctoken [line 121]

string getEnctoken( )

Get the [enctoken] column value.



Tags:

access:  public


[ Top ]

method getPeer [line 918]

EtvaVncTokenPeer getPeer( )

Returns a peer instance associated with this om.

Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.




Tags:

access:  public


[ Top ]

method getPrimaryKey [line 844]

string getPrimaryKey( )

Returns the primary key for this object (row).



Tags:

access:  public


[ Top ]

method getsfGuardUser [line 960]

sfGuardUser getsfGuardUser( [ $con = null])

Get the associated sfGuardUser object



Tags:

return:  The associated sfGuardUser object.
throws:  PropelException
access:  public


Parameters:

PropelPDO   $con   Optional Connection object.

[ Top ]

method getToken [line 111]

string getToken( )

Get the [token] column value.



Tags:

access:  public


[ Top ]

method getUserId [line 131]

int getUserId( )

Get the [user_id] column value.



Tags:

access:  public


[ Top ]

method getUsername [line 101]

string getUsername( )

Get the [username] column value.



Tags:

access:  public


[ Top ]

method getValidationFailures [line 590]

array getValidationFailures( )

Gets any ValidationFailed objects that resulted from last call to validate().



Tags:

return:  ValidationFailed[]
see:  BaseEtvaVncToken::validate()
access:  public


[ Top ]

method hasOnlyDefaultValues [line 310]

boolean hasOnlyDefaultValues( )

Indicates whether the columns in this object are only set to default values.

This method can be used in conjunction with isModified() to indicate whether an object is both modified _and_ has some values set which are non-default.




Tags:

return:  Whether the columns in this object are only been set with default values.
access:  public


[ Top ]

method hydrate [line 335]

int hydrate( array $row, [int $startcol = 0], [boolean $rehydrate = false])

Hydrates (populates) the object variables with values from the database resultset.

An offset (0-based "start column") is specified so that objects can be hydrated with a subset of the columns in the resultset rows. This is needed, for example, for results of JOIN queries where the resultset row includes columns from two or more tables.




Tags:

return:  next starting column
throws:  PropelException - Any caught Exception will be rewrapped as a PropelException.
access:  public


Parameters:

array   $row   The row returned by PDOStatement->fetch(PDO::FETCH_NUM)
int   $startcol   0-based offset column which indicates which restultset column to start with.
boolean   $rehydrate   Whether this object is being re-hydrated from the database.

[ Top ]

method reload [line 391]

void reload( [boolean $deep = false], [ $con = null])

Reloads this object from datastore based on primary key and (optionally) resets all associated objects.

This will only work if the object has been saved and has a valid primary key set.




Tags:

throws:  PropelException - if this object is deleted, unsaved or doesn't have pk match in db
access:  public


Parameters:

boolean   $deep   (optional) Whether to also de-associated any related objects.
PropelPDO   $con   (optional) The PropelPDO connection to use.

[ Top ]

method save [line 482]

int save( [ $con = null])

Persists this object to the database.

If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.




Tags:

return:  The number of rows affected by this insert/update and any referring fk objects' save() operations.
see:  BaseEtvaVncToken::doSave()
throws:  PropelException
access:  public


Parameters:

PropelPDO   $con  

[ Top ]

method setByName [line 742]

void setByName( string $name, mixed $value, [string $type = BasePeer::TYPE_PHPNAME])

Sets a field from the object by name passed in as a string.



Tags:

access:  public


Parameters:

string   $name   peer name
mixed   $value   field value
string   $type   The type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM

[ Top ]

method setByPosition [line 756]

void setByPosition( int $pos, mixed $value)

Sets a field from the object by Position as specified in the xml schema.

Zero-based.




Tags:

access:  public


Parameters:

int   $pos   position in xml schema
mixed   $value   field value

[ Top ]

method setCreatedAt [line 260]

EtvaVncToken setCreatedAt( mixed $v)

Sets the value of [created_at] column to a normalized version of the date/time value specified.



Tags:

return:  The current object (for fluent API support)
access:  public


Parameters:

mixed   $v   string, integer (timestamp), or DateTime value. Empty string will be treated as NULL for temporal objects.

[ Top ]

method setEnctoken [line 215]

EtvaVncToken setEnctoken( string $v)

Set the value of [enctoken] column.



Tags:

return:  The current object (for fluent API support)
access:  public


Parameters:

string   $v   new value

[ Top ]

method setPrimaryKey [line 855]

void setPrimaryKey( string $key)

Generic method to set the primary key (username column).



Tags:

access:  public


Parameters:

string   $key   Primary key.

[ Top ]

method setsfGuardUser [line 933]

EtvaVncToken setsfGuardUser( [ $v = null])

Declares an association between this object and a sfGuardUser object.



Tags:

return:  The current object (for fluent API support)
throws:  PropelException
access:  public


Parameters:

sfGuardUser   $v  

[ Top ]

method setToken [line 195]

EtvaVncToken setToken( string $v)

Set the value of [token] column.



Tags:

return:  The current object (for fluent API support)
access:  public


Parameters:

string   $v   new value

[ Top ]

method setUserId [line 235]

EtvaVncToken setUserId( int $v)

Set the value of [user_id] column.



Tags:

return:  The current object (for fluent API support)
access:  public


Parameters:

int   $v   new value

[ Top ]

method setUsername [line 175]

EtvaVncToken setUsername( string $v)

Set the value of [username] column.



Tags:

return:  The current object (for fluent API support)
access:  public


Parameters:

string   $v   new value

[ Top ]

method toArray [line 719]

an toArray( [string $keyType = BasePeer::TYPE_PHPNAME], [boolean $includeLazyLoadColumns = true])

Exports the object as an array.

You can specify the key type of the array by passing one of the class type constants.




Tags:

return:  associative array containing the field names (as keys) and field values
access:  public


Parameters:

string   $keyType   (optional) One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME.
boolean   $includeLazyLoadColumns   (optional) Whether to include lazy loaded columns. Defaults to TRUE.

[ Top ]

method validate [line 606]

boolean validate( [mixed $columns = null])

Validates the objects modified field values and all objects related to this table.

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




Tags:

return:  Whether all columns pass validation.
see:  BaseEtvaVncToken::doValidate()
see:  BaseEtvaVncToken::getValidationFailures()
access:  public


Parameters:

mixed   $columns   Column name or an array of column names.

[ Top ]

method __call [line 995]

void __call( $method, $arguments)



Tags:

access:  public


Parameters:

   $method  
   $arguments  

[ Top ]


Class Constants

PEER =  'EtvaVncTokenPeer'

[line 17]


[ Top ]



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