nook-ru / digitalwand.admin_helper

lib/widget/CheckboxWidget.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 17 and the first side effect is on line 7.

namespace DigitalWand\AdminHelper\Widget;

use Bitrix\Main\Localization\Loc;

Loc::loadMessages(__FILE__);

/**
 * Виджет "галочка"
 *
 * Доступные опции:
 * <ul>
 * <li> <b>FIELD_TYPE</b> - Тип данных для хранения булевых значений (строка, целые числа, булево) </li>
 * </ul>
 */
class CheckboxWidget extends HelperWidget
{
    /**
     * Строковый тип чекбокса (Y/N)
     * FIXME: если верить битриксу, мжет быть ещё и экзотичный случай со строками "true" и "false"!
     */
    const TYPE_STRING = 'string';
    /**
     * Целочисленный тип чекбокса (1/0)
     */
    const TYPE_INT = 'integer';
    /**
     * Булевый тип чекбокса
     */
    const TYPE_BOOLEAN = 'boolean';
    /**
     * Значение положительного варианта для строкового чекбокса
     */
    const TYPE_STRING_YES = 'Y';
    /**
     * Значение отрицательного варианта для строкового чекбокса
     */
    const TYPE_STRING_NO = 'N';
    /**
     * Значение положительного варианта для целочисленного чекбокса
     */
    const TYPE_INT_YES = 1;
    /**
     * Значение отрицательного варианта для целочисленного чекбокса
     */
    const TYPE_INT_NO = 0;

    protected static $defaults = array(
        'EDIT_IN_LIST' => true
    );

    /**
     * @inheritdoc
     */
    public function generateRow(&$row, $data)
    {
        $modeType = $this->getCheckboxType();

        $globalYes = '';
        $globalNo = '';

        switch ($modeType) {
            case self::TYPE_STRING: {

case statements should be defined using a colon.

                $globalYes = self::TYPE_STRING_YES;
                $globalNo = self::TYPE_STRING_NO;
                break;
            }
            case self::TYPE_INT:
            case self::TYPE_BOOLEAN: {

case statements should be defined using a colon.

                $globalYes = self::TYPE_INT_YES;
                $globalNo = self::TYPE_INT_NO;
                break;
            }
        }

        if ($this->getSettings('EDIT_IN_LIST') AND !$this->getSettings('READONLY')) {

Using logical operators such as and instead of && is generally not recommended.

            $checked = intval($this->getValue() == $globalYes) ? 'checked' : '';
            $js = 'var input = document.getElementsByName(\'' . $this->getEditableListInputName() . '\')[0];
                   input.value = this.checked ? \'' . $globalYes . '\' : \'' . $globalNo . '\';';
            $editHtml = '<input type="checkbox"
                                value="' . static::prepareToTagAttr($this->getValue()) . '" ' . $checked . '
                                onchange="' . $js . '"/>
                         <input type="hidden"
                                value="' . static::prepareToTagAttr($this->getValue()) . '"
                                name="' . $this->getEditableListInputName() . '" />';
            $row->AddEditField($this->getCode(), $editHtml);
        }

        if (intval($this->getValue() == $globalYes)) {
            $value = Loc::getMessage('DIGITALWAND_AH_CHECKBOX_YES');
        } else {
            $value = Loc::getMessage('DIGITALWAND_AH_CHECKBOX_NO');
        }

        $row->AddViewField($this->getCode(), $value);
    }

    /**
     * @inheritdoc
     */
    public function showFilterHtml()
    {
        $filterHtml = '<tr>';
        $filterHtml .= '<td>' . $this->getSettings('TITLE') . '</td>';
        $filterHtml .= '<td> <select  name="' . $this->getFilterInputName() . '">';
        $filterHtml .= '<option value=""></option>';

        $modeType = $this->getCheckboxType();

        $langYes = Loc::getMessage('DIGITALWAND_AH_CHECKBOX_YES');
        $langNo = Loc::getMessage('DIGITALWAND_AH_CHECKBOX_NO');

        switch ($modeType) {
            case self::TYPE_STRING: {

This code seems to be duplicated across your project.

case statements should be defined using a colon.

                $filterHtml .= '<option value="' . self::TYPE_STRING_YES . '">' . $langYes . '</option>';
                $filterHtml .= '<option value="' . self::TYPE_STRING_NO . '">' . $langNo . '</option>';
                break;
            }
            case self::TYPE_INT:
            case self::TYPE_BOOLEAN: {

This code seems to be duplicated across your project.

case statements should be defined using a colon.

                $filterHtml .= '<option value="' . self::TYPE_INT_YES . '">' . $langYes . '</option>';
                $filterHtml .= '<option value="' . self::TYPE_INT_NO . '">' . $langNo . '</option>';
                break;
            }
        }

        $filterHtml .= '</select></td>';
        $filterHtml .= '</tr>';

        print $filterHtml;
    }

    /**
     * @inheritdoc
     */
    public function getValueReadonly()
    {
        $code = $this->getCode();
        $value = isset($this->data[$code]) ? $this->data[$code] : null;
        $modeType = $this->getCheckboxType();

        switch ($modeType) {
            case static::TYPE_STRING: {

case statements should be defined using a colon.

                $value = $value == 'Y' ? Loc::getMessage('DIGITALWAND_AH_CHECKBOX_YES') : Loc::getMessage('DIGITALWAND_AH_CHECKBOX_NO');
                break;
            }
            case static::TYPE_INT:
            case static::TYPE_BOOLEAN: {

case statements should be defined using a colon.

                $value = $value ? Loc::getMessage('DIGITALWAND_AH_CHECKBOX_YES') : Loc::getMessage('DIGITALWAND_AH_CHECKBOX_NO');
                break;
            }
        }

        return static::prepareToOutput($value);
    }

    /**
     * @inheritdoc
     */
    public function processEditAction()
    {
        parent::processEditAction();

        if ($this->getCheckboxType() === static::TYPE_BOOLEAN) {
            $this->data[$this->getCode()] = (bool)$this->data[$this->getCode()];
        }
    }

    /**
     * @inheritdoc
     */
    protected function getEditHtml()
    {
        $html = '';

        $modeType = $this->getCheckboxType();

        switch ($modeType) {
            case static::TYPE_STRING: {

This code seems to be duplicated across your project.

case statements should be defined using a colon.

                $checked = $this->getValue() == self::TYPE_STRING_YES ? 'checked' : '';

                $html = '<input type="hidden" name="' . $this->getEditInputName() . '" value="' . self::TYPE_STRING_NO . '" />';
                $html .= '<input type="checkbox" name="' . $this->getEditInputName() . '" value="' . self::TYPE_STRING_YES . '" ' . $checked . ' />';
                break;
            }
            case static::TYPE_INT:
            case static::TYPE_BOOLEAN: {

This code seems to be duplicated across your project.

case statements should be defined using a colon.

                $checked = $this->getValue() == self::TYPE_INT_YES ? 'checked' : '';

                $html = '<input type="hidden" name="' . $this->getEditInputName() . '" value="' . self::TYPE_INT_NO . '" />';
                $html .= '<input type="checkbox" name="' . $this->getEditInputName() . '" value="' . self::TYPE_INT_YES . '" ' . $checked . ' />';
                break;
            }
        }

        return $html;
    }

    /**
     * Получить тип чекбокса по типу поля.
     * По-умолчанию возвращает TYPE_STRING
     * @return mixed
     */
    public function getCheckboxType()
    {
        $settingsFieldType = $this->getSettings('FIELD_TYPE');
        $checkTypes = array(static::TYPE_STRING, static::TYPE_BOOLEAN, static::TYPE_INT);
        $columnName = $this->getCode();

        if ($settingsFieldType AND in_array($settingsFieldType, $checkTypes)) {

Using logical operators such as and instead of && is generally not recommended.

            return $settingsFieldType;

        } else {
            $entity = $this->getEntityName();
            $entityMap = $entity::getMap();

            if (!isset($entityMap[$columnName])) {
                foreach ($entityMap as $field/** @var \Bitrix\Main\Entity\ScalarField $field */) {
                    if($field instanceof \Bitrix\Main\Entity\ReferenceField)
                        continue;
                    if (is_object($field) AND $field->getColumnName() === $columnName) {

Using logical operators such as and instead of && is generally not recommended.

                        return $field->getDataType(); //FIXME: deprecated? На что нужно заменить?
                    }
                }

            } elseif (isset($entityMap[$columnName]['values']) AND

Using logical operators such as and instead of && is generally not recommended.

                is_array($entityMap[$columnName]['values']) AND

Using logical operators such as and instead of && is generally not recommended.

                count($entityMap[$columnName]['values']) == 2
            ) {
                $value = reset($entityMap[$columnName]['values']);
                if (is_string($value)) {
                    return static::TYPE_STRING;
                } elseif (is_bool($value) OR is_integer($value)) {

Using logical operators such as or instead of || is generally not recommended.

                    return static::TYPE_BOOLEAN;
                }

            } elseif (isset($entityMap[$columnName]['data_type'])) {
                return $entityMap[$columnName]['data_type'];

            }

            /**
             * Теоретически, рзработчик мог ввести полную хрень, указывая варианты значений для сущности
             * В этом случае ни одна проверка выше не сработает.
             * FIXME: а нужен ли эксепшн?
             */
//            throw new \Bitrix\Main\ArgumentTypeException("Unknown checkbox type");

60% of this comment could be valid code. Did you maybe forget this after debugging?

        }

        return static::TYPE_STRING;
    }
}