Url Parameter Collection class
This class is a collection of Formaid_UrlParameter instances. It extends a Formaid_Properties class.
| category | Core |
|---|---|
| package | Formaid |
| author | Dieter Adriaenssens |
| copyright | 2006-2013 Dieter Adriaenssens |
| license | GPL |
| link | http://formaid.sourceforge.net/ |
__construct() : void
| access | public |
|---|
add(object $obj, string $ParamValue) : void
If the object is of the UrlParameter class, add it to the collection. If the object is not a class, create a new Formaid_UrlParameter instance, and set value.
objectUrlParameter instance or name
stringParameter value
addArray(array $params) : void
Creates UrlParameter instances from the values and names in a key-value pair array, and add them to the collection.
arrayarray with Urlparameter names and values, or objects
display() : void
| inherited_from | \Formaid_Collection::display() |
|---|---|
| inherited_from | \Formaid_Properties::display() |
getDisplayListSeparator() : string
| inherited_from | \Formaid_Collection::getDisplayListSeparator() |
|---|---|
| inherited_from | \Formaid_Properties::getDisplayListSeparator() |
stringString separating columnsgetDisplayPrefix() : string
| inherited_from | \Formaid_Collection::getDisplayPrefix() |
|---|---|
| inherited_from | \Formaid_Properties::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() |
|---|---|
| inherited_from | \Formaid_Properties::getDisplayString() |
stringgetDisplaySuffix() : string
| inherited_from | \Formaid_Collection::getDisplaySuffix() |
|---|---|
| inherited_from | \Formaid_Properties::getDisplaySuffix() |
stringSuffix string when displaying collection itemsgetName(string $name) : string
| inherited_from | \Formaid_Collection::getName() |
|---|---|
| inherited_from | \Formaid_Properties::getName() |
stringobject name
stringobject namegetNames() : array
| inherited_from | \Formaid_Collection::getNames() |
|---|---|
| inherited_from | \Formaid_Properties::getNames() |
arrayobject namesgetObject(string $name) : object
| inherited_from | \Formaid_Collection::getObject() |
|---|---|
| inherited_from | \Formaid_Properties::getObject() |
stringobject name
objectgetObjects() : array
| inherited_from | \Formaid_Collection::getObjects() |
|---|---|
| inherited_from | \Formaid_Properties::getObjects() |
arrayobjectsgetValue(string $name) : string
| inherited_from | \Formaid_Properties::getValue() |
|---|
stringproperty name
stringreturns current value of propertyisEmpty(string $name) : bool
| inherited_from | \Formaid_Properties::isEmpty() |
|---|
stringproperty name
booltrue if emptyisNameEmpty(string $name) : bool
| inherited_from | \Formaid_Collection::isNameEmpty() |
|---|---|
| inherited_from | \Formaid_Properties::isNameEmpty() |
stringobject name
booltrue if emptynumItems() : int
| inherited_from | \Formaid_Collection::numItems() |
|---|---|
| inherited_from | \Formaid_Properties::numItems() |
intnumber of objects in collectionremove(string $name) : void
| inherited_from | \Formaid_Collection::remove() |
|---|---|
| inherited_from | \Formaid_Properties::remove() |
stringobject name
resetAll() : void
| inherited_from | \Formaid_Properties::resetAll() |
|---|
resetValue(string $name) : void
| inherited_from | \Formaid_Properties::resetValue() |
|---|
stringproperty name
setDefault(string $name, string $value) : void
| inherited_from | \Formaid_Properties::setDefault() |
|---|
stringproperty name
stringnew default value
setDisplayAffixes(string $prefix, string $suffix) : void
| inherited_from | \Formaid_Collection::setDisplayAffixes() |
|---|---|
| inherited_from | \Formaid_Properties::setDisplayAffixes() |
stringprefix string when displaying collection items
stringsuffix string when displaying collection items
setDisplayListSeparator(string $separator) : void
| inherited_from | \Formaid_Collection::setDisplayListSeparator() |
|---|---|
| inherited_from | \Formaid_Properties::setDisplayListSeparator() |
stringstring separating columns
setDisplayPrefix(string $prefix) : void
| inherited_from | \Formaid_Collection::setDisplayPrefix() |
|---|---|
| inherited_from | \Formaid_Properties::setDisplayPrefix() |
stringprefix string when displaying collection items
setDisplaySuffix(string $suffix) : void
| inherited_from | \Formaid_Collection::setDisplaySuffix() |
|---|---|
| inherited_from | \Formaid_Properties::setDisplaySuffix() |
stringsuffix string when displaying collection items
setName(string $name, string $new_name) : void
| inherited_from | \Formaid_Collection::setName() |
|---|---|
| inherited_from | \Formaid_Properties::setName() |
stringobject name
stringnew name
setValue(string $name, string $new_value) : void
| inherited_from | \Formaid_Properties::setValue() |
|---|
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() |
|---|---|
| inherited_from | \Formaid_Properties::show() |