Overview

Namespaces

  • cli_db
    • propel
      • map
      • om
  • cli_import
  • LoggedPDO
  • None
  • PHP
  • webservices
    • cart
    • combisearch
    • details
      • annotations
        • feature
    • graphs
      • barplot
      • genome
    • listing
    • queue

Classes

  • BaseAcquisition
  • BaseAcquisitionPeer
  • BaseAcquisitionQuery
  • BaseAnalysis
  • BaseAnalysisPeer
  • BaseAnalysisQuery
  • BaseAssay
  • BaseAssayBiomaterial
  • BaseAssayBiomaterialPeer
  • BaseAssayBiomaterialQuery
  • BaseAssayPeer
  • BaseAssayQuery
  • BaseBiomaterial
  • BaseBiomaterialPeer
  • BaseBiomaterialprop
  • BaseBiomaterialpropPeer
  • BaseBiomaterialpropQuery
  • BaseBiomaterialQuery
  • BaseBiomaterialRelationship
  • BaseBiomaterialRelationshipPeer
  • BaseBiomaterialRelationshipQuery
  • BaseContact
  • BaseContactPeer
  • BaseContactQuery
  • BaseCv
  • BaseCvPeer
  • BaseCvQuery
  • BaseCvterm
  • BaseCvtermPeer
  • BaseCvtermQuery
  • BaseDb
  • BaseDbPeer
  • BaseDbQuery
  • BaseDbxref
  • BaseDbxrefPeer
  • BaseDbxrefQuery
  • BaseFeature
  • BaseFeatureCvterm
  • BaseFeatureCvtermDbxref
  • BaseFeatureCvtermDbxrefPeer
  • BaseFeatureCvtermDbxrefQuery
  • BaseFeatureCvtermPeer
  • BaseFeatureCvtermprop
  • BaseFeatureCvtermpropPeer
  • BaseFeatureCvtermpropQuery
  • BaseFeatureCvtermPub
  • BaseFeatureCvtermPubPeer
  • BaseFeatureCvtermPubQuery
  • BaseFeatureCvtermQuery
  • BaseFeatureDbxref
  • BaseFeatureDbxrefPeer
  • BaseFeatureDbxrefQuery
  • BaseFeaturePeer
  • BaseFeaturePub
  • BaseFeaturePubPeer
  • BaseFeaturePubQuery
  • BaseFeatureQuery
  • BaseFeatureSynonym
  • BaseFeatureSynonymPeer
  • BaseFeatureSynonymQuery
  • BaseOrganism
  • BaseOrganismPeer
  • BaseOrganismQuery
  • BaseProtocol
  • BaseProtocolPeer
  • BaseProtocolQuery
  • BasePub
  • BasePubauthor
  • BasePubauthorPeer
  • BasePubauthorQuery
  • BasePubDbxref
  • BasePubDbxrefPeer
  • BasePubDbxrefQuery
  • BasePubPeer
  • BasePubprop
  • BasePubpropPeer
  • BasePubpropQuery
  • BasePubQuery
  • BasePubRelationship
  • BasePubRelationshipPeer
  • BasePubRelationshipQuery
  • BaseQuantification
  • BaseQuantificationPeer
  • BaseQuantificationQuery
  • BaseSynonym
  • BaseSynonymPeer
  • BaseSynonymQuery
  • Overview
  • Namespace
  • Class
  • Tree

Class BaseDbxref

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

BaseObject
Extended by cli_db\propel\om\BaseDbxref implements Persistent

Direct known subclasses

cli_db\propel\Dbxref
Abstract
Namespace: cli_db\propel\om
Package: propel\generator\cli\db\om
Located at src/cli/db/propel-classes/cli_db/om/BaseDbxref.php
Methods summary
public
# applyDefaultValues( )

Applies default values to this object. This method should be called from the object's constructor (or equivalent initialization method).

Applies default values to this object. This method should be called from the object's constructor (or equivalent initialization method).

