Methods summary
public
|
#
__construct( string $dbName = 'cli_db', string $modelName = 'cli_db\\propel\\Organism', string $modelAlias = null )
Initializes internal state of BaseOrganismQuery object.
Initializes internal state of BaseOrganismQuery object.
Parameters
- $dbName
string $dbName The dabase name
- $modelName
string $modelName The phpName of a model, e.g. 'Book'
- $modelAlias
string $modelAlias The alias for the model in this query, e.g. 'b'
|
public static
cli_db\propel\OrganismQuery
|
#
create( string $modelAlias = null, cli_db\propel\OrganismQuery |Criteria $criteria = null )
Returns a new OrganismQuery object.
Returns a new OrganismQuery object.
Parameters
- $modelAlias
string $modelAlias The alias of a model in the query
- $criteria
cli_db\propel\OrganismQuery |Criteria
$criteria Optional Criteria to build the query from
Returns
|
public
cli_db\propel\Organism |cli_db\propel\Organism[] |mixed
|
#
findPk( mixed $key, PropelPDO $con = null )
Find object by primary key. Propel uses the instance pool to skip the
database if the object exists. Go fast if the query is untouched.
Find object by primary key. Propel uses the instance pool to skip the
database if the object exists. Go fast if the query is untouched.
$obj = $c->findPk(12, $con);
Parameters
- $key
mixed $key Primary key to use for the query
- $con
PropelPDO $con an optional connection object
Returns
|
public
cli_db\propel\Organism
|
#
findOneByOrganismId( mixed $key, PropelPDO $con = null )
Alias of findPk to use instance pooling
Alias of findPk to use instance pooling
Parameters
- $key
mixed $key Primary key to use for the query
- $con
PropelPDO $con A connection object
Returns
Throws
PropelException
|
protected
cli_db\propel\Organism
|
#
findPkSimple( mixed $key, PropelPDO $con )
Find object by primary key using raw SQL to go fast. Bypass doSelect() and
the object formatter by using generated code.
Find object by primary key using raw SQL to go fast. Bypass doSelect() and
the object formatter by using generated code.
Parameters
- $key
mixed $key Primary key to use for the query
- $con
PropelPDO $con A connection object
Returns
Throws
PropelException
|
protected
cli_db\propel\Organism |cli_db\propel\Organism[] |mixed
|
#
findPkComplex( mixed $key, PropelPDO $con )
Find object by primary key.
Find object by primary key.
Parameters
- $key
mixed $key Primary key to use for the query
- $con
PropelPDO $con A connection object
Returns
|
public
PropelObjectCollection|cli_db\propel\Organism[] |mixed
|
#
findPks( array $keys, PropelPDO $con = null )
Find objects by primary key
$objs = $c->findPks(array(12, 56, 832), $con);
Find objects by primary key
$objs = $c->findPks(array(12, 56, 832), $con);
Parameters
- $keys
array $keys Primary keys to use for the query
- $con
PropelPDO $con an optional connection object
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterByPrimaryKey( mixed $key )
Filter the query by primary key
Filter the query by primary key
Parameters
- $key
mixed $key Primary key to use for the query
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterByPrimaryKeys( array $keys )
Filter the query by a list of primary keys
Filter the query by a list of primary keys
Parameters
- $keys
array $keys The list of primary key to use for the query
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterByOrganismId( mixed $organismId = null, string $comparison = null )
Filter the query on the organism_id column
Filter the query on the organism_id column
Example usage:
$query->filterByOrganismId(1234);
$query->filterByOrganismId(array(12, 34));
$query->filterByOrganismId(array('min' => 12));
$query->filterByOrganismId(array('max' => 12));
Parameters
- $organismId
mixed $organismId The value to use as filter. Use scalar values for equality. Use
array values for in_array() equivalent. Use associative array('min' =>
$minValue, 'max' => $maxValue) for intervals.
- $comparison
string $comparison Operator to use for the column comparison, defaults to
Criteria::EQUAL
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterByAbbreviation( string $abbreviation = null, string $comparison = null )
Filter the query on the abbreviation column
Filter the query on the abbreviation column
Example usage:
$query->filterByAbbreviation('fooValue');
$query->filterByAbbreviation('%fooValue%');
Parameters
- $abbreviation
string $abbreviation The value to use as filter. Accepts wildcards (* and % trigger a
LIKE)
- $comparison
string $comparison Operator to use for the column comparison, defaults to
Criteria::EQUAL
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterByGenus( string $genus = null, string $comparison = null )
Filter the query on the genus column
Filter the query on the genus column
Example usage:
$query->filterByGenus('fooValue');
$query->filterByGenus('%fooValue%');
Parameters
- $genus
string $genus The value to use as filter. Accepts wildcards (* and % trigger a LIKE)
- $comparison
string $comparison Operator to use for the column comparison, defaults to
Criteria::EQUAL
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterBySpecies( string $species = null, string $comparison = null )
Filter the query on the species column
Filter the query on the species column
Example usage:
$query->filterBySpecies('fooValue');
$query->filterBySpecies('%fooValue%');
Parameters
- $species
string $species The value to use as filter. Accepts wildcards (* and % trigger a LIKE)
- $comparison
string $comparison Operator to use for the column comparison, defaults to
Criteria::EQUAL
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterByCommonName( string $commonName = null, string $comparison = null )
Filter the query on the common_name column
Filter the query on the common_name column
Example usage:
$query->filterByCommonName('fooValue');
$query->filterByCommonName('%fooValue%');
Parameters
- $commonName
string $commonName The value to use as filter. Accepts wildcards (* and % trigger a
LIKE)
- $comparison
string $comparison Operator to use for the column comparison, defaults to
Criteria::EQUAL
Returns
|
public
cli_db\propel\OrganismQuery
|
#
filterByBiomaterial( cli_db\propel\Biomaterial |PropelObjectCollection $biomaterial, string $comparison = null )
Filter the query by a related Biomaterial object
Filter the query by a related Biomaterial object
Parameters
- $biomaterial
cli_db\propel\Biomaterial |PropelObjectCollection
$biomaterial the related object to use as filter
- $comparison
string $comparison Operator to use for the column comparison, defaults to
Criteria::EQUAL
Returns
Throws
PropelException - if the provided filter is invalid.
|
public
cli_db\propel\OrganismQuery
|
#
joinBiomaterial( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::LEFT_JOIN )
Adds a JOIN clause to the query using the Biomaterial relation
Adds a JOIN clause to the query using the Biomaterial relation
Parameters
- $relationAlias
string $relationAlias optional alias for the relation
- $joinType
string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
Returns
|
public
cli_db\propel\BiomaterialQuery
|
#
useBiomaterialQuery( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::LEFT_JOIN )
Use the Biomaterial relation Biomaterial object
Use the Biomaterial relation Biomaterial object
Parameters
- $relationAlias
string $relationAlias optional alias for the relation, to be used as main alias in the
secondary query
- $joinType
string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
Returns
See
useQuery()
|
public
cli_db\propel\OrganismQuery
|
#
filterByFeature( cli_db\propel\Feature |PropelObjectCollection $feature, string $comparison = null )
Filter the query by a related Feature object
Filter the query by a related Feature object
Parameters
- $feature
cli_db\propel\Feature |PropelObjectCollection
$feature the related object to use as filter
- $comparison
string $comparison Operator to use for the column comparison, defaults to
Criteria::EQUAL
Returns
Throws
PropelException - if the provided filter is invalid.
|
public
cli_db\propel\OrganismQuery
|
#
joinFeature( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )
Adds a JOIN clause to the query using the Feature relation
Adds a JOIN clause to the query using the Feature relation
Parameters
- $relationAlias
string $relationAlias optional alias for the relation
- $joinType
string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
Returns
|
public
cli_db\propel\FeatureQuery
|
#
useFeatureQuery( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )
Use the Feature relation Feature object
Use the Feature relation Feature object
Parameters
- $relationAlias
string $relationAlias optional alias for the relation, to be used as main alias in the
secondary query
- $joinType
string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
Returns
See
useQuery()
|
public
cli_db\propel\OrganismQuery
|
|
Magic methods summary
public
cli_db\propel\OrganismQuery
|
#
orderByOrganismId( mixed $order = cli_db\propel\om\Criteria::ASC )
Order by the organism_id column
Order by the organism_id column
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
orderByAbbreviation( mixed $order = cli_db\propel\om\Criteria::ASC )
Order by the abbreviation column
Order by the abbreviation column
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
orderByGenus( mixed $order = cli_db\propel\om\Criteria::ASC )
Order by the genus column
Order by the genus column
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
orderBySpecies( mixed $order = cli_db\propel\om\Criteria::ASC )
Order by the species column
Order by the species column
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
orderByCommonName( mixed $order = cli_db\propel\om\Criteria::ASC )
Order by the common_name column
Order by the common_name column
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
groupByOrganismId( )
Group by the organism_id column
Group by the organism_id column
Returns
|
public
cli_db\propel\OrganismQuery
|
|
public
cli_db\propel\OrganismQuery
|
#
groupByGenus( )
Group by the genus column
Group by the genus column
Returns
|
public
cli_db\propel\OrganismQuery
|
#
groupBySpecies( )
Group by the species column
Group by the species column
Returns
|
public
cli_db\propel\OrganismQuery
|
#
groupByCommonName( )
Group by the common_name column
Group by the common_name column
Returns
|
public
cli_db\propel\OrganismQuery
|
#
leftJoin( mixed $relation = )
Adds a LEFT JOIN clause to the query
Adds a LEFT JOIN clause to the query
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
rightJoin( mixed $relation = )
Adds a RIGHT JOIN clause to the query
Adds a RIGHT JOIN clause to the query
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
innerJoin( mixed $relation = )
Adds a INNER JOIN clause to the query
Adds a INNER JOIN clause to the query
Parameters
Returns
|
public
cli_db\propel\OrganismQuery
|
#
leftJoinBiomaterial( mixed $relationAlias = null )
Adds a LEFT JOIN clause to the query using the Biomaterial relation
Adds a LEFT JOIN clause to the query using the Biomaterial relation
Parameters
- $relationAlias
mixed $relationAlias
Returns
|
public
cli_db\propel\OrganismQuery
|
#
rightJoinBiomaterial( mixed $relationAlias = null )
Adds a RIGHT JOIN clause to the query using the Biomaterial relation
Adds a RIGHT JOIN clause to the query using the Biomaterial relation
Parameters
- $relationAlias
mixed $relationAlias
Returns
|
public
cli_db\propel\OrganismQuery
|
#
innerJoinBiomaterial( mixed $relationAlias = null )
Adds a INNER JOIN clause to the query using the Biomaterial relation
Adds a INNER JOIN clause to the query using the Biomaterial relation
Parameters
- $relationAlias
mixed $relationAlias
Returns
|
public
cli_db\propel\OrganismQuery
|
#
leftJoinFeature( mixed $relationAlias = null )
Adds a LEFT JOIN clause to the query using the Feature relation
Adds a LEFT JOIN clause to the query using the Feature relation
Parameters
- $relationAlias
mixed $relationAlias
Returns
|
public
cli_db\propel\OrganismQuery
|
#
rightJoinFeature( mixed $relationAlias = null )
Adds a RIGHT JOIN clause to the query using the Feature relation
Adds a RIGHT JOIN clause to the query using the Feature relation
Parameters
- $relationAlias
mixed $relationAlias
Returns
|
public
cli_db\propel\OrganismQuery
|
#
innerJoinFeature( mixed $relationAlias = null )
Adds a INNER JOIN clause to the query using the Feature relation
Adds a INNER JOIN clause to the query using the Feature relation
Parameters
- $relationAlias
mixed $relationAlias
Returns
|
public
cli_db\propel\Organism
|
#
findOne( PropelPDO $con = null )
Return the first Organism matching the query
Return the first Organism matching the query
Parameters
Returns
|
public
cli_db\propel\Organism
|
#
findOneOrCreate( PropelPDO $con = null )
Return the first Organism matching the query, or a new Organism object
populated from the query conditions when no match is found
Return the first Organism matching the query, or a new Organism object
populated from the query conditions when no match is found
Parameters
Returns
|
public
cli_db\propel\Organism
|
#
findOneByAbbreviation( string $abbreviation = )
Return the first Organism filtered by the abbreviation column
Return the first Organism filtered by the abbreviation column
Parameters
- $abbreviation
string $abbreviation
Returns
|
public
cli_db\propel\Organism
|
#
findOneByGenus( string $genus = )
Return the first Organism filtered by the genus column
Return the first Organism filtered by the genus column
Parameters
Returns
|
public
cli_db\propel\Organism
|
#
findOneBySpecies( string $species = )
Return the first Organism filtered by the species column
Return the first Organism filtered by the species column
Parameters
Returns
|
public
cli_db\propel\Organism
|
#
findOneByCommonName( string $common_name = )
Return the first Organism filtered by the common_name column
Return the first Organism filtered by the common_name column
Parameters
- $common_name
string $common_name
Returns
|
public
array
|
#
findByOrganismId( integer $organism_id = )
Return Organism objects filtered by the organism_id column
Return Organism objects filtered by the organism_id column
Parameters
- $organism_id
integer $organism_id
Returns
array
|
public
array
|
#
findByAbbreviation( string $abbreviation = )
Return Organism objects filtered by the abbreviation column
Return Organism objects filtered by the abbreviation column
Parameters
- $abbreviation
string $abbreviation
Returns
array
|
public
array
|
#
findByGenus( string $genus = )
Return Organism objects filtered by the genus column
Return Organism objects filtered by the genus column
Parameters
Returns
array
|
public
array
|
#
findBySpecies( string $species = )
Return Organism objects filtered by the species column
Return Organism objects filtered by the species column
Parameters
Returns
array
|
public
array
|
#
findByCommonName( string $common_name = )
Return Organism objects filtered by the common_name column
Return Organism objects filtered by the common_name column
Parameters
- $common_name
string $common_name
Returns
array
|