HumHub Documentation (unofficial)

Between extends AbstractValidator
in package

Application

Constants

NOT_BETWEEN = 'notBetween'
NOT_BETWEEN_STRICT = 'notBetweenStrict'
VALUE_NOT_NUMERIC = 'valueNotNumeric'
VALUE_NOT_STRING = 'valueNotString'

Properties

$messageTemplates : array<string, string>
$messageVariables : array<string, mixed>
$options : array<string, mixed>
$abstractOptions : AbstractOptions|array<string, mixed>
$defaultTranslator : TranslatorInterface: Default translation object for all validate objects
$defaultTranslatorTextDomain : string: Default text domain to be used with translator
$messageLength : int: Limits the maximum returned length of an error message
$messageTemplates : array<string, string>: Validation failure message template definitions
$messageVariables : array<string|int, mixed>: Additional variables available for validation failure messages
$options : array<string|int, mixed>: Options for the between validator
$value : mixed: The value to be validated
$numeric : bool|null: Retain if min and max are numeric values. Allow to not compare string and numeric types

Methods

__construct() : mixed: Sets validator options Accepts the following option keys: 'min' => scalar, minimum border 'max' => scalar, maximum border 'inclusive' => boolean, inclusive border values
__get() : mixed: Magic function returns the value of the requested property, if and only if it is the value or a message variable.
__invoke() : bool: Invoke as command
getDefaultTranslator() : TranslatorInterface|null: Get default translation object for all validate objects
getDefaultTranslatorTextDomain() : string: Get default translation text domain for all validate objects
getInclusive() : bool: Returns the inclusive option
getMax() : mixed: Returns the max option
getMessageLength() : int: Returns the maximum allowed message length
getMessages() : array<string, string>: Returns array of validation failure messages
getMessageTemplates() : array<string, string>: Returns the message templates from the validator
getMessageVariables() : array<int, string>: Returns an array of the names of variables that are used in constructing validation failure messages
getMin() : mixed: Returns the min option
getOption() : mixed: Returns an option
getOptions() : array<string, mixed>: Returns all available options
getTranslator() : TranslatorInterface|null: Return translation object
getTranslatorTextDomain() : string: Return the translation text domain
hasDefaultTranslator() : bool: Is there a default translation object set?
hasTranslator() : bool: Does this validator have its own specific translator?
isTranslatorEnabled() : bool: Is translation enabled?
isValid() : bool: Returns true if and only if $value is between min and max options, inclusively if inclusive option is true.
isValueObscured() : bool: Retrieve flag indicating whether or not value should be obfuscated in messages
setDefaultTranslator() : void: Set default translation object for all validate objects
setDefaultTranslatorTextDomain() : void: Set default translation text domain for all validate objects
setInclusive() : $this: Sets the inclusive option
setMax() : $this: Sets the max option
setMessage() : $this: Sets the validation failure message template for a particular key
setMessageLength() : void: Sets the maximum allowed message length
setMessages() : $this: Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
setMin() : $this: Sets the min option
setOptions() : $this: Sets one or multiple options
setTranslator() : $this: Set translation object
setTranslatorEnabled() : $this: Indicate whether or not translation should be enabled
setTranslatorTextDomain() : $this: Set translation text domain
setValueObscured() : $this: Set flag indicating whether or not value should be obfuscated in messages
createMessage() : null|string: Constructs and returns a validation failure message with the given message key and value.
error() : void
getValue() : mixed: Returns the validation value
setValue() : void: Sets the value to be validated and clears the messages and errors arrays
translateMessage() : string: Translate a validation message

NOT_BETWEEN


    public
        mixed
    NOT_BETWEEN
    = 'notBetween'

NOT_BETWEEN_STRICT


    public
        mixed
    NOT_BETWEEN_STRICT
    = 'notBetweenStrict'

VALUE_NOT_NUMERIC


    public
        mixed
    VALUE_NOT_NUMERIC
    = 'valueNotNumeric'

VALUE_NOT_STRING


    public
        mixed
    VALUE_NOT_STRING
    = 'valueNotString'

$messageTemplates


    public
        array<string, string>
    $messageTemplates

$messageVariables


    public
        array<string, mixed>
    $messageVariables

$options


    public
        array<string, mixed>
    $options

$abstractOptions


    protected
        AbstractOptions|array<string, mixed>
    $abstractOptions
     = [
    'messages' => [],
    // Array of validation failure messages
    'messageTemplates' => [],
    // Array of validation failure message templates
    'messageVariables' => [],
    // Array of additional variables available for validation failure messages
    'translator' => null,
    // Translation object to used -> Translator\TranslatorInterface
    'translatorTextDomain' => null,
    // Translation text domain
    'translatorEnabled' => true,
    // Is translation enabled?
    'valueObscured' => false,
]