See

cli_db\propel\om\BaseDbxref::__construct()
public
# __construct( )

Initializes internal state of BaseDbxref object.

Initializes internal state of BaseDbxref object.

See

applyDefaults()
public integer
# getDbxrefId( )

Get the [dbxref_id] column value.

Get the [dbxref_id] column value.

Returns

integer
public integer
# getDbId( )

Get the [db_id] column value.

Get the [db_id] column value.

Returns

integer
public string
# getAccession( )

Get the [accession] column value.

Get the [accession] column value.

Returns

string
public string
# getVersion( )

Get the [version] column value.

Get the [version] column value.

Returns

string
public string
# getDescription( )

Get the [description] column value.

Get the [description] column value.

Returns

string
public cli_db\propel\Dbxref
# 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\Dbxref
The current object (for fluent API support)
public cli_db\propel\Dbxref
# setDbId( integer $v )

Set the value of [db_id] column.

Set the value of [db_id] column.

Parameters

$v
integer
$v new value

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public cli_db\propel\Dbxref
# setAccession( string $v )

Set the value of [accession] column.

Set the value of [accession] column.

Parameters

$v
string
$v new value

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public cli_db\propel\Dbxref
# setVersion( string $v )

Set the value of [version] column.

Set the value of [version] column.

Parameters

$v
string
$v new value

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public cli_db\propel\Dbxref
# 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\Dbxref
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\BaseDbxref::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\BaseDbxref::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\BaseDbxref::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\BaseDbxref::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\BaseDbxref::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\BaseDbxref::doValidate()
cli_db\propel\om\BaseDbxref::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 (dbxref_id column).

