Class: KTemplateHelperListbox

Source Location: /libraries/koowa/template/helper/listbox.php

Class Overview

KObject
   |
   --KTemplateHelperAbstract
      |
      --KTemplateHelperSelect
         |
         --KTemplateHelperListbox

Template Listbox Helper

Author(s):

Johan Janssens <johan@nooku.org>

Methods

Child classes:

ComDefaultTemplateHelperListbox: Editor Helper

ComDefaultTemplateHelperImage: Editor Helper

Inherited Variables

Class: KTemplateHelperAbstract

KTemplateHelperAbstract::$_template

Class: KObject

KObject::$_mixed_methods
KObject::$__methods
KObject::$__service_container
KObject::$__service_identifier

Inherited Methods

Class: KTemplateHelperSelect

KTemplateHelperSelect::booleanlist(): Generates an HTML boolean radio list
KTemplateHelperSelect::checklist(): Generates an HTML check list
KTemplateHelperSelect::option(): Generates an HTML select option
KTemplateHelperSelect::optionlist(): Generates an HTML select list
KTemplateHelperSelect::radiolist(): Generates an HTML radio list

Class: KTemplateHelperAbstract

KTemplateHelperAbstract::__construct(): Constructor
KTemplateHelperAbstract::getTemplate(): Get the template object

Class: KObject

KObject::__construct(): Constructor
KObject::get(): Get the object properties
KObject::getHandle(): Get a handle for this object
KObject::getIdentifier(): Gets the service identifier.
KObject::getMethods(): Get a list of all the available methods
KObject::getService(): Get an instance of a class based on a class identifier only creating it if it does not exist yet.
KObject::inherits(): Checks if the object or one of it's mixin's inherits from a class.
KObject::mixin(): Mixin an object
KObject::set(): Set the object properties
KObject::_initialize(): Initializes the options for the object
KObject::__call(): Search the mixin method map and call the method or trigger an error
KObject::__clone(): Preform a deep clone of the object.

Class Details

[line 18]
Template Listbox Helper

Tags:

author:

Johan Janssens <johan@nooku.org>

[ Top ]

Class Methods

method _autocomplete [line 120]

string _autocomplete(
[
$config = array()])

Renders a listbox with autocomplete behavior

Tags:

return:	The html output
see:	KTemplateHelperBehavior::autocomplete
access:	protected

Parameters:

$config

[ Top ]

method _listbox [line 68]

string _listbox(
[array
$config = array()])

Generates an HTML optionlist based on the distinct data from a model column.

The column used will be defined by the name -> value => column options in cascading order.

If no 'model' name is specified the model identifier will be created using the helper identifier. The model name will be the pluralised package name.

If no 'value' option is specified the 'name' option will be used instead. If no 'text' option is specified the 'value' option will be used instead.

Tags:

return:	Html
see:	KTemplateHelperListbox::__call()
access:	protected

Parameters:

array

$config

An optional array with configuration options

[ Top ]

method _render [line 36]

string _render(
[array
$config = array()])

Generates an HTML optionlist based on the distinct data from a model column.

The column used will be defined by the name -> value => column options in cascading order.

If no 'model' name is specified the model identifier will be created using the helper identifier. The model name will be the pluralised package name.

If no 'value' option is specified the 'name' option will be used instead. If no 'text' option is specified the 'value' option will be used instead.

Tags:

return:	Html
see:	KTemplateHelperListbox::__call()
access:	protected

Parameters:

array

$config

An optional array with configuration options

[ Top ]

method __call [line 162]

mixed __call(
string
$method, array
$arguments)

Search the mixin method map and call the method or trigger an error

This function check to see if the method exists in the mixing map if not it will call the 'listbox' function. The method name will become the 'name' in the config array.

This can be used to auto-magically create select filters based on the function name.

Tags:

return:	The result of the function
throws:	BadMethodCallException If method could not be found
access:	public

Overrides KObject::__call() (Search the mixin method map and call the method or trigger an error)

Parameters:

string	$method	The function name
array	$arguments	The function arguments

[ Top ]

Documentation generated on Wed, 22 May 2013 03:02:07 +0200 by phpDocumentor 1.4.3