Просмотр архива Contao (бывшая TYPOlight)


<?php

/**
 * Contao Open Source CMS
 *
 * Copyright (c) 2005-2016 Leo Feyer
 *
 * @license LGPL-3.0+
 */

namespace Contao;


/**
 * Class FormSelectMenu
 *
 * @property integer $mSize
 * @property boolean $mandatory
 * @property boolean $multiple
 * @property array   $options
 * @property boolean $chosen
 *
 * @author Leo Feyer <https://github.com/leofeyer>
 */
class FormSelectMenu extends Widget
{

    /**
     * Submit user input
     *
     * @var boolean
     */
    protected $blnSubmitInput = true;

    /**
     * Add a for attribute
     *
     * @var boolean
     */
    protected $blnForAttribute = true;

    /**
     * Template
     *
     * @var string
     */
    protected $strTemplate = 'form_select';

    /**
     * The CSS class prefix
     *
     * @var string
     */
    protected $strPrefix = 'widget widget-select';


    /**
     * Add specific attributes
     *
     * @param string $strKey   The attribute name
     * @param mixed  $varValue The attribute value
     */
    public function __set($strKey, $varValue)
    {
        switch ($strKey)
        {
            case 'mandatory':
                if ($varValue)
                {
                    $this->arrAttributes['required'] = 'required';
                }
                else
                {
                    unset($this->arrAttributes['required']);
                }
                parent::__set($strKey, $varValue);
                break;

            case 'mSize':
                if ($this->multiple)
                {
                    $this->arrAttributes['size'] = $varValue;
                }
                break;

            case 'multiple':
                if ($varValue != '')
                {
                    $this->arrAttributes['multiple'] = 'multiple';
                }
                break;

            case 'options':
                $this->arrOptions = deserialize($varValue);
                break;

            case 'rgxp':
            case 'minlength':
            case 'maxlength':
                // Ignore
                break;

            default:
                parent::__set($strKey, $varValue);
                break;
        }
    }


    /**
     * Check options if the field is mandatory
     */
    public function validate()
    {
        $mandatory = $this->mandatory;
        $options = $this->getPost($this->strName);

        // Check if there is at least one value
        if ($mandatory && is_array($options))
        {
            foreach ($options as $option)
            {
                if (strlen($option))
                {
                    $this->mandatory = false;
                    break;
                }
            }
        }

        $varInput = $this->validator($options);

        // Check for a valid option (see #4383)
        if (!empty($varInput) && !$this->isValidOption($varInput))
        {
            $this->addError(sprintf($GLOBALS['TL_LANG']['ERR']['invalid'], (is_array($varInput) ? implode(', ', $varInput) : $varInput)));
        }

        // Add class "error"
        if ($this->hasErrors())
        {
            $this->class = 'error';
        }
        else
        {
            $this->varValue = $varInput;
        }

        // Reset the property
        if ($mandatory)
        {
            $this->mandatory = true;
        }
    }


    /**
     * Return a parameter
     *
     * @param string $strKey The parameter name
     *
     * @return mixed The parameter value
     */
    public function __get($strKey)
    {
        if ($strKey == 'options')
        {
            return $this->arrOptions;
        }

        return parent::__get($strKey);
    }


    /**
     * Parse the template file and return it as string
     *
     * @param array $arrAttributes An optional attributes array
     *
     * @return string The template markup
     */
    public function parse($arrAttributes=null)
    {
        $strClass = 'select';

        if ($this->multiple)
        {
            $this->strName .= '[]';
            $strClass = 'multiselect';
        }

        // Make sure there are no multiple options in single mode
        elseif (is_array($this->varValue))
        {
            $this->varValue = $this->varValue[0];
        }

        // Chosen
        if ($this->chosen)
        {
            $strClass .= ' tl_chosen';
        }

        // Custom class
        if ($this->strClass != '')
        {
            $strClass .= ' ' . $this->strClass;
        }

        $this->strClass = $strClass;

        return parent::parse($arrAttributes);
    }


    /**
     * Generate the options
     *
     * @return array The options array
     */
    protected function getOptions()
    {
        $arrOptions = array();
        $blnHasGroups = false;

        // Add empty option (XHTML) if there are none
        if (empty($this->arrOptions))
        {
            $this->arrOptions = array(array('value' => '', 'label' => '-'));
        }

        // Generate options
        foreach ($this->arrOptions as $arrOption)
        {
            if ($arrOption['group'])
            {
                if ($blnHasGroups)
                {
                    $arrOptions[] = array
                    (
                        'type' => 'group_end'
                    );
                }

                $arrOptions[] = array
                (
                    'type'  => 'group_start',
                    'label' => specialchars($arrOption['label'])
                );

                $blnHasGroups = true;
            }
            else
            {
                $arrOptions[] = array
                (
                    'type'     => 'option',
                    'value'    => $arrOption['value'],
                    'selected' => $this->isSelected($arrOption),
                    'label'    => $arrOption['label'],
                );
            }
        }

        if ($blnHasGroups)
        {
            $arrOptions[] = array
            (
                'type' => 'group_end'
            );
        }

        return $arrOptions;
    }


    /**
     * Generate the widget and return it as string
     *
     * @return string The widget markup
     */
    public function generate()
    {
        $strOptions = '';
        $blnHasGroups = false;

        if ($this->multiple)
        {
            $this->strName .= '[]';
        }

        // Make sure there are no multiple options in single mode
        elseif (is_array($this->varValue))
        {
            $this->varValue = $this->varValue[0];
        }

        // Add empty option (XHTML) if there are none
        if (empty($this->arrOptions))
        {
            $this->arrOptions = array(array('value'=>'', 'label'=>'-'));
        }

        foreach ($this->arrOptions as $arrOption)
        {
            if ($arrOption['group'])
            {
                if ($blnHasGroups)
                {
                    $strOptions .= '</optgroup>';
                }

                $strOptions .= sprintf('<optgroup label="%s">',
                                        specialchars($arrOption['label']));

                $blnHasGroups = true;
                continue;
            }

            $strOptions .= sprintf('<option value="%s"%s>%s</option>',
                                    $arrOption['value'],
                                    $this->isSelected($arrOption),
                                    $arrOption['label']);
        }

        if ($blnHasGroups)
        {
            $strOptions .= '</optgroup>';
        }

        return sprintf('<select name="%s" id="ctrl_%s" class="%s"%s>%s</select>',
                        $this->strName,
                        $this->strId,
                        $this->class,
                        $this->getAttributes(),
                        $strOptions) . $this->addSubmit();
    }
}