This class provides the most basic object :
- it has a name
- and an encoding
Methods
Constructor, initialises an instance of Formaid_Link class
__construct(string $linkName, string $caption, string $url, array $urlParameters, bool $displayLink, bool $displayCaption) : void
Sets encoding to be used, and set name of the object
Parameters
$linkName
stringname of link object
$caption
stringtext to be displayed
$url
stringurl to link to
$urlParameters
arrayArray with UrlParameters (objects or name-value)
$displayLink
boolcreate link or not (optional, default = true)
$displayCaption
boolshow caption or nothing
(optional, default = true)
Disables trimming whitespace of object name
disableTrimName() : void
Inherited
| inherited_from |
\Formaid_Object::disableTrimName() |
Display object
display() : void
Inherited
The name of the object is printed to stdout.
| inherited_from |
\Formaid_Object::display() |
Enables trimming whitespace of object name
enableTrimName() : void
Inherited
| inherited_from |
\Formaid_Object::enableTrimName() |
Gets the caption
getCaption() : string
Get HTML string for link
getDisplayString() : string
Returns name of the object
getName() : string
Inherited
| inherited_from |
\Formaid_Object::getName() |
Returns
stringobject name
Gets the url
getUrl() : string
Checks if object name is empty
isNameEmpty() : bool
Inherited
| inherited_from |
\Formaid_Object::isNameEmpty() |
Returns
booltrue if empty
Sets the caption
setCaption(string $caption) : void
Parameters
$caption
stringLink caption
Sets new name for the object
setName(string $new_name) : void
Inherited
| inherited_from |
\Formaid_Object::setName() |
Parameters
Sets the url
setUrl(\Formaid_Url $url, array $urlParameters) : void
Parameters
$urlParameters
arrayArray with UrlParameters
(objects or name-value)
Show object
show() : void
Inherited
The name of the object is printed to stdout.
| inherited_from |
\Formaid_Object::show() |
Returns name formatted for displaying
getDisplayName() : string
Inherited
| inherited_from |
\Formaid_Object::getDisplayName() |
Returns
stringformatted object name
Properties
$encoding : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Object::$$encoding |
$name : string
Inherited
| access |
protected |
| inherited_from |
\Formaid_Object::$$name |
$_trimName : bool
Inherited
| access |
private |
| inherited_from |
\Formaid_Object::$$_trimName |