$defaultTranslator

Default translation object for all validate objects


    protected
    static    TranslatorInterface
    $defaultTranslator

$defaultTranslatorTextDomain

Default text domain to be used with translator


    protected
    static    string
    $defaultTranslatorTextDomain
     = 'default'

$messageLength

Limits the maximum returned length of an error message


    protected
    static    int
    $messageLength
     = -1

$messageTemplates

Validation failure message template definitions


    protected
        array<string, string>
    $messageTemplates
     = [self::NOT_BETWEEN => "The input is not between '%min%' and '%max%', inclusively", self::NOT_BETWEEN_STRICT => "The input is not strictly between '%min%' and '%max%'", self::VALUE_NOT_NUMERIC => "The min ('%min%') and max ('%max%') values are numeric, but the input is not", self::VALUE_NOT_STRING => "The min ('%min%') and max ('%max%') values are non-numeric strings, " . 'but the input is not a string']

$messageVariables

Additional variables available for validation failure messages


    protected
        array<string|int, mixed>
    $messageVariables
     = ['min' => ['options' => 'min'], 'max' => ['options' => 'max']]

$options

Options for the between validator


    protected
        array<string|int, mixed>
    $options
     = [
    'inclusive' => true,
    // Whether to do inclusive comparisons, allowing equivalence to min and/or max
    'min' => 0,
    'max' => \PHP_INT_MAX,
]

$value

The value to be validated


    protected
        mixed
    $value

$numeric

Retain if min and max are numeric values. Allow to not compare string and numeric types


    private
        bool|null
    $numeric
     = null

__construct()

Sets validator options Accepts the following option keys: 'min' => scalar, minimum border 'max' => scalar, maximum border 'inclusive' => boolean, inclusive border values


    public
                    __construct([array<string, mixed>|Traversable<string, mixed> $options = null ]) : mixed

Parameters

$options : array<string, mixed>|Traversable<string, mixed> = null

__get()

Magic function returns the value of the requested property, if and only if it is the value or a message variable.


    public
                    __get(string $property) : mixed

Parameters

$property : string

__invoke()

