Page History

This class provides methods for performing operations on SimpleDateTime objects, such as instantiating objects, for example.

You can also use this class to perform date-time operations, such as calculations, formatting or converting between date-time formats.

SimpleDateTime(dateTime)

Instantiates a new SimpleDateTime object with the current or transferred date/time.

Parameter(s):

Example:

const nowDateTime = new SimpleDateTime();
//
const registrationDateTime = new SimpleDateTime(record.registration_datetime);
//
const yearStartDateTime = new SimpleDateTime('2019-01-01 00:00:00');
//
const laborDayStart = new SimpleDateTime('2019-05-01'); // 2019-05-01 00:00:00

addDays(

days)

This method sets the date and time of the SimpleDateTime objectadds a specified number of days to the current SimpleDateTime object. The negative value of the parameter will subtract the days.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the days using local date and time values.

Parameter(s):

Return:

Return:

Example:

const startDateTimeregistrationDateTime = new SimpleDateTime('2019-01-01 08:0012:0010');
startDateTimeregistrationDateTime.setValue('2020-01-01 12:00:00'addDays(3);
ss.info(startDateTimeregistrationDateTime.getValue());  // 20202019-01-0104 08:12:00:0010

addMonths(

months)

This method adds a specified number of seconds months to the current SimpleDateTime object.

Parameter(s):

. The negative value of the parameter will subtract the months.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the months using local date and time values.

Parameter(s):

Return:

Example:

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addSecondsaddMonths(3600-1);
ss.info(registrationDateTime.getValue()); // 20192018-0112-01 0908:12:10

addSeconds(

seconds)

This method adds a specified number of days seconds to the current SimpleDateTime object. The negative value of the parameter will subtract the days.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the days using local date and time values.

.

Parameter(s)Parameter(s):

Return:

Example:

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addDaysaddSeconds(33600);
ss.info(registrationDateTime.getValue()); // 2019-01-0401 0809:12:10

addWeeks(weeks)

This method adds a specified number of weeks to the current SimpleDateTime object. The negative value of the parameter will subtract the weeks.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the weeks using local date and time values.

Parameter(s):

Return:

Example:

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addWeeks(1);
ss.info(registrationDateTime.getValue()); // 2019-01-08 08:12:10

addYears(

years)

This method adds a specified number of months years to the current SimpleDateTime object. The negative value of the parameter will subtract the monthsyears.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the months years using local date and time values.

Parameter(s):

Return:

Example:

const registrationDateTimecontractStartDateTime = new SimpleDateTime('2019-01-01 0800:1200:1000');
registrationDateTimecontractStartDateTime.addMonthsaddYears(-1);
ss.info(registrationDateTimecontractStartDateTime.getValue()); // 20182020-1201-01 0800:1200:1000

after(

dateTime)

This method adds a specified number of years to the current SimpleDateTime object. The negative value of the parameter will subtract the years.The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the years using local date and time valuesallows to compare the date specified by the ‘dateTime‘ parameter with the current date. The method returns TRUE, if the current date is after the specified; otherwise returns FALSE.

Parameter(s):

Return:

Example:

const contractStartDateTimestartDateTime = new SimpleDateTime('20192018-01-01 0007:0058:0035');
contractStartDateTime.addYears(1const endDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const isStartLaterThanEnd = startDateTime.after(endDateTime);
ss.info(contractStartDateTime.getValue()isStartLaterThanEnd); // 2020-01-01 00:00:00

false

before(dateTime)

This method allows to compare the date specified by the ‘dateTime‘ parameter with the current date. The

The method returns TRUE, if the current date is after before the specified; otherwise returns FALSEfalse.

Parameter(s):

Return:

Example:

const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const endDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const isStartLaterThanEndisStartBeforeEnd = startDateTime.afterbefore(endDateTime);
ss.info(isStartLaterThanEndisStartBeforeEnd); // falsetrue

compareTo(dateTime)

This method allows to compare the date specified by the ‘dateTime‘ parameter with the current date.The method returns TRUE, if the current date is before the specified; otherwise returns falsecompares two date and time objects to determine whether they are equivalent or not.

Parameter(s):

Return:

Example:

const startDateTimefirstDateTime = new SimpleDateTime('20182019-01-01 0708:5800:3500');
const endDateTimesecondDateTime = new SimpleDateTime('20192018-01-01 08:00:00');
const isStartBeforeEndthirdDateTime = new startDateTime.before(endDateTimeSimpleDateTime('2018-01-01 08:00:00');


ss.info(isStartBeforeEndthirdDateTime.compareTo(secondDateTime )); // 0
ss.info(firstDateTime.compareTo(secondDateTime)); // 1
ss.info(secondDateTime.compareTo(firstDateTime)); // true-1

equals(dateTime)

This method compares two date and time objects to determine whether they are equivalent or not.a datetime with an existing value if they are equal.

Parameter(s):

Return:

Example:

const firstDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const secondDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('2018-01-01 08:00:00');


ss.info(thirdDateTimefirstDateTime.compareToequals(secondDateTime )); // 0false
ss.info(firstDateTimethirdDateTime.compareToequals(secondDateTime)); // 1
ss.info(secondDateTime.compareTo(firstDateTime)); // -1

equals(dateTime)

This method compares a datetime with an existing value if they are equal.

Parameter(s):

Return:

true

getDate()

This method returns the date stored by the SimpleDateTime object, showed in the system time zone.

Return:

Example:

const firstDateTimestartDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDate()); // 2019-01-01

getDayOfMonthLocalTime()

This method returns the day of the month saved by the SimpleDateTime object, showed in the user's time zone.

Return:

Example:

const holidayDateTimeconst secondDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('20182019-01-0107 08:00:00');

ss.info(firstDateTimeholidayDateTime.equalsgetDayOfMonthLocalTime(secondDateTime)); // false
ss.info(thirdDateTime.equals(secondDateTime)); // true

getValue()

7

getDayOfMonthUTC()

This method returns the day of the month saved by the SimpleDateTime object, showed in the UTC time zoneThis method gets the date and time value in the internal format.

Return:

Example:

const startDateTimeholidayDateTime = new SimpleDateTime('2019-01-0107 08:00:00');
ss.info(startDateTimeholidayDateTime.getValuegetDayOfMonthUTC()); // 2019-01-01 08:00:00

7

getDayOfWeekLocalTime()

This method gets the date and time value in the current user's display format and timezonereturns the day of the week saved by the SimpleDateTime object, showed in the user's time zone.

Return:

Example:

const startDateTimeholidayDateTime = new SimpleDateTime('2019-01-0107 08:00:00');
ss.info(startDateTimeholidayDateTime.getDisplayValuegetDayOfWeekLocalTime()) ; // 2019-01-01 11:00:00

 // Mon

getDayOfWeekUTC()

This method returns the date stored day of the week saved by the SimpleDateTime object, showed in the system time zone.

Return:

, showed in the system time zone.

Return:

Example:

const startDateTimeholidayDateTime = new SimpleDateTime('2019-01-0107 08:00:00');
ss.info(startDateTimeholidayDateTime.getDategetDayOfWeekUTC()); // 2019-01-01Mon

getDaysInMonthLocalTime()

This method returns the number of days in the month saved by the SimpleDateTime object, showed in the user's time zone.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDaysInMonthLocalTime()); // 31

getDaysInMonthUTC()

This method returns the day number of days in the month saved by the SimpleDateTime object, showed in the user's system time zone.

Return:

Example:

const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfMonthLocalTimegetDaysInMonthUTC()); // 731

getDisplayValue()

This method returns the day of the month saved by the SimpleDateTime object, showed in the UTC time zonegets the date and time value in the current user's display format and timezone.

Return:

Example:

const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfMonthUTCgetDisplayValue()) ; // 7

