spacer.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.
 * Provides spacer markup to be used in form layouts.
 *
 * @package     Joomla.Platform
 * @subpackage  Form
 * @since       11.1
 */
class JFormFieldSpacer extends JFormField
{
        /**
         * The form field type.
         *
         * @var    string
         * @since  11.1
         */
        protected $type = 'Spacer';

        /**
         * Method to get the field input markup for a spacer.
         * The spacer does not have accept input.
         *
         * @return  string  The field input markup.
         *
         * @since   11.1
         */
        protected function getInput()
        {
                return ' ';
        }

        /**
         * Method to get the field label markup for a spacer.
         * Use the label text or name from the XML element as the spacer or
         * Use a hr="true" to automatically generate plain hr markup
         *
         * @return  string  The field label markup.
         *
         * @since   11.1
         */
        protected function getLabel()
        {
                $html = array();
                $class = !empty($this->class) ? ' class="' . $this->class . '"' : '';
                $html[] = '<span class="spacer">';
                $html[] = '<span class="before"></span>';
                $html[] = '<span' . $class . '>';

                if ((string) $this->element['hr'] == 'true')
                {
                        $html[] = '<hr' . $class . ' />';
                }
                else
                {
                        $label = '';

                        // Get the label text from the XML element, defaulting to the element name.
                        $text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];
                        $text = $this->translateLabel ? JText::_($text) : $text;

                        // Build the class for the label.
                        $class = !empty($this->description) ? 'hasTooltip' : '';
                        $class = $this->required == true ? $class . ' required' : $class;

                        // Add the opening label tag and main attributes attributes.
                        $label .= '<label id="' . $this->id . '-lbl" class="' . $class . '"';

                        // If a description is specified, use it to build a tooltip.
                        if (!empty($this->description))
                        {
                                JHtml::_('bootstrap.tooltip');
                                $label .= ' title="' . JHtml::tooltipText(trim($text, ':'), JText::_($this->description), 0) . '"';
                        }

                        // Add the label text and closing tag.
                        $label .= '>' . $text . '</label>';
                        $html[] = $label;
                }

                $html[] = '</span>';
                $html[] = '<span class="after"></span>';
                $html[] = '</span>';

                return implode('', $html);
        }

        /**
         * Method to get the field title.
         *
         * @return  string  The field title.
         *
         * @since   11.1
         */
        protected function getTitle()
        {
                return $this->getLabel();
        }
}