Maslosoft Mangan API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Annotations\Validators;
use Maslosoft\Addendum\Helpers\ParamsExpander;
use Maslosoft\Mangan\Annotations\Validators\ValidatorAnnotation;
use Maslosoft\Mangan\Meta\ValidatorMeta;
use Maslosoft\Mangan\Validators\Proxy\BooleanProxy;
use Maslosoft\Mangan\Validators\Traits\AllowEmpty;
use Maslosoft\Mangan\Validators\Traits\Strict;
/**
* BooleanValidator validates that the attribute value is either {@link trueValue} or {@link falseValue}.
*
* When using the {@link message} property to define a custom error message, the message
* may contain additional placeholders that will be replaced with the actual content. In addition
* to the "{attribute}" placeholder, recognized by all validators (see {@link Validator}),
* BooleanValidator allows for the following placeholders to be specified:
* <ul>
* <li>{true}: replaced with value representing the true status {@link trueValue}.</li>
* <li>{false}: replaced with value representing the false status {@link falseValue}.</li>
* </ul>
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
* @package system.validators
*/
class BooleanValidatorAnnotation extends ValidatorAnnotation
{
use Strict,
AllowEmpty;
/**
* @var mixed the value representing true status. Defaults to '1'.
*/
public $trueValue = '1';
/**
* @var mixed the value representing false status. Defaults to '0'.
*/
public $falseValue = '0';
public function init()
{
$this->proxy = BooleanProxy::class;
$this->getEntity()->validators[] = new ValidatorMeta(ParamsExpander::expand($this, [
'trueValue',
'falseValue',
'strict',
'allowEmpty',
'message',
'skipOnError',
'on',
'safe',
'enableClientValidation',
'except',
'proxy'
]));
}
}
API documentation generated by ApiGen