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

Class: BaseEtvaLogicalvolume

Source Location: /om/BaseEtvaLogicalvolume.php

Class Overview

BaseObject
   |
   --BaseEtvaLogicalvolume

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


Author(s):

Variables

Constants

Methods


Child classes:

EtvaLogicalvolume
Base class that represents a row from the 'logicalvolume' table.

Class Details

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



[ Top ]

$aEtvaNode =

[line 96]



Tags:

access:  protected

Type:   EtvaNode


[ Top ]

$aEtvaVolumegroup =

[line 91]



Tags:

access:  protected

Type:   EtvaVolumegroup


[ Top ]

$alreadyInSave =  false

[line 113]

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

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 ]

$collEtvaServers =

[line 101]



Tags:

var:  EtvaServer[] Collection to store aggregation of EtvaServer objects.
access:  protected

Type:   array


[ Top ]

$freesize =

[line 67]

The value for the freesize field.



Tags:

access:  protected

Type:   string


[ Top ]

$id =

[line 31]

The value for the id field.



Tags:

access:  protected

Type:   int


[ Top ]

$in_use =

[line 86]

The value for the in_use field.

Note: this column has a database default value of: 0




Tags:

access:  protected

Type:   int


[ Top ]

$lv =

[line 49]

The value for the lv field.



Tags:

access:  protected

Type:   string


[ Top ]

$lvdevice =

[line 55]

The value for the lvdevice field.



Tags:

access:  protected

Type:   string


[ Top ]

$node_id =

[line 43]

The value for the node_id field.



Tags:

access:  protected

Type:   int


[ Top ]

$size =

[line 61]

The value for the size field.



Tags:

access:  protected

Type:   string


[ Top ]

$storage_type =

[line 73]

The value for the storage_type field.



Tags:

access:  protected

Type:   string


[ Top ]

$validationFailures = array()

[line 761]

Array of ValidationFailed objects.



Tags:

var:  ValidationFailed[]
access:  protected

Type:   array


[ Top ]

$volumegroup_id =

[line 37]

The value for the volumegroup_id field.



Tags:

access:  protected

Type:   int


[ Top ]

$writeable =

[line 79]

The value for the writeable field.



Tags:

access:  protected

Type:   int


[ Top ]



Class Methods


constructor __construct [line 126]

BaseEtvaLogicalvolume __construct( )

Initializes internal state of BaseEtvaLogicalvolume object.



Tags:

see:  applyDefaults()
access:  public


[ Top ]

method addEtvaServer [line 1435]

void addEtvaServer( EtvaServer $l)

Method called to associate a EtvaServer object to this object through the EtvaServer foreign key attribute.



Tags:

throws:  PropelException
access:  public


Parameters:

EtvaServer   $l   EtvaServer

[ Top ]

method applyDefaultValues [line 138]

void applyDefaultValues( )

Applies default values to this object.

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




Tags:

see:  BaseEtvaLogicalvolume::__construct()
access:  public


[ Top ]

method buildCriteria [line 1044]

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

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

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 clearEtvaServers [line 1300]

void clearEtvaServers( )

Clears out the collEtvaServers collection (array).

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.




Tags:

see:  addEtvaServers()
access:  public


[ Top ]

method copy [line 1163]

EtvaLogicalvolume 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 1109]

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 EtvaLogicalvolume (or compatible) type.
boolean   $deepCopy   Whether to also copy all rows that refer (by fkey) to the current row.

[ Top ]

method countEtvaServers [line 1381]

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

Returns the number of related EtvaServer objects.



Tags:

return:  Count of related EtvaServer objects.
throws:  PropelException
access:  public


Parameters:

Criteria   $criteria  
boolean   $distinct  
PropelPDO   $con  

[ Top ]

method delete [line 596]

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

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:  BaseEtvaLogicalvolume::save()
throws:  PropelException
access:  protected


Parameters:

PropelPDO   $con  

[ Top ]

method doValidate [line 808]

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

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

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

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

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 getEtvaNode [line 1274]

EtvaNode getEtvaNode( [ $con = null])

Get the associated EtvaNode object



Tags:

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


Parameters:

PropelPDO   $con   Optional Connection object.

[ Top ]

method getEtvaServers [line 1332]

array getEtvaServers( [Criteria $criteria = null], [ $con = null])

Gets an array of EtvaServer objects which contain a foreign key that references this object.

If this collection has already been initialized with an identical Criteria, it returns the collection. Otherwise if this EtvaLogicalvolume has previously been saved, it will retrieve related EtvaServers from storage. If this EtvaLogicalvolume is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.




Tags:

return:  EtvaServer[]
throws:  PropelException
access:  public


Parameters:

PropelPDO   $con  
Criteria   $criteria  

[ Top ]

method getEtvaServersJoinEtvaNode [line 1458]

void getEtvaServersJoinEtvaNode( [ $criteria = null], [ $con = null], [ $join_behavior = Criteria::LEFT_JOIN])

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this EtvaLogicalvolume is new, it will return an empty collection; or if this EtvaLogicalvolume has previously been saved, it will retrieve related EtvaServers from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in EtvaLogicalvolume.




Tags:

access:  public


Parameters:

   $criteria  
   $con  
   $join_behavior  

[ Top ]

method getEtvaServersJoinsfGuardGroup [line 1505]

void getEtvaServersJoinsfGuardGroup( [ $criteria = null], [ $con = null], [ $join_behavior = Criteria::LEFT_JOIN])

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this EtvaLogicalvolume is new, it will return an empty collection; or if this EtvaLogicalvolume has previously been saved, it will retrieve related EtvaServers from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in EtvaLogicalvolume.




