Docs For Class FOFModelFieldText

Description

FrameworkOnFramework model behavior class

since: 2.1

Located in /libraries/fof/model/field/text.php (line 17)

FOFModelField
   |
   --FOFModelFieldText

Direct descendents

Class	Description
FOFModelFieldDate	FrameworkOnFramework model behavior class

Method Summary

FOFModelFieldText __construct (JDatabaseDriver $db, object $field, [ $table_alias = false])

string between (mixed $from, mixed $to, [boolean $include = true])

string exact (mixed $value)

string getDefaultSearchMethod ()

string interval (mixed $value, mixed $interval, [boolean $include = true])

string outside (mixed $from, mixed $to, [boolean $include = false])

string partial (mixed $value)

Variables

Inherited Variables

Inherited from FOFModelField

FOFModelField::$name
FOFModelField::$null_value
FOFModelField::$table_alias
FOFModelField::$type
FOFModelField::$_db

Methods

Constructor __construct (line 25)

Constructor

access: public

FOFModelFieldText __construct (JDatabaseDriver $db, object $field, [ $table_alias = false])

JDatabaseDriver $db: The database object
object $field: The field informations as taken from the db
$table_alias

Redefinition of:

FOFModelField::__construct(): Constructor

between (line 85)

Dummy method; this search makes no sense for text fields

return: Empty string
access: public

string between (mixed $from, mixed $to, [boolean $include = true])

mixed $from: Ignored
mixed $to: Ignored
boolean $include: Ignored

Redefinition of:

FOFModelField::between(): Perform a between limits match (usually: search for a value between

Redefined in descendants as:

FOFModelFieldDate::between() : Perform a between limits match. When $include is true

exact (line 66)

Perform an exact match (match string)

return: The SQL where clause for this search
access: public

string exact (mixed $value)

mixed $value: The value to compare to

Redefinition of:

FOFModelField::exact(): Perform an exact match (equality matching)

getDefaultSearchMethod (line 37)

Returns the default search method for this field.

access: public

string getDefaultSearchMethod ()

Redefinition of:

FOFModelField::getDefaultSearchMethod(): Returns the default search method for a field. This always returns 'exact' and you are supposed to override it in specialised classes. The possible values are exact, partial, between and outside, unless something different is returned by getSearchMethods().

Redefined in descendants as:

FOFModelFieldDate::getDefaultSearchMethod() : Returns the default search method for this field.

interval (line 113)

Dummy method; this search makes no sense for text fields

return: Empty string
access: public

string interval (mixed $value, mixed $interval, [boolean $include = true])

mixed $value: Ignored
mixed $interval: Ignored
boolean $include: Ignored

Redefinition of:

FOFModelField::interval(): Perform an interval search (usually: a date interval check)

Redefined in descendants as:

FOFModelFieldDate::interval() : Interval date search

outside (line 99)

Dummy method; this search makes no sense for text fields

return: Empty string
access: public

string outside (mixed $from, mixed $to, [boolean $include = false])

mixed $from: Ignored
mixed $to: Ignored
boolean $include: Ignored

Redefinition of:

FOFModelField::outside(): Perform an outside limits match (usually: search for a value outside an

Redefined in descendants as:

FOFModelFieldDate::outside() : Perform an outside limits match. When $include is true

partial (line 49)

Perform a partial match (search in string)

return: The SQL where clause for this search
access: public

string partial (mixed $value)

mixed $value: The value to compare to

Redefinition of:

FOFModelField::partial(): Perform a partial match (usually: search in string)

Inherited Methods

Inherited From FOFModelField

FOFModelField::__construct()
FOFModelField::between()
FOFModelField::exact()
FOFModelField::getDefaultSearchMethod()
FOFModelField::getField()
FOFModelField::getFieldName()
FOFModelField::getFieldType()
FOFModelField::getSearchMethods()
FOFModelField::interval()
FOFModelField::isEmpty()
FOFModelField::outside()
FOFModelField::partial()
FOFModelField::search()