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
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2019 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
abstract class CValidator {
/**
* Name of the object that can be used in error message. If it is set, it will replace the %1$s placeholder and
* all other places holders will be shifted by +1.
*
* @var string
*/
protected $objectName;
/**
* Validation errors.
*
* @var array
*/
private $error;
public function __construct(array $options = []) {
// set options
foreach ($options as $key => $value) {
$this->$key = $value;
}
}
/**
* Returns true if the given $value is valid, or set's an error and returns false otherwise.
*
* @abstract
*
* @param $value
*
* @return bool
*/
abstract public function validate($value);
/**
* Get first validation error.
*
* @return string
*/
public function getError() {
return $this->error;
}
/**
* Add validation error.
*
* @param $error
*/
protected function setError($error) {
$this->error = $error;
}
/**
* @param string $name
*/
public function setObjectName($name) {
$this->objectName = $name;
}
/**
* Throws an exception when trying to set an unexisting validator option.
*
* @param $name
* @param $value
*
* @throws Exception
*/
public function __set($name, $value) {
throw new Exception(sprintf('Incorrect option "%1$s" for validator "%2$s".', $name, get_class($this)));
}
/**
* Adds a validation error with custom parameter support. The value of $objectName will be passed as the
* first parameter.
*
* @param string $message Message optionally containing placeholders to substitute.
* @param mixed $param Unlimited number of optional parameters to replace sequential placeholders.
*
* @return string
*/
protected function error($message) {
$arguments = array_slice(func_get_args(), 1);
if ($this->objectName !== null) {
array_unshift($arguments, $this->objectName);
}
$this->setError(vsprintf($message, $arguments));
}
/**
* Returns string representation of a variable.
*
* @param mixed $value
* @return string
*/
protected function stringify($value) {
if (is_bool($value)) {
return $value ? 'true' : 'false';
}
elseif (is_null($value)) {
return 'null';
}
elseif (is_object($value)) {
return get_class($value);
}
elseif (is_scalar($value)) {
return (string)$value;
}
else {
return gettype($value);
}
}
}
|