Propel API
Class

Criteria

class Criteria implements IteratorAggregate

This is a utility class for holding criteria information for a query.

BasePeer constructs SQL statements based on the values in this class.

Constants

EQUAL

Comparison type.
NOT_EQUAL

Comparison type.
ALT_NOT_EQUAL

Comparison type.
GREATER_THAN

Comparison type.
LESS_THAN

Comparison type.
GREATER_EQUAL

Comparison type.
LESS_EQUAL

Comparison type.
LIKE

Comparison type.
NOT_LIKE

Comparison type.
CONTAINS_ALL

Comparison for array column types
CONTAINS_SOME

Comparison for array column types
CONTAINS_NONE

Comparison for array column types
ILIKE

PostgreSQL comparison type
NOT_ILIKE

PostgreSQL comparison type
CUSTOM

Comparison type.
RAW

Comparison type
CUSTOM_EQUAL

Comparison type for update
DISTINCT

Comparison type.
IN

Comparison type.
NOT_IN

Comparison type.
ALL

Comparison type.
JOIN

Comparison type.
BINARY_AND

Binary math operator: AND
BINARY_OR

Binary math operator: OR
ASC

"Order by" qualifier - ascending
DESC

"Order by" qualifier - descending
ISNULL

"IS NULL" null comparison
ISNOTNULL

"IS NOT NULL" null comparison
CURRENT_DATE

"CURRENT_DATE" ANSI SQL function
CURRENT_TIME

"CURRENT_TIME" ANSI SQL function
CURRENT_TIMESTAMP

"CURRENT_TIMESTAMP" ANSI SQL function
LEFT_JOIN

"LEFT JOIN" SQL statement
RIGHT_JOIN

"RIGHT JOIN" SQL statement
INNER_JOIN

"INNER JOIN" SQL statement
LOGICAL_OR

logical OR operator
LOGICAL_AND

logical AND operator

Methods

__construct(string $dbName = null)

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

Implementing SPL IteratorAggregate interface.
array getMap()

Get the criteria map, i.e.
void clear()

Brings this criteria back to its initial state, so that it can be reused as if it was new.
Criteria addAsColumn(string $name, string $clause)

Add an AS clause to the select columns.
array getAsColumns()

Get the column aliases.
string|null getColumnForAs(string $as)

Returns the column name associated with an alias (AS-column).
Criteria addAlias(string $alias, string $table)

Allows one to specify an alias for a table that can be used in various parts of the SQL.
Criteria removeAlias(string $alias)

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

Returns the aliases for this Criteria
string|null getTableForAlias(string $alias)

Returns the table name associated with an alias.
array($tableName, getTableNameAndAlias(string $tableAliasOrName)

Returns the table name and alias based on a table alias or name.
array keys()

Get the keys of the criteria map, i.e.
boolean containsKey(string $column)

Does this Criteria object contain the specified key?
boolean keyContainsValue(string $column)

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

Whether this Criteria has any where columns.
void setUseTransaction(bool $v)

Will force the sql represented by this criteria to be executed within a transaction.
boolean isUseTransaction()

Whether the sql command specified by this criteria must be wrapped in a transaction.
Criterion getCriterion(string $column)

Method to return criteria related to columns in a table.
Criterion getLastCriterion()

Method to return the latest Criterion in a table.
Criterion getNewCriterion(string $column, mixed $value = null, string $comparison = self::EQUAL)

Method to return criterion that is not added automatically to this Criteria.
string getColumnName(string $name)

Method to return a String table name.
array getTablesColumns()

Shortcut method to get an array of columns indexed by table.
string getComparison(string $key)

Method to return a comparison String.
string getDbName()

Get the Database(Map) name.
void setDbName(string $dbName = null)

Set the DatabaseMap name.
string getPrimaryTableName()

Get the primary table for this Criteria.
setPrimaryTableName(string $tableName)

Sets the primary table for this Criteria.
string getTableName(string $name)

Method to return a String table name.
mixed getValue(string $name)

Method to return the value that was added to Criteria.
mixed get(string $key)

An alias to getValue() -- exposing a Hashtable-like interface.
Criteria put(string $key, mixed $value)

Overrides Hashtable put, so that this object is returned instead of the value previously in the Criteria object.
putAll(mixed $t)

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.
Criteria add(string $critOrColumn, mixed $value = null, string $comparison = null)

This method adds a new criterion to the list of criterias.
Criteria addCond(string $name, string $p1, mixed $value = null, string $comparison = null)

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
Criteria combine(array $criterions = array(), string $operator = self::LOGICAL_AND, string $name = null)

Combine several named criterions with a logical operator
Criteria addJoin(mixed $left, mixed $right, mixed $joinType = null)

This is the way that you should add a join of two tables.
Criteria addMultipleJoin(array $conditions, string $joinType = null)

Add a join with multiple conditions
Criteria addJoinObject(Join $join)

Add a join object to the Criteria
array getJoins()

Get the array of Joins.
Criteria addSelectQuery(Criteria $subQueryCriteria, string $alias = null)

Adds a Criteria as subQuery in the From Clause.
Boolean hasSelectQueries()

Checks whether this Criteria has a subquery.
array getSelectQueries()

Get the associative array of Criteria for the subQueries per alias.
Criteria getSelectQuery(string $alias)

Get the Criteria for a specific subQuery.
boolean hasSelectQuery(string $alias)

checks if the Criteria for a specific subQuery is set.
forgeSelectQueryAlias()

Criteria setAll()

Adds "ALL" modifier to the SQL statement.
Criteria setDistinct()

Adds "DISTINCT" modifier to the SQL statement.
Criteria addSelectModifier(string $modifier)

Adds a modifier to the SQL statement.
Criteria removeSelectModifier(string $modifier)

Removes a modifier to the SQL statement.
bool hasSelectModifier(string $modifier)

Checks the existence of a SQL select modifier
Criteria setIgnoreCase(boolean $b)

Sets ignore case.
boolean isIgnoreCase()

Is ignore case on or off?
Criteria setSingleRecord(boolean $b)

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).
boolean isSingleRecord()

Is single record?
Criteria setLimit(int $limit)

Set limit.
int getLimit()

Get limit.
Criteria setOffset(int $offset)

Set offset.
int getOffset()

Get offset.
Criteria addSelectColumn(string $name)

Add select column.
Criteria setComment(string $comment = null)

Set the query comment, that appears after the first verb in the SQL query
string getComment()

Get the query comment, that appears after the first verb in the SQL query
boolean hasSelectClause()

Whether this Criteria has any select columns.
array getSelectColumns()

Get select columns.
Criteria clearSelectColumns()

Clears current select columns.
array getSelectModifiers()

Get select modifiers.
Criteria addGroupByColumn(string $groupBy)

Add group by column name.
Criteria addAscendingOrderByColumn(string $name)

Add order by column name, explicitly specifying ascending.
Criteria addDescendingOrderByColumn(string $name)

Add order by column name, explicitly specifying descending.
array getOrderByColumns()

Get order by columns.
Criteria clearOrderByColumns()

Clear the order-by columns.
Criteria clearGroupByColumns()

Clear the group-by columns.
array getGroupByColumns()

Get group by columns.
Criterion getHaving()

Get Having Criterion.
mixed|null remove(string $key)

Remove an object from the criteria.
string toString()

Build a string representation of the Criteria.
int size()

Returns the size (count) of this criteria.
boolean equals(Criteria|null $crit)

This method checks another Criteria to see if they contain the same attributes and hashtable entries.
Criteria mergeWith(Criteria $criteria, string $operator = null)

Add the content of a Criteria to the current Criteria In case of conflict, the current Criteria keeps its properties
Criteria addHaving(mixed $p1, mixed $value = null, mixed $comparison = null)

This method adds a prepared Criterion object to the Criteria as a having clause.
Criteria addAnd(mixed $p1, mixed $value = null, mixed $comparison = null, bool $preferColumnCondition = true)

If a criterion for the requested column already exists, the condition is "AND"ed to the existing criterion (necessary for Propel 1.4 compatibility).
Criteria addOr(mixed $p1, mixed $value = null, mixed $comparison = null, bool $preferColumnCondition = true)

If a criterion for the requested column already exists, the condition is "OR"ed to the existing criterion (necessary for Propel 1.4 compatibility).
Criteria addUsingOperator(string|Criterion $p1, mixed $value = null, string $operator = null, boolean $preferColumnCondition = true)

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

Criteria _and()

PropelConditionalProxy|Criteria _if(bool $cond)

Returns the current object if the condition is true, or a PropelConditionalProxy instance otherwise.
PropelConditionalProxy|Criteria _elseif(bool $cond)

Returns a PropelConditionalProxy instance.
PropelConditionalProxy|Criteria _else()

Returns a PropelConditionalProxy instance.
Criteria _endif()

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

Ensures deep cloning of attached objects

Details

at line 254
public __construct(string $dbName = null)

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

Parameters

string $dbName The dabase name.

at line 264
public getIterator()

Implementing SPL IteratorAggregate interface.

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

at line 273
public array getMap()

Get the criteria map, i.e.

the array of Criterions

Return Value

array

at line 284
public void clear()

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.

Return Value

void

at line 323
public Criteria addAsColumn(string $name, string $clause)

Add an AS clause to the select columns.

Usage:

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

Parameters

string $name Wanted Name of the column (alias).
string $clause SQL clause to select from the table If the name already exists, it is replaced by the new clause.

Return Value

Criteria A modified Criteria object.

at line 336
public array getAsColumns()

Get the column aliases.

Return Value

array An assoc array which map the column alias names to the alias clauses.

at line 347
public string|null getColumnForAs(string $as)

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

Parameters

string $as

Return Value

string|null $string The name if found, null otherwise.

at line 365
public Criteria addAlias(string $alias, string $table)

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

Parameters

string $alias
string $table

Return Value

Criteria A modified Criteria object.

at line 379
public Criteria removeAlias(string $alias)

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

Parameters

string $alias

Return Value

Criteria A modified Criteria object.

at line 391
public array getAliases()

Returns the aliases for this Criteria

Return Value

array

at line 402
public string|null getTableForAlias(string $alias)

Returns the table name associated with an alias.

Parameters

string $alias

Return Value

string|null $string The name if given, null otherwise.

