Zend Framework  3.0
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
DateStep Class Reference

Public Member Functions

 __construct ($options=[])
 Set default options for this instance.
 
 setBaseValue ($baseValue)
 Sets the base value from which the step should be computed.
 
 getBaseValue ()
 Returns the base value from which the step should be computed.
 
 setStep (DateInterval $step)
 Sets the step date interval.
 
 getStep ()
 Returns the step date interval.
 
 getTimezone ()
 Returns the timezone option.
 
 setTimezone (DateTimeZone $timezone)
 Sets the timezone option.
 
 isValid ($value)
 Returns true if a date is within a valid step.
 
- Public Member Functions inherited from Date
 __construct ($options=[])
 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=[])
 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 NOT_STEP = 'dateStepNotStep'
 
const FORMAT_DEFAULT = DateTime::ISO8601
 
- Public Attributes inherited from Date
const INVALID = 'dateInvalid'
 
const INVALID_DATE = 'dateInvalidDate'
 
const FALSEFORMAT = 'dateFalseFormat'
 
const FORMAT_DEFAULT = 'Y-m-d'
 

Protected Member Functions

 convertString ($value, $addErrors=true)
 Supports formats with ISO week (W) definitions.
 
- Protected Member Functions inherited from Date
 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
 
 $baseValue = '1970-01-01T00:00:00Z'
 
 $step
 
 $timezone
 
- Protected Attributes inherited from Date
 $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
 

Constructor & Destructor Documentation

__construct (   $options = [])

Set default options for this instance.

Parameters
array$options

Member Function Documentation

convertString (   $value,
  $addErrors = true 
)
protected

Supports formats with ISO week (W) definitions.

See Also
Date::convertString()
getBaseValue ( )

Returns the base value from which the step should be computed.

Returns
string|int|
getStep ( )

Returns the step date interval.

Returns
DateInterval
getTimezone ( )

Returns the timezone option.

Returns
DateTimeZone
isValid (   $value)

Returns true if a date is within a valid step.

Parameters
string | int | \DateTime$value
Returns
bool
Exceptions
Exception\InvalidArgumentException

Implements ValidatorInterface.

setBaseValue (   $baseValue)

Sets the base value from which the step should be computed.

Parameters
string | int | \DateTime$baseValue
Returns
DateStep
setStep ( DateInterval  $step)

Sets the step date interval.

Parameters
DateInterval$step
Returns
DateStep
setTimezone ( DateTimeZone  $timezone)

Sets the timezone option.

Parameters
DateTimeZone$timezone
Returns
DateStep

Member Data Documentation

$baseValue = '1970-01-01T00:00:00Z'
protected
$messageTemplates
protected
Initial value:
= [
self::INVALID => "Invalid type given. String, integer, array or DateTime expected"
$step
protected
$timezone
protected
const FORMAT_DEFAULT = DateTime::ISO8601
const NOT_STEP = 'dateStepNotStep'