DateTime Class Reference

Public Member Functions
	__construct ($options=[])
	Constructor for the Date validator.
	setCalendar ($calendar)
	Sets the calendar to be used by the IntlDateFormatter.
	getCalendar ()
	Returns the calendar to by the IntlDateFormatter.
	setDateType ($dateType)
	Sets the date format to be used by the IntlDateFormatter.
	getDateType ()
	Returns the date format used by the IntlDateFormatter.
	setPattern ($pattern)
	Sets the pattern to be used by the IntlDateFormatter.
	getPattern ()
	Returns the pattern used by the IntlDateFormatter.
	setTimeType ($timeType)
	Sets the time format to be used by the IntlDateFormatter.
	getTimeType ()
	Returns the time format used by the IntlDateFormatter.
	setTimezone ($timezone)
	Sets the timezone to be used by the IntlDateFormatter.
	getTimezone ()
	Returns the timezone used by the IntlDateFormatter or the system default if none given.
	setLocale ($locale)
	Sets the locale to be used by the IntlDateFormatter.
	getLocale ()
	Returns the locale used by the IntlDateFormatter or the system default if none given.
	isValid ($value)
	Returns true if and only if $value is a floating-point value.
Public Member Functions inherited from AbstractValidator
	__construct ($options=null)
	Abstract constructor for all validators A validator should accept following parameters:
	getOption ($option)
	Returns an option.
	getOptions ()
	Returns all available options.
	setOptions ($options=[])
	Sets one or multiple options.
	getMessages ()
	Returns array of validation failure messages.
	__invoke ($value)
	Invoke as command.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	setMessages (array $messages)
	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.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	setValueObscured ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	isValueObscured ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setTranslatorTextDomain ($textDomain= 'default')
	Set translation text domain.
	getTranslatorTextDomain ()
	Return the translation text domain.
	setTranslatorEnabled ($flag=true)
	Indicate whether or not translation should be enabled.
	isTranslatorEnabled ()
	Is translation enabled?
Public Member Functions inherited from TranslatorAwareInterface
	setTranslator (TranslatorInterface $translator=null, $textDomain=null)
	Sets translator to use in helper.

Public Attributes
const	INVALID = 'datetimeInvalid'
const	INVALID_DATETIME = 'datetimeInvalidDateTime'

Protected Member Functions
	getIntlDateFormatter ()
	Returns a non lenient configured IntlDateFormatter.
Protected Member Functions inherited from AbstractValidator
	createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	error ($messageKey, $value=null)
	getValue ()
	Returns the validation value.
	setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
	translateMessage ($messageKey, $message)
	Translate a validation message.

Protected Attributes
	$messageTemplates
	$locale
	$dateType
	$timeType
	$timezone
	$pattern
	$calendar
	$formatter
	$invalidateFormatter = false
Protected Attributes inherited from AbstractValidator
	$value
	$abstractOptions

Additional Inherited Members
Static Public Member Functions inherited from AbstractValidator
static	setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	setDefaultTranslatorTextDomain ($textDomain= 'default')
	Set default translation text domain for all validate objects.
static	getDefaultTranslatorTextDomain ()
	Get default translation text domain for all validate objects.
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Static Protected Attributes inherited from AbstractValidator
static	$defaultTranslator
static	$defaultTranslatorTextDomain = 'default'
static	$messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options = []

)

Constructor for the Date validator.

Parameters

array | Traversable

$options

Exceptions

I18nException\ExtensionNotLoadedException

if ext/intl is not present

Member Function Documentation

getCalendar

(

)

Returns the calendar to by the IntlDateFormatter.

Returns

int

getDateType

(

)

Returns the date format used by the IntlDateFormatter.

Returns

int

getIntlDateFormatter ( )

protected

Returns a non lenient configured IntlDateFormatter.

Returns

IntlDateFormatter

getLocale

(

)

Returns the locale used by the IntlDateFormatter or the system default if none given.

Returns

string

getPattern

(

)

Returns the pattern used by the IntlDateFormatter.

Returns

string

getTimeType

(

)

Returns the time format used by the IntlDateFormatter.

Returns

int

getTimezone

(

)

Returns the timezone used by the IntlDateFormatter or the system default if none given.

Returns

string

isValid

(

$value

)

Returns true if and only if $value is a floating-point value.

Parameters

string

$value

Returns

bool

Exceptions

ValidatorException\InvalidArgumentException

Implements ValidatorInterface.

setCalendar

(

$calendar

)

Sets the calendar to be used by the IntlDateFormatter.

Parameters

int | null

$calendar

Returns

DateTime provides fluent interface

setDateType

(

$dateType

)

Sets the date format to be used by the IntlDateFormatter.

Parameters

int | null

$dateType

Returns

DateTime provides fluent interface

setLocale

(

$locale

)

Sets the locale to be used by the IntlDateFormatter.

Parameters

string | null

$locale

Returns

DateTime provides fluent interface

setPattern

(

$pattern

)

Sets the pattern to be used by the IntlDateFormatter.

Parameters

string | null

$pattern

Returns

DateTime provides fluent interface

setTimeType

(

$timeType

)

Sets the time format to be used by the IntlDateFormatter.

Parameters

int | null

$timeType

Returns

DateTime provides fluent interface

setTimezone

(

$timezone

)

Sets the timezone to be used by the IntlDateFormatter.

Parameters

string | null

$timezone

Returns

DateTime provides fluent interface

Member Data Documentation

$calendar

protected

$dateType

protected

$formatter

protected

$invalidateFormatter = false

protected

$locale

protected

$messageTemplates

protected

Initial value:

= [
        self::INVALID          => "Invalid type given. String expected"

$pattern

protected

$timeType

protected

$timezone

protected

const INVALID = 'datetimeInvalid'

const INVALID_DATETIME = 'datetimeInvalidDateTime'