at line 419
public array($tableName, getTableNameAndAlias(string $tableAliasOrName)

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.

Parameters

string $tableAliasOrName

Return Value

array($tableName, $tableAlias)

at line 437
public array keys()

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>

Return Value

array

at line 448
public boolean containsKey(string $column)

Does this Criteria object contain the specified key?

Parameters

string $column [table.]column

Return Value

boolean True if this Criteria object contain the specified key.

at line 461
public boolean keyContainsValue(string $column)

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

Parameters

string $column [table.]column

Return Value

boolean True if this Criteria object contain the specified key and a value for that key

at line 476
public boolean hasWhereClause()

Whether this Criteria has any where columns.

This counts conditions added with the add() method.

Return Value

boolean

See also

add()

at line 490
public void setUseTransaction(bool $v)

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.

Parameters

bool $v

Return Value

void

at line 501
public boolean isUseTransaction()

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

Return Value

boolean

at line 515
public Criterion getCriterion(string $column)

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.

Parameters

string $column Column name.

Return Value

Criterion A Criterion object.

at line 525
public Criterion getLastCriterion()

Method to return the latest Criterion in a table.

Return Value

Criterion A Criterion or null no Criterion is added.

at line 546
public Criterion getNewCriterion(string $column, mixed $value = null, string $comparison = self::EQUAL)

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.

Parameters

string $column Full name of column (for example TABLE.COLUMN).
mixed $value
string $comparison

Return Value

Criterion

at line 557
public string getColumnName(string $name)

Method to return a String table name.

Parameters

string $name Name of the key.

Return Value

string The value of the object at key.

at line 578
public array getTablesColumns()

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>

Return Value

array array(table => array(table.column1, table.column2))

at line 595
public string getComparison(string $key)

Method to return a comparison String.

Parameters

string $key String name of the key.

Return Value

string A String with the value of the object at key.

at line 609
public string getDbName()

Get the Database(Map) name.

Return Value

string A String with the Database(Map) name.

at line 621
public void setDbName(string $dbName = null)

Set the DatabaseMap name.

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

Parameters

string $dbName The Database (Map) name.

Return Value

void

at line 635
public string getPrimaryTableName()

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.

Return Value

string

at line 649
public setPrimaryTableName(string $tableName)

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.

Parameters

string $tableName

at line 660
public string getTableName(string $name)

Method to return a String table name.

Parameters

string $name The name of the key.

Return Value

string The value of table for criterion at key.

at line 675
public mixed getValue(string $name)

Method to return the value that was added to Criteria.

Parameters

string $name A String with the name of the key.

Return Value

mixed The value of object at key.

at line 690
public mixed get(string $key)

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

Parameters

string $key An Object.

Return Value

mixed The value within the Criterion (not the Criterion object).

at line 709
public Criteria put(string $key, mixed $value)

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.

Parameters

string $key
mixed $value

Return Value

Criteria A modified Criteria object.

at line 724
public putAll(mixed $t)

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.

Parameters

mixed $t Mappings to be stored in this map.

at line 760
public Criteria add(string $critOrColumn, mixed $value = null, string $comparison = null)

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'.

Parameters

string $critOrColumn The column to run the comparison on, or a Criterion object.
mixed $value
string $comparison A String.

Return Value

Criteria A modified Criteria object.

at line 795
public Criteria addCond(string $name, string $p1, mixed $value = null, string $comparison = null)

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'.

Parameters

string $name name to combine the criterion later
string $p1 The column to run the comparison on, or Criterion object.
mixed $value
string $comparison A String.

Return Value

Criteria A modified Criteria object.

at line 813
public Criteria combine(array $criterions = array(), string $operator = self::LOGICAL_AND, string $name = null)

Combine several named criterions with a logical operator

Parameters

array $criterions array of the name of the criterions to combine
string $operator logical operator, either Criteria::LOGICAL_AND, or Criteria::LOGICAL_OR
string $name optional name to combine the criterion later

Return Value

Criteria

Exceptions

PropelException

at line 854
public Criteria addJoin(mixed $left, mixed $right, mixed $joinType = null)

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>

Parameters

mixed $left A String with the left side of the join, or an array (see addMultipleJoin).
mixed $right A String with the right side of the join, or an array (see addMultipleJoin).
mixed $joinType A String with the join operator among Criteria::INNER_JOIN, Criteria::LEFT_JOIN, and Criteria::RIGHT_JOIN

Return Value

Criteria A modified Criteria object.

at line 910
public Criteria addMultipleJoin(array $conditions, string $joinType = null)

Add a join with multiple conditions

Parameters

array $conditions An array of conditions, each condition being an array (left, right, operator)
string $joinType A String with the join operator. Defaults to an implicit join.

Return Value

Criteria A modified Criteria object.

See also

http://propel.phpdb.org/trac/ticket/167, http://propel.phpdb.org/trac/ticket/606 Example usage: $c->addMultipleJoin(array( array(LeftPeer::LEFT_COLUMN, RightPeer::RIGHT_COLUMN), // if no third argument, defaults to Criteria::EQUAL array(FoldersPeer::alias( 'fo', FoldersPeer::LFT ), FoldersPeer::alias( 'parent', FoldersPeer::RGT ), Criteria::LESS_EQUAL ) ), Criteria::LEFT_JOIN );
addJoin()

at line 964
public Criteria addJoinObject(Join $join)

Add a join object to the Criteria

Parameters

Join $join A join object

Return Value

Criteria A modified Criteria object

at line 977
public array getJoins()

Get the array of Joins.

Return Value

array Join[]

at line 990
public Criteria addSelectQuery(Criteria $subQueryCriteria, string $alias = null)

Adds a Criteria as subQuery in the From Clause.

Parameters

Criteria $subQueryCriteria Criteria to build the subquery from
string $alias alias for the subQuery

Return Value

Criteria this modified Criteria object (Fluid API)

at line 1005
public Boolean hasSelectQueries()

Checks whether this Criteria has a subquery.

Return Value

Boolean

at line 1015
public array getSelectQueries()

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

Return Value

array Criteria[]

at line 1026
public Criteria getSelectQuery(string $alias)

Get the Criteria for a specific subQuery.

Parameters

string $alias alias for the subQuery

Return Value

Criteria

at line 1037
public boolean hasSelectQuery(string $alias)

checks if the Criteria for a specific subQuery is set.

Parameters

string $alias alias for the subQuery

Return Value

boolean

at line 1042
public forgeSelectQueryAlias()

at line 1056
public Criteria setAll()

Adds "ALL" modifier to the SQL statement.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1068
public Criteria setDistinct()

Adds "DISTINCT" modifier to the SQL statement.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1084
public Criteria addSelectModifier(string $modifier)

Adds a modifier to the SQL statement.

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

Parameters

string $modifier The modifier to add

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1102
public Criteria removeSelectModifier(string $modifier)

Removes a modifier to the SQL statement.

Checks for existence before removal

Parameters

string $modifier The modifier to add

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1116
public bool hasSelectModifier(string $modifier)

Checks the existence of a SQL select modifier

Parameters

string $modifier The modifier to add

Return Value

bool

at line 1127
public Criteria setIgnoreCase(boolean $b)

Sets ignore case.

Parameters

boolean $b True if case should be ignored.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1139
public boolean isIgnoreCase()

Is ignore case on or off?

Return Value

boolean True if case is ignored.

at line 1156
public Criteria setSingleRecord(boolean $b)

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

Parameters

boolean $b Set to TRUE if you expect the query to select just one record.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1168
public boolean isSingleRecord()

Is single record?

Return Value

boolean True if a single record is being returned.

at line 1179
public Criteria setLimit(int $limit)

Set limit.

Parameters

int $limit An int with the value for limit.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1192
public int getLimit()

Get limit.

Return Value

int An int with the value for limit.

at line 1204
public Criteria setOffset(int $offset)

Set offset.

Parameters

int $offset An int with the value for offset. (Note this values is cast to a 32bit integer and may result in truncatation)

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1216
public int getOffset()

Get offset.

Return Value

int An int with the value for offset.

at line 1227
public Criteria addSelectColumn(string $name)

Add select column.

Parameters

string $name Name of the select column.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1240
public Criteria setComment(string $comment = null)

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

Parameters

string $comment The comment to add to the query, without comment sign

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1252
public string getComment()

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

Return Value

string The comment to add to the query, without comment sign

at line 1266
public boolean hasSelectClause()

Whether this Criteria has any select columns.

This will include columns added with addAsColumn() method.

Return Value

boolean

See also

addAsColumn()
addSelectColumn()

at line 1276
public array getSelectColumns()

Get select columns.

Return Value

array An array with the name of the select columns.

at line 1286
public Criteria clearSelectColumns()

Clears current select columns.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1298
public array getSelectModifiers()

Get select modifiers.

Return Value

array An array with the select modifiers.

at line 1309
public Criteria addGroupByColumn(string $groupBy)

Add group by column name.

Parameters

string $groupBy The name of the column to group by.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1322
public Criteria addAscendingOrderByColumn(string $name)

Add order by column name, explicitly specifying ascending.

Parameters

string $name The name of the column to order by.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1335
public Criteria addDescendingOrderByColumn(string $name)

Add order by column name, explicitly specifying descending.

Parameters

string $name The name of the column to order by.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1347
public array getOrderByColumns()

Get order by columns.

Return Value

array An array with the name of the order columns.

at line 1357
public Criteria clearOrderByColumns()

Clear the order-by columns.

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1369
public Criteria clearGroupByColumns()

Clear the group-by columns.

Return Value

Criteria

at line 1381
public array getGroupByColumns()

Get group by columns.

Return Value

array

at line 1391
public Criterion getHaving()

Get Having Criterion.

Return Value

Criterion A Criterion object that is the having clause.

at line 1402
public mixed|null remove(string $key)

Remove an object from the criteria.

Parameters

string $key A string with the key to be removed.

Return Value

mixed|null The removed value, null if not set.

at line 1422
public string toString()

Build a string representation of the Criteria.

Return Value

string A String with the representation of the Criteria.

at line 1450
public int size()

Returns the size (count) of this criteria.

Return Value

int

at line 1462
public boolean equals(Criteria|null $crit)

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

Parameters

Criteria|null $crit

Return Value

boolean

at line 1529
public Criteria mergeWith(Criteria $criteria, string $operator = null)

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

Parameters

Criteria $criteria The criteria to read properties from
string $operator The logical operator used to combine conditions Defaults to Criteria::LOGICAL_AND, also accapts Criteria::LOGICAL_OR This parameter is deprecated, use _or() instead

Return Value

Criteria The current criteria object

Exceptions

PropelException

at line 1624
public Criteria addHaving(mixed $p1, mixed $value = null, mixed $comparison = null)

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>

Parameters

mixed $p1 A Criterion, or a SQL clause with a question mark placeholder, or a column name
mixed $value The value to bind in the condition
mixed $comparison A Criteria class constant, or a PDO::PARAM_ class constant

Return Value

Criteria Modified Criteria object (for fluent API)

at line 1687
public Criteria addAnd(mixed $p1, mixed $value = null, mixed $comparison = null, bool $preferColumnCondition = true)

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)

