Inheritance diagram for BasePageStringQuery:

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

	findPk ($key, $con=null)

	findPks ($keys, $con=null)

	filterByPrimaryKey ($key)

	filterByPrimaryKeys ($keys)

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

	filterByLanguageId ($languageId=null, $comparison=null)

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

	filterByLinkText ($linkText=null, $comparison=null)

	filterByPageTitle ($pageTitle=null, $comparison=null)

	filterByMetaKeywords ($metaKeywords=null, $comparison=null)

	filterByMetaDescription ($metaDescription=null, $comparison=null)

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

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

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

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

	filterByPage ($page, $comparison=null)

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

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

	filterByLanguage ($language, $comparison=null)

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

	useLanguageQuery ($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 ($pageString=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

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

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

static

Returns a new PageStringQuery object.

Parameters

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

Returns: PageStringQuery

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

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

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

BasePageStringQuery::filterByLanguage	(	$language,
		$comparison = `null`
	)

Filter the query by a related Language object

Parameters

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

Returns: PageStringQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BasePageStringQuery::filterByLanguageId	(	$languageId = `null`,
		$comparison = `null`
	)

Filter the query on the language_id column

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

Parameters

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

BasePageStringQuery::filterByLinkText	(	$linkText = `null`,
		$comparison = `null`
	)

Filter the query on the link_text column

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

Parameters

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

BasePageStringQuery::filterByMetaDescription	(	$metaDescription = `null`,
		$comparison = `null`
	)

Filter the query on the meta_description column

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

Parameters

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

BasePageStringQuery::filterByMetaKeywords	(	$metaKeywords = `null`,
		$comparison = `null`
	)

Filter the query on the meta_keywords column

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

Parameters

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

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

Exceptions

PropelException - if the provided filter is invalid.

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

BasePageStringQuery::filterByPageTitle	(	$pageTitle = `null`,
		$comparison = `null`
	)

Filter the query on the page_title column

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

Parameters

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

BasePageStringQuery::filterByPrimaryKey ( $key )

Filter the query by primary key

Parameters

mixed $key Primary key to use for the query

Returns: PageStringQuery The current query, for fluid interface

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

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

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

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

Exceptions

PropelException - if the provided filter is invalid.

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

Exceptions

PropelException - if the provided filter is invalid.

BasePageStringQuery::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(array(12, 34), $con);

Parameters

array	$key	Primary key to use for the query A Primary key composition: [$page_id, $language_id]
PropelPDO	$con	an optional connection object

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

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

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

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

Parameters

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

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

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

Exceptions

PropelException

BasePageStringQuery::firstCreatedFirst ( )

Order by create date asc

Returns: PageStringQuery The current query, for fluid interface

BasePageStringQuery::firstUpdatedFirst ( )

Order by update date asc

Returns: PageStringQuery The current query, for fluid interface

BasePageStringQuery::joinLanguage	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the Language relation

Parameters

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

Returns: PageStringQuery The current query, for fluid interface

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

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

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

BasePageStringQuery::lastCreatedFirst ( )

Order by create date desc

Returns: PageStringQuery The current query, for fluid interface

BasePageStringQuery::lastUpdatedFirst ( )

Order by update date desc

Returns: PageStringQuery The current query, for fluid interface

BasePageStringQuery::prune ( $pageString = null )

Exclude object from result

Parameters

PageString $pageString Object to remove from the list of results

Returns: PageStringQuery The current query, for fluid interface

BasePageStringQuery::recentlyCreated ( $nbDays = 7 )

Filter by the latest created

Parameters

int $nbDays Maximum age of in days

Returns: PageStringQuery The current query, for fluid interface

BasePageStringQuery::recentlyUpdated ( $nbDays = 7 )

Filter by the latest updated

Parameters

int $nbDays Maximum age of the latest update in days

Returns: PageStringQuery The current query, for fluid interface

BasePageStringQuery::useLanguageQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

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

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

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation