HOME

<?php

/**
 * @file classes/form/validation/FormValidatorBoolean.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class FormValidatorBoolean
 *
 * @ingroup form_validation
 *
 * @brief Form validation check that checks if the value can be
 *  interpreted as a boolean value. An empty field is considered
 *  'false', a value of '1' is considered 'true'.
 */

namespace PKP\form\validation;

class FormValidatorBoolean extends FormValidator
{
    /**
     * Constructor.
     *
     * @param \PKP\form\Form $form the associated form
     * @param string $field the name of the associated field
     * @param string $message the error message for validation failures (i18n key)
     */
    public function __construct(&$form, $field, $message)
    {
        parent::__construct($form, $field, FormValidator::FORM_VALIDATOR_OPTIONAL_VALUE, $message);
    }


    //
    // Public methods
    //
    /**
     * Value is valid if it is empty (false) or has
     * value '1' (true). This assumes checkbox
     * behavior in the form.
     *
     * @see FormValidator::isValid()
     *
     * @return bool
     */
    public function isValid()
    {
        $value = $this->getFieldValue();
        $form = & $this->getForm();
        if (empty($value) || $value == 'on') {
            // Make sure that the form will contain a real
            // boolean value after validation.
            $value = ($value == 'on' ? true : false);
            $form->setData($this->getField(), $value);
            return true;
        } elseif ($value === '1' || $value === '0') {
            $value = ($value === '1' ? true : false);
            $form->setData($this->getField(), $value);
            return true;
        } else {
            return false;
        }
    }
}

if (!PKP_STRICT_MODE) {
    class_alias('\PKP\form\validation\FormValidatorBoolean', '\FormValidatorBoolean');
}