ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ilDateTime Class Reference
Services/Calendar

@classDescription Date and time handling More...

+ Inheritance diagram for ilDateTime:
+ Collaboration diagram for ilDateTime:

Public Member Functions

 __construct ($a_date=null, $a_format=0, $a_tz='')
 Create new date object. More...
 
 __clone ()
 
 __sleep ()
 
 __wakeup ()
 
 isNull ()
 Check if a date is null (Datetime == '0000-00-00 00:00:00', unixtime == 0,...) More...
 
 switchTimeZone ($a_timezone_identifier='')
 Switch timezone. More...
 
 getTimeZoneIdentifier ()
 get timezone identifier More...
 
 increment ($a_type, $a_count=1)
 increment More...
 
 getUnixTime ()
 get unix time More...
 
 getUTCOffset ()
 get UTC offset More...
 
 setDate ($a_date, $a_format)
 set date More...
 
 get ($a_format, $a_format_str='', $a_tz='')
 get formatted date More...
 
 __toString ()
 to string for date time objects Output is user time zone More...
 

Static Public Member Functions

static _before (ilDateTime $start, ilDateTime $end, $a_compare_field='', $a_tz='')
 compare two dates and check start is before end This method does not consider tz offsets. More...
 
static _equals (ilDateTime $start, ilDateTime $end, $a_compare_field='', $a_tz='')
 Check if two date are equal. More...
 
static _after (ilDateTime $start, ilDateTime $end, $a_compare_field='', $a_tz='')
 compare two dates and check start is after end This method does not consider tz offsets. More...
 
static _within (ilDateTime $dt, ilDateTime $start, ilDateTime $end, $a_compare_field='', $a_tz='')
 Check whether an date is within a date duration given by start and end. More...
 

Data Fields

const YEAR = 'year'
 
const MONTH = 'month'
 
const WEEK = 'week'
 
const DAY = 'day'
 
const HOUR = 'hour'
 
const MINUTE = 'minute'
 

Protected Member Functions

 parsePartsToDate ($a_year, $a_month, $a_day, $a_hour=null, $a_min=null, $a_sec=null, $a_timezone=null)
 

Protected Attributes

 $log
 
 $timezone = null
 
 $default_timezone = null
 
 $dt_obj
 

Detailed Description

@classDescription Date and time handling

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 32 of file class.ilDateTime.php.

Constructor & Destructor Documentation

◆ __construct()

ilDateTime::__construct (   $a_date = null,
  $a_format = 0,
  $a_tz = '' 
)

Create new date object.

@access public

Parameters
mixedinteger string following the format given as the second parameter
intformat of date presentation

throws ilDateTimeException

Definition at line 60 of file class.ilDateTime.php.

61 {
62 global $ilLog;
63
64 $this->log = $ilLog;
65
66 try
67 {
68 $this->timezone = ilTimeZone::_getInstance($a_tz);
69 $this->default_timezone = ilTimeZone::_getInstance('');
70
71 $this->setDate($a_date,$a_format);
72 }
73 catch(ilTimeZoneException $exc)
74 {
75 $this->log->write(__METHOD__.': '.$exc->getMessage());
76 throw new ilDateTimeException('Unsupported timezone given. Timezone: '.$a_tz);
77 }
78 }
ilDateTimeException
Class for DateTime exceptions.
Definition: class.ilDateTimeException.php:35
ilDateTime\setDate
setDate($a_date, $a_format)
set date
Definition: class.ilDateTime.php:414
ilTimeZoneException
Class for TimeZone exceptions.
Definition: class.ilTimeZoneException.php:35
ilTimeZone\_getInstance
static _getInstance($a_tz='')
get instance by timezone
Definition: class.ilTimeZone.php:123
$ilLog
$ilLog
Definition: inc.setup_header.php:130

References $ilLog, ilTimeZone\_getInstance(), and setDate().

+ Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilDateTime::__clone ( )

Definition at line 80 of file class.ilDateTime.php.

81 {
82 if($this->dt_obj)
83 {
84 $this->dt_obj = clone $this->dt_obj;
85 }
86 }

References $dt_obj.

◆ __sleep()

ilDateTime::__sleep ( )

