Propel\Runtime\ActiveQuery\Criteria

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

Get the criteria map, i.e.

the array of Criterions

Brings this criteria back to its initial state, so that it can be reused as if it was new.

Except if the criteria has grown in
capacity, it is left at the current capacity.

Add an AS clause to the select columns.

Usage:

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

If the name already exists, it is replaced by the new clause.

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 a 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>Configuration::getDefaultDatasource()</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(ProjectTableMap::ID, FooTableMap::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(BaseTableMap::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 prior criterion exists, the condition is "OR"ed to it.

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

Method to create an SQL query based on values in a Criteria.

This method creates only prepared statement SQL (using ? where values
will go). The second parameter ($params) stores the values that need
to be set before the statement is executed. The reason we do it this way
is to let the PDO layer handle all escaping & value formatting.

Method to perform inserts based on values and keys in a Criteria.

<p>
If the primary key is auto incremented the data in Criteria
will be inserted and the auto increment value will be returned.
<p>
If the primary key is included in Criteria then that value will
be used to insert the row.
<p>
If no primary key is included in Criteria then we will try to
figure out the primary key from the database map and insert the
row with the next available id using util.db.IDBroker.
<p>
If no primary key is defined for the table the values will be
inserted as specified in Criteria and null will be returned.

Method used to update rows in the DB.

Rows are selected based
on selectCriteria and updated using values in updateValues.
<p>
Use this method for performing an update of the kind:
<p>
WHERE some_column = some value AND could_have_another_column =
another value AND so on.

Checks whether the Criteria needs to use column aliasing This is implemented in a service class rather than in Criteria itself in order to avoid doing the tests when it's not necessary (e.g.

for SELECTs)

Issue a DELETE query based on the current ModelCriteria This method is called by ModelCriteria::delete() inside a transaction

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

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