Bitrix API

DateConverterResult

Class DateConverterResult

Table of Contents

Constants

TYPE_CALENDAR  = 'CALENDAR'
TYPE_DAYOFWEEK  = 'DAYOFWEEK'
TYPE_MODIFIER  = 'MODIFIER'
TYPE_PARTOFDAY  = 'PARTOFDAY'
TYPE_RELATIVE  = 'RELATIVE'
TYPE_UNKNOWN  = 'UNKNOWN'

Methods

__construct()  : mixed
DateConverterResult constructor.
getDate()  : DateTime|null
Date from the text
getMetricModifier()  : array<string|int, mixed>
Get recognition metric modifier
getMetrics()  : array<string|int, mixed>
Get recognition metrics
getText()  : string
The string used to build the date
getTextLength()  : int
Length of string used to build the date
getTextPosition()  : int
Position of string used to build the date
getType()  : string
Get primary recognition type

Constants

Methods

__construct()

DateConverterResult constructor.

public __construct(DateTime $date, mixed $matchParams[, mixed $type = self::TYPE_UNKNOWN ][, array<string|int, mixed> $metrics = array() ][, array<string|int, mixed> $metricModifier = array() ]) : mixed
Parameters
$date : DateTime
$matchParams : mixed
$type : mixed = self::TYPE_UNKNOWN
$metrics : array<string|int, mixed> = array()
$metricModifier : array<string|int, mixed> = array()

getMetricModifier()

Get recognition metric modifier

public getMetricModifier() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMetrics()

Get recognition metrics

public getMetrics() : array<string|int, mixed>
Return values
array<string|int, mixed>

getText()

The string used to build the date

public getText() : string
Return values
string

getTextLength()

Length of string used to build the date

public getTextLength() : int
Return values
int

getTextPosition()

Position of string used to build the date

public getTextPosition() : int
Return values
int

getType()

Get primary recognition type

public getType() : string
Return values
string

        
On this page

Search results