Propel\Runtime\ActiveQuery\ModelCriteria

Creates a new instance with the default capacity which corresponds to the specified database.

Gets the array of ModelWith specifying which objects must be hydrated together with the main object.

Sets the array of ModelWith specifying which objects must be hydrated together with the main object.

Sets the formatter to use for the find() output Formatters must extend AbstractFormatter Use the ModelCriteria constants for class names: <code> $c->setFormatter(ModelCriteria::FORMAT_ARRAY); </code>

Gets the formatter to use for the find() output Defaults to an instance of ModelCriteria::$defaultFormatterClass, i.e.

PropelObjectsFormatter

Returns the name of the class for this model criteria

Sets the model name.

This also sets `this->modelTableMapName` and `this->tableMap`.

Sets the alias for the model in this query

Returns the alias of the main class for this model criteria

Return the string to use in a clause as a model prefix for the main model

Return The short model name (the short ClassName for class with namespace)

Returns the TableMap object for this Criteria

Execute the query with a find(), and return a Traversable object.

The return value depends on the query formatter. By default, this returns an ArrayIterator
constructed on a Propel\Runtime\Collection\PropelCollection.
Compulsory for implementation of \IteratorAggregate.

Adds a condition on a column based on a pseudo SQL clause but keeps it for later use with combine() Until combine() is called, the condition is not added to the query Uses introspection to translate the column phpName into a fully qualified name <code> $c->condition('cond1', 'b.Title = ?', 'foo'); </code>

Adds a condition on a column based on a column phpName and a value Uses introspection to translate the column phpName into a fully qualified name Warning: recognizes only the phpNames of the main Model (not joined tables) <code> $c->filterBy('Title', 'foo'); </code>

Adds a list of conditions on the columns of the current model Uses introspection to translate the column phpName into a fully qualified name Warning: recognizes only the phpNames of the main Model (not joined tables) <code> $c->filterByArray(array( 'Title' => 'War And Peace', 'Publisher' => $publisher )); </code>

Adds a condition on a column based on a pseudo SQL clause Uses introspection to translate the column phpName into a fully qualified name <code> // simple clause $c->where('b.Title = ?', 'foo'); // named conditions $c->condition('cond1', 'b.Title = ?', 'foo'); $c->condition('cond2', 'b.ISBN = ?', 12345); $c->where(array('cond1', 'cond2'), Criteria::LOGICAL_OR); </code>

Adds a having condition on a column based on a pseudo SQL clause Uses introspection to translate the column phpName into a fully qualified name <code> // simple clause $c->having('b.Title = ?', 'foo'); // named conditions $c->condition('cond1', 'b.Title = ?', 'foo'); $c->condition('cond2', 'b.ISBN = ?', 12345); $c->having(array('cond1', 'cond2'), Criteria::LOGICAL_OR); </code>

Adds an ORDER BY clause to the query Usability layer on top of Criteria::addAscendingOrderByColumn() and Criteria::addDescendingOrderByColumn() Infers $column and $order from $columnName and some optional arguments Examples: $c->orderBy('Book.CreatedAt') => $c->addAscendingOrderByColumn(BookTableMap::CREATED_AT) $c->orderBy('Book.CategoryId', 'desc') => $c->addDescendingOrderByColumn(BookTableMap::CATEGORY_ID)

Adds a GROUP BY clause to the query Usability layer on top of Criteria::addGroupByColumn() Infers $column $columnName Examples: $c->groupBy('Book.AuthorId') => $c->addGroupByColumn(BookTableMap::AUTHOR_ID)

Adds a GROUP BY clause for all columns of a model to the query Examples: $c->groupBy('Book'); => $c->addGroupByColumn(BookTableMap::ID); => $c->addGroupByColumn(BookTableMap::TITLE); => $c->addGroupByColumn(BookTableMap::AUTHOR_ID); => $c->addGroupByColumn(BookTableMap::PUBLISHER_ID);

Adds a DISTINCT clause to the query Alias for Criteria::setDistinct()

Adds a LIMIT clause (or its subselect equivalent) to the query Alias for Criteria:::setLimit()

Adds an OFFSET clause (or its subselect equivalent) to the query Alias for of Criteria::setOffset()

Makes the ModelCriteria return a string, array, or ArrayCollection Examples: ArticleQuery::create()->select('Name')->find(); => ArrayCollection Object ('Foo', 'Bar')

ArticleQuery::create()->select('Name')->findOne();
=> string 'Foo'

ArticleQuery::create()->select(array('Id', 'Name'))->find();
=> ArrayCollection Object (
array('Id' => 1, 'Name' => 'Foo'),
array('Id' => 2, 'Name' => 'Bar')
)

ArticleQuery::create()->select(array('Id', 'Name'))->findOne();
=> array('Id' => 1, 'Name' => 'Foo')

Retrieves the columns defined by a previous call to select().

This method returns the previousJoin for this ModelCriteria, by default this is null, but after useQuery this is set the to the join of that use

This method sets the previousJoin for this ModelCriteria, by default this is null, but after useQuery this is set the to the join of that use

This method returns an already defined join clause from the query

Adds a JOIN clause to the query Infers the ON clause from a relation name Uses the Propel table maps, based on the schema, to guess the related columns Beware that the default JOIN operator is INNER JOIN, while Criteria defaults to WHERE Examples: <code> $c->join('Book.Author'); => $c->addJoin(BookTableMap::AUTHOR_ID, AuthorTableMap::ID, Criteria::INNER_JOIN); $c->join('Book.Author', Criteria::RIGHT_JOIN); => $c->addJoin(BookTableMap::AUTHOR_ID, AuthorTableMap::ID, Criteria::RIGHT_JOIN); $c->join('Book.Author a', Criteria::RIGHT_JOIN); => $c->addAlias('a', AuthorTableMap::TABLE_NAME); => $c->addJoin(BookTableMap::AUTHOR_ID, 'a.ID', Criteria::RIGHT_JOIN); </code>

