HumHub Documentation (unofficial)

Date extends AbstractValidator
in package

Application

Validates that a given value is a DateTime instance or can be converted into one.

Constants

FALSEFORMAT = 'dateFalseFormat'
FORMAT_DEFAULT = 'Y-m-d': Default format constant
INVALID = 'dateInvalid'
INVALID_DATE = 'dateInvalidDate'

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
$format : string
$messageLength : int: Limits the maximum returned length of an error message
$messageTemplates : array<string|int, string>: Validation failure message template definitions
$messageVariables : array<string|int, string>
$strict : bool
$value : mixed: The value to be validated

Methods

__construct() : mixed: Sets validator options
__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
getFormat() : string: Returns the format 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
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?
isStrict() : bool
isTranslatorEnabled() : bool: Is translation enabled?
isValid() : bool: Returns true if $value is a DateTimeInterface instance or can be converted into one.
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
setFormat() : $this: Sets the format 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.
setOptions() : $this: Sets one or multiple options
setStrict() : self
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
convertArray() : false|DateTime: Implodes the array into a string and proxies to {@link convertString()}.
convertDouble() : false|DateTime: Attempts to convert an double into a DateTime object
convertInteger() : false|DateTime: Attempts to convert an integer into a DateTime object
convertString() : false|DateTime: Attempts to convert a string into a DateTime object
convertToDateTime() : false|DateTime: Attempts to convert an int, string, or array to a DateTime object
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

FALSEFORMAT


    public
        mixed
    FALSEFORMAT
    = 'dateFalseFormat'

FORMAT_DEFAULT

Default format constant


    public
        mixed
    FORMAT_DEFAULT
    = 'Y-m-d'

INVALID


    public
        mixed
    INVALID
    = 'dateInvalid'

INVALID_DATE


    public
        mixed
    INVALID_DATE
    = 'dateInvalidDate'

$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'

$format


    protected
        string
    $format
     = self::FORMAT_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|int, string>
    $messageTemplates
     = [self::INVALID => 'Invalid type given. String, integer, array or DateTime expected', self::INVALID_DATE => 'The input does not appear to be a valid date', self::FALSEFORMAT => "The input does not fit the date format '%format%'"]

$messageVariables


    protected
        array<string|int, string>
    $messageVariables
     = ['format' => 'format']

$strict


    protected
        bool
    $strict
     = false

$value

The value to be validated


    protected
        mixed
    $value

__construct()

Sets validator options


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

Parameters

$options : string|array<string|int, mixed>|Traversable = []: OPTIONAL

__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

getFormat()

Returns the format option


    public
                    getFormat() : string

Return values

string

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>

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

isStrict()


    public
                    isStrict() : bool

Return values

bool

isTranslatorEnabled()

Is translation enabled?


    public
                    isTranslatorEnabled() : bool

Return values

bool

isValid()

Returns true if $value is a DateTimeInterface instance or can be converted into one.


    public
                    isValid(string|(numeric)|array<string|int, mixed>|DateTimeInterface $value) : bool

Parameters

$value : string|(numeric)|array<string|int, mixed>|DateTimeInterface

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'

setFormat()

Sets the format option


    public
                    setFormat([string|null $format = self::FORMAT_DEFAULT ]) : $this

Format cannot be null. It will always default to 'Y-m-d', even if null is provided.

Parameters

$format : string|null = self::FORMAT_DEFAULT

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

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

setStrict()


    public
                    setStrict(bool $strict) : self

Parameters

$strict : bool

Return values

self

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

convertArray()

Implodes the array into a string and proxies to {@link convertString()}.


    protected
                    convertArray(array<string|int, mixed> $value[, bool $addErrors = true ]) : false|DateTime

Parameters

$value : array<string|int, mixed>
$addErrors : bool = true

Return values

false|DateTime

convertDouble()

Attempts to convert an double into a DateTime object


    protected
                    convertDouble(float $value) : false|DateTime

Parameters

$value : float

Return values

false|DateTime

convertInteger()

Attempts to convert an integer into a DateTime object


    protected
                    convertInteger(int $value) : false|DateTime

Parameters

$value : int

Return values

false|DateTime

convertString()

Attempts to convert a string into a DateTime object


    protected
                    convertString(string $value[, bool $addErrors = true ]) : false|DateTime

Parameters

$value : string
$addErrors : bool = true

Return values

false|DateTime

convertToDateTime()

Attempts to convert an int, string, or array to a DateTime object


    protected
                    convertToDateTime(string|(numeric)|array<string|int, mixed>|DateTimeInterface $param[, bool $addErrors = true ]) : false|DateTime

Parameters

$param : string|(numeric)|array<string|int, mixed>|DateTimeInterface
$addErrors : bool = true

Return values

false|DateTime

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

Date extends AbstractValidator in package Application

Table of Contents

Constants

Properties

Methods

Constants

FALSEFORMAT

FORMAT_DEFAULT

INVALID

INVALID_DATE

Properties

$messageTemplates

$messageVariables

$options

$abstractOptions

$defaultTranslator

$defaultTranslatorTextDomain

$format

$messageLength

$messageTemplates

$messageVariables

$strict

$value

Methods

__construct()

Parameters

__get()

Parameters

Tags

__invoke()

Parameters

Return values

getDefaultTranslator()

Return values

getDefaultTranslatorTextDomain()

Return values

getFormat()

Return values

getMessageLength()

Return values

getMessages()

Return values

getMessageTemplates()

Return values

getMessageVariables()

Return values

getOption()

Parameters

Tags

Return values

getOptions()

Return values

getTranslator()

Return values

getTranslatorTextDomain()

Return values

hasDefaultTranslator()

Return values

hasTranslator()

Return values

isStrict()

Return values

isTranslatorEnabled()

Return values

isValid()

Parameters

Return values

isValueObscured()

Return values

setDefaultTranslator()

Parameters

Tags

setDefaultTranslatorTextDomain()

Date extends AbstractValidator
in package

Application