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

Class: pnFormCategorySelector

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

Class Overview

pnFormPlugin
   |
   --pnFormStyledPlugin
      |
      --pnFormBaseListSelector
         |
         --pnFormDropdownList
            |
            --pnFormCategorySelector

Category selector


Author(s):

Version:

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

Copyright:

  • (c) 2007, Zikula Development Team

Variables

Methods


Inherited Variables

Inherited Methods

Class: pnFormDropdownList

pnFormDropdownList::create()
pnFormDropdownList::decode()
pnFormDropdownList::getFilename()
pnFormDropdownList::getSelectedIndex()
pnFormDropdownList::getSelectedValue()
pnFormDropdownList::load()
pnFormDropdownList::raisePostBackEvent()
pnFormDropdownList::render()
pnFormDropdownList::setSelectedIndex()
pnFormDropdownList::setSelectedValue()
pnFormDropdownList::validate()

Class: pnFormBaseListSelector

pnFormBaseListSelector::addItem()
pnFormBaseListSelector::clearValidation()
pnFormBaseListSelector::create()
pnFormBaseListSelector::getFilename()
pnFormBaseListSelector::getSelectedValue()
pnFormBaseListSelector::initialize()
pnFormBaseListSelector::load()
pnFormBaseListSelector::loadValue()
pnFormBaseListSelector::saveValue()
pnFormBaseListSelector::setError()
pnFormBaseListSelector::setItems()
pnFormBaseListSelector::setSelectedValue()

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 28]
Category selector

This plugin creates a category selector using a dropdown list. The selected value of the base dropdown list will be set to ID of the selected category.




Tags:

version:  $Id: pnversion.php 19260 2006-06-12 13:08:15Z markwest $
copyright:  (c) 2007, Zikula Development Team


[ Top ]


Class Variables

$category =

[line 31]


Type:   mixed


[ Top ]

$editLink =

[line 30]


Type:   mixed


[ Top ]

$enableDBUtil =

[line 54]

Enable save/load of values in separate __CATEGORIES_ field for use in DBUtil.

If enabled then selected category is returned in a sub-array named __CATEGORIES__ such that it can be used directly with DBUtils standard categorization of data items. Example code:

  1.  // Template: <!--[pnformcategoryselector id=myCat category=xxx enableDBUtil=1]-->
  2.  // Result:
  3.  array('title' => 'Item title',
  4.        '__CATEGORIES__' => array('myCat' => zzz)
  5.       )




Tags:

var:  (default false)

Type:   bool


[ Top ]

$includeEmptyElement =

[line 37]

Enable inclusion of an empty null value element



Tags:

var:  (default false)

Type:   bool


[ Top ]



Class Methods


method getFilename [line 57]

void getFilename( )



Overrides pnFormDropdownList::getFilename() (parent method not documented)

[ Top ]

method load [line 129]

void load( &$render, $params)



Overrides pnFormDropdownList::load() (parent method not documented)

Parameters:

   &$render  
   $params  

[ Top ]

method loadParameters [line 64]

void loadParameters( &$list, $includeEmptyElement, $params)



Parameters:

   &$list  
   $includeEmptyElement  
   $params  

[ Top ]

method loadValue [line 172]

void loadValue( &$render, &$values)



Overrides pnFormBaseListSelector::loadValue() (parent method not documented)

Parameters:

   &$render  
   &$values  

[ Top ]

method render [line 137]

void render( &$render)



Overrides pnFormDropdownList::render() (parent method not documented)

Parameters:

   &$render  

[ Top ]

method saveValue [line 152]

void saveValue( &$render, &$data)



Overrides pnFormBaseListSelector::saveValue() (parent method not documented)

Parameters:

   &$render  
   &$data  

[ Top ]


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