Parameters

mixed $p1 A Criterion, or a SQL clause with a question mark placeholder, or a column name
mixed $value The value to bind in the condition
mixed $comparison A Criteria class constant, or a PDO::PARAM_ class constant
bool $preferColumnCondition

Return Value

Criteria A modified Criteria object.

at line 1723
public Criteria addOr(mixed $p1, mixed $value = null, mixed $comparison = null, bool $preferColumnCondition = true)

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)

Parameters

mixed $p1 A Criterion, or a SQL clause with a question mark placeholder, or a column name
mixed $value The value to bind in the condition
mixed $comparison A Criteria class constant, or a PDO::PARAM_ class constant
bool $preferColumnCondition

Return Value

Criteria A modified Criteria object.

at line 1761
public Criteria addUsingOperator(string|Criterion $p1, mixed $value = null, string $operator = null, boolean $preferColumnCondition = true)

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

Parameters

string|Criterion $p1 The column to run the comparison on (e.g. BookPeer::ID), or Criterion object
mixed $value
string $operator A String, like Criteria::EQUAL.
boolean $preferColumnCondition If true, the condition is combined with an existing condition on the same column (necessary for Propel 1.4 compatibility). If false, the condition is combined with the last existing condition.

Return Value

Criteria A modified Criteria object.

See also

Criteria::add()

at line 1777
public Criteria _or()

Return Value

Criteria

at line 1787
public Criteria _and()

Return Value

Criteria

at line 1805
public PropelConditionalProxy|Criteria _if(bool $cond)

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

Allows for conditional statements in a fluid interface.

Parameters

bool $cond

Return Value

PropelConditionalProxy|Criteria

at line 1822
public PropelConditionalProxy|Criteria _elseif(bool $cond)

Returns a PropelConditionalProxy instance.

Allows for conditional statements in a fluid interface.

Parameters

bool $cond ignored

Return Value

PropelConditionalProxy|Criteria

Exceptions

PropelException

at line 1839
public PropelConditionalProxy|Criteria _else()

Returns a PropelConditionalProxy instance.

Allows for conditional statements in a fluid interface.

Return Value

PropelConditionalProxy|Criteria

Exceptions

PropelException

at line 1856
public Criteria _endif()

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

Return Value

Criteria

Exceptions

PropelException

at line 1875
public __clone()

Ensures deep cloning of attached objects