ModelCriteria

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

Implementing SPL IteratorAggregate interface.

This allows
you to foreach () over a Criteria object.

Get the criteria map, i.e.

the array of Criterions

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.

Add an AS clause to the select columns.

Usage:

<code>
Criteria myCrit = new Criteria();
myCrit->addAsColumn("alias", "ALIAS(".MyPeer::ID.")");
</code>

Get the column aliases.

Returns the column name associated with an alias (AS-column).

Allows one to specify an alias for a table that can be used in various parts of the SQL.

Remove an alias for a table (useful when merging Criterias).

Returns the aliases for this Criteria

Returns the table name associated with an alias.

Returns the table name and alias based on a table alias or name.

Use this method to get the details of a table name that comes in a clause,
which can be either a table name or an alias name.

Get the keys of the criteria map, i.e.

the list of columns bearing a condition
<code>
print_r($c->keys());
=> array('book.price', 'book.title', 'author.first_name')
</code>

Does this Criteria object contain the specified key?

Does this Criteria object contain the specified key and does it have a value set for the key

Whether this Criteria has any where columns.

This counts conditions added with the add() method.

Will force the sql represented by this criteria to be executed within a transaction.

This is here primarily to support the oid type in
postgresql. Though it can be used to require any single sql statement
to use a transaction.

Whether the sql command specified by this criteria must be wrapped in a transaction.

Method to return criteria related to columns in a table.

Make sure you call containsKey($column) prior to calling this method,
since no check on the existence of the $column is made in this method.

Method to return the latest Criterion in a table.

Method to return criterion that is not added automatically to this Criteria.

This can be used to chain the
Criterions to form a more complex where clause.

Method to return a String table name.

Shortcut method to get an array of columns indexed by table.

<code>
print_r($c->getTablesColumns());
=> array(
'book' => array('book.price', 'book.title'),
'author' => array('author.first_name')
)
</code>

Method to return a comparison String.

Get the Database(Map) name.

Set the DatabaseMap name.

If <code>null</code> is supplied, uses value
provided by <code>Propel::getDefaultDB()</code>.

Get the primary table for this Criteria.

This is useful for cases where a Criteria may not contain
any SELECT columns or WHERE columns. This must be explicitly
set, of course, in order to be useful.

Sets the primary table for this Criteria.

This is useful for cases where a Criteria may not contain
any SELECT columns or WHERE columns. This must be explicitly
set, of course, in order to be useful.

Method to return a String table name.

Method to return the value that was added to Criteria.

An alias to getValue() -- exposing a Hashtable-like interface.

Overrides Hashtable put, so that this object is returned instead of the value previously in the Criteria object.

The reason is so that it more closely matches the behavior
of the add() methods. If you want to get the previous value
then you should first Criteria.get() it yourself. Note, if
you attempt to pass in an Object that is not a String, it will
throw a NPE. The reason for this is that none of the add()
methods support adding anything other than a String as a key.

Copies all of the mappings from the specified Map to this Criteria These mappings will replace any mappings that this Criteria had for any of the keys currently in the specified Map.

if the map was another Criteria, its attributes are copied to this
Criteria, overwriting previous settings.

This method adds a new criterion to the list of criterias.

If a criterion for the requested column already exists, it is
replaced. If is used as follow:

<code>
$crit = new Criteria();
$crit->add($column, $value, Criteria::GREATER_THAN);
</code>

Any comparison can be used.

The name of the table must be used implicitly in the column name,
so the Column name must be something like 'TABLE.id'.

This method creates a new criterion but keeps it for later use with combine() Until combine() is called, the condition is not added to the query

<code>
$crit = new Criteria();
$crit->addCond('cond1', $column1, $value1, Criteria::GREATER_THAN);
$crit->addCond('cond2', $column2, $value2, Criteria::EQUAL);
$crit->combine(array('cond1', 'cond2'), Criteria::LOGICAL_OR);
</code>

Any comparison can be used.

The name of the table must be used implicitly in the column name,
so the Column name must be something like 'TABLE.id'.

Combine several named criterions with a logical operator

This is the way that you should add a join of two tables.

Example usage:
<code>
$c->addJoin(ProjectPeer::ID, FooPeer::PROJECT_ID, Criteria::LEFT_JOIN);
// LEFT JOIN FOO ON (PROJECT.ID = FOO.PROJECT_ID)
</code>

Add a join with multiple conditions

Add a join object to the Criteria

Get the array of Joins.

Adds a Criteria as subQuery in the From Clause.

Checks whether this Criteria has a subquery.

Get the associative array of Criteria for the subQueries per alias.

Get the Criteria for a specific subQuery.

checks if the Criteria for a specific subQuery is set.

Adds "ALL" modifier to the SQL statement.

Adds "DISTINCT" modifier to the SQL statement.

Adds a modifier to the SQL statement.

e.g. self::ALL, self::DISTINCT, 'SQL_CALC_FOUND_ROWS', 'HIGH_PRIORITY', etc.

