sql.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;

JFormHelper::loadFieldClass('list');

/**
 * Supports an custom SQL select list
 *
 * @package     Joomla.Platform
 * @subpackage  Form
 * @since       11.1
 */
class JFormFieldSQL extends JFormFieldList
{
        /**
         * The form field type.
         *
         * @var    string
         * @since  11.1
         */
        public $type = 'SQL';

        /**
         * The keyField.
         *
         * @var    string
         * @since  3.2
         */
        protected $keyField;

        /**
         * The valueField.
         *
         * @var    string
         * @since  3.2
         */
        protected $valueField;

        /**
         * The translate.
         *
         * @var    boolean
         * @since  3.2
         */
        protected $translate = false;

        /**
         * The query.
         *
         * @var    string
         * @since  3.2
         */
        protected $query;

        /**
         * 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 'keyField':
                        case 'valueField':
                        case 'translate':
                        case 'query':
                                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 'keyField':
                        case 'valueField':
                        case 'translate':
                        case 'query':
                                $this->$name = (string) $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->keyField   = $this->element['key_field'] ? (string) $this->element['key_field'] : 'value';
                        $this->valueField = $this->element['value_field'] ? (string) $this->element['value_field'] : (string) $this->element['name'];
                        $this->translate  = $this->element['translate'] ? (string) $this->element['translate'] : false;
                        $this->query      = (string) $this->element['query'];
                }

                return $return;
        }

        /**
         * Method to get the custom field options.
         * Use the query attribute to supply a query to generate the list.
         *
         * @return  array  The field option objects.
         *
         * @since   11.1
         */
        protected function getOptions()
        {
                $options = array();

                // Initialize some field attributes.
                $key   = $this->keyField;
                $value = $this->valueField;

                // Get the database object.
                $db = JFactory::getDbo();

                // Set the query and get the result list.
                $db->setQuery($this->query);
                $items = $db->loadObjectlist();

                // Build the field options.
                if (!empty($items))
                {
                        foreach ($items as $item)
                        {
                                if ($this->translate == true)
                                {
                                        $options[] = JHtml::_('select.option', $item->$key, JText::_($item->$value));
                                }
                                else
                                {
                                        $options[] = JHtml::_('select.option', $item->$key, $item->$value);
                                }
                        }
                }

                // Merge any additional options in the XML definition.
                $options = array_merge(parent::getOptions(), $options);

                return $options;
        }
}