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 BasePubauthorQuery

Base class that represents a query for the 'pubauthor' table.

ModelCriteria
Extended by cli_db\propel\om\BasePubauthorQuery

Direct known subclasses

cli_db\propel\PubauthorQuery
Abstract
Namespace: cli_db\propel\om
Package: propel\generator\cli\db\om
Located at src/cli/db/propel-classes/cli_db/om/BasePubauthorQuery.php
Methods summary
public
# __construct( string $dbName = 'cli_db', string $modelName = 'cli_db\\propel\\Pubauthor', string $modelAlias = null )

Initializes internal state of BasePubauthorQuery object.

Initializes internal state of BasePubauthorQuery 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\PubauthorQuery
# create( string $modelAlias = null, cli_db\propel\PubauthorQuery|Criteria $criteria = null )

Returns a new PubauthorQuery object.

Returns a new PubauthorQuery object.

Parameters

$modelAlias
string
$modelAlias The alias of a model in the query
$criteria
cli_db\propel\PubauthorQuery|Criteria
$criteria Optional Criteria to build the query from

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\Pubauthor|cli_db\propel\Pubauthor[]|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

cli_db\propel\Pubauthor|cli_db\propel\Pubauthor[]|mixed
the result, formatted by the current formatter
public cli_db\propel\Pubauthor
# findOneByPubauthorId( 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

cli_db\propel\Pubauthor
A model object, or null if the key is not found

Throws

PropelException
protected cli_db\propel\Pubauthor
# 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

cli_db\propel\Pubauthor
A model object, or null if the key is not found

Throws

PropelException
protected cli_db\propel\Pubauthor|cli_db\propel\Pubauthor[]|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

cli_db\propel\Pubauthor|cli_db\propel\Pubauthor[]|mixed
the result, formatted by the current formatter
public PropelObjectCollection|cli_db\propel\Pubauthor[]|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

PropelObjectCollection|cli_db\propel\Pubauthor[]|mixed
the list of results, formatted by the current formatter
public cli_db\propel\PubauthorQuery
# 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# filterByPubauthorId( mixed $pubauthorId = null, string $comparison = null )

Filter the query on the pubauthor_id column

Filter the query on the pubauthor_id column

Example usage:

$query->filterByPubauthorId(1234); // WHERE pubauthor_id = 1234
$query->filterByPubauthorId(array(12, 34)); // WHERE pubauthor_id IN (12, 34)
$query->filterByPubauthorId(array('min' => 12)); // WHERE pubauthor_id >= 12
$query->filterByPubauthorId(array('max' => 12)); // WHERE pubauthor_id <= 12

Parameters

$pubauthorId
mixed
$pubauthorId 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# filterByPubId( mixed $pubId = null, string $comparison = null )

Filter the query on the pub_id column

Filter the query on the pub_id column

Example usage:

$query->filterByPubId(1234); // WHERE pub_id = 1234
$query->filterByPubId(array(12, 34)); // WHERE pub_id IN (12, 34)
$query->filterByPubId(array('min' => 12)); // WHERE pub_id >= 12
$query->filterByPubId(array('max' => 12)); // WHERE pub_id <= 12

Parameters

$pubId
mixed
$pubId 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface

See

cli_db\propel\om\BasePubauthorQuery::filterByPub()
public cli_db\propel\PubauthorQuery
# filterByRank( mixed $rank = null, string $comparison = null )

Filter the query on the rank column

Filter the query on the rank column

Example usage:

$query->filterByRank(1234); // WHERE rank = 1234
$query->filterByRank(array(12, 34)); // WHERE rank IN (12, 34)
$query->filterByRank(array('min' => 12)); // WHERE rank >= 12
$query->filterByRank(array('max' => 12)); // WHERE rank <= 12

Parameters

$rank
mixed
$rank 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# filterByEditor( boolean|string $editor = null, string $comparison = null )

Filter the query on the editor column

Filter the query on the editor column

Example usage:

$query->filterByEditor(true); // WHERE editor = true
$query->filterByEditor('yes'); // WHERE editor = true

Parameters

$editor
boolean|string
$editor The value to use as filter. Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
$comparison
string
$comparison Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# filterBySurname( string $surname = null, string $comparison = null )

Filter the query on the surname column

Filter the query on the surname column

Example usage:

$query->filterBySurname('fooValue');   // WHERE surname = 'fooValue'
$query->filterBySurname('%fooValue%'); // WHERE surname LIKE '%fooValue%'

Parameters

$surname
string
$surname 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# filterByGivennames( string $givennames = null, string $comparison = null )

