Inheritance diagram for BaseRightQuery:

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)

	filterByRoleKey ($roleKey=null, $comparison=null)

	filterByPageId ($pageId=null, $comparison=null)

	filterByIsInherited ($isInherited=null, $comparison=null)

	filterByMayEditPageDetails ($mayEditPageDetails=null, $comparison=null)

	filterByMayEditPageContents ($mayEditPageContents=null, $comparison=null)

	filterByMayDelete ($mayDelete=null, $comparison=null)

	filterByMayCreateChildren ($mayCreateChildren=null, $comparison=null)

	filterByMayViewPage ($mayViewPage=null, $comparison=null)

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

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

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

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

	filterByRole ($role, $comparison=null)

	joinRole ($relationAlias=null, $joinType=Criteria::INNER_JOIN)

	useRoleQuery ($relationAlias=null, $joinType=Criteria::INNER_JOIN)

	filterByPage ($page, $comparison=null)

	joinPage ($relationAlias=null, $joinType=Criteria::INNER_JOIN)

	usePageQuery ($relationAlias=null, $joinType=Criteria::INNER_JOIN)

	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 ($right=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

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

Initializes internal state of BaseRightQuery 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 BaseRightQuery::create	(	$modelAlias = `null`,
		$criteria = `null`
	)

static

Returns a new RightQuery object.

Parameters

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

Returns: RightQuery

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::filterByIsInherited	(	$isInherited = `null`,
		$comparison = `null`
	)

Filter the query on the is_inherited column

Example usage: $query->filterByIsInherited(true); // WHERE is_inherited = true $query->filterByIsInherited('yes'); // WHERE is_inherited = true

Parameters

boolean \| string	$isInherited	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').
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::filterByMayCreateChildren	(	$mayCreateChildren = `null`,
		$comparison = `null`
	)

Filter the query on the may_create_children column

Example usage: $query->filterByMayCreateChildren(true); // WHERE may_create_children = true $query->filterByMayCreateChildren('yes'); // WHERE may_create_children = true

Parameters

boolean \| string	$mayCreateChildren	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').
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::filterByMayDelete	(	$mayDelete = `null`,
		$comparison = `null`
	)

Filter the query on the may_delete column

Example usage: $query->filterByMayDelete(true); // WHERE may_delete = true $query->filterByMayDelete('yes'); // WHERE may_delete = true

Parameters

boolean \| string	$mayDelete	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').
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::filterByMayEditPageContents	(	$mayEditPageContents = `null`,
		$comparison = `null`
	)

Filter the query on the may_edit_page_contents column

Example usage: $query->filterByMayEditPageContents(true); // WHERE may_edit_page_contents = true $query->filterByMayEditPageContents('yes'); // WHERE may_edit_page_contents = true

Parameters

boolean \| string	$mayEditPageContents	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').
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::filterByMayEditPageDetails	(	$mayEditPageDetails = `null`,
		$comparison = `null`
	)

Filter the query on the may_edit_page_details column

Example usage: $query->filterByMayEditPageDetails(true); // WHERE may_edit_page_details = true $query->filterByMayEditPageDetails('yes'); // WHERE may_edit_page_details = true

Parameters

boolean \| string	$mayEditPageDetails	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').
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::filterByMayViewPage	(	$mayViewPage = `null`,
		$comparison = `null`
	)

Filter the query on the may_view_page column

Example usage: $query->filterByMayViewPage(true); // WHERE may_view_page = true $query->filterByMayViewPage('yes'); // WHERE may_view_page = true

Parameters

boolean \| string	$mayViewPage	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').
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::filterByPage	(	$page,
		$comparison = `null`
	)

Filter the query by a related Page object

Parameters

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

Returns: RightQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseRightQuery::filterByPageId	(	$pageId = `null`,
		$comparison = `null`
	)

Filter the query on the page_id column

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

See also: filterByPage()

Parameters

mixed	$pageId	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: RightQuery The current query, for fluid interface

BaseRightQuery::filterByPrimaryKey ( $key )

Filter the query by primary key

Parameters

mixed $key Primary key to use for the query

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::filterByRole	(	$role,
		$comparison = `null`
	)

Filter the query by a related Role object

Parameters

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

Returns: RightQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseRightQuery::filterByRoleKey	(	$roleKey = `null`,
		$comparison = `null`
	)

Filter the query on the role_key column

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

Parameters

string	$roleKey	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: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseRightQuery::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: RightQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseRightQuery::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: Right A model object, or null if the key is not found

Exceptions

PropelException

BaseRightQuery::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: Right|Right[]|mixed the result, formatted by the current formatter

BaseRightQuery::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: Right|Right[]|mixed the result, formatted by the current formatter

BaseRightQuery::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|Right[]|mixed the list of results, formatted by the current formatter

BaseRightQuery::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: Right A model object, or null if the key is not found

Exceptions

PropelException

BaseRightQuery::firstCreatedFirst ( )

Order by create date asc

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::firstUpdatedFirst ( )

Order by update date asc

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::joinPage	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the Page relation

Parameters

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

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::joinRole	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the Role relation

Parameters

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

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::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: RightQuery The current query, for fluid interface

BaseRightQuery::lastCreatedFirst ( )

Order by create date desc

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::lastUpdatedFirst ( )

Order by update date desc

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::prune ( $right = null )

Exclude object from result

Parameters

Right $right Object to remove from the list of results

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::recentlyCreated ( $nbDays = 7 )

Filter by the latest created

Parameters

int $nbDays Maximum age of in days

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::recentlyUpdated ( $nbDays = 7 )

Filter by the latest updated

Parameters

int $nbDays Maximum age of the latest update in days

Returns: RightQuery The current query, for fluid interface

BaseRightQuery::usePageQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Use the Page relation Page 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: PageQuery A secondary query class using the current class as primary query

BaseRightQuery::useRoleQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Use the Role relation Role 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: RoleQuery A secondary query class using the current class as primary query

BaseRightQuery::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

BaseRightQuery::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/BaseRightQuery.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation