FoRMAiD » \Formaid_LinkCollection

Link Collection class

This class is a collection of Formaid_Link instances. It extends a Formaid_Collection class.

category	Core
package	Formaid
author	Dieter Adriaenssens
copyright	2006-2013 Dieter Adriaenssens
license	GPL
link	http://formaid.sourceforge.net/

Methods

Constructor

__construct() : void

access	public

Adds a new Link instance to the collection

add(object $obj, string $url) : void

If the object is of the Link class, add it to the collection. If the object is not a class, create a new Formaid_Link instance, and set url and caption.

Parameters

$obj

object

Link instance or caption

$url

string

URL

Displays all objects in the collection

display() : void

Inherited

inherited_from	\Formaid_Collection::display()

Get display seperator

getDisplayListSeparator() : string

Inherited

inherited_from	\Formaid_Collection::getDisplayListSeparator()

Returns

stringString separating columns

Get display prefix

getDisplayPrefix() : string

Inherited

inherited_from	\Formaid_Collection::getDisplayPrefix()

Returns

stringPrefix string when displaying collection items

Generate formatted string of all objects

getDisplayString() : string

Inherited

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()

Returns

string

Get display suffix

getDisplaySuffix() : string

Inherited

inherited_from	\Formaid_Collection::getDisplaySuffix()

Returns

stringSuffix string when displaying collection items

Returns name of the object

getName(string $name) : string

Inherited

inherited_from	\Formaid_Collection::getName()

Parameters

$name

string

object name

Returns

stringobject name

Returns names of all objects in collection

getNames() : array

Inherited

inherited_from	\Formaid_Collection::getNames()

Returns

arrayobject names

Returns object

getObject(string $name) : object

Inherited

inherited_from	\Formaid_Collection::getObject()

Parameters

$name

string

object name

Returns

object

Returns all objects in collection

getObjects() : array

Inherited

inherited_from	\Formaid_Collection::getObjects()

Returns

arrayobjects

Checks if name of the selected object is empty

isNameEmpty(string $name) : bool

Inherited

inherited_from	\Formaid_Collection::isNameEmpty()

Parameters

$name

string

object name

Returns

booltrue if empty

Returns number of objects in collection

numItems() : int

Inherited

inherited_from	\Formaid_Collection::numItems()

Returns

intnumber of objects in collection

Removes the object from the collection

remove(string $name) : void

Inherited

inherited_from	\Formaid_Collection::remove()

Parameters

$name

string

object name

Set display pre- and suffix

setDisplayAffixes(string $prefix, string $suffix) : void

Inherited

inherited_from	\Formaid_Collection::setDisplayAffixes()

Parameters

$prefix

string

prefix string when displaying collection items

$suffix

string

suffix string when displaying collection items

Set display seperator for list mode

setDisplayListSeparator(string $separator) : void

Inherited

inherited_from	\Formaid_Collection::setDisplayListSeparator()

Parameters

$separator

string

string separating columns

Set display prefix

setDisplayPrefix(string $prefix) : void

Inherited

inherited_from	\Formaid_Collection::setDisplayPrefix()

Parameters

$prefix

string

prefix string when displaying collection items

Set display suffix

setDisplaySuffix(string $suffix) : void

Inherited

inherited_from	\Formaid_Collection::setDisplaySuffix()

Parameters

$suffix

string

suffix string when displaying collection items

Sets new name for the object

setName(string $name, string $new_name) : void

Inherited

inherited_from	\Formaid_Collection::setName()

Parameters

$name

string

object name

$new_name

string

new name

Show all objects in collection

show() : void

Inherited

The show method of every object is called. These functions print the object (name, value, ...) to stdout.

inherited_from	\Formaid_Collection::show()

Add pre- and suffixes to display string

addDisplayAffixes(string $displayString) : string

Inherited

The pre- and suffix should only be displayed when at least one item is displayed.

inherited_from	\Formaid_Collection::addDisplayAffixes()

Parameters

$displayString

string

String with collection items to be displayed

Returns

stringString with added affixes

Callback method used by getDisplayString()

callbackDisplayString(object $object) : string

InheritedStatic

It calls the getDisplayString() method of the instance

static
inherited_from	\Formaid_Collection::callbackDisplayString()

Parameters

$object

object

Instance to apply the method to

Returns

stringDisplaystring of object

Properties

$collection : array

Inherited

access	protected
inherited_from	\Formaid_Collection::$$collection

$_displayListSeparator : string

Inherited

access	private
inherited_from	\Formaid_Collection::$$_displayListSeparator

$_displayPrefix : string

Inherited

access	private
inherited_from	\Formaid_Collection::$$_displayPrefix

$_displaySuffix : string

Inherited

access	private
inherited_from	\Formaid_Collection::$$_displaySuffix