Properties class, a collection of property instances.
It provides some functionality to handle the collection of instances : - Add a new instance - Remove an instance - Get an instance name - Set a new name to an instance - Reset current values of all instances And it calls methods of the instances : - Set current value to a new value - Reset current value (make empty) - Set current value to default - Get value (return value) - Check if value is empty - Show value
| category | Core |
|---|---|
| package | Formaid |
| author | Dieter Adriaenssens |
| copyright | 2006-2013 Dieter Adriaenssens |
| license | GPL |
| link | http://formaid.sourceforge.net/ |
__construct() : void
add(object $obj, string $type, string $current_value, string $default_value) : void
If the object is of the property class, add it to the collection. If the object is not a class, create a new Formaid_Property instance, of the type provided by parameter type and set current value and default value.
objectProperty instance or name of new Formaid_Property
stringProperty type
stringCurrent value
stringDefault value
display() : void
| inherited_from | \Formaid_Collection::display() |
|---|
getDisplayListSeparator() : string
| inherited_from | \Formaid_Collection::getDisplayListSeparator() |
|---|
stringString separating columnsgetDisplayPrefix() : string
| inherited_from | \Formaid_Collection::getDisplayPrefix() |
|---|
stringPrefix string when displaying collection itemsgetDisplayString() : string
A displaystring is generated from all objects in the collection, all empty strings are removed and the remaining ones are chained together with the listSeparator.
| inherited_from | \Formaid_Collection::getDisplayString() |
|---|
stringgetDisplaySuffix() : string
| inherited_from | \Formaid_Collection::getDisplaySuffix() |
|---|
stringSuffix string when displaying collection itemsgetName(string $name) : string
| inherited_from | \Formaid_Collection::getName() |
|---|
stringobject name
stringobject namegetNames() : array
| inherited_from | \Formaid_Collection::getNames() |
|---|
arrayobject namesgetObject(string $name) : object
| inherited_from | \Formaid_Collection::getObject() |
|---|
stringobject name
objectgetObjects() : array
| inherited_from | \Formaid_Collection::getObjects() |
|---|
arrayobjectsgetValue(string $name) : string
stringproperty name
stringreturns current value of propertyisEmpty(string $name) : bool
stringproperty name
booltrue if emptyisNameEmpty(string $name) : bool
| inherited_from | \Formaid_Collection::isNameEmpty() |
|---|
stringobject name
booltrue if emptynumItems() : int
| inherited_from | \Formaid_Collection::numItems() |
|---|
intnumber of objects in collectionremove(string $name) : void
| inherited_from | \Formaid_Collection::remove() |
|---|
stringobject name
resetAll() : void
resetValue(string $name) : void
stringproperty name
setDefault(string $name, string $value) : void
stringproperty name
stringnew default value
setDisplayAffixes(string $prefix, string $suffix) : void
| inherited_from | \Formaid_Collection::setDisplayAffixes() |
|---|
stringprefix string when displaying collection items
stringsuffix string when displaying collection items
setDisplayListSeparator(string $separator) : void
| inherited_from | \Formaid_Collection::setDisplayListSeparator() |
|---|
stringstring separating columns
setDisplayPrefix(string $prefix) : void
| inherited_from | \Formaid_Collection::setDisplayPrefix() |
|---|
stringprefix string when displaying collection items
setDisplaySuffix(string $suffix) : void
| inherited_from | \Formaid_Collection::setDisplaySuffix() |
|---|
stringsuffix string when displaying collection items
setName(string $name, string $new_name) : void
| inherited_from | \Formaid_Collection::setName() |
|---|
stringobject name
stringnew name
setValue(string $name, string $new_value) : void
stringproperty name
stringnew value
show() : void
The show method of every object is called. These functions print the object (name, value, ...) to stdout.
| inherited_from | \Formaid_Collection::show() |
|---|
addDisplayAffixes(string $displayString) : string
The pre- and suffix should only be displayed when at least one item is displayed.
| inherited_from | \Formaid_Collection::addDisplayAffixes() |
|---|
stringString with collection items to be displayed
stringString with added affixescallbackDisplayString(object $object) : string
It calls the getDisplayString() method of the instance
| static | |
|---|---|
| inherited_from | \Formaid_Collection::callbackDisplayString() |
objectInstance to apply the method to
stringDisplaystring of object$collection : array
| access | protected |
|---|---|
| inherited_from | \Formaid_Collection::$$collection |
$_displayListSeparator : string
| access | private |
|---|---|
| inherited_from | \Formaid_Collection::$$_displayListSeparator |
$_displayPrefix : string
| access | private |
|---|---|
| inherited_from | \Formaid_Collection::$$_displayPrefix |
$_displaySuffix : string
| access | private |
|---|---|
| inherited_from | \Formaid_Collection::$$_displaySuffix |