Removes a modifier to the SQL statement.

Checks for existence before removal

Checks the existence of a SQL select modifier

Sets ignore case.

Is ignore case on or off?

Set single record? Set this to <code>true</code> if you expect the query to result in only a single result record (the default behaviour is to throw a PropelException if multiple records are returned when the query is executed).

This should be used in situations where returning multiple
rows would indicate an error of some sort. If your query might return
multiple records but you are only interested in the first one then you
should be using setLimit(1).

Is single record?

Set limit.

Get limit.

Set offset.

Get offset.

Add select column.

Set the query comment, that appears after the first verb in the SQL query

Get the query comment, that appears after the first verb in the SQL query

Whether this Criteria has any select columns.

This will include columns added with addAsColumn() method.

Get select columns.

Clears current select columns.

Get select modifiers.

Add group by column name.

Add order by column name, explicitly specifying ascending.

Add order by column name, explicitly specifying descending.

Get order by columns.

Clear the order-by columns.

Clear the group-by columns.

Get group by columns.

Get Having Criterion.

Remove an object from the criteria.

Build a string representation of the Criteria.

Returns the size (count) of this criteria.

This method checks another Criteria to see if they contain the same attributes and hashtable entries.

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

This method adds a prepared Criterion object to the Criteria as a having clause.

You can get a new, empty Criterion object with the
getNewCriterion() method.

<p>
<code>
$crit = new Criteria();
$c = $crit->getNewCriterion(BasePeer::ID, 5, Criteria::LESS_THAN);
$crit->addHaving($c);
</code>

If a criterion for the requested column already exists, the condition is "AND"ed to the existing criterion (necessary for Propel 1.4 compatibility).

If no criterion for the requested column already exists, the condition is "AND"ed to the latest criterion.
If no criterion exist, the condition is added a new criterion

Any comparison can be used.

Supports a number of different signatures:
- addAnd(column, value, comparison)
- addAnd(column, value)
- addAnd(Criterion)

If a criterion for the requested column already exists, the condition is "OR"ed to the existing criterion (necessary for Propel 1.4 compatibility).

If no criterion for the requested column already exists, the condition is "OR"ed to the latest criterion.
If no criterion exist, the condition is added a new criterion

Any comparison can be used.

Supports a number of different signatures:
- addOr(column, value, comparison)
- addOr(column, value)
- addOr(Criterion)

Overrides Criteria::add() to use the default combine operator

Returns the current object if the condition is true, or a PropelConditionalProxy instance otherwise.

Allows for conditional statements in a fluid interface.

Returns a PropelConditionalProxy instance.

Allows for conditional statements in a fluid interface.

Returns a PropelConditionalProxy instance.

Allows for conditional statements in a fluid interface.

Returns the current object Allows for conditional statements in a fluid interface.

Ensures deep cloning of attached objects

Returns the name of the class for this model criteria

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

Returns the name of the Peer class for this model criteria

Returns the TabkleMap object for this Criteria

Sets the formatter to use for the find() output Formatters must extend PropelFormatter 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

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 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->orWhere('b.Title = ?', 'foo'); // named conditions $c->condition('cond1', 'b.Title = ?', 'foo'); $c->condition('cond2', 'b.ISBN = ?', 12345); $c->orWhere(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(BookPeer::CREATED_AT) $c->orderBy('Book.CategoryId', 'desc') => $c->addDescendingOrderByColumn(BookPeer::CATEGORY_ID)

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

Adds a GROUB BY clause for all columns of a model to the query Examples: $c->groupBy('Book'); => $c->addGroupByColumn(BookPeer::ID); => $c->addGroupByColumn(BookPeer::TITLE); => $c->addGroupByColumn(BookPeer::AUTHOR_ID); => $c->addGroupByColumn(BookPeer::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 PropelArrayCollection Examples: ArticleQuery::create()->select('Name')->find(); => PropelArrayCollection Object ('Foo', 'Bar')

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

ArticleQuery::create()->select(array('Id', 'Name'))->find();
=> PropelArrayCollection 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(BookPeer::AUTHOR_ID, AuthorPeer::ID, Criteria::INNER_JOIN); $c->join('Book.Author', Criteria::RIGHT_JOIN); => $c->addJoin(BookPeer::AUTHOR_ID, AuthorPeer::ID, Criteria::RIGHT_JOIN); $c->join('Book.Author a', Criteria::RIGHT_JOIN); => $c->addAlias('a', AuthorPeer::TABLE_NAME); => $c->addJoin(BookPeer::AUTHOR_ID, 'a.ID', Criteria::RIGHT_JOIN); </code>

Add another condition to an already added join

Replace the condition of an already added join

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

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.

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

Sets the primary Criteria for this secondary Criteria

Gets the primary criteria for this secondary Criteria

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, temrination 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 temrination.

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 offet 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 This method is called by ModelCriteria::delete() inside a transaction

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.

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()

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 BasePeer::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')

Make explain plan of the query