FoRMAiD
Back to top  

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/

 Methods

Constructor, initialises an instance of Formaid_PropertyString class

__construct(string $property_name, string $current_value, string $default_value) : void

Defines current value and default value.

Parameters

$property_name

string

Property name

$current_value

string

Current value

$default_value

string

Default value

Disables trimming whitespace of object name

disableTrimName() : void
Inherited
inherited_from \Formaid_Object::disableTrimName()
inherited_from \Formaid_Property::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()

Enables trimming whitespace of object name

enableTrimName() : void
Inherited
inherited_from \Formaid_Object::enableTrimName()
inherited_from \Formaid_Property::enableTrimName()

Get display seperator

getDisplaySeparator() : string
Inherited
inherited_from \Formaid_Property::getDisplaySeparator()

Returns

stringString separating columns

return Display string

getDisplayString(bool $withValue, bool $discardEmptyValue) : string
Inherited
access public
inherited_from \Formaid_Property::getDisplayString()

Parameters

$withValue

bool

append value to column (optional, default : true)

$discardEmptyValue

bool

discard columns with empty values (optional, default : false)

Returns

stringformatted object string

Returns name of the object

getName() : string
Inherited
inherited_from \Formaid_Object::getName()
inherited_from \Formaid_Property::getName()

Returns

stringobject name

Returns current value

getValue() : string
Inherited
inherited_from \Formaid_Property::getValue()

Returns

stringcurrent value

Checks if current value is empty

isEmpty() : bool
Inherited
inherited_from \Formaid_Property::isEmpty()

Returns

booltrue if empty

Checks if object name is empty

isNameEmpty() : bool
Inherited
inherited_from \Formaid_Object::isNameEmpty()
inherited_from \Formaid_Property::isNameEmpty()

Returns

booltrue if empty

Resets current value

resetValue() : void
Inherited

Empty current value

inherited_from \Formaid_Property::resetValue()

Sets current value to default

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.

Parameters

$value

string

New default value

Sets new name for the object

setName(string $new_name) : void
Inherited
inherited_from \Formaid_Object::setName()
inherited_from \Formaid_Property::setName()

Parameters

$new_name

string

new name

Sets current value to new value

setValue(string $new_value) : void

The value is cast to string.

Parameters

$new_value

string

New value

Show object

show() : void
Inherited

The name of the object is printed to stdout.

inherited_from \Formaid_Object::show()
inherited_from \Formaid_Property::show()

 Properties