Page History

SimpleDateTime(dateTime)

Instantiates Use this constructor to instantiate a new SimpleDateTime object with the current or transferred date /and time. The Since the object keeps date and time value should be specified in the UTC timezone, ensure the data you pass to the object is in UTC, otherwise your results will be invalid.

Parameter(s):

Example:

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

You can also use the values in relative format for the SimpleDateTime constructor. All formats are available in the Relative Formats article.

const yesterdayDatetime = new SimpleDateTime('yesterday');
ss.info(yesterdayDatetime.getValue());
// Info: 2022-02-28 00:00:00  

const tomorrowDatetime = new SimpleDateTime('tomorrow');
ss.info(tomorrowDatetime.getValue());
// Info: 2022-03-02 00:00:00

const yesterdayWorkdayDayStart = new SimpleDateTime('yesterday 06:30');
ss.info(yesterdayWorkdayDayStart.getValue());
// Info: 2022-02-28 06:30:00

const fistDayOfNextMonthStart = new SimpleDateTime('first day of next month 00:00');
ss.info(fistDayOfNextMonthStart.getValue());
// Info: 2022-04-01 00:00:00

const rangeStartDatetime = new SimpleDateTime(`first day of ${monthName}`);
ss.info(rangeStartDatetime .getValue());
// Info: 2022-02-01 00:00:00

const YEAR = 2022;
const MONTH = 2;
const monthDatetime = new SimpleDateTime(`${YEAR}-${String(MONTH).padStart(2, '0')}-02 00:00:00`);
const monthName = monthDatetime.getMonthUTC();
ss.info(monthName);
// Info: February

addDays(days)

This Use this method is used to change the number of days in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds days to the object, the negative value diminishes the number of days.

Parameter(s):

Return:

Example:

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addDays(3);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-04 08:12:10

addMonths(months)

This Use this method is used to change the number of months in the current SimpleDateTime object according to the local current date and time. The positive value of the parameter adds months the number of days equal to the number of days in this month to the objectdate, the negative value diminishes subtracts the number of days equal to the number of monthsdays in the previous month from the date.

Parameter(s):

Return:

Example:

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

addSeconds(seconds)

This Use this method is used to change the number of seconds in the current SimpleDateTime object according to the local date and timelocal time. The positive value of the parameter adds seconds to the object, the negative value diminishes the number of seconds.

Parameter(s):

Return:

Example:

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addSeconds(3600);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-01 09:12:10

addWeeks(weeks)

This Use this method is used to change the number of weeks in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds weeks to the object, the negative value diminishes the number of weeks.

Parameter(s):

Return:

Example:

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

addYears(years)

This Use this method is used to change the number of years in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds years to the object, the negative value diminishes the number of years.

Parameter(s):

Return:

Example:

const contractStartDateTime = new SimpleDateTime('2019-01-01 00:00:00');
contractStartDateTime.addYears(1);
ss.info(contractStartDateTime.getValue());
//Info: 2020-01-01 00:00:00

after(dateTime)

This Use 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 after the specified; otherwise returns FALSE.

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 isStartAfterThanEnd = startDateTime.after(endDateTime);
ss.info(isStartAfterThanEnd);
//Info: false

before(dateTime)

This Use this method allows to compare the date specified by the ‘dateTime‘ parameter with the current date.The method returns TRUE, if by the dateTime parameter with the current date is before the specified; otherwise returns false.

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 isStartBeforeEnd = startDateTime.before(endDateTime);
ss.info(isStartBeforeEnd);
//Info: true

compareTo(dateTime)

This Use this method compares to compare two date and time objects to and determine whether they are equal and, if . If not, the method defines which goes after or before the other.

Parameter(s):

Return:

Example:

const begin = new SimpleDateTime('2019-04-01 08:15:00');
const end = new SimpleDateTime('2019-05-01 01:00:00');

ss.info(begin.compareTo(end));   // -1
ss.info(end.compareTo(begin));   // 1
ss.info(begin.compareTo(begin)); // 0

equals(dateTime)

This method compares a datetime Use this method to compare date and time objects with an existing value value to determine whether they are equal or not.

Parameter(s):

Return:

Example:

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

ss.info(firstDateTime.equals(secondDateTime));
ss.info(thirdDateTime.equals(firstDateTime));
//Info: false
//Info: true

getDate()

This Use this method returns to return the date saved by the SimpleDateTime object in the system time zoneUTC timezone.

Return:

Example:

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

getDayOfMonthLocalTime()

This Use this method returns to return the day of the month saved by the SimpleDateTime object in the current user's time zonetimezone.

Return:

Example:

const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfMonthLocalTime());
//Info: 7

getDayOfMonthUTC()

This Use this method returns to return the day of the month saved by the SimpleDateTime object in the UTC time zonetimezone.

Return:

Example:

const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfMonthUTC());
//Info: 7

getDayOfWeekLocalTime()

This Use this method returns to return the day of the week saved by the SimpleDateTime object in the current user's time zonetimezone.

Return:

Example:

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

getDayOfWeekUTC()

This Use this method returns to return the day of the week saved by the SimpleDateTime object in the system time zonetimezone.

Return:

Example:

const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfWeekUTC());
//Info: Mon

getDaysInMonthLocalTime()

This Use this method returns to return the number of days in the month saved by the SimpleDateTime object in the current user's time zonetimezone.

Return:

Example:

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

getDaysInMonthUTC()

This Use this method returns to return the number of days in the month saved by the SimpleDateTime object in the system time zonetimezone.

Return:

Example:

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

getDisplayValue()

This Use this method returns to return the date and time value in the current user's display format and timezone.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDisplayValue()); // current user's timezone is Europe/Moscow
//Info: 2019-01-01 11:00:00 

getErrorMsg()

This Use this method returns to return the error message if the SimpleDateTime object was is incorrect.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-zz-01 08:00:00');
ss.error(startDateTime.getErrorMsg());
//Error: DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null givenThe parsed date or time was invalid!

getLocalDate()

This Use this method returns to return the date saved by the SimpleDateTime object in the current user's time zonetimezone.

Return:

Example:

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

getLocalTime()

This Use this method returns to return the time saved in a SimpleDateTime object in the current user's time zone timezone.

Return:

Example:

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

getMonthLocalTime()

This Use this method returns to return the month saved by the SimpleDateTime object in the current user's time zonetimezone.

Return:

Example:

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

getMonthUTC()

This Use this method returns to return the month saved by SimpleDateTime object in the system time zoneUTC timezone.

Return:

Example:

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

getNumericValue()

This Use this method returns to return the Unix timestamp , which stores that stores the amount of seconds since January 1, 1970, 00:00:00.

Return:

Example:

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

getTime()

This Use this method returns to return a SimpleDateTime object that shows the piece of time value of the SimpleDateTime object.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getTime();
ss.info(time.getByFormat('h:i:s'));
//Info: 11:01:00

getValue()

This Use this method returns to return the date and time value in the internal format.

Return:

Example:

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

getWeekOfYearLocalTime()

This Use this method returns to return the week's number saved number saved by the SimpleDateTime object in the current user's time zonetimezone.

Return:

Example:

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

getWeekOfYearUTC()

This Use this method returns to return the number of the week saved by the SimpleDateTime object in the system time zoneUTC timezone.

Return:

Example:

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

getYearLocalTime()

This Use this method returns to return the year saved by the SimpleDateTime object in the current user's time zonetimezone.

Return:

Example:

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

getYearUTC()

This Use this method returns to return the year saved by the SimpleDateTime object in the system time zonetimezone.

Return:

Example:

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

isValid()

This Use this method allows to determine if a specified value is a valid to check whether the specified date and time values are valid.

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
startDateTime.setValue('2011-aa-01 00:00:00');
ss.info(startDateTime.isValid());
//Info: false

setValue(dateTime)

This Use this method is intended to define the date and time value within the SimpleDateTime object.

Parameter(s):

. The value of the dateTime parameter should be in the UTC timezone and the internal format of YYYY-MM-DD hh:mm:ss.

Parameter(s):

Return:

Example:

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
startDateTime.setValue('2020-01-01 12:00:00');
ss.info(startDateTime.getValue());
//Info: 2020-01-01 12:00:00

subtract(first, second)

This Use this method returns to return the amount of time between two SimpleDateTime values. Also, it can subtract the amount of time from the current SimpleDateTime object.

Parameter(s):

Return:

Example 1:

const startDatetime = new SimpleDateTime('2019-11-08 20:00:00');
const endDatetime = new SimpleDateTime('2019-11-08 20:06:28');
const diffDuration = new SimpleDateTime().subtract(startDatetime, endDatetime); 
ss.info(diffDuration.getDurationSeconds());
// Info: 388

Same example without using of the subtract:

const startDatetime = new SimpleDateTime('2019-11-08 20:00:00');
const endDatetime = new SimpleDateTime('2019-11-08 20:06:28');
const diffSeconds = endDatetime.getNumericValue() - startDatetime.getNumericValue(); 
ss.info(diffSeconds);
// Info: 388

Example 2:

const datetime = new SimpleDateTime('2020-08-28 09:00:00');
datetime.subtract(3600);
ss.info(datetime.getValue());
//Info: 2020-08-28 08:00:00

Same example without using of the subtract:

const datetime = new SimpleDateTime('2020-08-28 09:00:00');
datetime.addSeconds(-3600);
ss.info(datetime.getValue());
//Info: 2020-08-28 08:00:00