list.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 generic list of options.
 *
 * @package     Joomla.Platform
 * @subpackage  Form
 * @since       11.1
 */
class JFormFieldList extends JFormField
{
        /**
         * The form field type.
         *
         * @var    string
         * @since  11.1
         */
        protected $type = 'List';

        /**
         * Method to get the field input markup for a generic list.
         * Use the multiple attribute to enable multiselect.
         *
         * @return  string  The field input markup.
         *
         * @since   11.1
         */
        protected function getInput()
        {
                $html = array();
                $attr = '';

                // Initialize some field attributes.
                $attr .= !empty($this->class) ? ' class="' . $this->class . '"' : '';
                $attr .= !empty($this->size) ? ' size="' . $this->size . '"' : '';
                $attr .= $this->multiple ? ' multiple' : '';
                $attr .= $this->required ? ' required aria-required="true"' : '';
                $attr .= $this->autofocus ? ' autofocus' : '';

                // To avoid user's confusion, readonly="true" should imply disabled="true".
                if ((string) $this->readonly == '1' || (string) $this->readonly == 'true' || (string) $this->disabled == '1'|| (string) $this->disabled == 'true')
                {
                        $attr .= ' disabled="disabled"';
                }

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

                // Get the field options.
                $options = (array) $this->getOptions();

                // Create a read-only list (no name) with a hidden input to store the value.
                if ((string) $this->readonly == '1' || (string) $this->readonly == 'true')
                {
                        $html[] = JHtml::_('select.genericlist', $options, '', trim($attr), 'value', 'text', $this->value, $this->id);
                        $html[] = '<input type="hidden" name="' . $this->name . '" value="' . $this->value . '"/>';
                }
                else
                // Create a regular list.
                {
                        $html[] = JHtml::_('select.genericlist', $options, $this->name, trim($attr), 'value', 'text', $this->value, $this->id);
                }

                return implode($html);
        }

        /**
         * Method to get the field options.
         *
         * @return  array  The field option objects.
         *
         * @since   11.1
         */
        protected function getOptions()
        {
                $options = array();

                foreach ($this->element->children() as $option)
                {
                        // Only add <option /> elements.
                        if ($option->getName() != 'option')
                        {
                                continue;
                        }

                        // Filter requirements
                        if ($requires = explode(',', (string) $option['requires']))
                        {
                                // Requires multilanguage
                                if (in_array('multilanguage', $requires) && !JLanguageMultilang::isEnabled())
                                {
                                        continue;
                                }

                                // Requires associations
                                if (in_array('associations', $requires) && !JLanguageAssociations::isEnabled())
                                {
                                        continue;
                                }
                        }

                        $value = (string) $option['value'];

                        $disabled = (string) $option['disabled'];
                        $disabled = ($disabled == 'true' || $disabled == 'disabled' || $disabled == '1');

                        $disabled = $disabled || ($this->readonly && $value != $this->value);

                        // Create a new option object based on the <option /> element.
                        $tmp = JHtml::_(
                                'select.option', $value,
                                JText::alt(trim((string) $option), preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)), 'value', 'text',
                                $disabled
                        );

                        // Set some option attributes.
                        $tmp->class = (string) $option['class'];

                        // Set some JavaScript option attributes.
                        $tmp->onclick = (string) $option['onclick'];

                        // Add the option object to the result set.
                        $options[] = $tmp;
                }

                reset($options);

                return $options;
        }
}