Class: pnFormCheckbox

Source Location: /system/pnForm/plugins/function.pnformcheckbox.php

Class Overview

pnFormPlugin
   |
   --pnFormStyledPlugin
      |
      --pnFormCheckbox

Check box plugin

Variables

Methods

Inherited Variables

Class: pnFormStyledPlugin

pnFormStyledPlugin::$styleAttributes

Class: pnFormPlugin

pnFormPlugin::$attributes
pnFormPlugin::$blockBeginOutput
pnFormPlugin::$id
pnFormPlugin::$onDataBound
pnFormPlugin::$parentPlugin
pnFormPlugin::$plugins
pnFormPlugin::$visible
pnFormPlugin::$volatile

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 22]
Check box plugin

Plugin to generate a checkbox for true/false selection.

[ Top ]

Class Variables

$checked =

[line 30]

Checked value

Set to true when checkbox is checked, false otherwise.

Type:

bool

[ Top ]

$dataBased =

[line 50]

Enable or disable use of $dataField

Type:

bool

[ Top ]

$dataField =

[line 44]

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. Defaults to the ID of the plugin. See also tutorials on the Zikula site.

Type:

string

[ Top ]

$group =

[line 61]

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:

see:	pnFormRender::pnFormIsValid()
see:	pnFormRender::pnFormGetValues()

Type:

string

[ Top ]

$inputName =

[line 67]

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

Type:

string

[ Top ]

$readOnly =

[line 35]

Enable or disable read only mode

Type:

mixed

[ Top ]

Class Methods

method create [line 76]

void create(

&$render, 
$params)

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

Parameters:

	&$render
	$params

[ Top ]

method decode [line 138]

void decode(

&$render)

Overrides pnFormPlugin::decode() (Decode event handler)

Parameters:

&$render

[ Top ]

method getFilename [line 70]

void getFilename(
)

[ Top ]

method load [line 91]

void load(

&$render, 
&$params)

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

Parameters:

	&$render
	&$params

[ Top ]

method loadValue [line 97]

void loadValue(

&$render, 
&$values)

Parameters:

	&$render
	&$values

[ Top ]

method render [line 122]

void render(

&$render)

Overrides pnFormPlugin::render() (Render event handler)

Parameters:

&$render

[ Top ]

method saveValue [line 146]

void saveValue(

&$render, 
&$data)

Parameters:

	&$render
	&$data

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:45:43 +0200 by phpDocumentor 1.4.1