File Source for pnformbaselistselector.php

<?php
/**
* Base implementation for checkbox and dropdown list
*
* @copyright (c) 2006, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: function.pnformdropdownlist.php 22138 2007-06-01 10:19:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @author Jorn Wildt
* @package Zikula_System_Modules
* @subpackage pnForm
*/
/**
* Zikula Application Framework
*
* @copyright (c) 2007, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: pnversion.php 19260 2006-06-12 13:08:15Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @package Zikula_System_Modules
* @subpackage pnForm
*/
class pnFormBaseListSelector extends pnFormStyledPlugin
{
/**
* Enable or disable read only mode
* @var bool
*/
var $readOnly;
/**
* CSS class for styling
*/
var $cssClass;
/**
* 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.
* @var string
*/
var $dataField;
/**
* Enable or disable use of $dataField
* @var bool
*/
var $dataBased;
/**
* 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).
* @see pnFormRender::pnFormGetValues()
* @see pnFormRender::pnFormIsValid()
* @var string
*/
var $group;
/**
* 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.
* @var string
*/
var $itemsDataField;
/**
* Validation indicator used by the framework.
*
* The true/false value of this variable indicates whether or not the list selection is valid.
* @var bool
*/
var $isValid = true;
/**
* Enable or disable mandatory check
*
* @var bool
*/
var $mandatory;
/**
* Error message to display when selection does not validate
*
* @var string
*/
var $errorMessage;
/**
* Text label for this plugin
*
* This variable contains the label text for the input. The {@link pnFormLabel} plugin will set
* this text automatically when it is a label for this list.
* @var string
*/
var $myLabel;
/**
* 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') )
*/
var $items = array();
/**
* HTML input name for this plugin. Defaults to the ID of the plugin.
* @var string
*/
var $inputName;
function getFilename()
{
return __FILE__;
}
function create(&$render, $params)
{
$this->inputName = $this->id;
$this->readOnly = (array_key_exists('readOnly', $params) ? $params['readOnly'] : false);
$this->dataBased = (array_key_exists('dataBased', $params) ? $params['dataBased'] : true);
$this->dataField = (array_key_exists('dataField', $params) ? $params['dataField'] : $this->id);
$this->itemsDataField = (isset($params['itemsDataField'])) ? $params['itemsDataField'] : $this->id . 'Items';
$this->isValid = true;
$this->mandatory = (array_key_exists('mandatory', $params) ? $params['mandatory'] : false);
}
function initialize(&$render)
{
$render->pnFormAddValidator($this);
}
function load(&$render, &$params)
{
// The load function expects the plugin to read values from the render.
// This can be done with the loadValue function (which can be called in other situations than
// through the onLoad event).
$this->loadValue($render, $render->get_template_vars());
}
function setError($msg)
{
$this->isValid = false;
$this->errorMessage = $msg;
}
function clearValidation(&$render)
{
$this->isValid = true;
$this->errorMessage = null;
}
function saveValue(&$render, &$data)
{
if ($this->dataBased)
{
if ($this->group == null)
{
$data[$this->dataField] = $this->getSelectedValue();
}
else
{
if (!array_key_exists($this->group, $data))
$data[$this->group] = array();
$data[$this->group][$this->dataField] = $this->getSelectedValue();
}
}
}
// Called internally by the plugin itself to load values from the render.
// Can also by called when some one is calling the render object's pnFormSetValues
function loadValue(&$render, &$values)
{
if ($this->dataBased)
{
$items = null;
$value = null;
if ($this->group == null)
{
if ($this->dataField != null && isset($values[$this->dataField]))
$value = $values[$this->dataField];
if ($this->itemsDataField != null && isset($values[$this->itemsDataField]))
$items = $values[$this->itemsDataField];
}
else
{
if (isset($values[$this->group]))
{
$data = $values[$this->group];
if (isset($data[$this->dataField]))
{
$value = $data[$this->dataField];
if ($this->itemsDataField != null && isset($data[$this->itemsDataField]))
$items = $data[$this->itemsDataField];
}
}
}
if ($items !== null)
$this->setItems($items);
$this->setSelectedValue($value);
}
}
function setSelectedValue($value)
{
// To be implemented by extending class
return true;
}
function getSelectedValue()
{
// To be implemented by extending class
return null;
}
function addItem($text, $value)
{
$item = array('text' => $text, 'value' => $value);
$this->items[] = $item;
}
function setItems($items)
{
// Quicker than copying the items one by one
// If addItem() does som special logic in the future then call that for each element in $items
$this->items = $items;
}
}

Source for file pnformbaselistselector.php