File Source for function.pnformcheckboxlist.php

<?php
/**
* Checkbox list plugin
*
* @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_Template_Plugins
* @subpackage Functions
*/
Loader::requireOnce('system/pnForm/plugins/pnformbaselistselector.php');
/**
* Checkbox list
*
* Renders a list of checkboxes with the supplied items.
* Usefull for selecting multiple items.
*
* You can set the items directly like this:
* <code>
*
* </code>
* with the form event handler code like this:
* <code>
* class mymodule_user_testHandler extends pnFormHandler
* {
* function initialize(&$render)
* {
* $items = array( array('text' => 'A', 'value' => '1'),
* array('text' => 'B', 'value' => '2'),
* array('text' => 'C', 'value' => '3') );
*
* $render->assign('items', $items); // Supply items
* $render->assign('mylist', 2); // Supply selected value
* }
* }
* </code>
* Or you can set them indirectly using the plugin's databased features:
* <code>
*
* </code>
* with the form event handler code like this:
* <code>
* class mymodule_user_testHandler extends pnFormHandler
* {
* function initialize(&$render)
* {
* $items = array( array('text' => 'A', 'value' => '1'),
* array('text' => 'B', 'value' => '2'),
* array('text' => 'C', 'value' => '3') );
*
* $render->assign('mylistItems', $items); // Supply items
* $render->assign('mylist', 2); // Supply selected value
* }
* }
* </code>
*
* The resulting dataset is a list of strings representing the selected
* values. So when you do a $data = $render->pnFormGetValues(); you will
* get a dataset like this:
*
* <code>
* array('xxx' => 'valueXX',
* 'checkboxes' => array('15','17','22','34'),
* 'yyy' => 'valueYYY')
* </code>
*
* @package pnForm
* @subpackage Plugins
*/
class pnFormCheckboxList extends pnFormBaseListSelector
{
/**
* Selected value(s)
*
* The selected value(s) of a checkboxlist is an array of the item values.
* You can assign to this in your templates like:
* <code>
*
* </code>
* But in your code you should use {@link pnFormCheckboxList::setSelectedValue()}
* and {@link pnFormCheckboxList::getSelectedValue()}.
* @var array
*/
var $selectedValue;
/**
* HTML input name for this plugin. Defaults to the ID of the plugin.
* @var string
*/
var $inputName;
/**
* Number of columns to display checkboxes in
* @var int
*/
var $repeatColumns;
/**
* Width of each checkbox list item (combination of checkbox and label).
* @var string Width including CSS unit (for instance "200px")
*/
var $repeatWidth;
/**
* Enable saving of selected values as a colon delimited string
*
* Enable this to save the selected values as a single string instead of
* an array of selected values. The result is a colon separated string
* like ":10:20:30".
* @var bool
*/
var $saveAsString;
function getFilename()
{
return __FILE__;
}
function create(&$render, $params)
{
parent::create($render, $params);
}
function load(&$render, &$params)
{
parent::load($render, $params);
if (array_key_exists('selectedValue', $params))
$this->setSelectedValue($params['selectedValue']);
}
function render(&$render)
{
$readOnlyHtml = ($this->readOnly ? " disabled=\"disabled\"" : '');
$class = '';
if ($this->readOnly) {
$class .= ' readonly';
}
if ($this->cssClass != null) {
$class .= ' ' . $this->cssClass;
}
$classHtml = ($class == '' ? '' : " class=\"$class\"");
$nameHtml = " name=\"{$this->inputName}[]\"";
$selectedByValue = array();
if (is_array($this->selectedValue)) {
foreach ($this->selectedValue as $v)
$selectedByValue[$v] = 1;
}
$result = '<div class="checkboxlist pn-clearfix">';
if ($this->repeatColumns > 0)
$result .= '<table>';
for ($i=0,$count=count($this->items); $i<$count; ++$i)
{
if ($this->repeatColumns > 0 && ($i % $this->repeatColumns) == 0)
$result .= '<tr>';
$item = &$this->items[$i];
$idHtml = " id=\"{$this->id}_$i\"";
$text = DataUtil::formatForDisplay($item['text']);
if ($item['value'] === null)
$value = '#null#';
else
$value = DataUtil::formatForDisplay($item['value']);
if (isset($selectedByValue[$value]) && $selectedByValue[$value])
$selected = ' checked="checked"';
else
$selected = '';
if ($this->repeatColumns > 0)
$result .= '<td>';
if (!empty($this->repeatWidth))
$style = " style=\"width: $this->repeatWidth\"";
else
$style = '';
$result .= "<div class=\"checkboxlistitem\"$style>";
$result .= "<input type=\"checkbox\" value=\"$value\"{$selected}{$idHtml}{$nameHtml}{$readOnlyHtml}{$classHtml}/> ";
$result .= "<label for=\"{$this->id}_$i\">$text</label>\n";
$result .= '</div>';
if ($this->repeatColumns > 0)
$result .= '</td>';
if ($this->repeatColumns > 0 && ($i % $this->repeatColumns) == $this->repeatColumns-1)
$result .= '</tr>';
}
if ($this->repeatColumns > 0 && $i % $this->repeatColumns != 0)
$result .= '</tr>';
if ($this->repeatColumns > 0)
$result .= '</table>';
$result .= '</div>';
return $result;
}
function decode(&$render)
{
// Do not read new value if readonly (evil submiter might have forged it)
// Besides that, a disabled checkbox returns nothing at all, so old values are good to keep
if (!$this->readOnly)
{
$value = FormUtil::getPassedValue($this->inputName, null, 'POST');
if ($value == null)
$value = array();
for ($i=0,$count=count($value); $i<$count; ++$i)
$value[$i] = ($value[$i] == '#null#' ? null : $value[$i]);
$this->setSelectedValue($value);
}
}
function validate(&$render)
{
$this->clearValidation($render);
if ($this->mandatory && $this->selectedIndex <= 0)
{
$this->setError(_PNFORM_MANDATORYSELECTERROR);
}
}
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)
{
if (is_string($value))
$value = split(':', $value);
else if (!is_array($value))
$value = array($value);
$this->selectedValue = $value;
}
function getSelectedValue()
{
if ($this->saveAsString)
{
$s = '';
for ($i=0,$count=count($this->selectedValue); $i<$count; ++$i)
$s .= (empty($s) ? '' : ':') . $this->selectedValue[$i];
return $s;
}
return $this->selectedValue;
}
}
function smarty_function_pnformcheckboxlist($params, &$render)
{
return $render->pnFormRegisterPlugin('pnFormCheckboxList', $params);

Source for file function.pnformcheckboxlist.php