mediatekformation

DateIntervalToArrayTransformer
in package
implements DataTransformerInterface

Transforms between a normalized date interval and an interval string/array.

Tags
author

Steffen Roßkamp steffen.rosskamp@gimmickmedia.de

Interfaces, Classes, Traits and Enums

DataTransformerInterface
Transforms a value between different representations.

Table of Contents

DAYS  = 'days'
HOURS  = 'hours'
INVERT  = 'invert'
MINUTES  = 'minutes'
MONTHS  = 'months'
SECONDS  = 'seconds'
YEARS  = 'years'
AVAILABLE_FIELDS  = [self::YEARS => 'y', self::MONTHS => 'm', self::DAYS => 'd', self::HOURS => 'h', self::MINUTES => 'i', self::SECONDS => 's', self::INVERT => 'r']
$fields  : mixed
$pad  : mixed
__construct()  : mixed
reverseTransform()  : DateInterval|null
Transforms an interval array into a normalized date interval.
transform()  : array<string|int, mixed>
Transforms a normalized date interval into an interval array.

Constants

AVAILABLE_FIELDS

private mixed AVAILABLE_FIELDS = [self::YEARS => 'y', self::MONTHS => 'm', self::DAYS => 'd', self::HOURS => 'h', self::MINUTES => 'i', self::SECONDS => 's', self::INVERT => 'r']

Properties

Methods

__construct()

public __construct([array<string|int, string>|null $fields = null ][, bool $pad = false ]) : mixed
Parameters
$fields : array<string|int, string>|null = null

The date fields

$pad : bool = false

Whether to use padding

Return values
mixed —

reverseTransform()

Transforms an interval array into a normalized date interval.

public reverseTransform(array<string|int, mixed> $value) : DateInterval|null
Parameters
$value : array<string|int, mixed>

Interval array

Tags
throws
UnexpectedTypeException

if the given value is not an array

throws
TransformationFailedException

if the value could not be transformed

Return values
DateInterval|null —

Normalized date interval

transform()

Transforms a normalized date interval into an interval array.

public transform(DateInterval $dateInterval) : array<string|int, mixed>
Parameters
$dateInterval : DateInterval

Normalized date interval

Tags
throws
UnexpectedTypeException

if the given value is not a \DateInterval instance

Return values
array<string|int, mixed> —

Interval array

Search results