Filter the query on the givennames column

Filter the query on the givennames column

Example usage:

$query->filterByGivennames('fooValue');   // WHERE givennames = 'fooValue'
$query->filterByGivennames('%fooValue%'); // WHERE givennames LIKE '%fooValue%'

Parameters

$givennames
string
$givennames 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# filterBySuffix( string $suffix = null, string $comparison = null )

Filter the query on the suffix column

Filter the query on the suffix column

Example usage:

$query->filterBySuffix('fooValue');   // WHERE suffix = 'fooValue'
$query->filterBySuffix('%fooValue%'); // WHERE suffix LIKE '%fooValue%'

Parameters

$suffix
string
$suffix 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

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubauthorQuery
# filterByPub( cli_db\propel\Pub|PropelObjectCollection $pub, string $comparison = null )

Filter the query by a related Pub object

Filter the query by a related Pub object

Parameters

$pub
cli_db\propel\Pub|PropelObjectCollection
$pub The related object(s) to use as filter
$comparison
string
$comparison Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns

cli_db\propel\PubauthorQuery
The current query, for fluid interface

Throws

PropelException
- if the provided filter is invalid.
public cli_db\propel\PubauthorQuery
# joinPub( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )

Adds a JOIN clause to the query using the Pub relation

Adds a JOIN clause to the query using the Pub relation

Parameters

$relationAlias
string
$relationAlias optional alias for the relation
$joinType
string
$joinType Accepted values are null, 'left join', 'right join', 'inner join'

Returns

cli_db\propel\PubauthorQuery
The current query, for fluid interface
public cli_db\propel\PubQuery
# usePubQuery( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )

Use the Pub relation Pub object

Use the Pub relation Pub 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

cli_db\propel\PubQuery
A secondary query class using the current class as primary query

See

useQuery()
public cli_db\propel\PubauthorQuery
# prune( cli_db\propel\Pubauthor $pubauthor = null )

Exclude object from result

Exclude object from result

Parameters

$pubauthor
cli_db\propel\Pubauthor
$pubauthor Object to remove from the list of results

Returns

cli_db\propel\PubauthorQuery
The current query, for fluid interface
Magic methods summary
public cli_db\propel\PubauthorQuery
# orderByPubauthorId( mixed $order = cli_db\propel\om\Criteria::ASC )

Order by the pubauthor_id column

Order by the pubauthor_id column

Parameters

$order
mixed
$order

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# orderByPubId( mixed $order = cli_db\propel\om\Criteria::ASC )

Order by the pub_id column

Order by the pub_id column

Parameters

$order
mixed
$order

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# orderByRank( mixed $order = cli_db\propel\om\Criteria::ASC )

Order by the rank column

Order by the rank column

Parameters

$order
mixed
$order

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# orderByEditor( mixed $order = cli_db\propel\om\Criteria::ASC )

Order by the editor column

Order by the editor column

Parameters

$order
mixed
$order

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# orderBySurname( mixed $order = cli_db\propel\om\Criteria::ASC )

Order by the surname column

Order by the surname column

Parameters

$order
mixed
$order

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# orderByGivennames( mixed $order = cli_db\propel\om\Criteria::ASC )

Order by the givennames column

Order by the givennames column

Parameters

$order
mixed
$order

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# orderBySuffix( mixed $order = cli_db\propel\om\Criteria::ASC )

Order by the suffix column

Order by the suffix column

Parameters

$order
mixed
$order

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# groupByPubauthorId( )

Group by the pubauthor_id column

Group by the pubauthor_id column

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# groupByPubId( )

Group by the pub_id column

Group by the pub_id column

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# groupByRank( )

Group by the rank column

Group by the rank column

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# groupByEditor( )

Group by the editor column

Group by the editor column

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# groupBySurname( )

Group by the surname column

Group by the surname column

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# groupByGivennames( )

Group by the givennames column

Group by the givennames column

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# groupBySuffix( )

Group by the suffix column

Group by the suffix column

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# leftJoin( mixed $relation = )

Adds a LEFT JOIN clause to the query

Adds a LEFT JOIN clause to the query

Parameters

$relation
mixed
$relation

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# rightJoin( mixed $relation = )

Adds a RIGHT JOIN clause to the query

Adds a RIGHT JOIN clause to the query

Parameters

$relation
mixed
$relation

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# innerJoin( mixed $relation = )

Adds a INNER JOIN clause to the query

Adds a INNER JOIN clause to the query

Parameters

$relation
mixed
$relation

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# leftJoinPub( mixed $relationAlias = null )