Invoke as command


    public
                    __invoke(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

getDefaultTranslator()

Get default translation object for all validate objects


    public
            static        getDefaultTranslator() : TranslatorInterface|null

Return values

TranslatorInterface|null

getDefaultTranslatorTextDomain()

Get default translation text domain for all validate objects


    public
            static        getDefaultTranslatorTextDomain() : string

Return values

string

getInclusive()

Returns the inclusive option


    public
                    getInclusive() : bool

Return values

bool

getMax()

Returns the max option


    public
                    getMax() : mixed

getMessageLength()

Returns the maximum allowed message length


    public
            static        getMessageLength() : int

Return values

int

getMessages()

Returns array of validation failure messages


    public
                    getMessages() : array<string, string>

Return values

array<string, string>

getMessageTemplates()

Returns the message templates from the validator


    public
                    getMessageTemplates() : array<string, string>

Return values

array<string, string>

getMessageVariables()

Returns an array of the names of variables that are used in constructing validation failure messages


    public
                    getMessageVariables() : array<int, string>

Return values

array<int, string>

getMin()

Returns the min option


    public
                    getMin() : mixed

getOption()

Returns an option


    public
                    getOption(string $option) : mixed

Parameters

$option : string: Option to be returned

Return values

mixed —

Returned option

getOptions()

Returns all available options


    public
                    getOptions() : array<string, mixed>

Return values

array<string, mixed> —

Array with all available options

getTranslator()

Return translation object


    public
                    getTranslator() : TranslatorInterface|null

Return values

TranslatorInterface|null

getTranslatorTextDomain()

Return the translation text domain


    public
                    getTranslatorTextDomain() : string

Return values

string

hasDefaultTranslator()

Is there a default translation object set?


    public
            static        hasDefaultTranslator() : bool

Return values

bool

hasTranslator()

Does this validator have its own specific translator?


    public
                    hasTranslator() : bool

Return values

bool

isTranslatorEnabled()

Is translation enabled?


    public
                    isTranslatorEnabled() : bool

Return values

bool

isValid()

Returns true if and only if $value is between min and max options, inclusively if inclusive option is true.


    public
                    isValid(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

isValueObscured()

Retrieve flag indicating whether or not value should be obfuscated in messages


    public
                    isValueObscured() : bool

Return values

bool

setDefaultTranslator()

Set default translation object for all validate objects


    public
            static        setDefaultTranslator([TranslatorInterface|null $translator = null ][, string $textDomain = null ]) : void

Parameters

$translator : TranslatorInterface|null = null
$textDomain : string = null: (optional)

setDefaultTranslatorTextDomain()

Set default translation text domain for all validate objects


    public
            static        setDefaultTranslatorTextDomain([string $textDomain = 'default' ]) : void

Parameters

$textDomain : string = 'default'

setInclusive()

Sets the inclusive option


    public
                    setInclusive(bool $inclusive) : $this

Parameters

$inclusive : bool

Return values

$this —

Provides a fluent interface

setMax()

Sets the max option


    public
                    setMax(mixed $max) : $this

Parameters

$max : mixed

Return values

$this —

Provides a fluent interface

setMessage()

Sets the validation failure message template for a particular key


    public
                    setMessage(string $messageString[, string|null $messageKey = null ]) : $this

Parameters

$messageString : string
$messageKey : string|null = null: OPTIONAL

Return values

$this —

Provides a fluent interface

setMessageLength()

Sets the maximum allowed message length


    public
            static        setMessageLength([int $length = -1 ]) : void

Parameters

$length : int = -1

setMessages()

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.


    public
                    setMessages(array<string, string> $messages) : $this

Parameters

$messages : array<string, string>

Return values

$this

setMin()

Sets the min option


    public
                    setMin(mixed $min) : $this

Parameters

$min : mixed

Return values

$this —

Provides a fluent interface

setOptions()

Sets one or multiple options


    public
                    setOptions([array<string, mixed>|Traversable<string, mixed> $options = [] ]) : $this

Parameters

$options : array<string, mixed>|Traversable<string, mixed> = []: Options to set

Return values

$this —

Provides fluid interface

setTranslator()

Set translation object


    public
                    setTranslator([TranslatorInterface|null $translator = null ][, string $textDomain = null ]) : $this

Parameters

$translator : TranslatorInterface|null = null: [optional] translator. Default is null, which sets no translator.
$textDomain : string = null: (optional)

Return values

$this

setTranslatorEnabled()

Indicate whether or not translation should be enabled


    public
                    setTranslatorEnabled([bool $enabled = true ]) : $this

Parameters

$enabled : bool = true

Return values

$this

setTranslatorTextDomain()

Set translation text domain


    public
                    setTranslatorTextDomain([string $textDomain = 'default' ]) : $this

Parameters

$textDomain : string = 'default'

Return values

$this

setValueObscured()

Set flag indicating whether or not value should be obfuscated in messages


    public
                    setValueObscured(bool $flag) : $this

Parameters

$flag : bool

Return values

$this

createMessage()

Constructs and returns a validation failure message with the given message key and value.


    protected
                    createMessage(string $messageKey, string|array<string|int, mixed>|object $value) : null|string

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters

$messageKey : string
$value : string|array<string|int, mixed>|object

Return values

null|string

error()


    protected
                    error(string|null $messageKey[, null|string|array<string|int, mixed>|object $value = null ]) : void

Parameters

$messageKey : string|null
$value : null|string|array<string|int, mixed>|object = null: OPTIONAL

getValue()

Returns the validation value


    protected
                    getValue() : mixed

Return values

mixed —

Value to be validated

setValue()

Sets the value to be validated and clears the messages and errors arrays


    protected
                    setValue(mixed $value) : void

Parameters

$value : mixed

translateMessage()

Translate a validation message


    protected
                    translateMessage(string $messageKey, string $message) : string

Parameters

$messageKey : string
$message : string

Return values

string

Between extends AbstractValidator in package Application

Table of Contents

Constants

Properties

Methods

Constants

NOT_BETWEEN

NOT_BETWEEN_STRICT

VALUE_NOT_NUMERIC

VALUE_NOT_STRING

Properties

$messageTemplates

$messageVariables

$options

$abstractOptions

$defaultTranslator

$defaultTranslatorTextDomain

$messageLength

$messageTemplates

$messageVariables

$options

$value

$numeric

Methods

__construct()

Parameters

Tags

__get()

Parameters

Tags

__invoke()

Parameters

Return values

getDefaultTranslator()

Return values

getDefaultTranslatorTextDomain()

Return values

getInclusive()

Return values

getMax()

getMessageLength()

Return values

getMessages()

Return values

getMessageTemplates()

Return values

getMessageVariables()

Return values

getMin()

getOption()

Parameters

Tags

Return values

getOptions()

Return values

getTranslator()

Return values

getTranslatorTextDomain()

Return values

hasDefaultTranslator()

Return values

hasTranslator()

Return values

isTranslatorEnabled()

Return values

isValid()

Parameters

Return values

isValueObscured()

Return values

setDefaultTranslator()

Parameters

Tags

Between extends AbstractValidator
in package

Application