Definition at line 88 of file class.ilDateTime.php.

89 {
90 return array('timezone', 'default_timezone', 'dt_obj');
91 }

◆ __toString()

ilDateTime::__toString ( )

to string for date time objects Output is user time zone

@access public

Parameters

return

Reimplemented in ilDate.

Definition at line 586 of file class.ilDateTime.php.

587 {
588 return $this->get(IL_CAL_DATETIME).'<br>';
589 }
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:9

References IL_CAL_DATETIME.

◆ __wakeup()

ilDateTime::__wakeup ( )

Definition at line 93 of file class.ilDateTime.php.

94 {
95 global $ilLog;
96
97 $this->log = $ilLog;
98 }

References $ilLog.

◆ _after()

static ilDateTime::_after ( ilDateTime  $start,
ilDateTime  $end,
  $a_compare_field = '',
  $a_tz = '' 
)
static

compare two dates and check start is after end This method does not consider tz offsets.

So you have to take care that both dates are defined in the the same timezone

@access public

Parameters
objectilDateTime
objectilDateTime
stringfield used for comparison. E.g IL_CAL_YEAR checks if start is one or more years after than end
stringtimezone

Definition at line 229 of file class.ilDateTime.php.

230 {
231 if($start->isNull() || $end->isNull())
232 {
233 return;
234 }
235
236 switch($a_compare_field)
237 {
238 case IL_CAL_YEAR:
239 return $start->get(IL_CAL_FKT_DATE,'Y',$a_tz) > $end->get(IL_CAL_FKT_DATE,'Y',$a_tz);
240
241 case IL_CAL_MONTH:
242 return (int) $start->get(IL_CAL_FKT_DATE,'Ym',$a_tz) > $end->get(IL_CAL_FKT_DATE,'Ym',$a_tz);
243
244 case IL_CAL_DAY:
245 return (int) $start->get(IL_CAL_FKT_DATE,'Ymd',$a_tz) > $end->get(IL_CAL_FKT_DATE,'Ymd',$a_tz);
246
247 case '':
248 default:
249 return $start->dt_obj > $end->dt_obj;
250
251 }
252 }
IL_CAL_YEAR
const IL_CAL_YEAR
Definition: class.ilDateTime.php:17
IL_CAL_MONTH
const IL_CAL_MONTH
Definition: class.ilDateTime.php:18
IL_CAL_FKT_DATE
const IL_CAL_FKT_DATE
Definition: class.ilDateTime.php:12
IL_CAL_DAY
const IL_CAL_DAY
Definition: class.ilDateTime.php:20
ilDateTime\get
get($a_format, $a_format_str='', $a_tz='')
get formatted date
Definition: class.ilDateTime.php:505
ilDateTime\isNull
isNull()
Check if a date is null (Datetime == '0000-00-00 00:00:00', unixtime == 0,...)
Definition: class.ilDateTime.php:105

References $start, get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_YEAR, and isNull().