Generic method to set the primary key (dbxref_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 Dbxref (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\Dbxref
# 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\Dbxref
Clone of current object.

Throws

PropelException
public cli_db\propel\DbxrefPeer
# 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\DbxrefPeer
public cli_db\propel\Dbxref
# setDb( cli_db\propel\Db $v = null )

Declares an association between this object and a Db object.

Declares an association between this object and a Db object.

Parameters

$v
cli_db\propel\Db
$v

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)

Throws

PropelException
public cli_db\propel\Db
# getDb( PropelPDO $con = null, mixed $doQuery = true )

Get the associated Db object

Get the associated Db object

Parameters

$con
PropelPDO
$con Optional Connection object.
$doQuery
mixed
$doQuery Executes a query to get the object if required

Returns

cli_db\propel\Db
The associated Db 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\Dbxref
# clearFeatures( )

Clears out the collFeatures collection

Clears out the collFeatures 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\Dbxref
The current object (for fluent API support)

See

addFeatures()
public
# resetPartialFeatures( mixed $v = true )

reset is the collFeatures collection loaded partially

reset is the collFeatures collection loaded partially

public
# initFeatures( boolean $overrideExisting = true )

Initializes the collFeatures collection.

Initializes the collFeatures collection.

By default this just sets the collFeatures collection to an empty array (like clearcollFeatures()); 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\Feature[]
# getFeatures( Criteria $criteria = null, PropelPDO $con = null )

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

Gets an array of Feature 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 Dbxref 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\Feature[]
List of Feature objects

Throws

PropelException
public cli_db\propel\Dbxref
# setFeatures( PropelCollection $features, PropelPDO $con = null )

Sets a collection of Feature 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 Feature 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

$features
PropelCollection
$features A Propel collection.
$con
PropelPDO
$con Optional connection object

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public integer
# countFeatures( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )

Returns the number of related Feature objects.

Returns the number of related Feature objects.

Parameters

$criteria
Criteria
$criteria
$distinct
boolean
$distinct
$con
PropelPDO
$con

Returns

integer
Count of related Feature objects.

Throws

PropelException
public cli_db\propel\Dbxref
# addFeature( cli_db\propel\Feature $l )

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

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

Parameters

$l
cli_db\propel\Feature
$l Feature

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
protected
# doAddFeature( cli_db\propel\Feature $feature )

Parameters

$feature
cli_db\propel\Feature
$feature The feature object to add.
public cli_db\propel\Dbxref
# removeFeature( cli_db\propel\Feature $feature )

Parameters

$feature
cli_db\propel\Feature
$feature The feature object to remove.

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public PropelObjectCollection|cli_db\propel\Feature[]
# getFeaturesJoinOrganism( 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 Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related Features from storage.

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related Features 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 Dbxref.

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\Feature[]
List of Feature objects
public PropelObjectCollection|cli_db\propel\Feature[]
# getFeaturesJoinCvterm( 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 Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related Features from storage.

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related Features 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 Dbxref.

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\Feature[]
List of Feature objects
public cli_db\propel\Dbxref
# clearFeatureCvtermDbxrefs( )

Clears out the collFeatureCvtermDbxrefs collection

Clears out the collFeatureCvtermDbxrefs 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\Dbxref
The current object (for fluent API support)

See

addFeatureCvtermDbxrefs()
public
# resetPartialFeatureCvtermDbxrefs( mixed $v = true )

reset is the collFeatureCvtermDbxrefs collection loaded partially

reset is the collFeatureCvtermDbxrefs collection loaded partially

public
# initFeatureCvtermDbxrefs( boolean $overrideExisting = true )

Initializes the collFeatureCvtermDbxrefs collection.

Initializes the collFeatureCvtermDbxrefs collection.

By default this just sets the collFeatureCvtermDbxrefs collection to an empty array (like clearcollFeatureCvtermDbxrefs()); 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\FeatureCvtermDbxref[]
# getFeatureCvtermDbxrefs( Criteria $criteria = null, PropelPDO $con = null )

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

Gets an array of FeatureCvtermDbxref 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 Dbxref 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\FeatureCvtermDbxref[]
List of FeatureCvtermDbxref objects

Throws

PropelException
public cli_db\propel\Dbxref
# setFeatureCvtermDbxrefs( PropelCollection $featureCvtermDbxrefs, PropelPDO $con = null )

Sets a collection of FeatureCvtermDbxref 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 FeatureCvtermDbxref 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

$featureCvtermDbxrefs
PropelCollection
$featureCvtermDbxrefs A Propel collection.
$con
PropelPDO
$con Optional connection object

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public integer
# countFeatureCvtermDbxrefs( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )

Returns the number of related FeatureCvtermDbxref objects.

Returns the number of related FeatureCvtermDbxref objects.

Parameters

$criteria
Criteria
$criteria
$distinct
boolean
$distinct
$con
PropelPDO
$con

Returns

integer
Count of related FeatureCvtermDbxref objects.

Throws

PropelException
public cli_db\propel\Dbxref
# addFeatureCvtermDbxref( cli_db\propel\FeatureCvtermDbxref $l )

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

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

Parameters

$l
cli_db\propel\FeatureCvtermDbxref
$l FeatureCvtermDbxref

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
protected
# doAddFeatureCvtermDbxref( cli_db\propel\FeatureCvtermDbxref $featureCvtermDbxref )

Parameters

$featureCvtermDbxref
cli_db\propel\FeatureCvtermDbxref
$featureCvtermDbxref The featureCvtermDbxref object to add.
public cli_db\propel\Dbxref
# removeFeatureCvtermDbxref( cli_db\propel\FeatureCvtermDbxref $featureCvtermDbxref )

Parameters

$featureCvtermDbxref
cli_db\propel\FeatureCvtermDbxref
$featureCvtermDbxref The featureCvtermDbxref object to remove.

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public PropelObjectCollection|cli_db\propel\FeatureCvtermDbxref[]
# getFeatureCvtermDbxrefsJoinFeatureCvterm( 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 Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related FeatureCvtermDbxrefs from storage.

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related FeatureCvtermDbxrefs 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 Dbxref.

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\FeatureCvtermDbxref[]
List of FeatureCvtermDbxref objects
public cli_db\propel\Dbxref
# clearFeatureDbxrefs( )

Clears out the collFeatureDbxrefs collection

Clears out the collFeatureDbxrefs 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\Dbxref
The current object (for fluent API support)

See

addFeatureDbxrefs()
public
# resetPartialFeatureDbxrefs( mixed $v = true )

reset is the collFeatureDbxrefs collection loaded partially

reset is the collFeatureDbxrefs collection loaded partially

public
# initFeatureDbxrefs( boolean $overrideExisting = true )

Initializes the collFeatureDbxrefs collection.

Initializes the collFeatureDbxrefs collection.

By default this just sets the collFeatureDbxrefs collection to an empty array (like clearcollFeatureDbxrefs()); 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\FeatureDbxref[]
# getFeatureDbxrefs( Criteria $criteria = null, PropelPDO $con = null )

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

Gets an array of FeatureDbxref 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 Dbxref 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\FeatureDbxref[]
List of FeatureDbxref objects

Throws

PropelException
public cli_db\propel\Dbxref
# setFeatureDbxrefs( PropelCollection $featureDbxrefs, PropelPDO $con = null )

Sets a collection of FeatureDbxref 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 FeatureDbxref 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

$featureDbxrefs
PropelCollection
$featureDbxrefs A Propel collection.
$con
PropelPDO
$con Optional connection object

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public integer
# countFeatureDbxrefs( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )

Returns the number of related FeatureDbxref objects.

Returns the number of related FeatureDbxref objects.

Parameters

$criteria
Criteria
$criteria
$distinct
boolean
$distinct
$con
PropelPDO
$con

Returns

integer
Count of related FeatureDbxref objects.

Throws

PropelException
public cli_db\propel\Dbxref
# addFeatureDbxref( cli_db\propel\FeatureDbxref $l )

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

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

Parameters

$l
cli_db\propel\FeatureDbxref
$l FeatureDbxref

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
protected
# doAddFeatureDbxref( cli_db\propel\FeatureDbxref $featureDbxref )

Parameters

$featureDbxref
cli_db\propel\FeatureDbxref
$featureDbxref The featureDbxref object to add.
public cli_db\propel\Dbxref
# removeFeatureDbxref( cli_db\propel\FeatureDbxref $featureDbxref )

Parameters

$featureDbxref
cli_db\propel\FeatureDbxref
$featureDbxref The featureDbxref object to remove.

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public PropelObjectCollection|cli_db\propel\FeatureDbxref[]
# getFeatureDbxrefsJoinFeature( 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 Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related FeatureDbxrefs from storage.

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related FeatureDbxrefs 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 Dbxref.

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\FeatureDbxref[]
List of FeatureDbxref objects
public cli_db\propel\Dbxref
# clearPubDbxrefs( )

Clears out the collPubDbxrefs collection

Clears out the collPubDbxrefs 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\Dbxref
The current object (for fluent API support)

See

addPubDbxrefs()
public
# resetPartialPubDbxrefs( mixed $v = true )

reset is the collPubDbxrefs collection loaded partially

reset is the collPubDbxrefs collection loaded partially

public
# initPubDbxrefs( boolean $overrideExisting = true )

Initializes the collPubDbxrefs collection.

Initializes the collPubDbxrefs collection.

By default this just sets the collPubDbxrefs collection to an empty array (like clearcollPubDbxrefs()); 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\PubDbxref[]
# getPubDbxrefs( Criteria $criteria = null, PropelPDO $con = null )

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

Gets an array of PubDbxref 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 Dbxref 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\PubDbxref[]
List of PubDbxref objects

Throws

PropelException
public cli_db\propel\Dbxref
# setPubDbxrefs( PropelCollection $pubDbxrefs, PropelPDO $con = null )

Sets a collection of PubDbxref 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 PubDbxref 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

$pubDbxrefs
PropelCollection
$pubDbxrefs A Propel collection.
$con
PropelPDO
$con Optional connection object

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public integer
# countPubDbxrefs( Criteria $criteria = null, boolean $distinct = false, PropelPDO $con = null )

Returns the number of related PubDbxref objects.

Returns the number of related PubDbxref objects.

Parameters

$criteria
Criteria
$criteria
$distinct
boolean
$distinct
$con
PropelPDO
$con

Returns

integer
Count of related PubDbxref objects.

Throws

PropelException
public cli_db\propel\Dbxref
# addPubDbxref( cli_db\propel\PubDbxref $l )

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

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

Parameters

$l
cli_db\propel\PubDbxref
$l PubDbxref

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
protected
# doAddPubDbxref( cli_db\propel\PubDbxref $pubDbxref )

Parameters

$pubDbxref
cli_db\propel\PubDbxref
$pubDbxref The pubDbxref object to add.
public cli_db\propel\Dbxref
# removePubDbxref( cli_db\propel\PubDbxref $pubDbxref )

Parameters

$pubDbxref
cli_db\propel\PubDbxref
$pubDbxref The pubDbxref object to remove.

Returns

cli_db\propel\Dbxref
The current object (for fluent API support)
public PropelObjectCollection|cli_db\propel\PubDbxref[]
# getPubDbxrefsJoinPub( 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 Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related PubDbxrefs from storage.

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Dbxref is new, it will return an empty collection; or if this Dbxref has previously been saved, it will retrieve related PubDbxrefs 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 Dbxref.

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\PubDbxref[]
List of PubDbxref 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\\DbxrefPeer'
#

Peer class name

Peer class name

Properties summary
protected static cli_db\propel\DbxrefPeer $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 $dbxref_id
#

The value for the dbxref_id field.

The value for the dbxref_id field.

protected integer $db_id
#

The value for the db_id field.

The value for the db_id field.

protected string $accession
#

The value for the accession field.

The value for the accession field.

protected string $version
#

The value for the version field. Note: this column has a database default value of: ''

The value for the version field. Note: this column has a database default value of: ''

protected string $description
#

The value for the description field.

The value for the description field.

protected cli_db\propel\Db $aDb
#
protected PropelObjectCollection|cli_db\propel\Feature[] $collFeatures
#

Collection to store aggregation of Feature objects.

Collection to store aggregation of Feature objects.

protected mixed $collFeaturesPartial
#
protected PropelObjectCollection|cli_db\propel\FeatureCvtermDbxref[] $collFeatureCvtermDbxrefs
#

Collection to store aggregation of FeatureCvtermDbxref objects.

Collection to store aggregation of FeatureCvtermDbxref objects.

protected mixed $collFeatureCvtermDbxrefsPartial
#
protected PropelObjectCollection|cli_db\propel\FeatureDbxref[] $collFeatureDbxrefs
#

Collection to store aggregation of FeatureDbxref objects.

Collection to store aggregation of FeatureDbxref objects.

protected mixed $collFeatureDbxrefsPartial
#
protected PropelObjectCollection|cli_db\propel\PubDbxref[] $collPubDbxrefs
#

Collection to store aggregation of PubDbxref objects.

Collection to store aggregation of PubDbxref objects.

protected mixed $collPubDbxrefsPartial
#
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 $featuresScheduledForDeletion null
#

An array of objects scheduled for deletion.

An array of objects scheduled for deletion.

protected PropelObjectCollection $featureCvtermDbxrefsScheduledForDeletion null
#

An array of objects scheduled for deletion.

An array of objects scheduled for deletion.

protected PropelObjectCollection $featureDbxrefsScheduledForDeletion null
#

An array of objects scheduled for deletion.

An array of objects scheduled for deletion.

protected PropelObjectCollection $pubDbxrefsScheduledForDeletion 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.

tbro API documentation generated by ApiGen 2.8.0