Docs For Class DBLBoolField

Description

Boolean field represented by a checkbox widget.

This is meant to represent two-state boolean field. In record index and record detail the state of the field is represented by a text ("YES" and "no" by default).

In the filtering form, the field is represented by a combo box alloving you to select "Any", "Yes" and "No" values to filter records which have Yes/No value (or to turn filter off by selecting Any).

Located in /DBLBoolField.php (line 22)

DBLField
   |
   --DBLBoolField

Variable Summary

string $anyText

string $noText

string $noValue

string $yesText

string $yesValue

Method Summary

DBLBoolField DBLBoolField (mixed $name, mixed $titleTxt, mixed $titleHTML)

void acceptValue (mixed $value, mixed &$err, mixed &$r, mixed $new)

void addCondition (mixed $value, mixed &$f, mixed &$q)

void formatDetail (mixed $value, mixed &$r)

void formatEdit (mixed $value, mixed &$r, mixed $dataSource, mixed $formName)

void formatFilter (mixed $value, mixed &$r, mixed $formName)

void formatIndex (mixed $value, mixed &$r)

Variables

string $anyText (line 28)

var: Text of the 'any' value (used for filtering form). '<Any>' by default (can be localized).

string $noText (line 36)

var: Value to use as 'NO'. Set to by default.

string $noValue (line 44)

var: Value to use as 'YES'. Set to 1 by default.

string $yesText (line 32)

var: Text to display for the 'NO' value. 'no' by default (can be localized).

string $yesValue (line 40)

var: Text to display for the 'YES' value. 'YES' by default (can be localized).

Inherited Variables

Inherited from DBLField

DBLField::$addAsterixes
DBLField::$allowEmpty
DBLField::$computed
DBLField::$dbName
DBLField::$default
DBLField::$detailAttributes
DBLField::$detailPostfix
DBLField::$detailPrefix
DBLField::$editAttributes
DBLField::$editPostfix
DBLField::$editPrefix
DBLField::$filterAttributes
DBLField::$filterPostfix
DBLField::$filterPrefix
DBLField::$indexAttributes
DBLField::$indexPostfix
DBLField::$indexPrefix
DBLField::$lookupField
DBLField::$name
DBLField::$needsMultipart
DBLField::$noOrderByTitle
DBLField::$readOnly
DBLField::$referenceURL
DBLField::$titleHTML
DBLField::$titleTxt
DBLField::$widgetAttributes

Methods

Constructor DBLBoolField (line 51)

Constructor.

See DBLField::DBLField() for the parameter description.

DBLBoolField DBLBoolField (mixed $name, mixed $titleTxt, mixed $titleHTML)

acceptValue (line 94)

void acceptValue (mixed $value, mixed &$err, mixed &$r, mixed $new)

Redefinition of:

DBLField::acceptValue(): Accept value from post.

addCondition (line 106)

void addCondition (mixed $value, mixed &$f, mixed &$q)

Redefinition of:

DBLField::addCondition(): Add condition(s) to the query according to the filter value.

formatDetail (line 68)

void formatDetail (mixed $value, mixed &$r)

Redefinition of:

DBLField::formatDetail(): Format field for record detail.

formatEdit (line 73)

void formatEdit (mixed $value, mixed &$r, mixed $dataSource, mixed $formName)

Redefinition of:

DBLField::formatEdit(): Format field for record edit form.

formatFilter (line 81)

void formatFilter (mixed $value, mixed &$r, mixed $formName)

Redefinition of:

DBLField::formatFilter(): Format field for the filter form.

formatIndex (line 63)

void formatIndex (mixed $value, mixed &$r)

Redefinition of:

DBLField::formatIndex(): Format field for record index.

Inherited Methods

Inherited From DBLField

DBLField::DBLField()
DBLField::acceptFilterValue()
DBLField::acceptValue()
DBLField::addCondition()
DBLField::checkValue()
DBLField::formatDetail()
DBLField::formatEdit()
DBLField::formatFilter()
DBLField::formatIndex()
DBLField::jsCheck()
DBLField::setTitle()
DBLField::splitValue()