2019-01-01 11:00:00

getErrorMsg()

This method returns the day of the week saved by the SimpleDateTime object, showed in the user's time zonemethod gets the error message if the SimpleDateTime object was incorrect.

Return:

Example:

const holidayDateTimestartDateTime = new SimpleDateTime('2019-zz-01-07 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfWeekLocalTimegetErrorMsg());  // Mon

 DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given

getLocalDate()

This method returns the day of the week saved date stored by the SimpleDateTime object, showed in the system user's time zone.

Return:

Example:

const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfWeekUTCgetLocalDate()); // Mon

2019-01-01

getLocalTime()

This method returns the number of days in the month saved by the SimpleDateTime object, showed in the system a SimpleDateTime object that shows the time in the user's time zone.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getLocalTime();
ss.info(startDateTime.getDaysInMonthUTC( "My local time is " + time.getByFormat('h:m:s')); // 31

My local time is 02:01:00

getMonthLocalTime()

This method allows to determine if a specified value is a valid date and time. returns the month saved by SimpleDateTime object, showed in the current user's time zone.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
startDateTime.setValue("2011-aa-01 00:00:00");
ss.info(startDateTime.isValidgetMonthLocalTime());  // falseJanuary

getMonthUTC()

This method gets the error message if the SimpleDateTime object was incorrectreturns the month saved by SimpleDateTime object, showed in the system time zone.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-zz12-0131 0823:0045:00');
ss.info(startDateTime.getErrorMsggetMonthUTC());  // DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given

December

getNumericValue()

This method returns the date stored by the SimpleDateTime object, showed in the user's time zonegets the timestamp which stores the amount of milliseconds since January 1, 1970, 00:00:00.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getLocalDategetNumericValue()); // 2019-01-01

1546329600

getTime()

This method returns a SimpleDateTime object that shows the piece of time in the user's time zoneof the SimpleDateTime object.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getLocalTimegetTime();
ss.info( "My local time is " + time.getByFormat('h:m:s')); // My local time is 0211:01:00

getValue()

This method returns the month saved by SimpleDateTime object, showed in the current user's time zonegets the date and time value in the internal format.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-1201-3101 2308:4500:00');
ss.info(startDateTime.getMonthLocalTimegetValue()); // January

