Inheritance diagram for BaseReferenceQuery:

Public Member Functions
	__construct ($dbName=null, $modelName=null, $modelAlias=null)

	findPk ($key, $con=null)

	findOneById ($key, $con=null)

	findPks ($keys, $con=null)

	filterByPrimaryKey ($key)

	filterByPrimaryKeys ($keys)

	filterById ($id=null, $comparison=null)

	filterByFromId ($fromId=null, $comparison=null)

	filterByFromModelName ($fromModelName=null, $comparison=null)

	filterByToId ($toId=null, $comparison=null)

	filterByToModelName ($toModelName=null, $comparison=null)

	filterByCreatedAt ($createdAt=null, $comparison=null)

	filterByUpdatedAt ($updatedAt=null, $comparison=null)

	filterByCreatedBy ($createdBy=null, $comparison=null)

	filterByUpdatedBy ($updatedBy=null, $comparison=null)

	filterByUserRelatedByCreatedBy ($user, $comparison=null)

	joinUserRelatedByCreatedBy ($relationAlias=null, $joinType=Criteria::LEFT_JOIN)

	useUserRelatedByCreatedByQuery ($relationAlias=null, $joinType=Criteria::LEFT_JOIN)

	filterByUserRelatedByUpdatedBy ($user, $comparison=null)

	joinUserRelatedByUpdatedBy ($relationAlias=null, $joinType=Criteria::LEFT_JOIN)

	useUserRelatedByUpdatedByQuery ($relationAlias=null, $joinType=Criteria::LEFT_JOIN)

	prune ($reference=null)

	recentlyUpdated ($nbDays=7)

	lastUpdatedFirst ()

	firstUpdatedFirst ()

	recentlyCreated ($nbDays=7)

	lastCreatedFirst ()

	firstCreatedFirst ()

	findMostRecentUpdate ($bAsTimestamp=false)

	filterByPKArray ($pkArray)

	filterByPKString ($pkString)

Static Public Member Functions
static	create ($modelAlias=null, $criteria=null)

Protected Member Functions
	findPkSimple ($key, $con)

	findPkComplex ($key, $con)

Constructor & Destructor Documentation

BaseReferenceQuery::__construct	(	$dbName = `null`,
		$modelName = `null`,
		$modelAlias = `null`
	)

Initializes internal state of BaseReferenceQuery object.

Parameters

string	$dbName	The dabase name
string	$modelName	The phpName of a model, e.g. 'Book'
string	$modelAlias	The alias for the model in this query, e.g. 'b'

Member Function Documentation

static BaseReferenceQuery::create	(	$modelAlias = `null`,
		$criteria = `null`
	)

static

Returns a new ReferenceQuery object.

Parameters

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

Returns: ReferenceQuery

BaseReferenceQuery::filterByCreatedAt	(	$createdAt = `null`,
		$comparison = `null`
	)

Filter the query on the created_at column

Example usage: $query->filterByCreatedAt('2011-03-14'); // WHERE created_at = '2011-03-14' $query->filterByCreatedAt('now'); // WHERE created_at = '2011-03-14' $query->filterByCreatedAt(array('max' => 'yesterday')); // WHERE created_at < '2011-03-13'

Parameters

mixed	$createdAt	The value to use as filter. Values can be integers (unix timestamps), DateTime objects, or strings. Empty strings are treated as NULL. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByCreatedBy	(	$createdBy = `null`,
		$comparison = `null`
	)

Filter the query on the created_by column

Example usage: $query->filterByCreatedBy(1234); // WHERE created_by = 1234 $query->filterByCreatedBy(array(12, 34)); // WHERE created_by IN (12, 34) $query->filterByCreatedBy(array('min' => 12)); // WHERE created_by >= 12 $query->filterByCreatedBy(array('max' => 12)); // WHERE created_by <= 12

See also: filterByUserRelatedByCreatedBy()

Parameters

mixed	$createdBy	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.
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByFromId	(	$fromId = `null`,
		$comparison = `null`
	)

Filter the query on the from_id column

Example usage: $query->filterByFromId('fooValue'); // WHERE from_id = 'fooValue' $query->filterByFromId('fooValue'); // WHERE from_id LIKE 'fooValue'

Parameters

string	$fromId	The value to use as filter. Accepts wildcards (* and % trigger a LIKE)
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByFromModelName	(	$fromModelName = `null`,
		$comparison = `null`
	)

Filter the query on the from_model_name column

Example usage: $query->filterByFromModelName('fooValue'); // WHERE from_model_name = 'fooValue' $query->filterByFromModelName('fooValue'); // WHERE from_model_name LIKE 'fooValue'

Parameters

string	$fromModelName	The value to use as filter. Accepts wildcards (* and % trigger a LIKE)
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterById	(	$id = `null`,
		$comparison = `null`
	)

Filter the query on the id column

Example usage: $query->filterById(1234); // WHERE id = 1234 $query->filterById(array(12, 34)); // WHERE id IN (12, 34) $query->filterById(array('min' => 12)); // WHERE id >= 12 $query->filterById(array('max' => 12)); // WHERE id <= 12

Parameters

mixed	$id	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.
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByPrimaryKey ( $key )

Filter the query by primary key

Parameters

mixed $key Primary key to use for the query

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByPrimaryKeys ( $keys )

Filter the query by a list of primary keys

Parameters

array $keys The list of primary key to use for the query

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByToId	(	$toId = `null`,
		$comparison = `null`
	)

Filter the query on the to_id column

Example usage: $query->filterByToId('fooValue'); // WHERE to_id = 'fooValue' $query->filterByToId('fooValue'); // WHERE to_id LIKE 'fooValue'

