Propel 2 API
Class

Propel\Runtime\ActiveQuery\Criterion\CustomCriterion

class CustomCriterion extends AbstractCriterion

Specialized Criterion used for custom expressions with no binding, e.g.

'NOW() = 1'

Constants

UND

ODER

Methods

__construct(Criteria $outer, string $value)

Create a new instance.
init(Criteria $criteria)

Init some properties with the help of outer class

 from AbstractCriterion
string getColumn()

Get the column name.

 from AbstractCriterion
void setTable(string $name)

Set the table name.

 from AbstractCriterion
string getTable()

Get the table name.

 from AbstractCriterion
string getComparison()

Get the comparison.

 from AbstractCriterion
mixed getValue()

Get the value.

 from AbstractCriterion
AdapterInterface getAdapter()

Get the adapter.

 from AbstractCriterion
void setAdapter(AdapterInterface $v)

Set the adapter.

 from AbstractCriterion
array getConjunctions()

Get the list of conjunctions in this Criterion

 from AbstractCriterion
addAnd(AbstractCriterion $criterion)

Append an AND Criterion onto this Criterion's list.

 from AbstractCriterion
Criterion addOr(AbstractCriterion $criterion)

Append an OR Criterion onto this Criterion's list.

 from AbstractCriterion
void appendPsTo(string $sb, array $params)

Appends a Prepared Statement representation of the Criterion onto the buffer.

 from AbstractCriterion
__toString()

from AbstractCriterion
boolean equals($obj)

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

 from AbstractCriterion
array getAllTables()

Get all tables from nested criterion objects

 from AbstractCriterion
Criterion[] getAttachedCriterion()

get an array of all criterion attached to this recursing through all sub criterion

 from AbstractCriterion
__clone()

Ensures deep cloning of attached objects

 from AbstractCriterion

Details

at line 26
public __construct(Criteria $outer, string $value)

Create a new instance.

Parameters

Criteria $outer The outer class (this is an "inner" class).
string $value The condition to be added to the query string

in AbstractCriterion at line 97
public init(Criteria $criteria)

Init some properties with the help of outer class

Parameters

Criteria $criteria The outer class

in AbstractCriterion at line 139
public string getColumn()

Get the column name.

Return Value

string A String with the column name.

in AbstractCriterion at line 150
public void setTable(string $name)

Set the table name.

Parameters

string $name A String with the table name.

Return Value

void

in AbstractCriterion at line 160
public string getTable()

Get the table name.

Return Value

string A String with the table name.

in AbstractCriterion at line 170
public string getComparison()

Get the comparison.

Return Value

string A String with the comparison.

in AbstractCriterion at line 180
public mixed getValue()

Get the value.

Return Value

mixed An Object with the value.

in AbstractCriterion at line 192
public AdapterInterface getAdapter()

Get the adapter.

The AdapterInterface which might be used to get db specific
variations of sql.

Return Value

AdapterInterface value of db.

in AbstractCriterion at line 204
public void setAdapter(AdapterInterface $v)

Set the adapter.

The AdapterInterface might be used to get db specific variations of sql.

Parameters

AdapterInterface $v Value to assign to db.

Return Value

void

in AbstractCriterion at line 225
public array getConjunctions()

Get the list of conjunctions in this Criterion

Return Value

array

in AbstractCriterion at line 233
public addAnd(AbstractCriterion $criterion)

Append an AND Criterion onto this Criterion's list.

Parameters

AbstractCriterion $criterion

in AbstractCriterion at line 245
public Criterion addOr(AbstractCriterion $criterion)

Append an OR Criterion onto this Criterion's list.

Parameters

AbstractCriterion $criterion

Return Value

Criterion

in AbstractCriterion at line 263
public void appendPsTo(string $sb, array $params)

Appends a Prepared Statement representation of the Criterion onto the buffer.

Parameters

string $sb &$sb The string that will receive the Prepared Statement
array $params A list to which Prepared Statement parameters will be appended

Return Value

void

Exceptions

PropelException - if the expression builder cannot figure out how to turn a specified expression into proper SQL.

in AbstractCriterion at line 278
public __toString()

in AbstractCriterion at line 300
public boolean equals($obj)

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

Parameters

$obj

Return Value

boolean

in AbstractCriterion at line 341
public array getAllTables()

Get all tables from nested criterion objects

Return Value

array

in AbstractCriterion at line 367
public Criterion[] getAttachedCriterion()

get an array of all criterion attached to this recursing through all sub criterion

Return Value

Criterion[]

in AbstractCriterion at line 380
public __clone()

Ensures deep cloning of attached objects