File Source for function.pnformcheckbox.php

<?php
/**
* Checkbox plugin
*
* @copyright (c) 2006, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: function.pnformcheckbox.php 24342 2008-06-06 12:03:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @author Jorn Wildt
* @package Zikula_Template_Plugins
* @subpackage Functions
*/
/**
* Check box plugin
*
* Plugin to generate a checkbox for true/false selection.
*
* @package pnForm
* @subpackage Plugins
*/
class pnFormCheckbox extends pnFormStyledPlugin
{
/**
* Checked value
*
* Set to true when checkbox is checked, false otherwise.
* @var bool
*/
var $checked;
/**
* Enable or disable read only mode
*/
var $readOnly;
/**
* 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.
* @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;
/**
* HTML input name for this plugin. Defaults to the ID of the plugin.
* @var string
*/
var $inputName;
function getFilename()
{
return __FILE__; // FIXME: should be found in smarty's data???
}
function create(&$render, $params)
{
// Load all special and non-string parameters
// - the rest are fetched automatically
$this->checked = (array_key_exists('checked', $params) ? $params['checked'] : false);
$this->inputName = (array_key_exists('inputName', $params) ? $params['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);
}
function load(&$render, &$params)
{
$this->loadValue($render, $render->get_template_vars());
}
function loadValue(&$render, &$values)
{
if ($this->dataBased)
{
$value = null;
if ($this->group == null)
{
if (array_key_exists($this->dataField, $values))
$value = $values[$this->dataField];
}
else
{
if (array_key_exists($this->group, $values))
{
$value = $values[$this->group][$this->dataField];
}
}
if ($value !== null)
$this->checked = $value;
}
}
function render(&$render)
{
$idHtml = $this->getIdHtml();
$nameHtml = " name=\"{$this->inputName}\"";
$readOnlyHtml = ($this->readOnly ? " disabled=\"disabled\"" : '');
$checkedHtml = ($this->checked ? " checked=\"checked\"" : '');
$attributes = $this->renderAttributes($render);
$result = "<input type=\"checkbox\" value=\"1\" class=\"cbx\"{$idHtml}{$nameHtml}{$readOnlyHtml}{$checkedHtml}{$attributes}/>";
return $result;
}
function decode(&$render)
{
// Do not read new value if readonly (evil submiter might have forged it)
if (!$this->readOnly)
$this->checked = (FormUtil::getPassedValue($this->inputName, null, 'REQUEST') == null ? false : true);
}
function saveValue(&$render, &$data)
{
if ($this->dataBased)
{
if ($this->group == null)
{
$data[$this->dataField] = $this->checked;
}
else
{
if (!array_key_exists($this->group, $data))
$data[$this->group] = array();
$data[$this->group][$this->dataField] = $this->checked;
}
}
}
}
function smarty_function_pnformcheckbox($params, &$render)
{
return $render->pnFormRegisterPlugin('pnFormCheckbox', $params);

Source for file function.pnformcheckbox.php