Parameters

string	$toId	The value to use as filter. Accepts wildcards (* and % trigger a LIKE)
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByToModelName	(	$toModelName = `null`,
		$comparison = `null`
	)

Filter the query on the to_model_name column

Example usage: $query->filterByToModelName('fooValue'); // WHERE to_model_name = 'fooValue' $query->filterByToModelName('fooValue'); // WHERE to_model_name LIKE 'fooValue'

Parameters

string	$toModelName	The value to use as filter. Accepts wildcards (* and % trigger a LIKE)
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByUpdatedAt	(	$updatedAt = `null`,
		$comparison = `null`
	)

Filter the query on the updated_at column

Example usage: $query->filterByUpdatedAt('2011-03-14'); // WHERE updated_at = '2011-03-14' $query->filterByUpdatedAt('now'); // WHERE updated_at = '2011-03-14' $query->filterByUpdatedAt(array('max' => 'yesterday')); // WHERE updated_at < '2011-03-13'

Parameters

mixed	$updatedAt	The value to use as filter. Values can be integers (unix timestamps), DateTime objects, or strings. Empty strings are treated as NULL. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByUpdatedBy	(	$updatedBy = `null`,
		$comparison = `null`
	)

Filter the query on the updated_by column

Example usage: $query->filterByUpdatedBy(1234); // WHERE updated_by = 1234 $query->filterByUpdatedBy(array(12, 34)); // WHERE updated_by IN (12, 34) $query->filterByUpdatedBy(array('min' => 12)); // WHERE updated_by >= 12 $query->filterByUpdatedBy(array('max' => 12)); // WHERE updated_by <= 12

See also: filterByUserRelatedByUpdatedBy()

Parameters

mixed	$updatedBy	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.
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::filterByUserRelatedByCreatedBy	(	$user,
		$comparison = `null`
	)

Filter the query by a related User object

Parameters

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

Returns: ReferenceQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseReferenceQuery::filterByUserRelatedByUpdatedBy	(	$user,
		$comparison = `null`
	)

Filter the query by a related User object

Parameters

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

Returns: ReferenceQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseReferenceQuery::findOneById	(	$key,
		$con = `null`
	)

Alias of findPk to use instance pooling

Parameters

mixed	$key	Primary key to use for the query
PropelPDO	$con	A connection object

Returns: Reference A model object, or null if the key is not found

Exceptions

PropelException

BaseReferenceQuery::findPk	(	$key,
		$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.

$obj = $c->findPk(12, $con);

Parameters

mixed	$key	Primary key to use for the query
PropelPDO	$con	an optional connection object

Returns: Reference|Reference[]|mixed the result, formatted by the current formatter

BaseReferenceQuery::findPkComplex	(	$key,
		$con
	)

protected

Find object by primary key.

Parameters

mixed	$key	Primary key to use for the query
PropelPDO	$con	A connection object

Returns: Reference|Reference[]|mixed the result, formatted by the current formatter

BaseReferenceQuery::findPks	(	$keys,
		$con = `null`
	)

Find objects by primary key $objs = $c->findPks(array(12, 56, 832), $con);

Parameters

array	$keys	Primary keys to use for the query
PropelPDO	$con	an optional connection object

Returns: PropelObjectCollection|Reference[]|mixed the list of results, formatted by the current formatter

BaseReferenceQuery::findPkSimple	(	$key,
		$con
	)

protected

Find object by primary key using raw SQL to go fast. Bypass doSelect() and the object formatter by using generated code.

Parameters

mixed	$key	Primary key to use for the query
PropelPDO	$con	A connection object

Returns: Reference A model object, or null if the key is not found

Exceptions

PropelException

BaseReferenceQuery::firstCreatedFirst ( )

Order by create date asc

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::firstUpdatedFirst ( )

Order by update date asc

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::joinUserRelatedByCreatedBy	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Adds a JOIN clause to the query using the UserRelatedByCreatedBy relation

Parameters

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

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::joinUserRelatedByUpdatedBy	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Adds a JOIN clause to the query using the UserRelatedByUpdatedBy relation

Parameters

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

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::lastCreatedFirst ( )

Order by create date desc

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::lastUpdatedFirst ( )

Order by update date desc

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::prune ( $reference = null )

Exclude object from result

Parameters

Reference $reference Object to remove from the list of results

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::recentlyCreated ( $nbDays = 7 )

Filter by the latest created

Parameters

int $nbDays Maximum age of in days

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::recentlyUpdated ( $nbDays = 7 )

Filter by the latest updated

Parameters

int $nbDays Maximum age of the latest update in days

Returns: ReferenceQuery The current query, for fluid interface

BaseReferenceQuery::useUserRelatedByCreatedByQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Use the UserRelatedByCreatedBy relation User object

See also: useQuery()

Parameters

string	$relationAlias	optional alias for the relation, to be used as main alias in the secondary query
string	$joinType	Accepted values are null, 'left join', 'right join', 'inner join'

Returns: UserQuery A secondary query class using the current class as primary query

BaseReferenceQuery::useUserRelatedByUpdatedByQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Use the UserRelatedByUpdatedBy relation User object

See also: useQuery()

Parameters

string	$relationAlias	optional alias for the relation, to be used as main alias in the secondary query
string	$joinType	Accepted values are null, 'left join', 'right join', 'inner join'

Returns: UserQuery A secondary query class using the current class as primary query

The documentation for this class was generated from the following file:

cms-full/base/lib/model/om/BaseReferenceQuery.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation