TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter:

Public Member Functions
	canConvertFrom ($source, $targetType)
	convertFrom ($source, $targetType, array $convertedChildProperties=array(), \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration=NULL)
Public Member Functions inherited from TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter
	getSupportedSourceTypes ()
	getSupportedTargetType ()
	getTargetTypeForSource ($source, $originalTargetType, \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration=NULL)
	getPriority ()
	canConvertFrom ($source, $targetType)
	getSourceChildPropertiesToBeConverted ($source)
	getTypeOfChildProperty ($targetType, $propertyName, \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration)
Public Member Functions inherited from TYPO3\CMS\Extbase\Property\TypeConverterInterface
	getTargetTypeForSource ($source, $originalTargetType, PropertyMappingConfigurationInterface $configuration=NULL)

Public Attributes
const	CONFIGURATION_DATE_FORMAT = 'dateFormat'
const	DEFAULT_DATE_FORMAT = \DateTime::W3C

Protected Member Functions
	isDatePartKeysProvided (array $source)
	getDefaultDateFormat (\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration=NULL)
	overrideTimeIfSpecified (\DateTime $date, array $source)

Protected Attributes
	$sourceTypes = array('string', 'integer', 'array')
	$targetType = 'DateTime'
	$priority = 1
Protected Attributes inherited from TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter
	$sourceTypes = array()
	$targetType = ''
	$priority
	$objectManager

Detailed Description

Converter which transforms from different input formats into DateTime objects.

Source can be either a string or an array. The date string is expected to be formatted according to DEFAULT_DATE_FORMAT.

But the default date format can be overridden in the initialize*Action() method like this::

$this->arguments['<argumentName>'] ->getPropertyMappingConfiguration() ->forProperty('<propertyName>') // this line can be skipped in order to specify the format for all properties ->setTypeConverterOption('TYPO3', ::CONFIGURATION_DATE_FORMAT, '<dateFormat>');

If the source is of type array, it is possible to override the format in the source::

array( 'date' => '<dateString>', 'dateFormat' => '<dateFormat>' );

By using an array as source you can also override time and timezone of the created DateTime object::

array( 'date' => '<dateString>', 'hour' => '<hour>', // integer 'minute' => '<minute>', // integer 'seconds' => '<seconds>', // integer 'timezone' => '<timezone>', // string, see http://www.php.net/manual/timezones.php );

As an alternative to providing the date as string, you might supply day, month and year as array items each::

array( 'day' => '<day>', // integer 'month' => '<month>', // integer 'year' => '<year>', // integer );

Definition at line 63 of file DateTimeConverter.php.

Member Function Documentation

canConvertFrom()

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::canConvertFrom	(		$source,
			$targetType
	)

If conversion is possible.

Parameters

string	$source
string	$targetType

Returns

boolean

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 100 of file DateTimeConverter.php.

References TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\$targetType.

convertFrom()

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::convertFrom	(		$source,
			$targetType,
		array	$convertedChildProperties = array(),
		\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface	$configuration = NULL
	)

Converts $source to a using the configured dateFormat

Parameters

string | integer | array	$source	the string to be converted to a object
string	$targetType	must be "DateTime"
array	$convertedChildProperties	not used currently
\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface	$configuration

Returns

Exceptions

Implements TYPO3\CMS\Extbase\Property\TypeConverterInterface.

Definition at line 123 of file DateTimeConverter.php.

References TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\getDefaultDateFormat(), TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\isDatePartKeysProvided(), and TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\overrideTimeIfSpecified().

getDefaultDateFormat()

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::getDefaultDateFormat ( \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface  $configuration = NULL )

protected

Determines the default date format to use for the conversion. If no format is specified in the mapping configuration DEFAULT_DATE_FORMAT is used.

Parameters

\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface

$configuration

Returns

string

Exceptions

Definition at line 191 of file DateTimeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\convertFrom().

isDatePartKeysProvided()

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::isDatePartKeysProvided ( array  $source )

protected

Returns whether date information (day, month, year) are present as keys in $source.

Parameters

array

$source

Returns

boolean

Definition at line 177 of file DateTimeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\convertFrom().

overrideTimeIfSpecified()

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::overrideTimeIfSpecified ( \DateTime  $date, array  $source  )

protected

Overrides hour, minute & second of the given date with the values in the $source array

Parameters

\DateTime	$date
array	$source

Returns

void

Definition at line 211 of file DateTimeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\convertFrom().

Member Data Documentation

$priority

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::$priority = 1

protected

Definition at line 91 of file DateTimeConverter.php.

$sourceTypes

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::$sourceTypes = array('string', 'integer', 'array')

protected

Definition at line 81 of file DateTimeConverter.php.

$targetType

TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::$targetType = 'DateTime'

protected

Definition at line 86 of file DateTimeConverter.php.

Referenced by TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter\canConvertFrom().

CONFIGURATION_DATE_FORMAT

const TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT = 'dateFormat'

Definition at line 68 of file DateTimeConverter.php.

DEFAULT_DATE_FORMAT

const TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::DEFAULT_DATE_FORMAT = \DateTime::W3C

Definition at line 76 of file DateTimeConverter.php.

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Property\TypeConverter\DateTimeConverterTest\convertFromArrayTests(), and TYPO3\CMS\Extbase\Tests\Unit\Property\TypeConverter\DateTimeConverterTest\convertFromStringTests().