2019-01-01 08:00:00

getWeekOfYearLocalTime()

This method returns the number of the month week saved by the SimpleDateTime object, showed in the system user's time-zone.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getMonthUTCgetWeekOfYearLocalTime()); // December1

getWeekOfYearUTC()

This method gets the timestamp which stores the amount of milliseconds since January 1, 1970, 00:00:00returns the number of the week saved by the SimpleDateTime object, showed in the system time-zone.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTime.getNumericValuegetWeekOfYearUTC()); // 15463296001

getYearLocalTime()

This method returns a the year saved by the SimpleDateTime object that shows the piece of time of the SimpleDateTime object, showed in the user's time zone.

Return:

Example:

const startDateTimeholidayDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
const time = startDateTime.getTime();
ss.info(timeholidayDateTime.getByFormat('h:m:s'getYearLocalTime()); // 11:01:00

2020

getYearUTC()

This method returns the number of the week year saved by the SimpleDateTime object, showed in the user's system time - zone.

Return:

Example:

const startDateTimeholidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTimeholidayDateTime.getWeekOfYearLocalTimegetYearUTC()); // 12019

isValid()

This method returns the number of the week saved by the SimpleDateTime object, showed in the system time-zone.allows to determine if a specified value is a valid date and time. 

Return:

Example:

const startDateTime = new SimpleDateTime('2019-1201-3101 2308:4500:00');
startDateTime.setValue("2011-aa-01 00:00:00");
ss.info(startDateTime.getWeekOfYearUTCisValid());  // 1false

setValue(dateTime)

This method returns the year saved by the SimpleDateTime object, showed in the user's time zone.

Return:

sets the date and time of the SimpleDateTime object.

Parameter(s):

Example:

const holidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(holidayDateTime.getYearLocalTime()); // 2020

getYearUTC()

This method returns the year saved by the SimpleDateTime object, showed in the system time zone.

Return:

Example:

const holidayDateTimestartDateTime = new SimpleDateTime('2019-12-31 23:45-01-01 08:00:00');
startDateTime.setValue('2020-01-01 12:00:00');
ss.info(holidayDateTimestartDateTime.getYearUTCgetValue());  // 20192020-01-01 12:00:00

subtract(first, second)

This method gets the duration between to SimpleDateTime values. Also, it can subtract the amount of time from the current SimpleDateTime object.

Parameter(s):

Return:

Example:

const startDateTime = new SimpleDateTime("2019-01-01 08:00:00");
const periodTime = new SimpleTime();
periodTime.setValue("00:00:20");
startDateTime.subtract(periodTime);
const afterSutractDateTime = startDateTime.getTime();
ss.info(afterSutractDateTime.getByFormat('h:m:s')); // 01:12:40