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 <?php
/*
* This file is part of the ICanBoogie package.
*
* (c) Olivier Laviale <olivier.laviale@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace ICanBoogie\Validate;
/**
* Representation of a validation context.
*/
class Context
{
/**
* The attribute being validated.
*
* @var string
*/
public $attribute;
/**
* The value of the attribute being validated.
*
* @var mixed
*/
public $value;
/**
* A reader adapter.
*
* @var Reader
*/
public $reader;
/**
* The current validator.
*
* @var Validator
*/
public $validator;
/**
* The validator parameters.
*
* @var array
*/
public $validator_params = [];
/**
* The possible error message for the current validator.
*
* @var string
*/
public $message;
/**
* The arguments for the possible error message.
*
* @var array
*/
public $message_args = [];
/**
* The collected errors.
*
* @var Message[][]
*/
public $errors = [];
/**
* Retrieves a value from the reader adapter.
*
* @param string $name
*
* @return mixed|null The value, or `null` if it is not defined.
*/
public function value($name)
{
return $this->reader->read($name);
}
/**
* Retrieves a parameter from the validator parameters.
*
* @param string $name
*
* @return mixed
*
* @throws ParameterIsMissing if the parameter is not set.
*/
public function param($name)
{
if (!isset($this->validator_params[$name]))
{
throw new ParameterIsMissing(get_class($this->validator) . '::PARAM_' . strtoupper($name));
}
return $this->validator_params[$name];
}
/**
* Retrieves an option from the validator parameters.
*
* @param string $name
* @param mixed|null $default
*
* @return mixed|null The option value or `null` if it is not defined.
*/
public function option($name, $default = null)
{
return isset($this->validator_params[$name]) ? $this->validator_params[$name] : $default;
}
}