Class BaseBiomaterial

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

BaseObject

cli_db\propel\om\BaseBiomaterial implements Persistent

Direct known subclasses

Abstract
Namespace: cli_db\propel\om
Package: propel\generator\cli\db\om
Located at src/cli/db/propel-classes/cli_db/om/BaseBiomaterial.php

Methods summary
`public integer`	# `getBiomaterialId( )` Get the [biomaterial_id] column value. Get the [biomaterial_id] column value. Returns `integer`
`public integer`	# `getTaxonId( )` Get the [taxon_id] column value. Get the [taxon_id] column value. Returns `integer`
`public integer`	# `getBiosourceproviderId( )` Get the [biosourceprovider_id] column value. Get the [biosourceprovider_id] column value. Returns `integer`
`public integer`	# `getDbxrefId( )` Get the [dbxref_id] column value. Get the [dbxref_id] column value. Returns `integer`
`public string`	# `getName( )` Get the [name] column value. Get the [name] column value. Returns `string`
`public string`	# `getDescription( )` Get the [description] column value. Get the [description] column value. Returns `string`
`public cli_db\propel\Biomaterial`	# `setBiomaterialId( integer $v )` Set the value of [biomaterial_id] column. Set the value of [biomaterial_id] column. Parameters `$v` `integer` $v new value Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public cli_db\propel\Biomaterial`	# `setTaxonId( integer $v )` Set the value of [taxon_id] column. Set the value of [taxon_id] column. Parameters `$v` `integer` $v new value Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public cli_db\propel\Biomaterial`	# `setBiosourceproviderId( integer $v )` Set the value of [biosourceprovider_id] column. Set the value of [biosourceprovider_id] column. Parameters `$v` `integer` $v new value Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public cli_db\propel\Biomaterial`	# `setDbxrefId( integer $v )` Set the value of [dbxref_id] column. Set the value of [dbxref_id] column. Parameters `$v` `integer` $v new value Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public cli_db\propel\Biomaterial`	# `setName( string $v )` Set the value of [name] column. Set the value of [name] column. Parameters `$v` `string` $v new value Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public cli_db\propel\Biomaterial`	# `setDescription( string $v )` Set the value of [description] column. Set the value of [description] column. Parameters `$v` `string` $v new value Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public boolean`	# `hasOnlyDefaultValues( )` Indicates whether the columns in this object are only set to default values. 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. Returns `boolean` Whether the columns in this object are only been set with default values.
`public integer`	# `hydrate( array $row, integer $startcol = 0, boolean $rehydrate = false )` Hydrates (populates) the object variables with values from the database resultset. 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. Parameters `$row` `array` $row The row returned by PDOStatement->fetch(PDO::FETCH_NUM) `$startcol` `integer` $startcol 0-based offset column which indicates which restultset column to start with. `$rehydrate` `boolean` $rehydrate Whether this object is being re-hydrated from the database. Returns `integer` next starting column Throws `PropelException` - Any caught Exception will be rewrapped as a PropelException.
`public`	# `ensureConsistency( )` Checks and repairs the internal consistency of the object. 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. Throws `PropelException`
`public`	# `reload( boolean $deep = false, PropelPDO $con = null )` Reloads this object from datastore based on primary key and (optionally) resets all associated objects. 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. Parameters `$deep` `boolean` $deep (optional) Whether to also de-associated any related objects. `$con` `PropelPDO` $con (optional) The PropelPDO connection to use. Throws `PropelException` - if this object is deleted, unsaved or doesn't have pk match in db
`public`	# `delete( PropelPDO $con = null )` Removes this object from datastore and sets delete attribute. Removes this object from datastore and sets delete attribute. Parameters `$con` `PropelPDO` $con Throws `PropelException` `Exception` See BaseObject::setDeleted() BaseObject::isDeleted()
`public integer`	# `save( PropelPDO $con = null )` Persists this object to the database. 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. Parameters `$con` `PropelPDO` $con Returns `integer` The number of rows affected by this insert/update and any referring fk objects' save() operations. Throws `PropelException` `Exception` See `cli_db\propel\om\BaseBiomaterial::doSave()`
`protected integer`	# `doSave( PropelPDO $con )` Performs the work of inserting or updating the row in the database. 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. Parameters `$con` `PropelPDO` $con Returns `integer` The number of rows affected by this insert/update and any referring fk objects' save() operations. Throws `PropelException` See `cli_db\propel\om\BaseBiomaterial::save()`
`protected`	# `doInsert( PropelPDO $con )` Insert the row in the database. Insert the row in the database. Parameters `$con` `PropelPDO` $con Throws `PropelException` See `cli_db\propel\om\BaseBiomaterial::doSave()`
`protected`	# `doUpdate( PropelPDO $con )` Update the row in the database. Update the row in the database. Parameters `$con` `PropelPDO` $con See `cli_db\propel\om\BaseBiomaterial::doSave()`
`public array`	# `getValidationFailures( )` Gets any ValidationFailed objects that resulted from last call to validate(). Gets any ValidationFailed objects that resulted from last call to validate(). Returns `array` ValidationFailed[] See `cli_db\propel\om\BaseBiomaterial::validate()`
`public boolean`	# `validate( mixed $columns = null )` Validates the objects modified field values and all objects related to this table. 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. Parameters `$columns` `mixed` $columns Column name or an array of column names. Returns `boolean` Whether all columns pass validation. See `cli_db\propel\om\BaseBiomaterial::doValidate()` `cli_db\propel\om\BaseBiomaterial::getValidationFailures()`
`protected mixed`	# `doValidate( array $columns = null )` This function performs the validation work for complex object models. 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 `<span class="php-keyword1">true</span>` is returned; otherwise an aggreagated array of ValidationFailed objects will be returned. Parameters `$columns` `array` $columns Array of column names to validate. Returns `mixed` `<span class="php-keyword1">true</span>` if all validations pass; array of `ValidationFailed` objets otherwise.
`public mixed`	# `getByName( string $name, string $type = cli_db\propel\om\BasePeer::TYPE_PHPNAME )` Retrieves a field from the object by name passed in as a string. Retrieves a field from the object by name passed in as a string. Parameters `$name` `string` $name name `$type` `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. Defaults to BasePeer::TYPE_PHPNAME Returns `mixed` Value of field.
`public mixed`	# `getByPosition( integer $pos )` Retrieves a field from the object by Position as specified in the xml schema. Zero-based. Retrieves a field from the object by Position as specified in the xml schema. Zero-based. Parameters `$pos` `integer` $pos position in xml schema Returns `mixed` Value of field at $pos
`public array`	# `toArray( string $keyType = cli_db\propel\om\BasePeer::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $includeForeignObjects = false )` Exports the object as an array. Exports the object as an array. You can specify the key type of the array by passing one of the class type constants. Parameters `$keyType` `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. `$includeLazyLoadColumns` `boolean` $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to true. `$alreadyDumpedObjects` `array` $alreadyDumpedObjects List of objects to skip to avoid recursion `$includeForeignObjects` `boolean` $includeForeignObjects (optional) Whether to include hydrated related objects. Default to FALSE. Returns `array` an associative array containing the field names (as keys) and field values
`public`	# `setByName( string $name, mixed $value, string $type = cli_db\propel\om\BasePeer::TYPE_PHPNAME )` Sets a field from the object by name passed in as a string. Sets a field from the object by name passed in as a string. Parameters `$name` `string` $name peer name `$value` `mixed` $value field value `$type` `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. Defaults to BasePeer::TYPE_PHPNAME
`public`	# `setByPosition( integer $pos, mixed $value )` Sets a field from the object by Position as specified in the xml schema. Zero-based. Sets a field from the object by Position as specified in the xml schema. Zero-based. Parameters `$pos` `integer` $pos position in xml schema `$value` `mixed` $value field value
`public`	# `fromArray( array $arr, string $keyType = cli_db\propel\om\BasePeer::TYPE_PHPNAME )` Populates the object using an array. 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 BasePeer::TYPE_PHPNAME Parameters `$arr` `array` $arr An array to populate the object from. `$keyType` `string` $keyType The type of keys the array uses.
`public Criteria`	# `buildCriteria( )` Build a Criteria object containing the values of all modified columns in this object. Build a Criteria object containing the values of all modified columns in this object. Returns `Criteria` The Criteria object containing all modified values.
`public Criteria`	# `buildPkeyCriteria( )` Builds a Criteria object containing the primary key for this object. 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. Returns `Criteria` The Criteria object containing value(s) for primary key(s).
`public integer`	# `getPrimaryKey( )` Returns the primary key for this object (row). Returns the primary key for this object (row). Returns `integer`
`public`	# `setPrimaryKey( integer $key )` Generic method to set the primary key (biomaterial_id column). Generic method to set the primary key (biomaterial_id column). Parameters `$key` `integer` $key Primary key.
`public boolean`	# `isPrimaryKeyNull( )` Returns true if the primary key for this object is null. Returns true if the primary key for this object is null. Returns `boolean`
`public`	# `copyInto( object $copyObj, boolean $deepCopy = false, boolean $makeNew = true )` Sets contents of passed object to values from current object. Sets contents of passed object to values from current object. If desired, this method can also make copies of all associated (fkey referrers) objects. Parameters `$copyObj` `object` $copyObj An object of Biomaterial (or compatible) type. `$deepCopy` `boolean` $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. `$makeNew` `boolean` $makeNew Whether to reset autoincrement PKs and make the object new. Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `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. 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. Parameters `$deepCopy` `boolean` $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. Returns `cli_db\propel\Biomaterial` Clone of current object. Throws `PropelException`
`public cli_db\propel\BiomaterialPeer`	# `getPeer( )` Returns a peer instance associated with this om. 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. Returns `cli_db\propel\BiomaterialPeer`
`public cli_db\propel\Biomaterial`	# `setContact( cli_db\propel\Contact $v = null )` Declares an association between this object and a Contact object. Declares an association between this object and a Contact object. Parameters `$v` `cli_db\propel\Contact` $v Returns `cli_db\propel\Biomaterial` The current object (for fluent API support) Throws `PropelException`
`public cli_db\propel\Contact`	# `getContact( PropelPDO $con = null, mixed $doQuery = true )` Get the associated Contact object Get the associated Contact object Parameters `$con` `PropelPDO` $con Optional Connection object. `$doQuery` `mixed` $doQuery Executes a query to get the object if required Returns `cli_db\propel\Contact` The associated Contact object. Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `setOrganism( cli_db\propel\Organism $v = null )` Declares an association between this object and a Organism object. Declares an association between this object and a Organism object. Parameters `$v` `cli_db\propel\Organism` $v Returns `cli_db\propel\Biomaterial` The current object (for fluent API support) Throws `PropelException`
`public cli_db\propel\Organism`	# `getOrganism( PropelPDO $con = null, mixed $doQuery = true )` Get the associated Organism object Get the associated Organism object Parameters `$con` `PropelPDO` $con Optional Connection object. `$doQuery` `mixed` $doQuery Executes a query to get the object if required Returns `cli_db\propel\Organism` The associated Organism object. Throws `PropelException`
`public`	# `initRelation( string $relationName )` Initializes a collection based on the name of a relation. Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used. Initializes a collection based on the name of a relation. Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used. Parameters `$relationName` `string` $relationName The name of the relation to initialize
`public cli_db\propel\Biomaterial`	# `clearAssayBiomaterials( )` Clears out the collAssayBiomaterials collection Clears out the collAssayBiomaterials collection This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support) See addAssayBiomaterials()
`public`	# `resetPartialAssayBiomaterials( mixed $v = true )` reset is the collAssayBiomaterials collection loaded partially reset is the collAssayBiomaterials collection loaded partially
`public`	# `initAssayBiomaterials( boolean $overrideExisting = true )` Initializes the collAssayBiomaterials collection. Initializes the collAssayBiomaterials collection. By default this just sets the collAssayBiomaterials collection to an empty array (like clearcollAssayBiomaterials()); 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. Parameters `$overrideExisting` `boolean` $overrideExisting If set to true, the method call initializes the collection even if it is not empty
`public PropelObjectCollection\|cli_db\propel\AssayBiomaterial[]`	# `getAssayBiomaterials( Criteria $criteria = null, PropelPDO $con = null )` Gets an array of AssayBiomaterial objects which contain a foreign key that references this object. Gets an array of AssayBiomaterial objects which contain a foreign key that references this object. If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Biomaterial is new, it will return an empty collection or the current collection; the criteria is ignored on a new object. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object Returns `PropelObjectCollection\|cli_db\propel\AssayBiomaterial[]` List of AssayBiomaterial objects Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `setAssayBiomaterials( PropelCollection $assayBiomaterials, PropelPDO $con = null )` Sets a collection of AssayBiomaterial objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Sets a collection of AssayBiomaterial objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Parameters `$assayBiomaterials` `PropelCollection` $assayBiomaterials A Propel collection. `$con` `PropelPDO` $con Optional connection object Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public integer`	# `countAssayBiomaterials( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )` Returns the number of related AssayBiomaterial objects. Returns the number of related AssayBiomaterial objects. Parameters `$criteria` `Criteria` $criteria `$distinct` `boolean` $distinct `$con` `PropelPDO` $con Returns `integer` Count of related AssayBiomaterial objects. Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `addAssayBiomaterial( cli_db\propel\AssayBiomaterial $l )` Method called to associate a AssayBiomaterial object to this object through the AssayBiomaterial foreign key attribute. Method called to associate a AssayBiomaterial object to this object through the AssayBiomaterial foreign key attribute. Parameters `$l` `cli_db\propel\AssayBiomaterial` $l AssayBiomaterial Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`protected`	# `doAddAssayBiomaterial( cli_db\propel\AssayBiomaterial $assayBiomaterial )` Parameters `$assayBiomaterial` `cli_db\propel\AssayBiomaterial` $assayBiomaterial The assayBiomaterial object to add.
`public cli_db\propel\Biomaterial`	# `removeAssayBiomaterial( cli_db\propel\AssayBiomaterial $assayBiomaterial )` Parameters `$assayBiomaterial` `cli_db\propel\AssayBiomaterial` $assayBiomaterial The assayBiomaterial object to remove. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public PropelObjectCollection\|cli_db\propel\AssayBiomaterial[]`	# `getAssayBiomaterialsJoinAssay( Criteria $criteria = null, PropelPDO $con = null, string $join_behavior = cli_db\propel\om\Criteria::LEFT_JOIN )` If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related AssayBiomaterials from storage. If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related AssayBiomaterials 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 Biomaterial. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object `$join_behavior` `string` $join_behavior optional join type to use (defaults to Criteria::LEFT_JOIN) Returns `PropelObjectCollection\|cli_db\propel\AssayBiomaterial[]` List of AssayBiomaterial objects
`public cli_db\propel\Biomaterial`	# `clearBiomaterialRelationshipsRelatedByObjectId( )` Clears out the collBiomaterialRelationshipsRelatedByObjectId collection Clears out the collBiomaterialRelationshipsRelatedByObjectId collection This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support) See addBiomaterialRelationshipsRelatedByObjectId()
`public`	# `resetPartialBiomaterialRelationshipsRelatedByObjectId( mixed $v = true )` reset is the collBiomaterialRelationshipsRelatedByObjectId collection loaded partially reset is the collBiomaterialRelationshipsRelatedByObjectId collection loaded partially
`public`	# `initBiomaterialRelationshipsRelatedByObjectId( boolean $overrideExisting = true )` Initializes the collBiomaterialRelationshipsRelatedByObjectId collection. Initializes the collBiomaterialRelationshipsRelatedByObjectId collection. By default this just sets the collBiomaterialRelationshipsRelatedByObjectId collection to an empty array (like clearcollBiomaterialRelationshipsRelatedByObjectId()); 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. Parameters `$overrideExisting` `boolean` $overrideExisting If set to true, the method call initializes the collection even if it is not empty
`public PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]`	# `getBiomaterialRelationshipsRelatedByObjectId( Criteria $criteria = null, PropelPDO $con = null )` Gets an array of BiomaterialRelationship objects which contain a foreign key that references this object. Gets an array of BiomaterialRelationship objects which contain a foreign key that references this object. If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Biomaterial is new, it will return an empty collection or the current collection; the criteria is ignored on a new object. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object Returns `PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]` List of BiomaterialRelationship objects Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `setBiomaterialRelationshipsRelatedByObjectId( PropelCollection $biomaterialRelationshipsRelatedByObjectId, PropelPDO $con = null )` Sets a collection of BiomaterialRelationshipRelatedByObjectId objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Sets a collection of BiomaterialRelationshipRelatedByObjectId objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Parameters `$biomaterialRelationshipsRelatedByObjectId` `PropelCollection` $biomaterialRelationshipsRelatedByObjectId A Propel collection. `$con` `PropelPDO` $con Optional connection object Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public integer`	# `countBiomaterialRelationshipsRelatedByObjectId( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )` Returns the number of related BiomaterialRelationship objects. Returns the number of related BiomaterialRelationship objects. Parameters `$criteria` `Criteria` $criteria `$distinct` `boolean` $distinct `$con` `PropelPDO` $con Returns `integer` Count of related BiomaterialRelationship objects. Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `addBiomaterialRelationshipRelatedByObjectId( cli_db\propel\BiomaterialRelationship $l )` Method called to associate a BiomaterialRelationship object to this object through the BiomaterialRelationship foreign key attribute. Method called to associate a BiomaterialRelationship object to this object through the BiomaterialRelationship foreign key attribute. Parameters `$l` `cli_db\propel\BiomaterialRelationship` $l BiomaterialRelationship Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`protected`	# `doAddBiomaterialRelationshipRelatedByObjectId( BiomaterialRelationshipRelatedByObjectId $biomaterialRelationshipRelatedByObjectId )` Parameters `$biomaterialRelationshipRelatedByObjectId` `BiomaterialRelationshipRelatedByObjectId` $biomaterialRelationshipRelatedByObjectId The biomaterialRelationshipRelatedByObjectId object to add.
`public cli_db\propel\Biomaterial`	# `removeBiomaterialRelationshipRelatedByObjectId( BiomaterialRelationshipRelatedByObjectId $biomaterialRelationshipRelatedByObjectId )` Parameters `$biomaterialRelationshipRelatedByObjectId` `BiomaterialRelationshipRelatedByObjectId` $biomaterialRelationshipRelatedByObjectId The biomaterialRelationshipRelatedByObjectId object to remove. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]`	# `getBiomaterialRelationshipsRelatedByObjectIdJoinCvterm( Criteria $criteria = null, PropelPDO $con = null, string $join_behavior = cli_db\propel\om\Criteria::LEFT_JOIN )` If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related BiomaterialRelationshipsRelatedByObjectId from storage. If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related BiomaterialRelationshipsRelatedByObjectId 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 Biomaterial. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object `$join_behavior` `string` $join_behavior optional join type to use (defaults to Criteria::LEFT_JOIN) Returns `PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]` List of BiomaterialRelationship objects
`public cli_db\propel\Biomaterial`	# `clearBiomaterialRelationshipsRelatedBySubjectId( )` Clears out the collBiomaterialRelationshipsRelatedBySubjectId collection Clears out the collBiomaterialRelationshipsRelatedBySubjectId collection This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support) See addBiomaterialRelationshipsRelatedBySubjectId()
`public`	# `resetPartialBiomaterialRelationshipsRelatedBySubjectId( mixed $v = true )` reset is the collBiomaterialRelationshipsRelatedBySubjectId collection loaded partially reset is the collBiomaterialRelationshipsRelatedBySubjectId collection loaded partially
`public`	# `initBiomaterialRelationshipsRelatedBySubjectId( boolean $overrideExisting = true )` Initializes the collBiomaterialRelationshipsRelatedBySubjectId collection. Initializes the collBiomaterialRelationshipsRelatedBySubjectId collection. By default this just sets the collBiomaterialRelationshipsRelatedBySubjectId collection to an empty array (like clearcollBiomaterialRelationshipsRelatedBySubjectId()); 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. Parameters `$overrideExisting` `boolean` $overrideExisting If set to true, the method call initializes the collection even if it is not empty
`public PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]`	# `getBiomaterialRelationshipsRelatedBySubjectId( Criteria $criteria = null, PropelPDO $con = null )` Gets an array of BiomaterialRelationship objects which contain a foreign key that references this object. Gets an array of BiomaterialRelationship objects which contain a foreign key that references this object. If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Biomaterial is new, it will return an empty collection or the current collection; the criteria is ignored on a new object. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object Returns `PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]` List of BiomaterialRelationship objects Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `setBiomaterialRelationshipsRelatedBySubjectId( PropelCollection $biomaterialRelationshipsRelatedBySubjectId, PropelPDO $con = null )` Sets a collection of BiomaterialRelationshipRelatedBySubjectId objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Sets a collection of BiomaterialRelationshipRelatedBySubjectId objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Parameters `$biomaterialRelationshipsRelatedBySubjectId` `PropelCollection` $biomaterialRelationshipsRelatedBySubjectId A Propel collection. `$con` `PropelPDO` $con Optional connection object Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public integer`	# `countBiomaterialRelationshipsRelatedBySubjectId( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )` Returns the number of related BiomaterialRelationship objects. Returns the number of related BiomaterialRelationship objects. Parameters `$criteria` `Criteria` $criteria `$distinct` `boolean` $distinct `$con` `PropelPDO` $con Returns `integer` Count of related BiomaterialRelationship objects. Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `addBiomaterialRelationshipRelatedBySubjectId( cli_db\propel\BiomaterialRelationship $l )` Method called to associate a BiomaterialRelationship object to this object through the BiomaterialRelationship foreign key attribute. Method called to associate a BiomaterialRelationship object to this object through the BiomaterialRelationship foreign key attribute. Parameters `$l` `cli_db\propel\BiomaterialRelationship` $l BiomaterialRelationship Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`protected`	# `doAddBiomaterialRelationshipRelatedBySubjectId( BiomaterialRelationshipRelatedBySubjectId $biomaterialRelationshipRelatedBySubjectId )` Parameters `$biomaterialRelationshipRelatedBySubjectId` `BiomaterialRelationshipRelatedBySubjectId` $biomaterialRelationshipRelatedBySubjectId The biomaterialRelationshipRelatedBySubjectId object to add.
`public cli_db\propel\Biomaterial`	# `removeBiomaterialRelationshipRelatedBySubjectId( BiomaterialRelationshipRelatedBySubjectId $biomaterialRelationshipRelatedBySubjectId )` Parameters `$biomaterialRelationshipRelatedBySubjectId` `BiomaterialRelationshipRelatedBySubjectId` $biomaterialRelationshipRelatedBySubjectId The biomaterialRelationshipRelatedBySubjectId object to remove. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]`	# `getBiomaterialRelationshipsRelatedBySubjectIdJoinCvterm( Criteria $criteria = null, PropelPDO $con = null, string $join_behavior = cli_db\propel\om\Criteria::LEFT_JOIN )` If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related BiomaterialRelationshipsRelatedBySubjectId from storage. If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related BiomaterialRelationshipsRelatedBySubjectId 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 Biomaterial. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object `$join_behavior` `string` $join_behavior optional join type to use (defaults to Criteria::LEFT_JOIN) Returns `PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]` List of BiomaterialRelationship objects
`public cli_db\propel\Biomaterial`	# `clearBiomaterialprops( )` Clears out the collBiomaterialprops collection Clears out the collBiomaterialprops collection This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support) See addBiomaterialprops()
`public`	# `resetPartialBiomaterialprops( mixed $v = true )` reset is the collBiomaterialprops collection loaded partially reset is the collBiomaterialprops collection loaded partially
`public`	# `initBiomaterialprops( boolean $overrideExisting = true )` Initializes the collBiomaterialprops collection. Initializes the collBiomaterialprops collection. By default this just sets the collBiomaterialprops collection to an empty array (like clearcollBiomaterialprops()); 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. Parameters `$overrideExisting` `boolean` $overrideExisting If set to true, the method call initializes the collection even if it is not empty
`public PropelObjectCollection\|cli_db\propel\Biomaterialprop[]`	# `getBiomaterialprops( Criteria $criteria = null, PropelPDO $con = null )` Gets an array of Biomaterialprop objects which contain a foreign key that references this object. Gets an array of Biomaterialprop objects which contain a foreign key that references this object. If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Biomaterial is new, it will return an empty collection or the current collection; the criteria is ignored on a new object. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object Returns `PropelObjectCollection\|cli_db\propel\Biomaterialprop[]` List of Biomaterialprop objects Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `setBiomaterialprops( PropelCollection $biomaterialprops, PropelPDO $con = null )` Sets a collection of Biomaterialprop objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Sets a collection of Biomaterialprop objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection. Parameters `$biomaterialprops` `PropelCollection` $biomaterialprops A Propel collection. `$con` `PropelPDO` $con Optional connection object Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public integer`	# `countBiomaterialprops( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )` Returns the number of related Biomaterialprop objects. Returns the number of related Biomaterialprop objects. Parameters `$criteria` `Criteria` $criteria `$distinct` `boolean` $distinct `$con` `PropelPDO` $con Returns `integer` Count of related Biomaterialprop objects. Throws `PropelException`
`public cli_db\propel\Biomaterial`	# `addBiomaterialprop( cli_db\propel\Biomaterialprop $l )` Method called to associate a Biomaterialprop object to this object through the Biomaterialprop foreign key attribute. Method called to associate a Biomaterialprop object to this object through the Biomaterialprop foreign key attribute. Parameters `$l` `cli_db\propel\Biomaterialprop` $l Biomaterialprop Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`protected`	# `doAddBiomaterialprop( cli_db\propel\Biomaterialprop $biomaterialprop )` Parameters `$biomaterialprop` `cli_db\propel\Biomaterialprop` $biomaterialprop The biomaterialprop object to add.
`public cli_db\propel\Biomaterial`	# `removeBiomaterialprop( cli_db\propel\Biomaterialprop $biomaterialprop )` Parameters `$biomaterialprop` `cli_db\propel\Biomaterialprop` $biomaterialprop The biomaterialprop object to remove. Returns `cli_db\propel\Biomaterial` The current object (for fluent API support)
`public PropelObjectCollection\|cli_db\propel\Biomaterialprop[]`	# `getBiomaterialpropsJoinCvterm( Criteria $criteria = null, PropelPDO $con = null, string $join_behavior = cli_db\propel\om\Criteria::LEFT_JOIN )` If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related Biomaterialprops from storage. If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Biomaterial is new, it will return an empty collection; or if this Biomaterial has previously been saved, it will retrieve related Biomaterialprops 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 Biomaterial. Parameters `$criteria` `Criteria` $criteria optional Criteria object to narrow the query `$con` `PropelPDO` $con optional connection object `$join_behavior` `string` $join_behavior optional join type to use (defaults to Criteria::LEFT_JOIN) Returns `PropelObjectCollection\|cli_db\propel\Biomaterialprop[]` List of Biomaterialprop objects
`public`	# `clear( )` Clears the current object and sets all attributes to their default values Clears the current object and sets all attributes to their default values
`public`	# `clearAllReferences( boolean $deep = false )` Resets all references to other model objects or collections of model objects. Resets all references to other model objects or collections of model objects. This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volumne/high-memory operations. Parameters `$deep` `boolean` $deep Whether to also clear the references on all referrer objects.
`public string`	# `__toString( )` return the string representation of this object return the string representation of this object Returns `string`
`public boolean`	# `isAlreadyInSave( )` return true is the object is in saving state return true is the object is in saving state Returns `boolean`