Adds a LEFT JOIN clause to the query using the Pub relation

Adds a LEFT JOIN clause to the query using the Pub relation

Parameters

$relationAlias
mixed
$relationAlias

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# rightJoinPub( mixed $relationAlias = null )

Adds a RIGHT JOIN clause to the query using the Pub relation

Adds a RIGHT JOIN clause to the query using the Pub relation

Parameters

$relationAlias
mixed
$relationAlias

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\PubauthorQuery
# innerJoinPub( mixed $relationAlias = null )

Adds a INNER JOIN clause to the query using the Pub relation

Adds a INNER JOIN clause to the query using the Pub relation

Parameters

$relationAlias
mixed
$relationAlias

Returns

cli_db\propel\PubauthorQuery
public cli_db\propel\Pubauthor
# findOne( PropelPDO $con = null )

Return the first Pubauthor matching the query

Return the first Pubauthor matching the query

Parameters

$con
PropelPDO
$con

Returns

cli_db\propel\Pubauthor
public cli_db\propel\Pubauthor
# findOneOrCreate( PropelPDO $con = null )

Return the first Pubauthor matching the query, or a new Pubauthor object populated from the query conditions when no match is found

Return the first Pubauthor matching the query, or a new Pubauthor object populated from the query conditions when no match is found

Parameters

$con
PropelPDO
$con

Returns

cli_db\propel\Pubauthor
public cli_db\propel\Pubauthor
# findOneByPubId( integer $pub_id = )

Return the first Pubauthor filtered by the pub_id column

Return the first Pubauthor filtered by the pub_id column

Parameters

$pub_id
integer
$pub_id

Returns

cli_db\propel\Pubauthor
public cli_db\propel\Pubauthor
# findOneByRank( integer $rank = )

Return the first Pubauthor filtered by the rank column

Return the first Pubauthor filtered by the rank column

Parameters

$rank
integer
$rank

Returns

cli_db\propel\Pubauthor
public cli_db\propel\Pubauthor
# findOneByEditor( boolean $editor = )

Return the first Pubauthor filtered by the editor column

Return the first Pubauthor filtered by the editor column

Parameters

$editor
boolean
$editor

Returns

cli_db\propel\Pubauthor
public cli_db\propel\Pubauthor
# findOneBySurname( string $surname = )

Return the first Pubauthor filtered by the surname column

Return the first Pubauthor filtered by the surname column

Parameters

$surname
string
$surname

Returns

cli_db\propel\Pubauthor
public cli_db\propel\Pubauthor
# findOneByGivennames( string $givennames = )

Return the first Pubauthor filtered by the givennames column

Return the first Pubauthor filtered by the givennames column

Parameters

$givennames
string
$givennames

Returns

cli_db\propel\Pubauthor
public cli_db\propel\Pubauthor
# findOneBySuffix( string $suffix = )

Return the first Pubauthor filtered by the suffix column

Return the first Pubauthor filtered by the suffix column

Parameters

$suffix
string
$suffix

Returns

cli_db\propel\Pubauthor
public array
# findByPubauthorId( integer $pubauthor_id = )

Return Pubauthor objects filtered by the pubauthor_id column

Return Pubauthor objects filtered by the pubauthor_id column

Parameters

$pubauthor_id
integer
$pubauthor_id

Returns

array
public array
# findByPubId( integer $pub_id = )

Return Pubauthor objects filtered by the pub_id column

Return Pubauthor objects filtered by the pub_id column

Parameters

$pub_id
integer
$pub_id

Returns

array
public array
# findByRank( integer $rank = )

Return Pubauthor objects filtered by the rank column

Return Pubauthor objects filtered by the rank column

Parameters

$rank
integer
$rank

Returns

array
public array
# findByEditor( boolean $editor = )

Return Pubauthor objects filtered by the editor column

Return Pubauthor objects filtered by the editor column

Parameters

$editor
boolean
$editor

Returns

array
public array
# findBySurname( string $surname = )

Return Pubauthor objects filtered by the surname column

Return Pubauthor objects filtered by the surname column

Parameters

$surname
string
$surname

Returns

array
public array
# findByGivennames( string $givennames = )

Return Pubauthor objects filtered by the givennames column

Return Pubauthor objects filtered by the givennames column

Parameters

$givennames
string
$givennames

Returns

array
public array
# findBySuffix( string $suffix = )

Return Pubauthor objects filtered by the suffix column

Return Pubauthor objects filtered by the suffix column

Parameters

$suffix
string
$suffix

Returns

array
tbro API documentation generated by ApiGen 2.8.0