datetime

Datetime Methods

lsWeek(locale=[string], timezone=[string])

Provides the Localized BIF and member functions for time units ( e.g.

different locales have different start days to the week )

Arguments:

Argument	Type	Required	Default
locale	string	false	null
timezone	string	false	null

lsDayOfWeek(locale=[string], timezone=[string])

Provides the Localized BIF and member functions for time units ( e.g.

different locales have different start days to the week )

Arguments:

Argument	Type	Required	Default
locale	string	false	null
timezone	string	false	null

compare(date2=[any], datepart=[string])

nullArguments:

Argument	Type	Required	Default
date2	any	true	null
datepart	string	false	null

compareTo(date2=[any], datepart=[string])

nullArguments:

Argument	Type	Required	Default
date2	any	true	null
datepart	string	false	null

lSDateTimeFormat(mask=[string], locale=[string], timezone=[string])

Formats a date in a locale-specific format

Arguments:

Argument	Type	Required	Default
mask	string	false	null
locale	string	false	null
timezone	string	false	null

lSDateFormat(mask=[string], locale=[string], timezone=[string])

Formats a date in a locale-specific format

Arguments:

Argument	Type	Required	Default
mask	string	false	null
locale	string	false	null
timezone	string	false	null

lSTimeFormat(mask=[string], locale=[string], timezone=[string])

Formats a date in a locale-specific format

Arguments:

Argument	Type	Required	Default
mask	string	false	null
locale	string	false	null
timezone	string	false	null

toLegacyDate()

Takes a BoxLang DateTime object and converts it to the legacy java.util.Date object used by ACF and Lucee.

equals(date2=[any])

Provides an overload to the native equals method for comparing two date/time values

This method providers a looser comparison than the native equals method, which also adds timezone comparison, in addition to the instant

Arguments:

Argument	Type	Required	Default
date2	any	true	null

format(mask=[string], timezone=[string], locale=[string])

Formats a datetime, date or time

Arguments:

Argument	Type	Required	Default
mask	string	false	null
timezone	string	false	null
locale	string	false	null

dateFormat(mask=[string], timezone=[string], locale=[string])

Formats a datetime, date or time

Arguments:

Argument	Type	Required	Default
mask	string	false	null
timezone	string	false	null
locale	string	false	null

timeFormat(mask=[string], timezone=[string], locale=[string])

Formats a datetime, date or time

Arguments:

Argument	Type	Required	Default
mask	string	false	null
timezone	string	false	null
locale	string	false	null

dateTimeFormat(mask=[string], timezone=[string], locale=[string])

Formats a datetime, date or time

Arguments:

Argument	Type	Required	Default
mask	string	false	null
timezone	string	false	null
locale	string	false	null

hash(algorithm=[string], encoding=[string], numIterations=[integer])

Creates an algorithmic hash of an object and returns it in the CFML compat upper case format

Arguments:

Argument	Type	Required	Default
algorithm	string	false	MD5
encoding	string	false	utf-8
numIterations	integer	false	1

Examples