Tags:

access:  public


Parameters:

   $criteria  
   $con  
   $join_behavior  

[ Top ]

method getEtvaVolumegroup [line 1223]

EtvaVolumegroup getEtvaVolumegroup( [ $con = null])

Get the associated EtvaVolumegroup object



Tags:

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


Parameters:

PropelPDO   $con   Optional Connection object.

[ Top ]

method getFreesize [line 208]

string getFreesize( )

Get the [freesize] column value.



Tags:

access:  public


[ Top ]

method getId [line 148]

int getId( )

Get the [id] column value.



Tags:

access:  public


[ Top ]

method getInUse [line 238]

int getInUse( )

Get the [in_use] column value.



Tags:

access:  public


[ Top ]

method getLv [line 178]

string getLv( )

Get the [lv] column value.



Tags:

access:  public


[ Top ]

method getLvdevice [line 188]

string getLvdevice( )

Get the [lvdevice] column value.



Tags:

access:  public


[ Top ]

method getNodeId [line 168]

int getNodeId( )

Get the [node_id] column value.



Tags:

access:  public


[ Top ]

method getPeer [line 1181]

EtvaLogicalvolumePeer 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 1083]

int getPrimaryKey( )

Returns the primary key for this object (row).



Tags:

access:  public


[ Top ]

method getSize [line 198]

string getSize( )

Get the [size] column value.



Tags:

access:  public


[ Top ]

method getStorageType [line 218]

string getStorageType( )

Get the [storage_type] column value.



Tags:

access:  public


[ Top ]

method getValidationFailures [line 770]

array getValidationFailures( )

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



Tags:

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


[ Top ]

method getVolumegroupId [line 158]

int getVolumegroupId( )

Get the [volumegroup_id] column value.



Tags:

access:  public


[ Top ]

method getWriteable [line 228]

int getWriteable( )

Get the [writeable] column value.



Tags:

access:  public


[ Top ]

method hasOnlyDefaultValues [line 459]

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

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 initEtvaServers [line 1314]

void initEtvaServers( )

Initializes the collEtvaServers collection (array).

By default this just sets the collEtvaServers collection to an empty array (like clearcollEtvaServers()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.




Tags:

access:  public


[ Top ]

method reload [line 552]

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

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:  BaseEtvaLogicalvolume::doSave()
throws:  PropelException
access:  public


Parameters:

PropelPDO   $con  

[ Top ]

method setByName [line 956]

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

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 setEtvaNode [line 1247]

EtvaLogicalvolume setEtvaNode( [EtvaNode $v = null])

Declares an association between this object and a EtvaNode object.



Tags:

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


Parameters:

EtvaNode   $v  

[ Top ]

method setEtvaVolumegroup [line 1196]

EtvaLogicalvolume setEtvaVolumegroup( [EtvaVolumegroup $v = null])

Declares an association between this object and a EtvaVolumegroup object.



Tags:

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


Parameters:

EtvaVolumegroup   $v  

[ Top ]

method setFreesize [line 377]

EtvaLogicalvolume setFreesize( string $v)

Set the value of [freesize] column.



Tags:

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


Parameters:

string   $v   new value

[ Top ]

method setId [line 249]

EtvaLogicalvolume setId( int $v)

Set the value of [id] column.



Tags:

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


Parameters:

int   $v   new value

[ Top ]

method setInUse [line 437]

EtvaLogicalvolume setInUse( int $v)

Set the value of [in_use] column.



Tags:

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


Parameters:

int   $v   new value

[ Top ]

method setLv [line 317]

EtvaLogicalvolume setLv( string $v)

Set the value of [lv] column.



Tags:

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


Parameters:

string   $v   new value

[ Top ]

method setLvdevice [line 337]

EtvaLogicalvolume setLvdevice( string $v)

Set the value of [lvdevice] column.



Tags:

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


Parameters:

string   $v   new value

[ Top ]

method setNodeId [line 293]

EtvaLogicalvolume setNodeId( int $v)

Set the value of [node_id] column.



Tags:

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


Parameters:

int   $v   new value

[ Top ]

method setPrimaryKey [line 1094]

void setPrimaryKey( int $key)

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



Tags:

access:  public


Parameters:

int   $key   Primary key.

[ Top ]

method setSize [line 357]

EtvaLogicalvolume setSize( string $v)

Set the value of [size] column.



Tags:

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


Parameters:

string   $v   new value

[ Top ]

method setStorageType [line 397]

EtvaLogicalvolume setStorageType( string $v)

Set the value of [storage_type] column.



Tags:

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


Parameters:

string   $v   new value

[ Top ]

method setVolumegroupId [line 269]

EtvaLogicalvolume setVolumegroupId( int $v)

Set the value of [volumegroup_id] column.



Tags:

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


Parameters:

int   $v   new value

[ Top ]

method setWriteable [line 417]

EtvaLogicalvolume setWriteable( int $v)

Set the value of [writeable] column.



Tags:

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


Parameters:

int   $v   new value

[ Top ]

method toArray [line 928]

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

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:  BaseEtvaLogicalvolume::doValidate()
see:  BaseEtvaLogicalvolume::getValidationFailures()
access:  public


Parameters:

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

[ Top ]

method __call [line 1565]

void __call( $method, $arguments)



Tags:

access:  public


Parameters:

   $method  
   $arguments  

[ Top ]


Class Constants

PEER =  'EtvaLogicalvolumePeer'

[line 17]


[ Top ]



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