Inheritance diagram for BaseDocumentQuery:

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)

	filterByOriginalName ($originalName=null, $comparison=null)

	filterByDescription ($description=null, $comparison=null)

	filterByContentCreatedAt ($contentCreatedAt=null, $comparison=null)

	filterByLicense ($license=null, $comparison=null)

	filterByAuthor ($author=null, $comparison=null)

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

	filterByOwnerId ($ownerId=null, $comparison=null)

	filterByDocumentTypeId ($documentTypeId=null, $comparison=null)

	filterByDocumentCategoryId ($documentCategoryId=null, $comparison=null)

	filterByIsPrivate ($isPrivate=null, $comparison=null)

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

	filterBySort ($sort=null, $comparison=null)

	filterByHash ($hash=null, $comparison=null)

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

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

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

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

	filterByLanguage ($language, $comparison=null)

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

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

	filterByUserRelatedByOwnerId ($user, $comparison=null)

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

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

	filterByDocumentType ($documentType, $comparison=null)

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

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

	filterByDocumentCategory ($documentCategory, $comparison=null)

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

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

	filterByDocumentData ($documentData, $comparison=null)

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

	useDocumentDataQuery ($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 ($document=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

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

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

static

Returns a new DocumentQuery object.

Parameters

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

Returns: DocumentQuery

BaseDocumentQuery::filterByAuthor	(	$author = `null`,
		$comparison = `null`
	)

Filter the query on the author column

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

Parameters

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

BaseDocumentQuery::filterByContentCreatedAt	(	$contentCreatedAt = `null`,
		$comparison = `null`
	)

Filter the query on the content_created_at column

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

Parameters

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

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

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

BaseDocumentQuery::filterByDescription	(	$description = `null`,
		$comparison = `null`
	)

Filter the query on the description column

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

Parameters

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

BaseDocumentQuery::filterByDocumentCategory	(	$documentCategory,
		$comparison = `null`
	)

Filter the query by a related DocumentCategory object

Parameters

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

Returns: DocumentQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseDocumentQuery::filterByDocumentCategoryId	(	$documentCategoryId = `null`,
		$comparison = `null`
	)

Filter the query on the document_category_id column

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

See also: filterByDocumentCategory()

Parameters

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

BaseDocumentQuery::filterByDocumentData	(	$documentData,
		$comparison = `null`
	)

Filter the query by a related DocumentData object

Parameters

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

Returns: DocumentQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseDocumentQuery::filterByDocumentType	(	$documentType,
		$comparison = `null`
	)

Filter the query by a related DocumentType object

Parameters

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

Returns: DocumentQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

BaseDocumentQuery::filterByDocumentTypeId	(	$documentTypeId = `null`,
		$comparison = `null`
	)

Filter the query on the document_type_id column

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

See also: filterByDocumentType()

Parameters

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

BaseDocumentQuery::filterByHash	(	$hash = `null`,
		$comparison = `null`
	)

Filter the query on the hash column

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

Parameters

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

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

BaseDocumentQuery::filterByIsPrivate	(	$isPrivate = `null`,
		$comparison = `null`
	)

Filter the query on the is_private column

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

Parameters

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

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

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

Exceptions

PropelException - if the provided filter is invalid.

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

BaseDocumentQuery::filterByLicense	(	$license = `null`,
		$comparison = `null`
	)

Filter the query on the license column

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

Parameters

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

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

BaseDocumentQuery::filterByOriginalName	(	$originalName = `null`,
		$comparison = `null`
	)

Filter the query on the original_name column

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

Parameters

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

BaseDocumentQuery::filterByOwnerId	(	$ownerId = `null`,
		$comparison = `null`
	)

Filter the query on the owner_id column

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

See also: filterByUserRelatedByOwnerId()

Parameters

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

BaseDocumentQuery::filterByPrimaryKey ( $key )

Filter the query by primary key

Parameters

mixed $key Primary key to use for the query

Returns: DocumentQuery The current query, for fluid interface

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

BaseDocumentQuery::filterBySort	(	$sort = `null`,
		$comparison = `null`
	)

Filter the query on the sort column

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

Parameters

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

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

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

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

Exceptions

PropelException - if the provided filter is invalid.

BaseDocumentQuery::filterByUserRelatedByOwnerId	(	$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: DocumentQuery The current query, for fluid interface

Exceptions

PropelException - if the provided filter is invalid.

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

Exceptions

PropelException - if the provided filter is invalid.

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

Exceptions

PropelException

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

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

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

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

Exceptions

PropelException

BaseDocumentQuery::firstCreatedFirst ( )

Order by create date asc

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::firstUpdatedFirst ( )

Order by update date asc

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::joinDocumentCategory	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Adds a JOIN clause to the query using the DocumentCategory relation

Parameters

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

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::joinDocumentData	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the DocumentData relation

Parameters

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

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::joinDocumentType	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

Adds a JOIN clause to the query using the DocumentType relation

Parameters

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

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::joinLanguage	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_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: DocumentQuery The current query, for fluid interface

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

BaseDocumentQuery::joinUserRelatedByOwnerId	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

Adds a JOIN clause to the query using the UserRelatedByOwnerId relation

Parameters

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

Returns: DocumentQuery The current query, for fluid interface

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

BaseDocumentQuery::lastCreatedFirst ( )

Order by create date desc

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::lastUpdatedFirst ( )

Order by update date desc

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::prune ( $document = null )

Exclude object from result

Parameters

Document $document Object to remove from the list of results

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::recentlyCreated ( $nbDays = 7 )

Filter by the latest created

Parameters

int $nbDays Maximum age of in days

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::recentlyUpdated ( $nbDays = 7 )

Filter by the latest updated

Parameters

int $nbDays Maximum age of the latest update in days

Returns: DocumentQuery The current query, for fluid interface

BaseDocumentQuery::useDocumentCategoryQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

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

BaseDocumentQuery::useDocumentDataQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

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

BaseDocumentQuery::useDocumentTypeQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::INNER_JOIN`
	)

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

BaseDocumentQuery::useLanguageQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_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

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

BaseDocumentQuery::useUserRelatedByOwnerIdQuery	(	$relationAlias = `null`,
		$joinType = `Criteria::LEFT_JOIN`
	)

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation