checkbox.php

Aller à la documentation de ce fichier.

<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Form
 *
 * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

/**
 * Form Field class for the Joomla Platform.
 * Single check box field.
 * This is a boolean field with null for false and the specified option for true
 *
 * @package     Joomla.Platform
 * @subpackage  Form
 * @link        http://www.w3.org/TR/html-markup/input.checkbox.html#input.checkbox
 * @see         JFormFieldCheckboxes
 * @since       11.1
 */
class JFormFieldCheckbox extends JFormField
{
        /**
         * The form field type.
         *
         * @var    string
         * @since  11.1
         */
        protected $type = 'Checkbox';

        /**
         * The checked state of checkbox field.
         *
         * @var    boolean
         * @since  3.2
         */
        protected $checked = false;

        /**
         * Method to get certain otherwise inaccessible properties from the form field object.
         *
         * @param   string  $name  The property name for which to the the value.
         *
         * @return  mixed  The property value or null.
         *
         * @since   3.2
         */
        public function __get($name)
        {
                switch ($name)
                {
                        case 'checked':
                                return $this->$name;
                }

                return parent::__get($name);
        }

        /**
         * Method to set certain otherwise inaccessible properties of the form field object.
         *
         * @param   string  $name   The property name for which to the the value.
         * @param   mixed   $value  The value of the property.
         *
         * @return  void
         *
         * @since   3.2
         */
        public function __set($name, $value)
        {
                switch ($name)
                {
                        case 'checked':
                                $value = (string) $value;
                                $this->$name = ($value == 'true' || $value == $name || $value == '1');
                                break;

                        default:
                                parent::__set($name, $value);
                }
        }

        /**
         * Method to attach a JForm object to the field.
         *
         * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the <field /> tag for the form field object.
         * @param   mixed             $value    The form field value to validate.
         * @param   string            $group    The field name group control value. This acts as as an array container for the field.
         *                                      For example if the field has name="foo" and the group value is set to "bar" then the
         *                                      full field name would end up being "bar[foo]".
         *
         * @return  boolean  True on success.
         *
         * @see     JFormField::setup()
         * @since   3.2
         */
        public function setup(SimpleXMLElement $element, $value, $group = null)
        {
                $return = parent::setup($element, $value, $group);

                if ($return)
                {
                        $checked = (string) $this->element['checked'];
                        $this->checked = ($checked == 'true' || $checked == 'checked' || $checked == '1');

                        empty($this->value) || $this->checked ? null : $this->checked = true;
                }

                return $return;
        }

        /**
         * Method to get the field input markup.
         * The checked element sets the field to selected.
         *
         * @return  string  The field input markup.
         *
         * @since   11.1
         */
        protected function getInput()
        {
                // Initialize some field attributes.
                $class     = !empty($this->class) ? ' class="' . $this->class . '"' : '';
                $disabled  = $this->disabled ? ' disabled' : '';
                $value     = !empty($this->default) ? $this->default : '1';
                $required  = $this->required ? ' required aria-required="true"' : '';
                $autofocus = $this->autofocus ? ' autofocus' : '';
                $checked   = $this->checked || !empty($this->value) ? ' checked' : '';

                // Initialize JavaScript field attributes.
                $onclick  = !empty($this->onclick) ? ' onclick="' . $this->onclick . '"' : '';
                $onchange = !empty($this->onchange) ? ' onchange="' . $this->onchange . '"' : '';

                // Including fallback code for HTML5 non supported browsers.
                JHtml::_('jquery.framework');
                JHtml::_('script', 'system/html5fallback.js', false, true);

                return '<input type="checkbox" name="' . $this->name . '" id="' . $this->id . '" value="'
                        . htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"' . $class . $checked . $disabled . $onclick . $onchange
                        . $required . $autofocus . ' />';
        }
}