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

Class: pnFormBaseListSelector

Source Location: /system/pnForm/plugins/pnformbaselistselector.php

Class Overview

pnFormPlugin
   |
   --pnFormStyledPlugin
      |
      --pnFormBaseListSelector

Zikula Application Framework


Author(s):

Version:

  • $Id: pnversion.php 19260 2006-06-12 13:08:15Z markwest $

Copyright:

  • (c) 2007, Zikula Development Team

Variables

Methods


Child classes:

pnFormCheckboxList
Checkbox list
pnFormDropdownList
Drop down list

Inherited Variables

Inherited Methods

Class: pnFormStyledPlugin

pnFormStyledPlugin::renderAttributes()

Class: pnFormPlugin

pnFormPlugin::pnFormPlugin()
Constructor
pnFormPlugin::create()
Create event handler
pnFormPlugin::dataBound()
DataBound event handler
pnFormPlugin::decode()
Decode event handler
pnFormPlugin::decodePostBackEvent()
Decode event handler for actions that generate a postback event
pnFormPlugin::getIdHtml()
Utility function to generate HTML for ID attribute
pnFormPlugin::initialize()
Initialize event handler
pnFormPlugin::load()
Load event handler
pnFormPlugin::postRender()
PostRender event handler
pnFormPlugin::readParameters()
Read Smarty plugin parameters
pnFormPlugin::registerPlugin()
pnFormPlugin::render()
Render event handler
pnFormPlugin::renderAttributes()
pnFormPlugin::renderBegin()
RenderBegin event handler
pnFormPlugin::renderContent()
RenderContent event handler
pnFormPlugin::renderEnd()
RenderEnd event handler

Class Details

[line 24]
Zikula Application Framework



Tags:

version:  $Id: pnversion.php 19260 2006-06-12 13:08:15Z markwest $
copyright:  (c) 2007, Zikula Development Team
link:  http://www.zikula.org
license:  GNU/GPL


[ Top ]


Class Variables

$cssClass =

[line 35]

CSS class for styling


Type:   mixed


[ Top ]

$dataBased =

[line 51]

Enable or disable use of $dataField


Type:   bool


[ Top ]

$dataField =

[line 45]

Data field name for looking up initial data

The name stored here is used to lookup initial data for the plugin in the render's variables. The value itself depends on the plugin that extends this base class. Defaults to the ID of the plugin. See also tutorials on the Zikula site.



Type:   string


[ Top ]

$errorMessage =

[line 94]

Error message to display when selection does not validate


Type:   string


[ Top ]

$group =

[line 62]

Group name for this input

The group name is used to locate data in the render (when databased) and to restrict which plugins to do validation on (to be implemented).




Tags:


Type:   string


[ Top ]

$inputName =

[line 119]

HTML input name for this plugin. Defaults to the ID of the plugin.


Type:   string


[ Top ]

$isValid =  true

[line 80]

Validation indicator used by the framework.

The true/false value of this variable indicates whether or not the list selection is valid.



Type:   bool


[ Top ]

$items = array()

[line 113]

The list of selectable items

This is an array of arrays like this: array( array('text' => 'A', 'value' => '1'), array('text' => 'B', 'value' => '2'), array('text' => 'C', 'value' => '3') )



Type:   mixed


[ Top ]

$itemsDataField =

[line 72]

Data field name for looking up initial item list

The name stored here is used to lookup initial item list in the render's variables. The value should be an array as described for the $items variable. Defaults to the data field name concatenated with "Items". See also tutorials on the Zikula site.



Type:   string


[ Top ]

$mandatory =

[line 87]

Enable or disable mandatory check


Type:   bool


[ Top ]

$myLabel =

[line 103]

Text label for this plugin

This variable contains the label text for the input. The pnFormLabel plugin will set this text automatically when it is a label for this list.



Type:   string


[ Top ]

$readOnly =

[line 30]

Enable or disable read only mode


Type:   bool


[ Top ]



Class Methods


method addItem [line 242]

void addItem( $text, $value)



Parameters:

   $text  
   $value  

[ Top ]

method clearValidation [line 165]

void clearValidation( &$render)



Overridden in child classes as:

pnFormCheckboxList::clearValidation()

Parameters:

   &$render  

[ Top ]

method create [line 128]

void create( &$render, $params)



Overridden in child classes as:

pnFormCheckboxList::create()
pnFormDropdownList::create()

Overrides pnFormPlugin::create() (Create event handler)

Parameters:

   &$render  
   $params  

[ Top ]

method getFilename [line 122]


method getSelectedValue [line 235]

void getSelectedValue( )



Overridden in child classes as:

pnFormCheckboxList::getSelectedValue()
pnFormDropdownList::getSelectedValue()

[ Top ]

method initialize [line 143]

void initialize( &$render)



Overrides pnFormPlugin::initialize() (Initialize event handler)

Parameters:

   &$render  

[ Top ]

method load [line 149]

void load( &$render, &$params)



Overridden in child classes as:

pnFormCheckboxList::load()
pnFormCategoryCheckboxList::load()
pnFormDropdownList::load()
pnFormCategorySelector::load()
pnFormLanguageSelector::load()

Overrides pnFormPlugin::load() (Load event handler)

Parameters:

   &$render  
   &$params  

[ Top ]

method loadValue [line 192]

void loadValue( &$render, &$values)



Overridden in child classes as:

pnFormCheckboxList::loadValue()
pnFormCategorySelector::loadValue()

Parameters:

   &$render  
   &$values  

[ Top ]

method saveValue [line 172]

void saveValue( &$render, &$data)



Overridden in child classes as:

pnFormCheckboxList::saveValue()
pnFormCategorySelector::saveValue()

Parameters:

   &$render  
   &$data  

[ Top ]

method setError [line 158]

void setError( $msg)



Overridden in child classes as:

pnFormCheckboxList::setError()

Parameters:

   $msg  

[ Top ]

method setItems [line 250]

void setItems( $items)



Parameters:

   $items  

[ Top ]

method setSelectedValue [line 228]

void setSelectedValue( $value)



Overridden in child classes as:

pnFormCheckboxList::setSelectedValue()
pnFormDropdownList::setSelectedValue()

Parameters:

   $value  

[ Top ]


Documentation generated on Fri, 18 Jul 2008 21:52:58 +0200 by phpDocumentor 1.4.1