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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 <?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\Validators\BuiltIn;
use InvalidArgumentException;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Interfaces\Validators\ValidatorInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
use Maslosoft\Mangan\Validators\Traits\AllowEmpty;
use Maslosoft\Mangan\Validators\Traits\Messages;
use Maslosoft\Mangan\Validators\Traits\OnScenario;
use Maslosoft\Mangan\Validators\Traits\Safe;
use Maslosoft\Mangan\Validators\Traits\SkipOnError;
use Maslosoft\Mangan\Validators\Traits\Strict;
/**
* CompareValidator
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class CompareValidator implements ValidatorInterface
{
use AllowEmpty,
Messages,
Strict,
OnScenario,
Safe,
SkipOnError;
/**
* @var string the name of the attribute to be compared with
*/
public $compareAttribute;
/**
* @var string the constant value to be compared with
*/
public $compareValue;
/**
* @var string the operator for comparison. Defaults to '='.
* The followings are valid operators:
* <ul>
* <li>'=' or '==': validates to see if the two values are equal. If {@link strict} is true, the comparison
* will be done in strict mode (i.e. checking value type as well).</li>
* <li>'!=': validates to see if the two values are NOT equal. If {@link strict} is true, the comparison
* will be done in strict mode (i.e. checking value type as well).</li>
* <li>'>': validates to see if the value being validated is greater than the value being compared with.</li>
* <li>'>=': validates to see if the value being validated is greater than or equal to the value being compared with.</li>
* <li>'<': validates to see if the value being validated is less than the value being compared with.</li>
* <li>'<=': validates to see if the value being validated is less than or equal to the value being compared with.</li>
* </ul>
*/
public $operator = '=';
/**
* @Label('{attribute} must be repeated exactly')
* @var string
*/
public $msgRepeat = '';
/**
* @Label('{attribute} must not be equal to "{compareValue}"')
* @var string
*/
public $msgEq = '';
/**
* @Label('{attribute} must be greater than "{compareValue}"')
* @var string
*/
public $msgGt = '';
/**
* @Label('{attribute} must be greater than or equal to "{compareValue}"')
* @var string
*/
public $msgGte = '';
/**
* @Label('{attribute} must be less than "{compareValue}"')
* @var string
*/
public $msgLt = '';
/**
* @Label('{attribute} must be less than or equal to "{compareValue}"')
* @var string
*/
public $msgLte = '';
public function isValid(AnnotatedInterface $model, $attribute)
{
$value = $model->$attribute;
if ($this->allowEmpty && empty($value))
{
return true;
}
$label = ManganMeta::create($model)->field($attribute)->label;
if ($this->compareValue !== null)
{
$compareLabel = $compareValue = $this->compareValue;
}
else
{
$compareAttribute = $this->compareAttribute === null ? $attribute . '_repeat' : $this->compareAttribute;
$compareValue = $model->$compareAttribute;
$compareLabel = ManganMeta::create($model)->field($compareAttribute)->label;
}
switch ($this->operator)
{
case '=':
case '==':
if (($this->strict && $value !== $compareValue) || (!$this->strict && $value != $compareValue))
{
$this->addError('msgRepeat', ['{attribute}' => $compareLabel]);
return false;
}
break;
case '!=':
if (($this->strict && $value === $compareValue) || (!$this->strict && $value == $compareValue))
{
$this->addError('msgEq', ['{attribute}' => $label, '{compareValue}' => $compareValue]);
return false;
}
break;
case '>':
if ($value <= $compareValue)
{
$this->addError('msgGt', ['{attribute}' => $label, '{compareValue}' => $compareValue]);
return false;
}
break;
case '>=':
if ($value < $compareValue)
{
$this->addError('msgGte', ['{attribute}' => $label, '{compareValue}' => $compareValue]);
return false;
}
break;
case '<':
if ($value >= $compareValue)
{
$this->addError('msgLt', ['{attribute}' => $label, '{compareValue}' => $compareValue]);
return false;
}
break;
case '<=':
if ($value > $compareValue)
{
$this->addError('msgLte', ['{attribute}' => $label, '{compareValue}' => $compareValue]);
return false;
}
break;
default:
$msg = sprintf('Invalid operator `%s` on attribute `%s` of model `%s`', $this->operator, $attribute, get_class($model));
throw new InvalidArgumentException($msg);
}
return true;
}
}
API documentation generated by ApiGen