date and time format object abstraction based on ISO 8601 standard
| package | Default |
|---|
__construct(string $dateTimeString = ''): \org\turbocommons\src\main\php\model\DateTimeObject
All the class methods are based and expect values that follow the ISO 8601 format, which is the international standard for the
representation of dates and times. Any other date/time format will be considered as invalid.
Following is an example of a valid ISO 8601 dateTime value:
yyyy-mm-ddTHH:MM:SS.UUU+TT:TT
where:
IMPORTANT: It is highly recommended to always physically store your datetime values as UTC (aka 00 timezone offset). The local timezone offset should be applied only when showing the datetime values to the user. All the other date and time usages of your application should be performed with UTC values.
| example | Will create a DateTimeObject with the value '1996-01-01T00:00:00.000000+00:00' based on the UTC 00 timezone Will create a DateTimeObject with the value '1996-12-01T00:00:00.000000+00:00' based on the UTC 00 timezone is a fully valid ISO 8601 string value: '2017-10-14T17:55:25.163583+02:00' |
|---|---|
| see | https://es.wikipedia.org/wiki/ISO_8601 |
stringA string containing a valid ISO 8601 date/time value that will be used to initialize this instance. If string is empty, the current system date/time WITH UTC TIMEZONE will be used. If string is incomplete, all missing parts will be filled with the lowest possible value. If timezone offset is missing, UTC will be used.
\org\turbocommons\src\main\php\model\DateTimeObjectThe created instance
add(string $value,string $type = 'minutes'): void
stringThe numeric amount that will be added to this DateTimeObject instance
stringTODO - this paramenter description
compare(mixed $dateTime1,mixed $dateTime2): integer
Timezones from the specified dateTime values are taken into consideration for the comparison.
| Throws |
|
|---|
mixedA valid ISO 8601 dateTime value or a DateTimeObject instance.
mixedA valid ISO 8601 dateTime value or a DateTimeObject instance.
integer0 If the two dateTime values represent the exact same time, 1 if dateTime1 > dateTime2 or 2 if dateTime2 > dateTime1
compareTo(mixed $dateTime): integer
Timezones from the both dateTime values are taken into consideration for the comparison.
| see | \org\turbocommons\src\main\php\model\DateTimeObject::compare |
|---|---|
| Throws |
|
mixedA valid ISO 8601 dateTime value or a DateTimeObject instance.
integer0 If the two dateTime values represent the exact same time, 1 if this instance > dateTime or 2 if dateTime > this instance
getCurrentDay(): integer
integerThe day of month as a value between 1 and 31
getCurrentDayOfWeek(): integer
..
integerA numeric value between 1 and 7 (where Sunday is 1, Monday is 2, ...)
getCurrentHour(): integer
integerThe hour as a value between 0 and 23
getCurrentMicroSecond(): integer
integerThe microseconds as a value up to 6 digits
getCurrentMiliSecond(): integer
integerThe miliseconds as a value up to 3 digits
getCurrentMinute(): integer
integerThe minute as a value between 0 and 59
getCurrentMonth(): integer
integerA value between 1 and 12
getCurrentSecond(): integer
integerThe seconds as a value between 0 and 59
getCurrentTimeZoneOffset(): integer
integerThe timezone offset as a numeric value in seconds
getCurrentYear(): integer
integerA numeric value representing the current year
getDay(): integer
integerA value between 1 and 31
getDayName(integer $day): string
..
integerA day number between 1 and 7
stringThe day name in english and with capital letters, like for example: MONDAY, SATURDAY...
getDayOfWeek(): integer
..
integerA numeric value between 1 and 7
getFirstDayOfMonth(): \org\turbocommons\src\main\php\model\DateTimeObject
\org\turbocommons\src\main\php\model\DateTimeObjectA dateTime object representing the first day of month based on the current instance
getHour(): integer
integerA value between 0 and 23
getLastDayOfMonth(): \org\turbocommons\src\main\php\model\DateTimeObject
\org\turbocommons\src\main\php\model\DateTimeObjectA dateTime object representing the last day of month based on the current instance
getMicroSecond(): integer
integerA value up to 6 digit
getMiliSecond(): integer
integerA value up to 3 digit
getMinute(): integer
integerA value between 0 and 59
getMonth(): integer
integerA value between 1 and 12
getMonthName(integer $month): string
integerA month number between 1 and 12
stringthe month name in english and with capital letters, like: JANUARY, FEBRUARY, ...
getSecond(): integer
integerA value between 0 and 59
getTimeZoneOffset(): integer
integerThe UTC timezone offset in seconds
getYear(): integer
integerA 4 digits numeric value
isEqual(mixed $dateTime1,mixed $dateTime2): boolean
| see | \org\turbocommons\src\main\php\model\DateTimeObject::__construct |
|---|
mixedA valid ISO 8601 dateTime string or a DateTimeObject instance.
mixedA valid ISO 8601 dateTime string or a DateTimeObject instance.
booleanTrue if the date and time values on both elements are the same
isEqualTo(mixed $dateTime): boolean
mixedA valid ISO 8601 dateTime string or a DateTimeObject instance.
booleanTrue if both dateTime values are equivalent to the exact same date and time
isUTC(): boolean
booleanTrue if the instance timezone is UTC, false if not
isValidDateTime(mixed $dateTime): boolean
Therefore, this method considers a dateTime string value to be valid only if it is a string that follows that standard or a DateTimeObject instance.
| see | \org\turbocommons\src\main\php\model\DateTimeObject::__construct |
|---|
mixedA string containing a valid ISO 8601 date/time value or a valid DateTimeObject instance.
booleantrue if the specified value is ISO 8601 or a DateTimeObject instance, false if value contains invalid information.
setLocalTimeZone(): \org\turbocommons\src\main\php\model\DateTimeObject
setTimeZoneOffset(string $offset): \org\turbocommons\src\main\php\model\DateTimeObject
stringOne of the supported timezone names or an offset value (+0200, +05:00, -0300, -03:00, etc...)
\org\turbocommons\src\main\php\model\DateTimeObjectThis object instance
setUTC(): \org\turbocommons\src\main\php\model\DateTimeObject
| example | this instance contains a +02:00 timezone offset, after calling this method the offset will be +00:00 (date and time will be updated accordingly) |
|---|---|
\org\turbocommons\src\main\php\model\DateTimeObjectThis object instance
substract( $value, $type = 'minutes')
toString(string $formatString = 'Y-M-DTH:N:S.UOffset'): string
stringA string containing the output format like 'd/m/Y' or 'm-d-y'
where the following characters will be automatically replaced:
stringThe dateTime with the specified format.