Constants summary
`string`	`PEER`	`'cli_db\\propel\\BiomaterialPeer'`	# Peer class name Peer class name

Properties summary
`protected static cli_db\propel\BiomaterialPeer`	`$peer`		# The Peer class. Instance provides a convenient way of calling static methods on a class that calling code may not be able to identify. The Peer class. Instance provides a convenient way of calling static methods on a class that calling code may not be able to identify.
`protected boolean`	`$startCopy`	`false`	# The flag var to prevent infinit loop in deep copy The flag var to prevent infinit loop in deep copy
`protected integer`	`$biomaterial_id`		# The value for the biomaterial_id field. The value for the biomaterial_id field.
`protected integer`	`$taxon_id`		# The value for the taxon_id field. The value for the taxon_id field.
`protected integer`	`$biosourceprovider_id`		# The value for the biosourceprovider_id field. The value for the biosourceprovider_id field.
`protected integer`	`$dbxref_id`		# The value for the dbxref_id field. The value for the dbxref_id field.
`protected string`	`$name`		# The value for the name field. The value for the name field.
`protected string`	`$description`		# The value for the description field. The value for the description field.
`protected cli_db\propel\Contact`	`$aContact`		#
`protected cli_db\propel\Organism`	`$aOrganism`		#
`protected PropelObjectCollection\|cli_db\propel\AssayBiomaterial[]`	`$collAssayBiomaterials`		# Collection to store aggregation of AssayBiomaterial objects. Collection to store aggregation of AssayBiomaterial objects.
`protected mixed`	`$collAssayBiomaterialsPartial`		#
`protected PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]`	`$collBiomaterialRelationshipsRelatedByObjectId`		# Collection to store aggregation of BiomaterialRelationship objects. Collection to store aggregation of BiomaterialRelationship objects.
`protected mixed`	`$collBiomaterialRelationshipsRelatedByObjectIdPartial`		#
`protected PropelObjectCollection\|cli_db\propel\BiomaterialRelationship[]`	`$collBiomaterialRelationshipsRelatedBySubjectId`		# Collection to store aggregation of BiomaterialRelationship objects. Collection to store aggregation of BiomaterialRelationship objects.
`protected mixed`	`$collBiomaterialRelationshipsRelatedBySubjectIdPartial`		#
`protected PropelObjectCollection\|cli_db\propel\Biomaterialprop[]`	`$collBiomaterialprops`		# Collection to store aggregation of Biomaterialprop objects. Collection to store aggregation of Biomaterialprop objects.
`protected mixed`	`$collBiomaterialpropsPartial`		#
`protected boolean`	`$alreadyInSave`	`false`	# Flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction. Flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.
`protected boolean`	`$alreadyInValidation`	`false`	# Flag to prevent endless validation loop, if this object is referenced by another object which falls in this transaction. Flag to prevent endless validation loop, if this object is referenced by another object which falls in this transaction.
`protected boolean`	`$alreadyInClearAllReferencesDeep`	`false`	# Flag to prevent endless clearAllReferences($deep=true) loop, if this object is referenced Flag to prevent endless clearAllReferences($deep=true) loop, if this object is referenced
`protected PropelObjectCollection`	`$assayBiomaterialsScheduledForDeletion`	`null`	# An array of objects scheduled for deletion. An array of objects scheduled for deletion.
`protected PropelObjectCollection`	`$biomaterialRelationshipsRelatedByObjectIdScheduledForDeletion`	`null`	# An array of objects scheduled for deletion. An array of objects scheduled for deletion.
`protected PropelObjectCollection`	`$biomaterialRelationshipsRelatedBySubjectIdScheduledForDeletion`	`null`	# An array of objects scheduled for deletion. An array of objects scheduled for deletion.
`protected PropelObjectCollection`	`$biomaterialpropsScheduledForDeletion`	`null`	# An array of objects scheduled for deletion. An array of objects scheduled for deletion.
`protected array`	`$validationFailures`	`array()`	# Array of ValidationFailed objects. Array of ValidationFailed objects.

Namespaces

Classes

Class BaseBiomaterial

Direct known subclasses

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Throws

Parameters

Throws

Parameters

Throws

See

Parameters

Returns

Throws

See

Parameters

Returns

Throws

See

Parameters

Throws

See

Parameters

See

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns