Property class, value is a string
It is derived from the basic property class. It has a value and a default value of the string type. It provides functionality to handle the value : - Set current value to a new value - Reset current value (make empty) - Set current value to default - Get value (read out) - Check if value is empty
category | Core |
---|---|
package | Formaid |
author | Dieter Adriaenssens |
copyright | 2006-2013 Dieter Adriaenssens |
license | GPL |
link | http://formaid.sourceforge.net/ |
__construct(string $property_name, string $current_value, string $default_value) : void
Defines current value and default value.
string
Property name
string
Current value
string
Default value
disableTrimName() : void
inherited_from | \Formaid_Object::disableTrimName() |
---|---|
inherited_from | \Formaid_Property::disableTrimName() |
display() : void
The name of the object is printed to stdout.
inherited_from | \Formaid_Object::display() |
---|---|
inherited_from | \Formaid_Property::display() |
enableTrimName() : void
inherited_from | \Formaid_Object::enableTrimName() |
---|---|
inherited_from | \Formaid_Property::enableTrimName() |
getDisplaySeparator() : string
inherited_from | \Formaid_Property::getDisplaySeparator() |
---|
string
String separating columnsgetDisplayString(bool $withValue, bool $discardEmptyValue) : string
access | public |
---|---|
inherited_from | \Formaid_Property::getDisplayString() |
bool
append value to column (optional, default : true)
bool
discard columns with empty values (optional, default : false)
string
formatted object stringgetName() : string
inherited_from | \Formaid_Object::getName() |
---|---|
inherited_from | \Formaid_Property::getName() |
string
object namegetValue() : string
inherited_from | \Formaid_Property::getValue() |
---|
string
current valueisEmpty() : bool
inherited_from | \Formaid_Property::isEmpty() |
---|
bool
true if emptyisNameEmpty() : bool
inherited_from | \Formaid_Object::isNameEmpty() |
---|---|
inherited_from | \Formaid_Property::isNameEmpty() |
bool
true if emptyresetValue() : void
Empty current value
inherited_from | \Formaid_Property::resetValue() |
---|
setDefault(string $value) : void
The value is cast to string. 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.
string
New default value
setName(string $new_name) : void
inherited_from | \Formaid_Object::setName() |
---|---|
inherited_from | \Formaid_Property::setName() |
string
new name
setValue(string $new_value) : void
The value is cast to string.
string
New value
show() : void
The name of the object is printed to stdout.
inherited_from | \Formaid_Object::show() |
---|---|
inherited_from | \Formaid_Property::show() |