FoRMAiD » \Formaid_DbColumnList

Database column list

This defines the public methods for adding database columns to a collection and retrieving the columns from the collection as a formatted list

category	Database
package	Formaid
author	Dieter Adriaenssens
copyright	2006-2013 Dieter Adriaenssens
license	GPL
link	http://formaid.sourceforge.net/
todo	implement displayPrefix and displaySuffix in Logic mode

Methods

Constructor

__construct() : void

access	public

Adds a column to a collection

add(\DbColumnInterface $dbColumn) : 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.

Parameters

$dbColumn

\DbColumnInterface

Formaid_DbColumn object

Displays all objects in the collection

display() : void

Inherited

inherited_from	\Formaid_Collection::display()
inherited_from	\Formaid_Properties::display()

Get display seperator

getDisplayListSeparator() : string

Returns

stringString separating columns

Get display mode

getDisplayMode() : string

Returns

stringdisplay mode

Get display prefix

getDisplayPrefix() : string

Inherited

inherited_from	\Formaid_Collection::getDisplayPrefix()
inherited_from	\Formaid_Properties::getDisplayPrefix()

Returns

stringPrefix string when displaying collection items

Get formatted Database column list

getDisplayString(bool $withValue, bool $discardEmptyValue) : 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.

todo	make withValue and discardEmptyValue properties of the class
todo	implement setDisplaymode on collection level
todo	inherit from Collection::getDisplayString (relies on two other todo's)

Parameters

$withValue

bool

append value to column (optional, default : true)

$discardEmptyValue

bool

discard columns with empty values (optional, default : false)

Returns

string

Get display suffix

getDisplaySuffix() : string

Inherited

inherited_from	\Formaid_Collection::getDisplaySuffix()
inherited_from	\Formaid_Properties::getDisplaySuffix()

Returns

stringSuffix string when displaying collection items

Returns name of the object

getName(string $name) : string

Inherited

inherited_from	\Formaid_Collection::getName()
inherited_from	\Formaid_Properties::getName()

Parameters

$name

string

object name

Returns

stringobject name

Returns names of all objects in collection

getNames() : array

Inherited

inherited_from	\Formaid_Collection::getNames()
inherited_from	\Formaid_Properties::getNames()

Returns

arrayobject names

Returns object

getObject(string $name) : object

Inherited

inherited_from	\Formaid_Collection::getObject()
inherited_from	\Formaid_Properties::getObject()

Parameters

$name

string

object name

Returns

object

Returns all objects in collection

getObjects() : array

Inherited

inherited_from	\Formaid_Collection::getObjects()
inherited_from	\Formaid_Properties::getObjects()

Returns

arrayobjects

Get current value of the selected property

getValue(string $name) : string

Inherited

inherited_from	\Formaid_Properties::getValue()

Parameters

$name

string

property name

Returns

stringreturns current value of property

Checks if current value of the selected property is empty

isEmpty(string $name) : bool

Inherited

inherited_from	\Formaid_Properties::isEmpty()

Parameters

$name

string

property name

Returns

booltrue if empty

Checks if name of the selected object is empty

isNameEmpty(string $name) : bool

Inherited

inherited_from	\Formaid_Collection::isNameEmpty()
inherited_from	\Formaid_Properties::isNameEmpty()

Parameters

$name

string

object name

Returns

booltrue if empty

Returns number of objects in collection

numItems() : int

Inherited

inherited_from	\Formaid_Collection::numItems()
inherited_from	\Formaid_Properties::numItems()

Returns

intnumber of objects in collection

Removes the object from the collection

remove(string $name) : void

Inherited

inherited_from	\Formaid_Collection::remove()
inherited_from	\Formaid_Properties::remove()

Parameters

$name

string

object name

Resets current values of all property instances in the collection

resetAll() : void

Inherited

inherited_from	\Formaid_Properties::resetAll()

Resets current value of the selected property

resetValue(string $name) : void

Inherited

inherited_from	\Formaid_Properties::resetValue()

Parameters

$name

string

property name

Set current value of the selected property to default

setDefault(string $name, string $value) : void

Inherited

inherited_from	\Formaid_Properties::setDefault()

Parameters

$name

string

property name

$value

string

new default value

Set display pre- and suffix

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

Inherited

inherited_from	\Formaid_Collection::setDisplayAffixes()
inherited_from	\Formaid_Properties::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	\DbColumnListInterface::setDisplayListSeparator()

Parameters

$separator

string

string separating columns

Set display seperator for binary logic mode

setDisplayLogicSeparator(string $separator) : void

Parameters

$separator

string

string separating columns

Set display mode

setDisplayMode(string $mode, string $separator) : void

Parameters

$mode

string

display mode : list, (binary )logic

$separator

string

string separating columns

Set display prefix

setDisplayPrefix(string $prefix) : void

Inherited

inherited_from	\Formaid_Collection::setDisplayPrefix()
inherited_from	\Formaid_Properties::setDisplayPrefix()

Parameters

$prefix

string

prefix string when displaying collection items

Set display suffix

setDisplaySuffix(string $suffix) : void

Inherited

inherited_from	\Formaid_Collection::setDisplaySuffix()
inherited_from	\Formaid_Properties::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()
inherited_from	\Formaid_Properties::setName()

Parameters

$name

string

object name

$new_name

string

new name

Sets current value of the selected property

setValue(string $name, string $new_value) : void

Inherited

inherited_from	\Formaid_Properties::setValue()

Parameters

$name

string

property name

$new_value

string

new value

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()
inherited_from	\Formaid_Properties::show()

Add pre- and suffixes to display string

addDisplayAffixes(string $displayString, int $numItems) : string

The pre- and suffix should only be displayed in binary logic mode and when more than one item will be displayed

Parameters

$displayString

string

String with columns to be displayed

$numItems

int

Number of columns in displayString

Returns

stringString separating columns

Callback method used by getDisplayString()

callbackDisplayString(object $object) : string

InheritedStatic

It calls the getDisplayString() method of the instance

static
inherited_from	\Formaid_Collection::callbackDisplayString()
inherited_from	\Formaid_Properties::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
inherited_from	\Formaid_Properties::$$collection

$_displayListSeparator : string

Inherited

access	private
inherited_from	\Formaid_Collection::$$_displayListSeparator
inherited_from	\Formaid_Properties::$$_displayListSeparator

$_displayLogicSeparator : string

access	private

$_displayMode : string

access	private

$_displayPrefix : string

Inherited

access	private
inherited_from	\Formaid_Collection::$$_displayPrefix
inherited_from	\Formaid_Properties::$$_displayPrefix

$_displaySuffix : string

Inherited

access	private
inherited_from	\Formaid_Collection::$$_displaySuffix
inherited_from	\Formaid_Properties::$$_displaySuffix