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.
object
UrlParameter instance or name
string
Parameter 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.
array
array 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() |
string
String separating columnsgetDisplayPrefix() : string
inherited_from | \Formaid_Collection::getDisplayPrefix() |
---|---|
inherited_from | \Formaid_Properties::getDisplayPrefix() |
string
Prefix 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() |
string
getDisplaySuffix() : string
inherited_from | \Formaid_Collection::getDisplaySuffix() |
---|---|
inherited_from | \Formaid_Properties::getDisplaySuffix() |
string
Suffix string when displaying collection itemsgetName(string $name) : string
inherited_from | \Formaid_Collection::getName() |
---|---|
inherited_from | \Formaid_Properties::getName() |
string
object name
string
object namegetNames() : array
inherited_from | \Formaid_Collection::getNames() |
---|---|
inherited_from | \Formaid_Properties::getNames() |
array
object namesgetObject(string $name) : object
inherited_from | \Formaid_Collection::getObject() |
---|---|
inherited_from | \Formaid_Properties::getObject() |
string
object name
object
getObjects() : array
inherited_from | \Formaid_Collection::getObjects() |
---|---|
inherited_from | \Formaid_Properties::getObjects() |
array
objectsgetValue(string $name) : string
inherited_from | \Formaid_Properties::getValue() |
---|
string
property name
string
returns current value of propertyisEmpty(string $name) : bool
inherited_from | \Formaid_Properties::isEmpty() |
---|
string
property name
bool
true if emptyisNameEmpty(string $name) : bool
inherited_from | \Formaid_Collection::isNameEmpty() |
---|---|
inherited_from | \Formaid_Properties::isNameEmpty() |
string
object name
bool
true if emptynumItems() : int
inherited_from | \Formaid_Collection::numItems() |
---|---|
inherited_from | \Formaid_Properties::numItems() |
int
number of objects in collectionremove(string $name) : void
inherited_from | \Formaid_Collection::remove() |
---|---|
inherited_from | \Formaid_Properties::remove() |
string
object name
resetAll() : void
inherited_from | \Formaid_Properties::resetAll() |
---|
resetValue(string $name) : void
inherited_from | \Formaid_Properties::resetValue() |
---|
string
property name
setDefault(string $name, string $value) : void
inherited_from | \Formaid_Properties::setDefault() |
---|
string
property name
string
new default value
setDisplayAffixes(string $prefix, string $suffix) : void
inherited_from | \Formaid_Collection::setDisplayAffixes() |
---|---|
inherited_from | \Formaid_Properties::setDisplayAffixes() |
string
prefix string when displaying collection items
string
suffix string when displaying collection items
setDisplayListSeparator(string $separator) : void
inherited_from | \Formaid_Collection::setDisplayListSeparator() |
---|---|
inherited_from | \Formaid_Properties::setDisplayListSeparator() |
string
string separating columns
setDisplayPrefix(string $prefix) : void
inherited_from | \Formaid_Collection::setDisplayPrefix() |
---|---|
inherited_from | \Formaid_Properties::setDisplayPrefix() |
string
prefix string when displaying collection items
setDisplaySuffix(string $suffix) : void
inherited_from | \Formaid_Collection::setDisplaySuffix() |
---|---|
inherited_from | \Formaid_Properties::setDisplaySuffix() |
string
suffix string when displaying collection items
setName(string $name, string $new_name) : void
inherited_from | \Formaid_Collection::setName() |
---|---|
inherited_from | \Formaid_Properties::setName() |
string
object name
string
new name
setValue(string $name, string $new_value) : void
inherited_from | \Formaid_Properties::setValue() |
---|
string
property name
string
new 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() |