0byt3m1n1

Path: /data/applications/aps/xoops/2.3.2b-6/standard/htdocs/class/xoopsform/ [ Home ]
File: formcheckbox.php
<?php
/**
 * XOOPS form checkbox compo
 *
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code 
 * which is considered copyrighted (c) material of the original comment or credit authors.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * @copyright       The XOOPS Project http://sourceforge.net/projects/xoops/
 * @license         http://www.fsf.org/copyleft/gpl.html GNU public license
 * @package         kernel
 * @since           2.0
 * @author          Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/
 * @author          Skalpa Keo <skalpa@xoops.org>
 * @author          Taiwen Jiang <phppp@users.sourceforge.net>
 * @version         $Id: formcheckbox.php 2084 2008-09-14 15:35:57Z phppp $
 * @package         kernel
 */
 
if (!defined('XOOPS_ROOT_PATH')) {
    die("XOOPS root path not defined");
}

xoops_load('xoopsformelement');

class XoopsFormCheckBox extends XoopsFormElement
{

    /**
     * Availlable options
     * @var array
     * @access    private
     */
    var $_options = array();

    /**
     * pre-selected values in array
     * @var    array
     * @access    private
     */
    var $_value = array();

    /**
     * HTML to seperate the elements
     * @var    string  
     * @access  private
     */
    var $_delimeter;

    /**
     * Column number for rendering
     * @var        int  
     * @access  public
     */
    var $columns;
    
    /**
     * Constructor
     *
     * @param    string  $caption
     * @param    string  $name
     * @param    mixed   $value  Either one value as a string or an array of them.
     */
    function XoopsFormCheckBox($caption, $name, $value = null, $delimeter = "&nbsp;")
    {
        $this->setCaption($caption);
        $this->setName($name);
        if (isset($value)) {
            $this->setValue($value);
        }
        $this->_delimeter = $delimeter;
    }

    /**
     * Get the "value"
     *
     * @param    bool    $encode To sanitizer the text?
     * @return    array
     */
    function getValue($encode = false)
    {
        if (!$encode) {
            return $this->_value;
        }
        $value = array();
        foreach ($this->_value as $val) {
            $value[] = $val ? htmlspecialchars($val, ENT_QUOTES) : $val;
        }
        return $value;
    }

    /**
     * Set the "value"
     *
     * @param    array
     */
    function setValue($value)
    {
        $this->_value = array();
        if (is_array($value)) {
            foreach ($value as $v) {
                $this->_value[] = $v;
            }
        } else {
            $this->_value[] = $value;
        }
    }

    /**
     * Add an option
     *
     * @param    string  $value
     * @param    string  $name
     */
    function addOption($value, $name = "")
    {
        if ($name != "") {
            $this->_options[$value] = $name;
        } else {
            $this->_options[$value] = $value;
        }
    }

    /**
     * Add multiple Options at once
     *
     * @param    array   $options    Associative array of value->name pairs
     */
    function addOptionArray($options)
    {
        if ( is_array($options) ) {
            foreach ( $options as $k => $v ) {
                $this->addOption($k, $v);
            }
        }
    }

    /**
     * Get an array with all the options
     *
     * @param    int     $encode     To sanitizer the text? potential values: 0 - skip; 1 - only for value; 2 - for both value and name
     * @return    array   Associative array of value->name pairs
     */
    function getOptions($encode = false)
    {
        if (!$encode) {
            return $this->_options;
        }
        $value = array();
        foreach ($this->_options as $val => $name) {
            $value[ $encode ? htmlspecialchars($val, ENT_QUOTES) : $val ] = ($encode > 1) ? htmlspecialchars($name, ENT_QUOTES) : $name;
        }
        return $value;
    }

    /**
     * Get the delimiter of this group
     * 
     * @param    bool    $encode To sanitizer the text?
     * @return    string  The delimiter
     */
    function getDelimeter($encode = false)
    {
        return $encode ? htmlspecialchars(str_replace('&nbsp;', ' ', $this->_delimeter)) : $this->_delimeter;
    }

    /**
     * prepare HTML for output
     *
     * @return    string
     */
    function render()
    {
        $ele_name = $this->getName();
        $ele_id = $ele_name;
        $ele_value = $this->getValue();
        $ele_options = $this->getOptions();
        $ele_extra = $this->getExtra();
        $ele_delimeter = empty($this->columns) ? $this->getDelimeter() : "";
        if ( count($ele_options) > 1 && substr($ele_name, -2, 2) != "[]" ) {
            $ele_name = $ele_name . "[]";
            $this->setName($ele_name);
        }
        $ret = "";
        if (!empty($this->columns)) {
            $ret .= "<table><tr>";
        }
        $i = 0;
        foreach ( $ele_options as $value => $name ) {
            if (!empty($this->columns)) {
                if ($i % $this->columns == 0) {
                    $ret .= "<tr>";
                }
                $ret .= "<td>";
            }
            $ret .= "<input type='checkbox' name='{$ele_name}' id='{$ele_id}{$i}' value='" . htmlspecialchars($value, ENT_QUOTES) . "'";
            if (count($ele_value) > 0 && in_array($value, $ele_value)) {
                $ret .= " checked='checked'";
            }
            $ret .= $ele_extra . " />". $name . $ele_delimeter . "\n";
            if (!empty($this->columns)) {
                $ret .= "</td>";
                if (++$i % $this->columns == 0) {
                    $ret .= "</tr>";
                }
            }
        }
        if (!empty($this->columns)) {
            if ($span = $i % $this->columns) {
                $ret .= "<td colspan='" . ( $this->columns - $span ) . "'></td></tr>";
            }
            $ret .= "</table>";
        }
        return $ret;
    }

    /**
     * Render custom javascript validation code
     *
     * @seealso XoopsForm::renderValidationJS
    */
    function renderValidationJS() 
    {
        // render custom validation code if any
        if ( !empty( $this->customValidationCode ) ) {
            return implode( "\n", $this->customValidationCode );
        // generate validation code if required 
        } elseif ($this->isRequired()) {
            $eltname    = $this->getName();
            $eltcaption = $this->getCaption();
            $eltmsg = empty($eltcaption) ? sprintf( _FORM_ENTER, $eltname ) : sprintf( _FORM_ENTER, $eltcaption );
            $eltmsg = str_replace('"', '\"', stripslashes( $eltmsg ) );
            return "\nvar hasChecked = false; var checkBox = myform.elements['{$eltname}'];" .
                "for ( var i = 0; i < checkBox.length; i++ ) { if (checkBox[i].checked == true) { hasChecked = true; break; } }" .
                "if (!hasChecked) { window.alert(\"{$eltmsg}\"); checkBox[0].focus(); return false; }";
        }
        return ''; 
    }
}
?>