HumHub Documentation (unofficial)

DateStep extends Date

in package

• Application

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

Table of Contents

Constants

FALSEFORMAT  = 'dateFalseFormat'

FORMAT_DEFAULT  = \DateTime::ISO8601

Default format constant

INVALID  = 'dateInvalid'

INVALID_DATE  = 'dateInvalidDate'

NOT_STEP  = 'dateStepNotStep'

Validity constants

Properties

$messageTemplates  : array<string, string>

$messageVariables  : array<string, mixed>

$options  : array<string, mixed>

$abstractOptions  : AbstractOptions|array<string, mixed>

$baseValue  : string|int|DateTimeInterface

Optional base date value

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

$step  : DateInterval

Date step interval (defaults to 1 day).

$strict  : bool

$timezone  : DateTimeZone

Optional timezone to be used when the baseValue and validation values do not contain timezone info

$value  : mixed

The value to be validated

Methods

__construct()  : mixed

Set default options for this instance

__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

getBaseValue()  : string|int|DateTimeInterface

Returns the base value from which the step should be computed

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

getStep()  : DateInterval

Returns the step date interval

getTimezone()  : DateTimeZone

Returns the timezone option

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 a date is within a valid step

isValueObscured()  : bool

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

setBaseValue()  : $this

Sets the base value from which the step should be computed

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

setStep()  : $this

Sets the step date interval

setStrict()  : self

setTimezone()  : $this

Sets the timezone option

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()  : DateTime|false

Supports formats with ISO week (W) definitions

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

computeDiffMinSeconds()  : int

Get lower bound of difference in secondss Converts a given `$diffParts` array into seconds

computeIntervalMaxSeconds()  : int

Get upper bound of the given interval in seconds Converts a given `$intervalParts` array into seconds

computeMinimumInterval()  : DateInterval

Computes minimum interval to use for iterations while checking steps

computeMinStepAndRequiredIterations()  : array<string|int, int>

computeMinSteps()  : float|int

Multiply the step interval by the lower bound of steps to reach the target

fallbackIncrementalIterationLogic()  : bool

Fall back to slower (but accurate) method for complex intervals.