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

Public Member Functions
	__construct ($options=array())
	Sets validator options.

	getFormat ()
	Returns the format option.

	setFormat ($format=self::FORMAT_DEFAULT)
	Sets the format option.

	isValid ($value)
	Returns true if $value is a DateTime instance or can be converted into one.

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=array())
	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 = 'dateInvalid'

const	INVALID_DATE = 'dateInvalidDate'

const	FALSEFORMAT = 'dateFalseFormat'

const	FORMAT_DEFAULT = 'Y-m-d'

Protected Member Functions
	convertToDateTime ($param, $addErrors=true)
	Attempts to convert an int, string, or array to a DateTime object.

	convertInteger ($value)
	Attempts to convert an integer into a DateTime object.

	convertDouble ($value)
	Attempts to convert an double into a DateTime object.

	convertString ($value, $addErrors=true)
	Attempts to convert a string into a DateTime object.

	convertArray (array $value, $addErrors=true)
	Implodes the array into a string and proxies to convertString().

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

	$messageVariables

	$format = self::FORMAT_DEFAULT

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

Detailed Description

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

Constructor & Destructor Documentation

__construct ( $options = array() )

Sets validator options.

Parameters

string | array | Traversable $options OPTIONAL

Member Function Documentation

convertArray	(	array	$value,
			$addErrors = `true`
	)

protected

Implodes the array into a string and proxies to convertString().

Parameters

array	$value
bool	$addErrors

Returns: bool|DateTime

Todo:: enhance the implosion

convertDouble ( $value )

protected

Attempts to convert an double into a DateTime object.

Parameters

double $value

Returns: bool|DateTime

convertInteger ( $value )

protected

Attempts to convert an integer into a DateTime object.

Parameters

integer $value

Returns: bool|DateTime

convertString	(	$value,
		$addErrors = `true`
	)

protected

Attempts to convert a string into a DateTime object.

Parameters

string	$value
bool	$addErrors

Returns: bool|DateTime

convertToDateTime	(	$param,
		$addErrors = `true`
	)

protected

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

Parameters

string \| int \| array	$param
bool	$addErrors

Returns: bool|DateTime

getFormat ( )

Returns the format option.

Returns: string|null

isValid ( $value )

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

Parameters

string | array | int | DateTime $value

Returns: bool

Implements ValidatorInterface.

setFormat ( $format = self::FORMAT_DEFAULT )

Sets the format option.

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

Parameters

string $format

Returns: Date provides a fluent interface

Todo:: validate the format

Member Data Documentation

$format = self::FORMAT_DEFAULT

protected

$messageTemplates

protected

Initial value:

= array(
        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

Initial value:

= array(
        'format' => 'format',
    )

const FALSEFORMAT = 'dateFalseFormat'

const FORMAT_DEFAULT = 'Y-m-d'

const INVALID = 'dateInvalid'

const INVALID_DATE = 'dateInvalidDate'

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation