Inheritance diagram for BasePageQuery:

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)

	filterByName ($name=null, $comparison=null)

	filterByIdentifier ($identifier=null, $comparison=null)

	filterByPageType ($pageType=null, $comparison=null)

	filterByTemplateName ($templateName=null, $comparison=null)

	filterByIsInactive ($isInactive=null, $comparison=null)

	filterByIsFolder ($isFolder=null, $comparison=null)

	filterByIsHidden ($isHidden=null, $comparison=null)

	filterByIsProtected ($isProtected=null, $comparison=null)

	filterByCanonicalId ($canonicalId=null, $comparison=null)

	filterByTreeLeft ($treeLeft=null, $comparison=null)

	filterByTreeRight ($treeRight=null, $comparison=null)

	filterByTreeLevel ($treeLevel=null, $comparison=null)

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

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

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

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

	filterByPageRelatedByCanonicalId ($page, $comparison=null)

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

	usePageRelatedByCanonicalIdQuery ($relationAlias=null, $joinType=Criteria::LEFT_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)

	filterByPageRelatedById ($page, $comparison=null)

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

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

	filterByPageProperty ($pageProperty, $comparison=null)

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

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

	filterByPageString ($pageString, $comparison=null)

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

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

	filterByContentObject ($contentObject, $comparison=null)

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

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

	filterByRight ($right, $comparison=null)

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

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

	prune ($page=null)

	descendantsOf ($page)

	branchOf ($page)

	childrenOf ($page)

	siblingsOf ($page, PropelPDO $con=null)

	ancestorsOf ($page)

	rootsOf ($page)

	orderByBranch ($reverse=false)

	orderByLevel ($reverse=false)

	findRoot ($con=null)

	findTree ($con=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

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

Initializes internal state of BasePageQuery 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

BasePageQuery::ancestorsOf ( $page )

Filter the query to restrict the result to ancestors of an object

Parameters

Page $page The object to use for ancestors search

Returns: PageQuery The current query, for fluid interface

BasePageQuery::branchOf ( $page )

Filter the query to restrict the result to the branch of an object. Same as descendantsOf(), except that it includes the object passed as parameter in the result

Parameters

Page $page The object to use for branch search

Returns: PageQuery The current query, for fluid interface

BasePageQuery::childrenOf ( $page )

Filter the query to restrict the result to children of an object

Parameters

Page $page The object to use for child search

Returns: PageQuery The current query, for fluid interface

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

static

Returns a new PageQuery object.

Parameters

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

Returns: PageQuery

BasePageQuery::descendantsOf ( $page )

Filter the query to restrict the result to descendants of an object

Parameters

Page $page The object to use for descendant search

Returns: PageQuery The current query, for fluid interface

BasePageQuery::filterByCanonicalId	(	$canonicalId = `null`,
		$comparison = `null`
	)

Filter the query on the canonical_id column

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

See also: filterByPageRelatedByCanonicalId()

Parameters

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

BasePageQuery::filterByContentObject	(	$contentObject,
		$comparison = `null`
	)

Filter the query by a related ContentObject object

Parameters

ContentObject \| PropelObjectCollection	$contentObject	the related object to use as filter
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: PageQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

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

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

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

BasePageQuery::filterByIdentifier	(	$identifier = `null`,
		$comparison = `null`
	)

Filter the query on the identifier column

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

Parameters

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

BasePageQuery::filterByIsFolder	(	$isFolder = `null`,
		$comparison = `null`
	)

Filter the query on the is_folder column

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

Parameters

boolean \| string	$isFolder	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: PageQuery The current query, for fluid interface

BasePageQuery::filterByIsHidden	(	$isHidden = `null`,
		$comparison = `null`
	)

Filter the query on the is_hidden column

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

Parameters

boolean \| string	$isHidden	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: PageQuery The current query, for fluid interface

BasePageQuery::filterByIsInactive	(	$isInactive = `null`,
		$comparison = `null`
	)

Filter the query on the is_inactive column

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

Parameters

boolean \| string	$isInactive	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: PageQuery The current query, for fluid interface

BasePageQuery::filterByIsProtected	(	$isProtected = `null`,
		$comparison = `null`
	)

Filter the query on the is_protected column

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

Parameters

boolean \| string	$isProtected	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: PageQuery The current query, for fluid interface

BasePageQuery::filterByName	(	$name = `null`,
		$comparison = `null`
	)

Filter the query on the name column

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

Parameters

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

BasePageQuery::filterByPageProperty	(	$pageProperty,
		$comparison = `null`
	)

Filter the query by a related PageProperty object

Parameters

PageProperty \| PropelObjectCollection	$pageProperty	the related object to use as filter
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: PageQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BasePageQuery::filterByPageRelatedByCanonicalId	(	$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: PageQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BasePageQuery::filterByPageRelatedById	(	$page,
		$comparison = `null`
	)

Filter the query by a related Page object

Parameters

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

Returns: PageQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BasePageQuery::filterByPageString	(	$pageString,
		$comparison = `null`
	)

Filter the query by a related PageString object

Parameters

PageString \| PropelObjectCollection	$pageString	the related object to use as filter
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: PageQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BasePageQuery::filterByPageType	(	$pageType = `null`,
		$comparison = `null`
	)

Filter the query on the page_type column

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

Parameters

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

BasePageQuery::filterByPrimaryKey ( $key )

Filter the query by primary key

Parameters

mixed $key Primary key to use for the query

Returns: PageQuery The current query, for fluid interface

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

BasePageQuery::filterByRight	(	$right,
		$comparison = `null`
	)

Filter the query by a related Right object

Parameters

Right \| PropelObjectCollection	$right	the related object to use as filter
string	$comparison	Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns: PageQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BasePageQuery::filterByTemplateName	(	$templateName = `null`,
		$comparison = `null`
	)

Filter the query on the template_name column

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

Parameters

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

BasePageQuery::filterByTreeLeft	(	$treeLeft = `null`,
		$comparison = `null`
	)

Filter the query on the tree_left column

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

Parameters

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

BasePageQuery::filterByTreeLevel	(	$treeLevel = `null`,
		$comparison = `null`
	)

Filter the query on the tree_level column

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

Parameters

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

BasePageQuery::filterByTreeRight	(	$treeRight = `null`,
		$comparison = `null`
	)

Filter the query on the tree_right column

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

Parameters

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

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

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

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

Exceptions

PropelException - if the provided filter is invalid.

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

Exceptions

PropelException - if the provided filter is invalid.

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

Exceptions

PropelException

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

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

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

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

Exceptions

PropelException

BasePageQuery::findRoot ( $con = null )

Returns the root node for the tree

Parameters

PropelPDO $con Connection to use.

Returns: Page The tree root object

BasePageQuery::findTree ( $con = null )

Returns the tree of objects

Parameters

PropelPDO $con Connection to use.

Returns: mixed the list of results, formatted by the current formatter

BasePageQuery::firstCreatedFirst ( )

Order by create date asc

Returns: PageQuery The current query, for fluid interface

BasePageQuery::firstUpdatedFirst ( )

Order by update date asc

Returns: PageQuery The current query, for fluid interface

BasePageQuery::joinContentObject	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the ContentObject relation

Parameters

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

Returns: PageQuery The current query, for fluid interface

BasePageQuery::joinPageProperty	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the PageProperty relation

Parameters

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

Returns: PageQuery The current query, for fluid interface

BasePageQuery::joinPageRelatedByCanonicalId	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Adds a JOIN clause to the query using the PageRelatedByCanonicalId relation

Parameters

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

Returns: PageQuery The current query, for fluid interface

BasePageQuery::joinPageRelatedById	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Adds a JOIN clause to the query using the PageRelatedById relation

Parameters

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

Returns: PageQuery The current query, for fluid interface

BasePageQuery::joinPageString	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the PageString relation

Parameters

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

Returns: PageQuery The current query, for fluid interface

BasePageQuery::joinRight	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the Right relation

Parameters

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

Returns: PageQuery The current query, for fluid interface

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

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

BasePageQuery::lastCreatedFirst ( )

Order by create date desc

Returns: PageQuery The current query, for fluid interface

BasePageQuery::lastUpdatedFirst ( )

Order by update date desc

Returns: PageQuery The current query, for fluid interface

BasePageQuery::orderByBranch ( $reverse = false )

Order the result by branch, i.e. natural tree order

Parameters

bool $reverse if true, reverses the order

Returns: PageQuery The current query, for fluid interface

BasePageQuery::orderByLevel ( $reverse = false )

Order the result by level, the closer to the root first

Parameters

bool $reverse if true, reverses the order

Returns: PageQuery The current query, for fluid interface

BasePageQuery::prune ( $page = null )

Exclude object from result

Parameters

Page $page Object to remove from the list of results

Returns: PageQuery The current query, for fluid interface

BasePageQuery::recentlyCreated ( $nbDays = 7 )

Filter by the latest created

Parameters

int $nbDays Maximum age of in days

Returns: PageQuery The current query, for fluid interface

BasePageQuery::recentlyUpdated ( $nbDays = 7 )

Filter by the latest updated

Parameters

int $nbDays Maximum age of the latest update in days

Returns: PageQuery The current query, for fluid interface

BasePageQuery::rootsOf ( $page )

Filter the query to restrict the result to roots of an object. Same as ancestorsOf(), except that it includes the object passed as parameter in the result

Parameters

Page $page The object to use for roots search

Returns: PageQuery The current query, for fluid interface

BasePageQuery::siblingsOf	(		$page,
		PropelPDO	$con = `null`
	)

Filter the query to restrict the result to siblings of an object. The result does not include the object passed as parameter.

Parameters

Page	$page	The object to use for sibling search
PropelPDO	$con	Connection to use.

Returns: PageQuery The current query, for fluid interface

BasePageQuery::useContentObjectQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

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

BasePageQuery::usePagePropertyQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

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

BasePageQuery::usePageRelatedByCanonicalIdQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Use the PageRelatedByCanonicalId 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

BasePageQuery::usePageRelatedByIdQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Use the PageRelatedById 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

BasePageQuery::usePageStringQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

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

BasePageQuery::useRightQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

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

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation