No error displayed for checkbox

koxu1996 commented 5 years ago

What steps will reproduce the problem?

Create form that require accepting checkbox. Example:

use yii\base\DynamicModel;
use yii\bootstrap4\ActiveForm;
$model = new DynamicModel(['text_field' => '', 'checkbox_field' => '']);
$model->addRule('text_field', 'required', ['requiredValue' => '1'])
        ->addRule('checkbox_field', 'required', ['requiredValue' => '1'])
        ->validate();
print_r($model->getErrors());
$form = ActiveForm::begin();
echo $form->field($model, 'text_field');
echo $form->field($model, 'checkbox_field')->checkBox();
ActiveForm::end();

What's expected?

Error message for required checkbox should be displayed.

What do you get instead?

There is no error for checkbox field: issue

However client-side validation works, so after filling form you get: cs-ok After un-filling form: cs-error

Additional info

Name	Version
yiisoft/yii2	2.0.25
yiisoft/yii2-bootstrap4	2.0.7
PHP	7.3.9

ruskid commented 4 years ago

Looks like is-invalid class doesn't apply to the checkbox

ActiveField's checkbox and radio function should look like this:

public function checkbox($options = [], $enclosedByLabel = true)
    {
        if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
            $this->addErrorClassIfNeeded($options);
        }

        $this->addAriaAttributes($options);
        $this->adjustLabelFor($options);

        if ($enclosedByLabel) {
            $this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
            $this->parts['{label}'] = '';
        } else {
            if (isset($options['label']) && !isset($this->parts['{label}'])) {
                $this->parts['{label}'] = $options['label'];
                if (!empty($options['labelOptions'])) {
                    $this->labelOptions = $options['labelOptions'];
                }
            }
            unset($options['labelOptions']);
            $options['label'] = null;
            $this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
        }

        return $this;
    }

Currently addErrorClassIfNeeded is called after printing the checkbox.

smigles commented 4 years ago

Also no error is for checkboxList with a custom validation rule.

The part of the model:

public function rules()
{
    return [
        ['categories', 'validateCategoryCount'],
    ];
}

public function validateCategoryCount($attribute, $params)
{
    if (!is_array($this->$attribute)) {
        $this->addError($attribute, 'Некорректное значение.');
    } elseif (count($this->$attribute) > 3) {
        $this->addError($attribute, 'Должно быть выбрано не более 3 категорий.');
    }
}

The part of the view:

<?= $form->field($model, 'categories')->checkboxList($categories) ?>

The screenshot from Firefox Page Inspector:

Gray color is for hidden elements.

alexgivi commented 4 years ago

I've fixed this bug such way:

create AcriveField class, inherit from \yii\bootstrap4\ActiveField.

implement checkbox method such way:

public function checkbox($options = [], $enclosedByLabel = false)
{
    Html::addCssClass($options, 'custom-control-input');
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }

    return parent::checkbox($options, $enclosedByLabel); // TODO: Change the autogenerated stub
}

when create ActiveForm instance - pass 'fieldClass' config option as your new ActiveField class name.
```
$form = ActiveForm::begin([
    'fieldClass' => \app\widgets\ActiveField::class,
    // ...
]);
```