Checkbox field, for selecting a single option.
This class provides a basic input field. This includes :
- getting data from a database or via html variables
- Privileges for handling and showing data
- displaying the data in a form or as text
Methods
Initialises an instance of a Formaid_FieldCheckbox class.
__construct(string $field_name, string $current_value, string $title, string $comment) : void
Defines current value and default value.
Parameters
$field_name
stringName of the checkbox field.
$current_value
stringInitial value.
$title
stringTitle/caption that precedes this field.
$comment
stringComment that is shown after this field.
Checks if INSERT of the value of this field in an SQL record is allowed.
allowSqlInsert() : bool
Inherited
If the Privileges on this field ( allow_change and allow_sql_insert) are set,
it is allowed to insert the value of this field.
| inherited_from |
\Formaid_FieldInputAbstract::allowSqlInsert() |
| inherited_from |
\Formaid_FieldInput::allowSqlInsert() |
Returns
booltrue if insert is allowed.
Checks if SELECTing the value of this field from an SQL record is allowed.
allowSqlSelect() : bool
Inherited
If the Privileges on this field (allow_show) is set,
it is allowed to select the value of this field.
| inherited_from |
\Formaid_FieldInputAbstract::allowSqlSelect() |
| inherited_from |
\Formaid_FieldInput::allowSqlSelect() |
Returns
booltrue if select is allowed.
Checks if UPDATE of the value of this field in an SQL record is allowed.
allowSqlUpdate() : bool
Inherited
If the Privileges on this field ( allow_change and allow_sql_update) are set,
it is allowed to update the value of this field.
| inherited_from |
\Formaid_FieldInputAbstract::allowSqlUpdate() |
| inherited_from |
\Formaid_FieldInput::allowSqlUpdate() |
Returns
booltrue if update is allowed.
Disables trimming whitespace of object name
disableTrimName() : void
Inherited
| inherited_from |
\Formaid_Object::disableTrimName() |
| inherited_from |
\Formaid_Property::disableTrimName() |
| inherited_from |
\Formaid_FieldInputAbstract::disableTrimName() |
| inherited_from |
\Formaid_FieldInput::disableTrimName() |
Display object
display() : void
Inherited
The name of the object is printed to stdout.
| inherited_from |
\Formaid_Object::display() |
| inherited_from |
\Formaid_Property::display() |
| inherited_from |
\Formaid_FieldInputAbstract::display() |
| inherited_from |
\Formaid_FieldInput::display() |
Enables trimming whitespace of object name
enableTrimName() : void
Inherited
| inherited_from |
\Formaid_Object::enableTrimName() |
| inherited_from |
\Formaid_Property::enableTrimName() |
| inherited_from |
\Formaid_FieldInputAbstract::enableTrimName() |
| inherited_from |
\Formaid_FieldInput::enableTrimName() |
Get display seperator
getDisplaySeparator() : string
Inherited
| inherited_from |
\Formaid_Property::getDisplaySeparator() |
| inherited_from |
\Formaid_FieldInputAbstract::getDisplaySeparator() |
| inherited_from |
\Formaid_FieldInput::getDisplaySeparator() |
Returns
stringString separating columns
Generates the HTML string for this element
getDisplayString() : string
Inherited
If the mode is form, a form element is shown :
this includes a title, html tags and a comment
If the mode is value, only the values of a record are shown:
this includes a title and the value in human readable form.
| inherited_from |
\Formaid_FieldInputAbstract::getDisplayString() |
| inherited_from |
\Formaid_FieldInput::getDisplayString() |
Returns
string
Returns the html-code for the input field properties
getFieldPropertiesHtmlString() : string
Inherited
| inherited_from |
\Formaid_FieldInput::getFieldPropertiesHtmlString() |
Returns
string
Returns a html string of the object.
getHtmlString() : string
Inherited
A field object is converted to a html string to display it in a web page
or web form.
| inherited_from |
\Formaid_FieldInput::getHtmlString() |
Returns
stringhtml string
Returns name of the object
getName() : string
Inherited
| inherited_from |
\Formaid_Object::getName() |
| inherited_from |
\Formaid_Property::getName() |
| inherited_from |
\Formaid_FieldInputAbstract::getName() |
| inherited_from |
\Formaid_FieldInput::getName() |
Returns
stringobject name
Returns current value
getValue() : string
Inherited
| inherited_from |
\Formaid_Property::getValue() |
| inherited_from |
\Formaid_FieldInputAbstract::getValue() |
| inherited_from |
\Formaid_FieldInput::getValue() |
Returns
stringcurrent value
Returns a value formatted to show on a web page.
getValueDisplayString(bool $specialchars) : string
The value is in human readable form.
The value in the database (Y or N), will be converted to
'Yes' or 'No'.
Parameters
$specialchars
boolConvert with htmlspecialchars, default = no
Returns
string
Returns a html string of the object value.
getValueHtmlString() : string
A field object value is converted to a html string to display it
in a web page or web form. If the checkbox value is true, display 'checked',
if it is false, nothing is displayed.
Returns
stringhtml string
Checks if current value is empty
isEmpty() : bool
Inherited
| inherited_from |
\Formaid_Property::isEmpty() |
| inherited_from |
\Formaid_FieldInputAbstract::isEmpty() |
| inherited_from |
\Formaid_FieldInput::isEmpty() |
Returns
booltrue if empty
Checks if the value of the checkbox is false
isFalse() : bool
Checks if object name is empty
isNameEmpty() : bool
Inherited
| inherited_from |
\Formaid_Object::isNameEmpty() |
| inherited_from |
\Formaid_Property::isNameEmpty() |
| inherited_from |
\Formaid_FieldInputAbstract::isNameEmpty() |
| inherited_from |
\Formaid_FieldInput::isNameEmpty() |
Returns
booltrue if empty
Checks if the value of the checkbox is true
isTrue() : bool
Reads value in the $_GET array
readGetValue() : void
The field value on a form is submitted and made available by the
webserver in the $_GET array.
This function checks if the value exist, applies encoding
and sets the value of this object.
If the checkbox is not checked, it will return no value, so if the _status
field is set and the field value is not, this means it was not checked.
If the _status field is not set, there was no checkbox on the form,
then the default value will be used.
Reads value in the $_POST array
readPostValue() : void
The field value on a form is submitted and made available by the
webserver in the $_POST array.
This function checks if the value exist, applies encoding
and sets the value of this object.
If the checkbox is not checked, it will return no value, so if the _status
field is set and the field value is not, this means it was not checked.
If the _status field is not set, there was no checkbox on the form,
then the default value will be used.
Reads value from an sql-row array
readSqlValue(array $sql_row) : void
Inherited
This function checks if the value exist
and sets the value of this object.
| inherited_from |
\Formaid_FieldInputAbstract::readSqlValue() |
| inherited_from |
\Formaid_FieldInput::readSqlValue() |
Parameters
$sql_row
arrayrow from sql_result
Resets current value
resetValue() : void
Inherited
| inherited_from |
\Formaid_Property::resetValue() |
| inherited_from |
\Formaid_FieldInputAbstract::resetValue() |
| inherited_from |
\Formaid_FieldInput::resetValue() |
Sets current value to default
setDefault(string $value) : void
Inherited
When the parameter is set,
the default value is changed to the new default value.
Then the current value is set to the (new) default value.
| inherited_from |
\Formaid_Property::setDefault() |
| inherited_from |
\Formaid_FieldInputAbstract::setDefault() |
| inherited_from |
\Formaid_FieldInput::setDefault() |
Parameters
$value
stringNew default value
Sets new name for the object
setName(string $new_name) : void
Inherited
| inherited_from |
\Formaid_Object::setName() |
| inherited_from |
\Formaid_Property::setName() |
| inherited_from |
\Formaid_FieldInputAbstract::setName() |
| inherited_from |
\Formaid_FieldInput::setName() |
Parameters
Set field value
setValue(string $value) : void
Inherited
| inherited_from |
\Formaid_FieldInputAbstract::setValue() |
| inherited_from |
\Formaid_FieldInput::setValue() |
Parameters
Show object
show() : void
Inherited
The name of the object is printed to stdout.
| inherited_from |
\Formaid_Object::show() |
| inherited_from |
\Formaid_Property::show() |
| inherited_from |
\Formaid_FieldInputAbstract::show() |
| inherited_from |
\Formaid_FieldInput::show() |
Validates value of the object.
validateValue() : bool
| todo |
move this to a value conversion/formatting method |
Returns
booltrue if value is valid.
Returns name formatted for displaying
getDisplayName() : string
Inherited
| inherited_from |
\Formaid_Object::getDisplayName() |
| inherited_from |
\Formaid_Property::getDisplayName() |
| inherited_from |
\Formaid_FieldInputAbstract::getDisplayName() |
| inherited_from |
\Formaid_FieldInput::getDisplayName() |
Returns
stringformatted object name
Returns value formatted for displaying
getDisplayValue() : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Property::getDisplayValue() |
| inherited_from |
\Formaid_FieldInputAbstract::getDisplayValue() |
| inherited_from |
\Formaid_FieldInput::getDisplayValue() |
Returns
stringformatted object value
Updates the value of the input field status
_updateStatus() : void
Inherited
When the input field is disabled, Privilege allow_change is false,
the status is set to disabled.
In all other cases, the status is set to default (= active).
| access |
private |
| inherited_from |
\Formaid_FieldInputAbstract::_updateStatus() |
| inherited_from |
\Formaid_FieldInput::_updateStatus() |
Properties
$auto_update : bool
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$auto_update |
| inherited_from |
\Formaid_FieldInput::$$auto_update |
$field_type : string
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInput::$$field_type |
$layout_class : string
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$layout_class |
| inherited_from |
\Formaid_FieldInput::$$layout_class |
$privileges : array
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$privileges |
| inherited_from |
\Formaid_FieldInput::$$privileges |
$properties : array
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$properties |
| inherited_from |
\Formaid_FieldInput::$$properties |
$size : integer
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInput::$$size |
$title : string
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$title |
| inherited_from |
\Formaid_FieldInput::$$title |
$urlReturnParamEnable : bool
Inherited
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$urlReturnParamEnable |
| inherited_from |
\Formaid_FieldInput::$$urlReturnParamEnable |
$urlReturnParamName : string
Inherited
Default is the field name.
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$urlReturnParamName |
| inherited_from |
\Formaid_FieldInput::$$urlReturnParamName |
$current_value : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Property::$$current_value |
| inherited_from |
\Formaid_FieldInputAbstract::$$current_value |
| inherited_from |
\Formaid_FieldInput::$$current_value |
$default_value : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Property::$$default_value |
| inherited_from |
\Formaid_FieldInputAbstract::$$default_value |
| inherited_from |
\Formaid_FieldInput::$$default_value |
$displaySeparator : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Property::$$displaySeparator |
| inherited_from |
\Formaid_FieldInputAbstract::$$displaySeparator |
| inherited_from |
\Formaid_FieldInput::$$displaySeparator |
$encoding : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Object::$$encoding |
| inherited_from |
\Formaid_Property::$$encoding |
| inherited_from |
\Formaid_FieldInputAbstract::$$encoding |
| inherited_from |
\Formaid_FieldInput::$$encoding |
$name : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Object::$$name |
| inherited_from |
\Formaid_Property::$$name |
| inherited_from |
\Formaid_FieldInputAbstract::$$name |
| inherited_from |
\Formaid_FieldInput::$$name |
$status : string
Inherited
Used to transfer the
status when submitting a form.
| access |
public |
| inherited_from |
\Formaid_FieldInputAbstract::$$status |
| inherited_from |
\Formaid_FieldInput::$$status |
$_trimName : bool
Inherited
| access |
private |
| inherited_from |
\Formaid_Object::$$_trimName |
| inherited_from |
\Formaid_Property::$$_trimName |
| inherited_from |
\Formaid_FieldInputAbstract::$$_trimName |
| inherited_from |
\Formaid_FieldInput::$$_trimName |