Add another condition to an already added join

Replace the condition of an already added join

Add a join object to the Criteria

Adds a JOIN clause to the query and hydrates the related objects Shortcut for $c->join()->with() <code> $c->joinWith('Book.Author'); => $c->join('Book.Author'); => $c->with('Author'); $c->joinWith('Book.Author a', Criteria::RIGHT_JOIN); => $c->join('Book.Author a', Criteria::RIGHT_JOIN); => $c->with('a'); </code>

Adds a relation to hydrate together with the main object The relation must be initialized via a join() prior to calling with() Examples: <code> $c->join('Book.Author'); $c->with('Author');

$c->join('Book.Author a', Criteria::RIGHT_JOIN);
$c->with('a');
</code>
WARNING: on a one-to-many relationship, the use of with() combined with limit()
will return a wrong number of results for the related objects

Adds a supplementary column to the select clause These columns can later be retrieved from the hydrated objects using getVirtualColumn()

Initializes a secondary ModelCriteria object, to be later merged with the current object

Finalizes a secondary criteria and merges it with its primary Criteria

Add the content of a Criteria to the current Criteria In case of conflict, the current Criteria keeps its properties

Clear the conditions to allow the reuse of the query object.

The ModelCriteria's Model and alias 'all the properties set by construct) will remain.

Sets the primary Criteria for this secondary Criteria

Gets the primary criteria for this secondary Criteria

Adds a Criteria as subQuery in the From Clause.

Adds the select columns for a the current table

Adds the select columns for a relation

Returns the class and alias of a string representing a model or a relation e.g.

'Book b' => array('Book', 'b')
e.g. 'Book' => array('Book', null)

Returns the name of a relation from a string.

The input looks like '$leftName.$relationName $relationAlias'

Triggers the automated cloning on termination.

By default, termination methods don't clone the current object,
even though they modify it. If the query must be reused after termination,
you must call this method prior to termination.

Checks whether the automated cloning on termination is enabled.

Issue a SELECT query based on the current ModelCriteria and format the list of results with the current formatter By default, returns an array of model objects

Issue a SELECT ...

LIMIT 1 query based on the current ModelCriteria
and format the result with the current formatter
By default, returns a model object

Issue a SELECT ...

LIMIT 1 query based on the current ModelCriteria
and format the result with the current formatter
By default, returns a model object

Find object by primary key Behaves differently if the model has simple or composite primary key <code> // simple primary key $book = $c->findPk(12, $con); // composite primary key $bookOpinion = $c->findPk(array(34, 634), $con); </code>

Find objects by primary key Behaves differently if the model has simple or composite primary key <code> // simple primary key $books = $c->findPks(array(12, 56, 832), $con); // composite primary key $bookOpinion = $c->findPks(array(array(34, 634), array(45, 518), array(34, 765)), $con); </code>

Apply a condition on a column and issues the SELECT query

Apply a list of conditions on columns and issues the SELECT query <code> $c->findByArray(array( 'Title' => 'War And Peace', 'Publisher' => $publisher ), $con); </code>

Apply a condition on a column and issues the SELECT ...

LIMIT 1 query

Apply a list of conditions on columns and issues the SELECT ...

LIMIT 1 query
<code>
$c->findOneByArray(array(
'Title' => 'War And Peace',
'Publisher' => $publisher
), $con);
</code>

Issue a SELECT COUNT(*) query based on the current ModelCriteria

Issue a SELECT query based on the current ModelCriteria and uses a page and a maximum number of results per page to compute an offset and a limit.

Issue a DELETE query based on the current ModelCriteria An optional hook on basePreDelete() can prevent the actual deletion

Issue a DELETE query based on the current ModelCriteria deleting all rows in the table An optional hook on basePreDelete() can prevent the actual deletion

Issue a DELETE query based on the current ModelCriteria deleting all rows in the table This method is called by ModelCriteria::deleteAll() inside a transaction

Issue an UPDATE query based the current ModelCriteria and a list of changes.

An optional hook on basePreUpdate() can prevent the actual update.
Beware that behaviors based on hooks in the object's save() method
will only be triggered if you force individual saves, i.e. if you pass true as second argument.

Issue an UPDATE query based the current ModelCriteria and a list of changes.

This method is called by ModelCriteria::update() inside a transaction.

Builds, binds and executes a SELECT query based on the current object.

Changes the table part of a a fully qualified column name if a true model alias exists e.g.

=> 'book.TITLE' => 'b.TITLE'
This is for use as first argument of Criteria::add()

Return the short ClassName for class with namespace

Overrides Criteria::add() to force the use of a true table alias if it exists

Get all the parameters to bind to this criteria Does part of the job of createSelectSql() for the cache

Handle the magic Supports findByXXX(), findOneByXXX(), filterByXXX(), orderByXXX(), and groupByXXX() methods, where XXX is a column phpName.

Supports XXXJoin(), where XXX is a join direction (in 'left', 'right', 'inner')

Ensures deep cloning of attached objects

Adds a LEFT JOIN clause to the query

Adds a RIGHT JOIN clause to the query

Adds a INNER JOIN clause to the query