Referenced by ilObjGroupAccess\_registrationEnabled(), _within(), ilCalendarRecurrenceCalculator\applyLimits(), ilCalendarRecurrenceCalculator\calculateDateList(), ilDateDurationInputGUI\checkInput(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilConsultationHourBookingTableGUI\fillRow(), ilPageObject\getActive(), ilCalendarAppointmentPanelGUI\getHTML(), ilObjCourse\getSubItems(), ilBookingEntry\isAppointmentBookableForUser(), ilECSCategoryMappingRule\matchesValue(), ilObjGroup\register(), and ilECSCategoryMappingRule\validate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _before()

static ilDateTime::_before ( ilDateTime  $start,
ilDateTime  $end,
  $a_compare_field = '',
  $a_tz = '' 
)
static

compare two dates and check start is before end This method does not consider tz offsets.

So you have to take care that both dates are defined in the the same timezone

@access public

Parameters
objectilDateTime
objectilDateTime
stringfield used for comparison. E.g IL_CAL_YEAR checks if start is one or more years earlier than end
stringtimezone
Returns
bool

Definition at line 156 of file class.ilDateTime.php.

157 {
158 if($start->isNull() || $end->isNull())
159 {
160 return;
161 }
162
163 switch($a_compare_field)
164 {
165 case IL_CAL_YEAR:
166 return $start->get(IL_CAL_FKT_DATE,'Y',$a_tz) < $end->get(IL_CAL_FKT_DATE,'Y',$a_tz);
167
168 case IL_CAL_MONTH:
169 return (int) $start->get(IL_CAL_FKT_DATE,'Ym',$a_tz) < $end->get(IL_CAL_FKT_DATE,'Ym',$a_tz);
170
171 case IL_CAL_DAY:
172 return (int) $start->get(IL_CAL_FKT_DATE,'Ymd',$a_tz) < $end->get(IL_CAL_FKT_DATE,'Ymd',$a_tz);
173
174 case '':
175 default:
176 return $start->dt_obj < $end->dt_obj;
177
178 }
179 }

References $start, get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_YEAR, and isNull().

Referenced by ilObjGroupAccess\_registrationEnabled(), _within(), ilCalendarBlockGUI\addMiniMonth(), ilMiniCalendarGUI\addMiniMonth(), ilCalendarRecurrenceCalculator\applyLimits(), ilCalendarRecurrenceCalculator\calculateDateList(), ilBookingEntry\cancelBooking(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilECSServerTableGUI\fillRow(), ilPageObject\getActive(), ilCalendarBlockGUI\getHTML(), ilObjCourse\getSubItems(), ilExerciseManagementGUI\handleIndividualDeadlineCallsObject(), ilECSTimePlace\loadFromJson(), ilObjCourseAccess\lookupRegistrationInfo(), ilObjGroupAccess\lookupRegistrationInfo(), ilECSCategoryMappingRule\matchesValue(), ilCalendarRecurrenceCalculator\optimizeStartingTime(), ilUserQuery\query(), ilObjGroup\register(), ilStudyProgramme\setLastChange(), ilStudyProgrammeAssignment\setLastChange(), ilStudyProgrammeProgress\setLastChange(), ilCalendarMonthGUI\show(), ilCalendarPresentationGUI\synchroniseExternalCalendars(), and ilCalendarEntry\validate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _equals()

static ilDateTime::_equals ( ilDateTime  $start,
ilDateTime  $end,
  $a_compare_field = '',
  $a_tz = '' 
)
static

Check if two date are equal.

@access public

Parameters
objectilDateTime
objectilDateTime
stringfield used for comparison. E.g IL_CAL_YEAR checks if start is the same years than end
stringtimzone

Definition at line 192 of file class.ilDateTime.php.

193 {
194 if($start->isNull() || $end->isNull())
195 {
196 return;
197 }
198
199 switch($a_compare_field)
200 {
201 case IL_CAL_YEAR:
202 return $start->get(IL_CAL_FKT_DATE,'Y',$a_tz) == $end->get(IL_CAL_FKT_DATE,'Y',$a_tz);
203
204 case IL_CAL_MONTH:
205 return (int) $start->get(IL_CAL_FKT_DATE,'Ym',$a_tz) == $end->get(IL_CAL_FKT_DATE,'Ym',$a_tz);
206
207 case IL_CAL_DAY:
208 return (int) $start->get(IL_CAL_FKT_DATE,'Ymd',$a_tz) == $end->get(IL_CAL_FKT_DATE,'Ymd',$a_tz);
209
210 case '':
211 default:
212 return $start->dt_obj == $end->dt_obj;
213
214 }
215 }

References $start, get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_YEAR, and isNull().

Referenced by ilCalendarUtil\_isToday(), _within(), ilCalendarBlockGUI\addMiniMonth(), ilMiniCalendarGUI\addMiniMonth(), ilCalendarRecurrenceCalculator\calculateDateList(), ilCalendarAppointmentGUI\edit(), ilSubItemSelectionTableGUI\fillRow(), ilDatePresentation\formatPeriod(), ilDatePresentation\isToday(), ilDatePresentation\isTomorrow(), ilDatePresentation\isYesterday(), ilDateList\removeByDAY(), and ilCalendarMonthGUI\show().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _within()

static ilDateTime::_within ( ilDateTime  $dt,
ilDateTime  $start,
ilDateTime  $end,
  $a_compare_field = '',
  $a_tz = '' 
)
static

Check whether an date is within a date duration given by start and end.

Parameters
ilDateTime$dt
ilDateTime$start
ilDateTime$end
type$a_compare_field
type$a_tz

Definition at line 262 of file class.ilDateTime.php.

263 {
264 return
265 (ilDateTime::_after($dt, $start,$a_compare_field,$a_tz) or ilDateTime::_equals($dt, $start,$a_compare_field,$a_tz)) &&
266 (ilDateTime::_before($dt, $end,$a_compare_field,$a_tz) or ilDateTime::_equals($dt, $end,$a_compare_field,$a_tz));
267 }
ilDateTime\_equals
static _equals(ilDateTime $start, ilDateTime $end, $a_compare_field='', $a_tz='')
Check if two date are equal.
Definition: class.ilDateTime.php:192
ilDateTime\_after
static _after(ilDateTime $start, ilDateTime $end, $a_compare_field='', $a_tz='')
compare two dates and check start is after end This method does not consider tz offsets.
Definition: class.ilDateTime.php:229
ilDateTime\_before
static _before(ilDateTime $start, ilDateTime $end, $a_compare_field='', $a_tz='')
compare two dates and check start is before end This method does not consider tz offsets.
Definition: class.ilDateTime.php:156

References $start, _after(), _before(), and _equals().

Referenced by ilCalendarScheduleFilterExercise\addCustomEvents(), and ilObjCourse\getSubItems().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get()

ilDateTime::get (   $a_format,
  $a_format_str = '',
  $a_tz = '' 
)

get formatted date

@access public

Parameters
intformat type
stringformat string
stringa specific timezone

Reimplemented in ilDate.

Definition at line 505 of file class.ilDateTime.php.

506 {
507 if($this->isNull())
508 {
509 return;
510 }
511
512 if($a_tz)
513 {
514 try
515 {
516 $timezone = ilTimeZone::_getInstance($a_tz);
517 }
518 catch(ilTimeZoneException $exc)
519 {
520 $this->log->write(__METHOD__.': Invalid timezone given. Timezone: '.$a_tz);
521 }
522 }
523 else
524 {
525 $timezone = $this->default_timezone;
526 }
527
528 $out_date = clone($this->dt_obj);
529 $out_date->setTimeZone(new DateTimeZone($timezone->getIdentifier()));
530
531 switch($a_format)
532 {
533 case IL_CAL_UNIX:
534 // timezone unrelated
535 $date = $this->getUnixTime();
536 break;
537
538 case IL_CAL_DATE:
539 $date = $out_date->format('Y-m-d');
540 break;
541
542 case IL_CAL_DATETIME:
543 $date = $out_date->format('Y-m-d H:i:s');
544 break;
545
546 case IL_CAL_FKT_DATE:
547 $date = $out_date->format($a_format_str);
548 break;
549
550 case IL_CAL_FKT_GETDATE:
551 $date = array(
552 'seconds' => (int)$out_date->format('s')
553 ,'minutes' => (int)$out_date->format('i')
554 ,'hours' => (int)$out_date->format('G')
555 ,'mday' => (int)$out_date->format('j')
556 ,'wday' => (int)$out_date->format('w')
557 ,'mon' => (int)$out_date->format('n')
558 ,'year' => (int)$out_date->format('Y')
559 ,'yday' => (int)$out_date->format('z')
560 ,'weekday' => $out_date->format('l')
561 ,'month' => $out_date->format('F')
562 ,'isoday' => (int)$out_date->format('N')
563 );
564 break;
565
566 case IL_CAL_ISO_8601:
567 $date = $out_date->format('c');
568 break;
569
570 case IL_CAL_TIMESTAMP:
571 $date = $out_date->format('YmdHis');
572 break;
573 }
574
575 return $date;
576 }
IL_CAL_FKT_GETDATE
const IL_CAL_FKT_GETDATE
Definition: class.ilDateTime.php:13
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:10
IL_CAL_ISO_8601
const IL_CAL_ISO_8601
Definition: class.ilDateTime.php:15
IL_CAL_TIMESTAMP
const IL_CAL_TIMESTAMP
Definition: class.ilDateTime.php:14
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
ilDateTime\getUnixTime
getUnixTime()
get unix time
Definition: class.ilDateTime.php:334

References $default_timezone, $timezone, ilTimeZone\_getInstance(), getUnixTime(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_FKT_DATE, IL_CAL_FKT_GETDATE, IL_CAL_ISO_8601, IL_CAL_TIMESTAMP, IL_CAL_UNIX, and isNull().

Referenced by _after(), _before(), _equals(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarRecurrenceCalculator\getYearWeekDays(), ilCalendarRegistration\isRegistered(), ilUtil\period2String(), ilExcel\prepareDateValue(), ilExAssignment\setIndividualDeadline(), ilStudyProgramme\setLastChange(), ilStudyProgrammeAssignment\setLastChange(), ilStudyProgrammeProgress\setLastChange(), and ilCalendarRegistration\unregister().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getTimeZoneIdentifier()

ilDateTime::getTimeZoneIdentifier ( )

get timezone identifier

@access public

Definition at line 137 of file class.ilDateTime.php.

138 {
139 return $this->timezone->getIdentifier();
140 }

Referenced by parsePartsToDate().

+ Here is the caller graph for this function:

◆ getUnixTime()

ilDateTime::getUnixTime ( )

get unix time

@access public

Definition at line 334 of file class.ilDateTime.php.

335 {
336 if(!$this->isNull())
337 {
338 return $this->dt_obj->getTimestamp();
339 }
340 }

References isNull().

Referenced by get(), and increment().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getUTCOffset()

ilDateTime::getUTCOffset ( )

get UTC offset

@access public

Returns
offset to utc in seconds

Definition at line 348 of file class.ilDateTime.php.

349 {
350 if(!$this->isNull())
351 {
352 // already correct/current timezone?
353 $offset = $this->dt_obj->getOffset();
354
355 // TODO: This is wrong: calculate UTC offset of given date
356 // $offset = mktime(0,0,0,2,1,1970) - gmmktime(0,0,0,2,1,1970);
357 }
358 return $offset;
359 }

References isNull().

+ Here is the call graph for this function:

◆ increment()

ilDateTime::increment (   $a_type,
  $a_count = 1 
)

increment

@access public

Parameters
inttype
intcount

Definition at line 277 of file class.ilDateTime.php.

278 {
279 if($this->isNull())
280 {
281 return;
282 }
283
284 $sub = ($a_count < 0);
285 $count_str = abs($a_count);
286
287 switch($a_type)
288 {
289 case self::YEAR:
290 $count_str .= 'year';
291 break;
292
293 case self::MONTH:
294 $count_str .= 'month';
295 break;
296
297 case self::WEEK:
298 $count_str .= 'week';
299 break;
300
301 case self::DAY:
302 $count_str .= 'day';
303 break;
304
305 case self::HOUR:
306 $count_str .= 'hour';
307 break;
308
309 case self::MINUTE:
310 $count_str .= 'minute';
311 break;
312 }
313
314 $interval = date_interval_create_from_date_string($count_str);
315 if(!$sub)
316 {
317 $this->dt_obj->add($interval);
318 }
319 else
320 {
321 $this->dt_obj->sub($interval);
322 }
323
324 // ???
325 return $this->getUnixTime();
326 }
$a_type
$a_type
Definition: workflow.php:93

References $a_type, DAY, getUnixTime(), HOUR, isNull(), MINUTE, MONTH, WEEK, and YEAR.

Referenced by ilCalendarSchedule\initPeriod().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isNull()

ilDateTime::isNull ( )

Check if a date is null (Datetime == '0000-00-00 00:00:00', unixtime == 0,...)

Returns
bool

Definition at line 105 of file class.ilDateTime.php.

106 {
107 return !($this->dt_obj instanceof DateTime);
108 }

Referenced by _after(), _before(), _equals(), ilDatePresentation\formatDate(), get(), getUnixTime(), getUTCOffset(), and increment().

+ Here is the caller graph for this function:

◆ parsePartsToDate()

ilDateTime::parsePartsToDate (   $a_year,
  $a_month,
  $a_day,
  $a_hour = null,
  $a_min = null,
  $a_sec = null,
  $a_timezone = null 
)
protected

Definition at line 361 of file class.ilDateTime.php.

362 {
363 $a_year = (int)$a_year;
364 $a_month = (int)$a_month;
365 $a_day = (int)$a_day;
366
367 if(!$a_year)
368 {
369 return;
370 }
371
372 try
373 {
374 $a_hour = (int)$a_hour;
375 $a_min = (int)$a_min;
376 $a_sec = (int)$a_sec;
377
378 $format = $a_year.'-'.$a_month.'-'.$a_day;
379
380 if($a_hour !== null)
381 {
382 $format .= ' '.(int)$a_hour.':'.(int)$a_min.':'.(int)$a_sec;
383
384 // use current timezone if no other given
385 if(!$a_timezone)
386 {
387 $a_timezone = $this->getTimeZoneIdentifier();
388 }
389
390 $date = new DateTime($format, new DateTimeZone($a_timezone));
391 }
392 else
393 {
394 $date = new DateTime($format);
395 }
396 }
397 catch (Exception $ex)
398 {
399 // :TODO: do anything?
400 }
401 return ($date instanceof DateTime)
402 ? $date
403 : null;
404 }
ilDateTime\getTimeZoneIdentifier
getTimeZoneIdentifier()
get timezone identifier
Definition: class.ilDateTime.php:137

References getTimeZoneIdentifier().

Referenced by setDate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setDate()

ilDateTime::setDate (   $a_date,
  $a_format 
)

set date

@access public

Parameters
mixeddate
intformat

Definition at line 414 of file class.ilDateTime.php.

415 {
416 $this->dt_obj = null;
417
418 if(!$a_date)
419 {
420 return;
421 }
422
423 switch($a_format)
424 {
425 case IL_CAL_UNIX:
426 try
427 {
428 $this->dt_obj = new DateTime('@'.$a_date);
429 }
430 catch (Exception $ex)
431 {
432 $this->log->write(__METHOD__.': Cannot parse date: '.$a_date);
433 throw new ilDateTimeException('Cannot parse date.');
434 }
435 break;
436
437 case IL_CAL_DATETIME:
438 $matches = preg_match('/^(\d{4})-?(\d{2})-?(\d{2})([T\s]?(\d{2}):?(\d{2}):?(\d{2})(\.\d+)?(Z|[\+\-]\d{2}:?\d{2})?)$/i',$a_date,$d_parts);
439 if($matches < 1)
440 {
441 $this->log->write(__METHOD__.': Cannot parse date: '.$a_date);
442 $this->log->write(__METHOD__.': '.print_r($matches,true));
443 $this->log->logStack();
444 throw new ilDateTimeException('Cannot parse date.');
445 }
446
447 $tz_id = ($d_parts[9] == 'Z')
448 ? 'UTC'
449 : null;
450 $this->dt_obj = $this->parsePartsToDate($d_parts[1], $d_parts[2], $d_parts[3],
451 $d_parts[5], $d_parts[6], $d_parts[7], $tz_id);
452 break;
453
454 case IL_CAL_DATE:
455 try
456 {
457 // Pure dates are not timezone sensible.
458 $this->dt_obj = new DateTime($a_date, new DateTimeZone('UTC'));
459 }
460 catch (Exception $ex)
461 {
462 $this->log->write(__METHOD__.': Cannot parse date : '.$a_date);
463 return false;
464 }
465 break;
466
467 case IL_CAL_FKT_GETDATE:
468 // Format like getdate parameters
469 $this->dt_obj = $this->parsePartsToDate($a_date['year'], $a_date['mon'], $a_date['mday'],
470 $a_date['hours'], $a_date['minutes'], $a_date['seconds']);
471 break;
472
473 case IL_CAL_TIMESTAMP:
474 if(preg_match("/(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/", $a_date,$d_parts) == false)
475 {
476 $this->log->write(__METHOD__.': Cannot parse date: '.$a_date);
477 throw new ilDateTimeException('Cannot parse date.');
478 }
479 $this->dt_obj = $this->parsePartsToDate($d_parts[1], $d_parts[2], $d_parts[3],
480 $d_parts[4], $d_parts[5], $d_parts[6]);
481 break;
482
483 case IL_CAL_ISO_8601:
484 $this->dt_obj = DateTime::createFromFormat(DateTime::ISO8601, $a_date);
485 break;
486 }
487
488 // internally we always use the default timezone
489 if($this->dt_obj)
490 {
491 $this->dt_obj->setTimeZone(new DateTimeZone($this->default_timezone->getIdentifier()));
492 }
493
494 return true;
495 }
ilDateTime\parsePartsToDate
parsePartsToDate($a_year, $a_month, $a_day, $a_hour=null, $a_min=null, $a_sec=null, $a_timezone=null)
Definition: class.ilDateTime.php:361

References IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_FKT_GETDATE, IL_CAL_ISO_8601, IL_CAL_TIMESTAMP, IL_CAL_UNIX, and parsePartsToDate().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ switchTimeZone()

ilDateTime::switchTimeZone (   $a_timezone_identifier = '')

Switch timezone.

@access public

Parameters
stringPHP timezone identifier
Exceptions
ilDateTimeException

Definition at line 117 of file class.ilDateTime.php.

118 {
119 try
120 {
121 $this->timezone = ilTimeZone::_getInstance($a_timezone_identifier);
122 return true;
123 }
124 catch(ilTimeZoneException $e)
125 {
126 $this->log->write('Unsupported timezone given: '.$a_timezone_identifier);
127 throw new ilDateTimeException('Unsupported timezone given. Timezone: '.$a_timezone_identifier);
128 }
129 }

References ilTimeZone\_getInstance().

Referenced by ilCalendarRecurrenceCalculator\adjustTimeZones().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $default_timezone

ilDateTime::$default_timezone = null
protected

Definition at line 44 of file class.ilDateTime.php.

Referenced by get().

◆ $dt_obj

ilDateTime::$dt_obj
protected

Definition at line 46 of file class.ilDateTime.php.

Referenced by __clone().

◆ $log

ilDateTime::$log
protected

Definition at line 41 of file class.ilDateTime.php.

◆ $timezone

ilDateTime::$timezone = null
protected

Definition at line 43 of file class.ilDateTime.php.

Referenced by get().

◆ DAY

const ilDateTime::DAY = 'day'

Definition at line 37 of file class.ilDateTime.php.

Referenced by ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilCalendarRecurrenceCalculator\applyBYYEARDAYRules(), ilCalendarSchedule\getByDay(), ilCalendarHeaderNavigationGUI\getHTML(), increment(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilBookingReservationsTableGUI\initFilter(), ilLoggerCronCleanErrorFiles\run(), and ilCalendarDayGUI\show().

◆ HOUR

const ilDateTime::HOUR = 'hour'

Definition at line 38 of file class.ilDateTime.php.

Referenced by ilConsultationHoursGUI\createAppointments(), and increment().

◆ MINUTE

const ilDateTime::MINUTE = 'minute'

Definition at line 39 of file class.ilDateTime.php.

Referenced by ilConsultationHoursGUI\createAppointments(), and increment().

◆ MONTH

const ilDateTime::MONTH = 'month'

Definition at line 35 of file class.ilDateTime.php.

Referenced by ilCalendarBlockGUI\addMiniMonth(), ilMiniCalendarGUI\addMiniMonth(), ilCalendarRecurrenceCalculator\applyBYMONTHRules(), ilCalendarHeaderNavigationGUI\getHTML(), increment(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilCalendarHeaderNavigationGUI\incrementDate(), and ilCalendarMonthGUI\show().

◆ WEEK

const ilDateTime::WEEK = 'week'

Definition at line 36 of file class.ilDateTime.php.

Referenced by ilCalendarRecurrenceCalculator\applyBYWEEKNORules(), ilCalendarHeaderNavigationGUI\getHTML(), increment(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilObjBookingPoolGUI\renderSlots(), and ilCalendarWeekGUI\show().

◆ YEAR

const ilDateTime::YEAR = 'year'

Definition at line 34 of file class.ilDateTime.php.

Referenced by ilConsultationHoursGUI\createAppointments(), increment(), ilCalendarRecurrenceCalculator\incrementByFrequency(), and ilObjBookingPoolGUI\renderSlots().

The documentation for this class was generated from the following file: