SKien\Formgenerator\FormCheck

Complexity

Total Complexity

14

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	buildReadonlySurrogate()	0	15	3
A	buildUncheckedSurrogate()	0	15	1
A	getBoolValue()	0	15	3
A	buildCheckBox()	0	13	2
A	getHTML()	0	21	3

<?php
declare(strict_types=1);

namespace SKien\Formgenerator;

/**
 * Checkbox input field.
 *
 * @package Formgenerator
 * @author Stefanius <s.kien@online.de>
 * @copyright MIT License - see the LICENSE file for details
 */
class FormCheck extends FormInput
{
    /**
     * Create a checkbox.
     * As default, the value 'on' is submitted for a checked element. This value can be 
     * changed by setting a btnValue for the elementname in the FormData. <br/>
     * <b>Note: HTML does not submit any value for unchecked checkboxes !!!.</b>
     * @param string $strName   name AND id of the element
     * @param int $wFlags    (default: 0)
     * @param string $strSuffix Text after the checkbox (default: '')
     */
    public function __construct(string $strName, int $wFlags = 0, string $strSuffix = '') 
    {
        $this->oFlags = new FormFlags($wFlags);
        $this->strName = $strName;
        $this->strSuffix = $strSuffix;
        if ($this->oFlags->isSet(FormFlags::READ_ONLY | FormFlags::DISABLED)) {
            $this->addAttribute('disabled');
        }
    }
    
    /**
     * Build the HTML-markup for the checkbox.
     * Checkbox is a special case, as it behaves particularly with regard to the transferred 
     * value and does not support read-only mode.
     * There is special treatment for both cases, which is explained in more detail in the 
     * respective code areas bolow.  
     * @return string
     */
    public function getHTML() : string 
    {
        $this->processFlags();
        $bChecked = $this->getBoolValue();
        if ($bChecked) {
            $this->addAttribute('checked');
        }
        
        $strHTML = $this->buildContainerDiv();
        
        $strHTML .= $this->buildUncheckedSurrogate();
        $strHTML .= $this->buildCheckBox();
        $strHTML .= $this->buildReadonlySurrogate($bChecked);
        
        if (!empty($this->strSuffix)) {
            $strHTML .= '&nbsp;' . $this->strSuffix;
        }
        
        $strHTML .= '</div>' . PHP_EOL;

        return $strHTML;
    }
    
    /**
     * Get the value as bool. <ul>
     * <li> 'real' bool values as is </li>
     * <li> numeric: 0 -> false, all other -> true </li>
     * <li> string: '1', 'on', 'true', 'yes' (case insensitive) -> true, all other -> false </li></ul>
     * @return bool
     */
    protected function getBoolValue() : bool
    {
        $bChecked = false;
        $value = $this->oFG->getData()->getValue($this->strName);
        if (is_bool($value)) {
            $bChecked = $value;
        } else {
            if (is_numeric($value)) {
                $bChecked = ($value !== 0);
            } else {
                $value = strtolower($value);
                $bChecked = in_array($value, ['1', 'on', 'true', 'yes']);
            }
        }
        return $bChecked;
    }
    
    /**
     * Build the checkbox.
     * @return string
     */
    protected function buildCheckBox() : string
    {
        $strHTML = '<input type="checkbox"';
        $strHTML .= $this->buildStyle();
        $strHTML .= $this->buildAttributes();
        $strHTML .= $this->buildTabindex();
        $strHTML .= ' id="' . $this->strName . '"';
        if (!$this->oFlags->isSet(FormFlags::READ_ONLY | FormFlags::DISABLED)) {
            $strHTML .= ' name="' . $this->strName . '"';
        }
        $strHTML .= '>';
        
        return $strHTML;
    }
    
    /**
     * Build the surrogate for unchecked box.
     * @return string
     */
    protected function buildUncheckedSurrogate() : string
    {
        // We insert a hidden edit field with same name/id BEFORE we create the checkbox
        // and  alwas set its value to 'off'.
        // If the checkbox is activated, 'on' (or the value set with BtnValue) is posted as normal. 
        // However, since the value of a non-activated checkbox is not transferred at all, in this 
        // case the hidden field defined in the previous order comes into play and the fixed value 
        // 'off' is transferred.
        // This is particularly helpful/important if a database operation is to be carried out 
        // dynamically on the basis of the transferred fields: If the 'off' were not transferred, 
        // the field would not be taken into account either and would therefore never be set from 
        // 'on' to 'off'!! 
        $strHTML = '<input type="hidden" value="off" name="' . $this->strName . '">';
        
        return $strHTML;
    }
    
    /**
     * Build the surrogate in case of readonly checkbox.
     * @param bool $bChecked
     * @return string
     */
    protected function buildReadonlySurrogate(bool $bChecked) : string
    {
        // NOTE: because checkboxes don't support readonly-attribute and disabled checkboxes
        // are not posted to reciever, we insert an hidden field with name and id to keep
        // value 'alive'
        // -> so we dont set name and id for readonly or disabled checkbox!
        $strHTML = '';
        if ($this->oFlags->isSet(FormFlags::READ_ONLY | FormFlags::DISABLED)) {
            $strHTML .= '<input';
            $strHTML .= ' type="hidden"';
            $strHTML .= ' name="' . $this->strName . '"';
            $strValue = ($bChecked) ? 'on' :'off';
            $strHTML .= ' value="' . $strValue . '">';
        }
        return $strHTML;        
    }
}