sfFormFilterPropel is the base class for filter forms based on Propel
objects.
Method Summary
-
addBooleanCriteria($criteria, $field, $value)
-
addDateCriteria($criteria, $field, $values)
-
addForeignKeyCriteria($criteria, $field, $value)
-
addNumberCriteria($criteria, $field, $values)
-
addTextCriteria($criteria, $field, $values)
-
Criteria
buildCriteria($values)
Builds a Propel Criteria based on the passed values.
-
camelize($text)
-
getColName($field)
-
Criteria
getCriteria()
Returns a Propel Criteria based on the current values form the form.
-
array
getFields()
Returns the fields and their filter type.
-
string
getModelName()
Returns the current model name.
-
array
processValues($values)
Processes cleaned up values with user defined methods.
Method Details
-
addBooleanCriteria ($criteria, $field, $value)
Browse code
-
addDateCriteria ($criteria, $field, $values)
Browse code
-
addForeignKeyCriteria ($criteria, $field, $value)
Browse code
-
addNumberCriteria ($criteria, $field, $values)
Browse code
-
addTextCriteria ($criteria, $field, $values)
Browse code
-
(Criteria) buildCriteria ($values)
Browse code
| $values |
An array of parameters to build the Criteria object
|
Builds a Propel Criteria based on the passed values.
returns A Propel Criteria object
-
-
-
(Criteria) getCriteria ()
Browse code
Returns a Propel Criteria based on the current values form the form.
returns A Propel Criteria object
-
Returns the fields and their filter type.
returns An array of fields with their filter type
-
(string) getModelName ()
Browse code
Returns the current model name.
returns The model class name
-
(array) processValues ($values)
Browse code
| $values |
An array of cleaned up values to process
|
Processes cleaned up values with user defined methods.
To process a value before it is used by the buildCriteria() method, you need to define an convertXXXValue() method where XXX is the PHP name of the column. The method must return the processed value or false to remove the value from the array of cleaned up values.
returns An array of cleaned up values processed by the user defined methods
|
