HexValidator
extends Validator
in package
Defines a Validator that checks if a given value is a valid hexadecimal value.
Table of Contents
Constants
- HEX_PREFIX = '0x'
Properties
- $allow_hex_prefix : bool
- $bytes : int
- $field_context : Field|null
- $model_context : Model|null
- $__log_level : int
- $expected_length : int
Methods
- __construct() : mixed
- Constructs the HexValidator object.
- get_class_fqn() : string
- Obtains the fully qualified name of the called class.
- get_class_shortname() : string
- Obtains the shortname of the called class.
- get_classes_in_namespace() : array<string|int, mixed>
- Obtains all classes associated with this class's current namespace.
- log() : void
- Writes a log entry to the applicable log file
- validate() : void
- Checks if a given value is a valid hexadecimal value of the provide byte length.
- set_label() : mixed
- Sets a label on the assigned $field_context if present.
Constants
HEX_PREFIX
public
mixed
HEX_PREFIX
= '0x'
Tags
Properties
$allow_hex_prefix
public
bool
$allow_hex_prefix
= true
$bytes
public
int
$bytes
$field_context
public
Field|null
$field_context
= null
The parent Model Field object that called this Validator.
$model_context
public
Model|null
$model_context
= null
The parent Model object that called this Validator.
$__log_level
private
static int
$__log_level
$expected_length
private
int
$expected_length
The maximum character length the hexadecimal value can have. This value is determined by the assigned $bytes value. This is generally twice the $bytes value.
Methods
__construct()
Constructs the HexValidator object.
public
__construct(int $bytes[, bool $allow_hex_prefix = true ]) : mixed
Parameters
- $bytes : int
-
The expected byte length of the hexadecimal value. Set to 0 to allow hex values of any length.
- $allow_hex_prefix : bool = true
-
Set to true to allow the hex prefix (0x) to be present in the value.
get_class_fqn()
Obtains the fully qualified name of the called class.
public
static get_class_fqn() : string
Return values
string —The FQN for this object's class.
get_class_shortname()
Obtains the shortname of the called class.
public
static get_class_shortname() : string
Return values
string —The shortname for this object's class.
get_classes_in_namespace()
Obtains all classes associated with this class's current namespace.
public
get_classes_in_namespace([bool $shortnames = false ]) : array<string|int, mixed>
Parameters
- $shortnames : bool = false
Return values
array<string|int, mixed> —An array of classes currently in this object's namespace
log()
Writes a log entry to the applicable log file
public
static log(int $level, string $message[, string $logfile = 'restapi' ]) : void
Parameters
- $level : int
-
The log level to write. This should be one of the LOG_* constants defined by syslog.
- $message : string
-
The message to write to the log file.
- $logfile : string = 'restapi'
-
The log file to write to. This must be a valid logging facility defined in the package's info.xml file.
validate()
Checks if a given value is a valid hexadecimal value of the provide byte length.
public
validate(mixed $value[, string $field_name = '' ]) : void
Parameters
- $value : mixed
-
The incoming value to be validated.
- $field_name : string = ''
-
The name of the field being validated.
Tags
set_label()
Sets a label on the assigned $field_context if present.
protected
set_label(string $label_name) : mixed
Parameters
- $label_name : string
-
The label to assign to the Field context object