lists
[ class tree: lists ] [ index: lists ] [ all elements ]

Class: lamListOption

Source Location: /lib/lists.inc

Class Overview


Represents a list configuration option.


Author(s):

  • Roland Gruber

Methods


Child classes:

lamBooleanListOption
Boolean option for list configuration.
lamSelectListOption
Boolean option for list configuration.

Class Details

[line 998]
Represents a list configuration option.



Tags:

author:  Roland Gruber
abstract:  


[ Top ]


Class Methods


constructor __construct [line 1010]

lamConfigOption __construct( String $ID)

Creates a new config option.



Tags:

return:  config option
access:  public


Overridden in child classes as:

lamBooleanListOption::__construct()
Creates a new boolean option.
lamSelectListOption::__construct()
Creates a new selection list option.

Parameters:

String   $ID   unique ID

[ Top ]

method fillFromPostData [line 1028]

array fillFromPostData( )

Fills the config option from POST data.



Tags:

return:  list of StatusMessages (array(<type>, <head line>, <body>))
abstract:  
access:  public


Overridden in child classes as:

lamBooleanListOption::fillFromPostData()
Fills the config option from POST data.
lamSelectListOption::fillFromPostData()
Fills the config option from POST data.

[ Top ]

method getID [line 1019]

String getID( )

Returns the option ID.



Tags:

return:  ID
access:  public


[ Top ]

method getMetaHTML [line 1056]

array getMetaHTML( )

Returns the meta HTML data to display this option.



Tags:

return:  meta HTML
abstract:  
access:  public


Overridden in child classes as:

lamBooleanListOption::getMetaHTML()
Returns the meta HTML data to display this option.
lamSelectListOption::getMetaHTML()
Returns the meta HTML data to display this option.

[ Top ]

method getValue [line 1035]

String getValue( )

Returns the option value. The value must not contain "=" and ";".



Tags:

return:  value
access:  public


[ Top ]

method setValue [line 1044]

void setValue( String $value)

Sets the config option value. The value must not contain "=" and ";".



Tags:

access:  public


Parameters:

String   $value  

[ Top ]


Documentation generated on Sun, 06 Jan 2008 18:59:14 +0100 by phpDocumentor 1.4.0