SKien\Formgenerator\FormRange

Complexity

Total Complexity

18

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	readAdditionalXML()	0	5	2
A	setStep()	0	3	1
B	getHTML()	0	33	6
A	buildValueLabel()	0	16	3
A	__construct()	0	6	1
A	setMinMax()	0	4	1
A	fromXML()	0	11	1
A	onParentSet()	0	4	2
A	buildValue()	0	4	1

<?php
declare(strict_types=1);

namespace SKien\Formgenerator;

/**
 * Range slider element.
 *
 * @SKienImage FormRange.png
 *
 * @package Formgenerator
 * @author Stefanius <s.kientzler@online.de>
 * @copyright MIT License - see the LICENSE file for details
 */
class FormRange extends FormInput
{
    /** @var int value */
    protected int $iValue = 0;
    /** @var int step */
    protected int $iStep = 1;
    /** @var int min value */
    protected int $iMin = 0;
    /** @var int max value */
    protected int $iMax = 100;

    /**
     * Create a range slider.
     * @param string $strName   name of the Element
     * @param string $strWidth  width
     * @param int $iMin         min value of the slider
     * @param int $iMax         max value of the slider
     * @param int $wFlags       any combination of FormFlag constants
     */
    public function __construct(string $strName, string $strWidth, int $iMin = 0, int $iMax = 100, int $wFlags = 0)
    {
        parent::__construct($strName, $strWidth, $wFlags);
        $this->strType = 'range';
        $this->iMin = $iMin;
        $this->iMax = $iMax;
    }

    /**
     * {@inheritDoc}
     * @see \SKien\Formgenerator\FormElement::fromXML()
     * @internal l
     */
    static public function fromXML(\DOMElement $oXMLElement, FormCollection $oFormParent) : ?FormElement
    {
        $strName = self::getAttribString($oXMLElement, 'name');
        $strWidth = self::getAttribString($oXMLElement, 'width');
        $iMin = self::getAttribInt($oXMLElement, 'min', 0);
        $iMax = self::getAttribInt($oXMLElement, 'max', 100);
        $wFlags = self::getAttribFlags($oXMLElement);
        $oFormElement = new self($strName, $strWidth, $iMin, $iMax, $wFlags);
        $oFormParent->add($oFormElement);
        $oFormElement->readAdditionalXML($oXMLElement);
        return $oFormElement;
    }

    /**
     * {@inheritDoc}
     * @see \SKien\Formgenerator\FormElement::readAdditionalXML()
     * @internal
     */
    public function readAdditionalXML(\DOMElement $oXMLElement) : void
    {
        parent::readAdditionalXML($oXMLElement);
        if (self::hasAttrib($oXMLElement, 'step')) {
            $this->setStep(self::getAttribInt($oXMLElement, 'step', 1));
        }
    }

    /**
     * Set min/max value for the slider.
     * @param int $iMin
     * @param int $iMax
     */
    public function setMinMax(?int $iMin, ?int $iMax) : void
    {
        $this->iMin = $iMin ?? $this->iMin;
        $this->iMax = $iMax ?? $this->iMax;
    }

    /**
     * Set step width to be performed by slider.
     * @param int $iStep
     */
    public function setStep(int $iStep) : void
    {
        $this->iStep = $iStep;
    }

    /**
     * get value from dataprovider.
     * Value have to be retrieved earlier because it may be needed for the value-label
     * before the value of the range element is set.
     */
    protected function onParentSet() : void
    {
        $value = $this->oFG->getData()->getValue($this->strName);
        $this->iValue = $value ? intval($value) : $this->iMin;
    }

    /**
     * {@inheritDoc}
     * @see \SKien\Formgenerator\FormElement::buildValue()
     */
    protected function buildValue() : string
    {
        $strHTML = ' value="' . $this->iValue . '"';
        return $strHTML;
    }


    /**
     * Build the HTML-notation for the input element.
     * {@inheritDoc}
     * @see \SKien\Formgenerator\FormElement::getHTML()
     * @internal
     */
    public function getHTML() : string
    {
        $this->addAttribute('step', (string)$this->iStep);
        $this->addAttribute('min', (string)$this->iMin);
        $this->addAttribute('max', (string)$this->iMax);
        $this->addAttribute('autocomplete', 'off');

        $this->processFlags();
        $strHTML = $this->buildContainerDiv('display: flex;');

        $this->strID = $this->strID ?: $this->strName;

        if ($this->oFlags->isSet(FormFlags::SHOW_VALUE) && !$this->oFlags->isSet(FormFlags::ALIGN_RIGHT)) {
            $strHTML .= $this->buildValueLabel();
        }
        $strHTML .= '<div class="slider" style="width: ' . $this->size . ';">';
        $strHTML .= '<input';
        $strHTML .= ' type="' . $this->strType . '"';
        $strHTML .= ' name="' . $this->strName . '"';
        $strHTML .= $this->buildClass();
        $strHTML .= $this->buildID();
        $strHTML .= $this->buildStyle();
        $strHTML .= $this->buildTabindex();
        $strHTML .= $this->buildAttributes();
        $strHTML .= $this->buildValue();
        $strHTML .= '>';
        $strHTML .= '</div>' . PHP_EOL;
        if ($this->oFlags->isSet(FormFlags::SHOW_VALUE) && $this->oFlags->isSet(FormFlags::ALIGN_RIGHT)) {
            $strHTML .= $this->buildValueLabel();
        }
        $strHTML .= '</div>' . PHP_EOL;

        return $strHTML;
    }

    /**
     * Build the label to display the actual value selected by the range element.
     * @return string
     */
    protected function buildValueLabel() : string
    {
        // if min is negative it can be longer than the max value...
        $iLen = (strlen((string)$this->iMin) > strlen((string)$this->iMax)) ? strlen((string)$this->iMin) : strlen((string)$this->iMax);

        $strHTML = '<label class="slider_label"';
        $strHTML .= ' for="' . $this->strID . '"';
        $strHTML .= ' style="width: ' . $iLen . 'em;';
        if ($this->oFlags->isSet(FormFlags::ALIGN_RIGHT)) {
            $strHTML .= ' text-align: right;';
        }
        $strHTML .= '">';
        $strHTML .= $this->iValue;
        $strHTML .= '</label>' . PHP_EOL;

        return $strHTML;
    }
}