FoRMAiD » \Formaid

» Private
- ```
$_trimName
```

Web string

It is derived from Formaid_PropertyString 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 - property to indicate if string is HTML escaped

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_Webstring class

__construct(string $property_name, string $current_value, string $default_value, bool $escaped, bool $defaultEscaped) : void

Defines current value and default value.

Parameters

$property_name

string

Property name

$current_value

string

Current value

$default_value

string

Default value

$escaped

bool

String is HTML escaped

$defaultEscaped

bool

Default string is HTML escaped

Disables trimming whitespace of object name

disableTrimName() : void

Inherited

inherited_from	\Formaid_Object::disableTrimName()
inherited_from	\Formaid_Property::disableTrimName()
inherited_from	\Formaid_PropertyString::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_PropertyString::display()

Enables trimming whitespace of object name

enableTrimName() : void

Inherited

inherited_from	\Formaid_Object::enableTrimName()
inherited_from	\Formaid_Property::enableTrimName()
inherited_from	\Formaid_PropertyString::enableTrimName()

Get display seperator

getDisplaySeparator() : string

Inherited

inherited_from	\Formaid_Property::getDisplaySeparator()
inherited_from	\Formaid_PropertyString::getDisplaySeparator()

Returns

stringString separating columns

return Display string

getDisplayString(bool $withValue, bool $discardEmptyValue) : string

Inherited

access	public
inherited_from	\Formaid_Property::getDisplayString()
inherited_from	\Formaid_PropertyString::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 value formatted for displaying

getDisplayValue(bool $escape) : string

access	public

Parameters

$escape

bool

if the returned string should be escaped

Returns

stringformatted object value

Returns name of the object

getName() : string

Inherited

inherited_from	\Formaid_Object::getName()
inherited_from	\Formaid_Property::getName()
inherited_from	\Formaid_PropertyString::getName()

Returns

stringobject name

Returns current value

getValue() : string

Inherited

inherited_from	\Formaid_Property::getValue()
inherited_from	\Formaid_PropertyString::getValue()

Returns

stringcurrent value

Checks if current value is empty

isEmpty() : bool

Inherited

inherited_from	\Formaid_Property::isEmpty()
inherited_from	\Formaid_PropertyString::isEmpty()

Returns

booltrue if empty

Checks if object name is empty

isNameEmpty() : bool

Inherited

inherited_from	\Formaid_Object::isNameEmpty()
inherited_from	\Formaid_Property::isNameEmpty()
inherited_from	\Formaid_PropertyString::isNameEmpty()

Returns

booltrue if empty

Resets current value

resetValue() : void

Inherited

Empty current value

inherited_from	\Formaid_Property::resetValue()
inherited_from	\Formaid_PropertyString::resetValue()

Sets current value to default

setDefault(string $value, bool $escaped) : 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

$escaped

bool

String is HTML escaped

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_PropertyString::setName()

Parameters

$new_name

string

new name

Sets current value to new value

setValue(string $new_value, bool $escaped) : void

The value is cast to string.

Parameters

$new_value

string

New value

$escaped

bool

String is HTML escaped

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_PropertyString::show()

Returns name formatted for displaying

getDisplayName() : string

Inherited

inherited_from	\Formaid_Object::getDisplayName()
inherited_from	\Formaid_Property::getDisplayName()
inherited_from	\Formaid_PropertyString::getDisplayName()

Returns

stringformatted object name

Properties

$defaultEscaped

$var object Formaid_PropertyBool $access public

$escaped

$var object Formaid_PropertyBool $access public

$current_value : string

Inherited

access	protected
inherited_from	\Formaid_Property::$$current_value
inherited_from	\Formaid_PropertyString::$$current_value

$default_value : string

Inherited

access	protected
inherited_from	\Formaid_Property::$$default_value
inherited_from	\Formaid_PropertyString::$$default_value

$displaySeparator : string

Inherited

access	protected
inherited_from	\Formaid_Property::$$displaySeparator
inherited_from	\Formaid_PropertyString::$$displaySeparator

$encoding : string

Inherited

access	protected
inherited_from	\Formaid_Object::$$encoding
inherited_from	\Formaid_Property::$$encoding
inherited_from	\Formaid_PropertyString::$$encoding

$name : string

Inherited

access	protected
inherited_from	\Formaid_Object::$$name
inherited_from	\Formaid_Property::$$name
inherited_from	\Formaid_PropertyString::$$name

$_trimName : bool

Inherited

access	private
inherited_from	\Formaid_Object::$$_trimName
inherited_from	\Formaid_Property::$$_trimName
inherited_from	\Formaid_PropertyString::$$_trimName