textarea.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.
 * Supports a multi line area for entry of plain text
 *
 * @package     Joomla.Platform
 * @subpackage  Form
 * @link        http://www.w3.org/TR/html-markup/textarea.html#textarea
 * @since       11.1
 */
class JFormFieldTextarea extends JFormField
{
        /**
         * The form field type.
         *
         * @var    string
         * @since  11.1
         */
        protected $type = 'Textarea';

        /**
         * The number of rows in textarea.
         *
         * @var    mixed
         * @since  3.2
         */
        protected $rows;

        /**
         * The number of columns in textarea.
         *
         * @var    mixed
         * @since  3.2
         */
        protected $columns;

        /**
         * 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 'rows':
                        case 'columns':
                                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 'rows':
                        case 'columns':
                                $this->name = (int) $value;
                                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)
                {
                        $this->rows    = isset($this->element['rows']) ? (int) $this->element['rows'] : false;
                        $this->columns = isset($this->element['cols']) ? (int) $this->element['cols'] : false;
                }

                return $return;
        }

        /**
         * Method to get the textarea field input markup.
         * Use the rows and columns attributes to specify the dimensions of the area.
         *
         * @return  string  The field input markup.
         *
         * @since   11.1
         */
        protected function getInput()
        {
                // Translate placeholder text
                $hint = $this->translateHint ? JText::_($this->hint) : $this->hint;

                // Initialize some field attributes.
                $class        = !empty($this->class) ? ' class="' . $this->class . '"' : '';
                $disabled     = $this->disabled ? ' disabled' : '';
                $readonly     = $this->readonly ? ' readonly' : '';
                $columns      = $this->columns ? ' cols="' . $this->columns . '"' : '';
                $rows         = $this->rows ? ' rows="' . $this->rows . '"' : '';
                $required     = $this->required ? ' required aria-required="true"' : '';
                $hint         = $hint ? ' placeholder="' . $hint . '"' : '';
                $autocomplete = !$this->autocomplete ? ' autocomplete="off"' : ' autocomplete="' . $this->autocomplete . '"';
                $autocomplete = $autocomplete == ' autocomplete="on"' ? '' : $autocomplete;
                $autofocus    = $this->autofocus ? ' autofocus' : '';
                $spellcheck   = $this->spellcheck ? '' : ' spellcheck="false"';

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

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

                return '<textarea name="' . $this->name . '" id="' . $this->id . '"' . $columns . $rows . $class
                        . $hint . $disabled . $readonly . $onchange . $onclick . $required . $autocomplete . $autofocus . $spellcheck . ' >'
                        . htmlspecialchars($this->value, ENT_COMPAT, 'UTF-8') . '</textarea>';
        }
}