Base object, from which other classes derive.

This class provides the most basic object : - it has a name - and an encoding

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 a base object

__construct(string $name) : void

Sets encoding to be used, and set name of the object

Parameters

$name

string

Base object name

Disables trimming whitespace of object name

disableTrimName() : void

Display object

display() : void

The name of the object is printed to stdout.

Enables trimming whitespace of object name

enableTrimName() : void

return Display string

getDisplayString() : string

Returns

stringformatted object string

Returns name of the object

getName() : string

Returns

stringobject name

Checks if object name is empty

isNameEmpty() : bool

Returns

booltrue if empty

Sets new name for the object

setName(string $new_name) : void

Parameters

$new_name

string

new name

Show object

show() : void

The name of the object is printed to stdout.

deprecated use display()

Returns name formatted for displaying

getDisplayName() : string

Returns

stringformatted object name

 Properties

 

$encoding : string
access protected
 

$name : string
access protected
 

$_trimName : bool
access private