Multiple.php

Go to the documentation of this file.

<?php

 
namespace Depage\HtmlForm\Elements;
 
use Depage\HtmlForm\Abstracts;

class Multiple extends Abstracts\Input
{
    protected $list = [];

    protected $listHtml = [];

    protected $skin = 'radio';

    protected $maxItems = null;

    public function __construct(string $name, array $parameters, object $form)
    {
        parent::__construct($name, $parameters, $form);
 
        $this->list = (isset($parameters['list']) && is_array($parameters['list'])) ? $parameters['list'] : [];
        $this->listHtml = (isset($parameters['listHtml']) && is_array($parameters['listHtml'])) ? $parameters['listHtml'] : [];
        $this->maxItems = isset($parameters['maxItems']) ? $parameters['maxItems'] : $this->maxItems;
    }

    protected function setDefaults(): void
    {
        parent::setDefaults();
 
        // multiple-choice-elements have values of type array
        $this->defaults['defaultValue'] = [];
        $this->defaults['skin']         = 'checkbox';
        $this->defaults['maxItems']     = null;
    }

    protected function htmlList(array|null $options = null, array|null $value = null): string
    {
        if ($value == null) {
            $value      = $this->htmlValue();
        }
        if ($options == null) {
            $options    = $this->list;
        }
 
        $options    = $this->htmlEscape($options);
        $list       = '';
 
        // select
        if (in_array($this->skin, ['select', 'tags'])) {
            foreach ($options as $index => $option) {
                if (is_array($option)) {
                    $list       .= "<optgroup label=\"{$index}\">" . $this->htmlList($option, $value) . "</optgroup>";
                } else {
                    $selected   = (in_array($index, $value)) ? ' selected' : '';
                    $list       .= "<option value=\"{$index}\"{$selected}>{$option}</option>";
                }
            }
            // checkbox
        } else {
            $inputAttributes = $this->htmlInputAttributes();
 
            foreach ($options as $index => $option) {
                $selected = (is_array($value) && (in_array($index, $value))) ? " checked=\"yes\"" : '';
                $class = "input-multiple-option-" . str_replace(" ", "-", $index);
                $optionHtml = $this->listHtml[$index] ?? "<span>{$option}</span>";
 
                $list .= "<span>" .
                    "<label class=\"{$class}\" title=\"{$option}\">" .
                        "<input type=\"checkbox\" name=\"{$this->name}[]\"{$inputAttributes} value=\"{$index}\"{$selected}>" .
                        $optionHtml .
                    "</label>" .
                "</span>";
            }
        }
 
        return $list;
    }

    public function __toString(): string
    {
        $marker             = $this->htmlMarker();
        $label              = $this->htmlLabel();
        $list               = $this->htmlList();
        $wrapperAttributes  = $this->htmlWrapperAttributes();
        $errorMessage       = $this->htmlErrorMessage();
        $helpMessage        = $this->htmlHelpMessage();
 
        if (in_array($this->skin, ['select', 'tags'])) {
            // render HTML select
 
            $inputAttributes = $this->htmlInputAttributes();
 
            return "<p {$wrapperAttributes}>" .
                "<label>" .
                    "<span class=\"depage-label\">{$label}{$marker}</span>" .
                    "<select multiple name=\"{$this->name}[]\"{$inputAttributes}>{$list}</select>" .
                "</label>" .
                $errorMessage .
                $helpMessage .
            "</p>\n";
        } else {
            // render HTML checkbox
            return "<p {$wrapperAttributes}>" .
                "<span class=\"depage-label\">{$label}{$marker}</span>" .
                "<span>{$list}</span>" .
                $errorMessage .
                $helpMessage .
            "</p>\n";
        }
    }

    protected function htmlInputAttributes(): string
    {
        $attributes = '';
 
        // HTML5 validator hack
        if ($this->required && in_array($this->skin, ['select', 'tags'])) {
            $attributes .= ' required="required"';
        }
        if ($this->maxItems) {
            $attributes .= " data-max-items=\"$this->maxItems\"";
        }
        return $attributes;
    }

    protected function typeCastValue(): void
    {
        if ($this->value == "") {
            $this->value = [];
        } else {
            $this->value = (array) $this->value;
 
            if ($this->maxItems) {
                $this->value = array_slice($this->value, 0, $this->maxItems);
            }
        }
    }
}
 
/* vim:set ft=php sw=4 sts=4 fdm=marker et : */