ilDateTime Class Reference

@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...
	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 Attributes
	$log
	$timezone = null
	$default_timezone = null
	$unix = 0

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

mixed	integer string following the format given as the second parameter
int	format of date presentation

throws ilDateTimeException

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

        {
                global $ilLog;
                
                $this->log = $ilLog;
                
                try
                {
                        $this->timezone = ilTimeZone::_getInstance($a_tz);
                        $this->default_timezone = ilTimeZone::_getInstance('');
                        
                        if(!$a_date)
                        {
                                $this->setDate(0,IL_CAL_UNIX);
                        }
                        else
                        {
                                $this->setDate($a_date,$a_format);
                        }
                }
                catch(ilTimeZoneException $exc)
                {
                        $this->log->write(__METHOD__.': '.$exc->getMessage());
                        throw new ilDateTimeException('Unsupported timezone given. Timezone: '.$a_tz);
                }
        }

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

Here is the call graph for this function:

Member Function Documentation

__toString()

ilDateTime::__toString

(

)

to string for date time objects Output is user time zone

@access public

Parameters

return

Reimplemented in ilDate.

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

        {
                return $this->get(IL_CAL_DATETIME).'<br>';
        }

References IL_CAL_DATETIME.

_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

object	ilDateTime
object	ilDateTime
string	field used for comparison. E.g IL_CAL_YEAR checks if start is one or more years after than end
string	timezone

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

        {
                switch($a_compare_field)
                {
                        case IL_CAL_YEAR:
                                return $start->get(IL_CAL_FKT_DATE,'Y',$a_tz) > $end->get(IL_CAL_FKT_DATE,'Y',$a_tz);
 
                        case IL_CAL_MONTH:
                                return (int) $start->get(IL_CAL_FKT_DATE,'Ym',$a_tz) > $end->get(IL_CAL_FKT_DATE,'Ym',$a_tz);
 
                        case IL_CAL_DAY:
                                return (int) $start->get(IL_CAL_FKT_DATE,'Ymd',$a_tz) > $end->get(IL_CAL_FKT_DATE,'Ymd',$a_tz);
 
                        case '':
                        default:
                                return $start->get(IL_CAL_UNIX) > $end->get(IL_CAL_UNIX);
                        
                }
        }

References get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_UNIX, and IL_CAL_YEAR.

Referenced by ilObjGroupAccess\_registrationEnabled(), _within(), ilCalendarRecurrenceCalculator\applyLimits(), ilCalendarRecurrenceCalculator\calculateDateList(), 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

object	ilDateTime
object	ilDateTime
string	field used for comparison. E.g IL_CAL_YEAR checks if start is one or more years earlier than end
string	timezone

Returns

bool

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

        {
                switch($a_compare_field)
                {
                        case IL_CAL_YEAR:
                                return $start->get(IL_CAL_FKT_DATE,'Y',$a_tz) < $end->get(IL_CAL_FKT_DATE,'Y',$a_tz);
                                
                        case IL_CAL_MONTH:
                                return (int) $start->get(IL_CAL_FKT_DATE,'Ym',$a_tz) < $end->get(IL_CAL_FKT_DATE,'Ym',$a_tz);
                        
                        case IL_CAL_DAY:
                                return (int) $start->get(IL_CAL_FKT_DATE,'Ymd',$a_tz) < $end->get(IL_CAL_FKT_DATE,'Ymd',$a_tz);
 
                        case '':
                        default:
                                return $start->get(IL_CAL_UNIX) < $end->get(IL_CAL_UNIX);
                        
                }
        }

References get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_UNIX, and IL_CAL_YEAR.

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(), ilECSTimePlace\loadFromJson(), ilObjCourseAccess\lookupRegistrationInfo(), ilObjGroupAccess\lookupRegistrationInfo(), ilECSCategoryMappingRule\matchesValue(), ilCalendarRecurrenceCalculator\optimizeStartingTime(), ilUserQuery\query(), ilObjGroup\register(), ilCalendarMonthGUI\show(), ilCalendarPresentationGUI\synchroniseExternalCalendars(), ilObjGroup\validate(), 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

object	ilDateTime
object	ilDateTime
string	field used for comparison. E.g IL_CAL_YEAR checks if start is the same years than end
string	timzone

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

        {
                switch($a_compare_field)
                {
                        case IL_CAL_YEAR:
                                return $start->get(IL_CAL_FKT_DATE,'Y',$a_tz) == $end->get(IL_CAL_FKT_DATE,'Y',$a_tz);
 
                        case IL_CAL_MONTH:
                                return (int) $start->get(IL_CAL_FKT_DATE,'Ym',$a_tz) == $end->get(IL_CAL_FKT_DATE,'Ym',$a_tz);
 
                        case IL_CAL_DAY:
                                return (int) $start->get(IL_CAL_FKT_DATE,'Ymd',$a_tz) == $end->get(IL_CAL_FKT_DATE,'Ymd',$a_tz);
 
                        case '':
                        default:
                                return $start->get(IL_CAL_UNIX) == $end->get(IL_CAL_UNIX);
                        
                }
        }

References get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_UNIX, and IL_CAL_YEAR.

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 234 of file class.ilDateTime.php.

        {
                return 
                        (ilDateTime::_after($dt, $start,$a_compare_field,$a_tz) or ilDateTime::_equals($dt, $start,$a_compare_field,$a_tz)) &&
                        (ilDateTime::_before($dt, $end,$a_compare_field,$a_tz) or ilDateTime::_equals($dt, $end,$a_compare_field,$a_tz));
        }

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

Referenced by 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

int	format type
string	format string
string	a specific timezone

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

        {
                if($a_tz)
                {
                        try
                        {
                                $timezone = ilTimeZone::_getInstance($a_tz);
                        }
                        catch(ilTimeZoneException $exc)
                        {
                                $this->log->write(__METHOD__.': Invalid timezone given. Timezone: '.$a_tz);
                        }
                }
                else
                {
                        #$timezone = $this->timezone;
                        $timezone = $this->default_timezone; 
                }
 
                switch($a_format)
                {
                        case IL_CAL_UNIX:
                                $date = $this->getUnixTime();
                                break;
                        
                        case IL_CAL_DATE:
                                $timezone->switchTZ();
                                $date = date('Y-m-d',$this->getUnixTime());
                                $timezone->restoreTZ();
                                break;
                        
                        case IL_CAL_DATETIME:
                                $timezone->switchTZ();
                                $date = date('Y-m-d H:i:s',$this->getUnixTime());
                                $timezone->restoreTZ();
                                break;
                        
                        case IL_CAL_FKT_DATE:
                                $timezone->switchTZ();
                                $date = date($a_format_str,$this->getUnixTime());
                                $timezone->restoreTZ();
                                break;
                                
                        case IL_CAL_FKT_GETDATE:
                                $timezone->switchTZ();
                                $date = getdate($this->getUnixTime());
                                $timezone->restoreTZ();
 
                                // add iso 8601 week day number (Sunday = 7)
                                $date['isoday'] = $date['wday'] == 0 ? 7 : $date['wday'];
                                break;
                        
                        case IL_CAL_ISO_8601:
                                $date = date('c',$this->getUnixTime());
                                break;
                                
                        case IL_CAL_TIMESTAMP:
                                $timezone->switchTZ();
                                $date = date('YmdHis',$this->getUnixTime());
                                $timezone->restoreTZ();
                                break;
                }
                return $date;
        }

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, and IL_CAL_UNIX.

Referenced by _after(), _before(), _equals(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarRecurrenceCalculator\getYearWeekDays(), ilCalendarRegistration\isRegistered(), ilUtil\period2String(), 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 124 of file class.ilDateTime.php.

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

getUnixTime()

ilDateTime::getUnixTime

(

)

get unix time

@access public

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

        {
                return $this->unix;
        }

References $unix.

Referenced by get().

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 307 of file class.ilDateTime.php.

        {
                $this->timezone->switchTZ();
                // TODO: This is wrong: calculate UTC offset of given date
                $offset = mktime(0,0,0,2,1,1970) - gmmktime(0,0,0,2,1,1970);
                $this->timezone->restoreTZ();
                return $offset;         
        }

increment()

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

increment

@access public

Parameters

int	type
int	count

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

        {
                $count_str = $a_count > 0 ? ('+'.$a_count.' ') : ($a_count.' ');
 
                $this->timezone->switchTZ();
                switch($a_type)
                {
                        case self::YEAR:
                                $this->unix = strtotime($count_str.'year',$this->unix);
                                break;                          
 
                        case self::MONTH:
                                $this->unix = strtotime($count_str.'month',$this->unix);
                                break;
                                
                        case self::WEEK:
                                $this->unix = strtotime($count_str.'week',$this->unix);
                                break;
                                
                        case self::DAY:
                                $this->unix = strtotime($count_str.'day',$this->unix);
                                break;
                                
                        case self::HOUR:
                                $this->unix = strtotime($count_str.'hour',$this->unix);
                                break;
                                
                        case self::MINUTE:
                                
                                $this->unix = strtotime($count_str.'minute',$this->unix);
                                $d = new ilDateTime($this->unix,IL_CAL_UNIX);
                                
 
                                break;
                                
                }
                $this->timezone->restoreTZ();
                return $this->unix;
        }

References $d, $unix, DAY, HOUR, IL_CAL_UNIX, MINUTE, MONTH, WEEK, and YEAR.

Referenced by ilCalendarSchedule\initPeriod().

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 92 of file class.ilDateTime.php.

        {
                return $this->unix ? false : true;       
        }

Referenced by ilDatePresentation\formatDate().

Here is the caller graph for this function:

setDate()

ilDateTime::setDate	(		$a_date,
			$a_format
	)

set date

@access public

Parameters

mixed	date
int	format

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

        {
                switch($a_format)
                {
                        case IL_CAL_UNIX:
                                $this->unix = $a_date;
                                break;
                                
                        case IL_CAL_DATETIME:
                                $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);
                                if($matches < 1)
                                {
                                        $this->log->write(__METHOD__.': Cannot parse date: '.$a_date);
                                        $this->log->write(__METHOD__.': '.print_r($matches,true));
                                        $this->log->logStack();
                                        throw new ilDateTimeException('Cannot parse date.');
                                }
                                
                                // UTC designator
                                if($d_parts[9] == 'Z')
                                {
                                        $utc = ilTimeZone::_getInstance('UTC');
                                        $utc->switchTZ();
                                }
                                else
                                {
                                        $this->timezone->switchTZ();
                                }
                                $this->unix = mktime(
                                        isset($d_parts[5]) ? $d_parts[5] : 0, 
                                        isset($d_parts[6]) ? $d_parts[6] : 0,
                                        isset($d_parts[7]) ? $d_parts[7] : 0,
                                        $d_parts[2],
                                        $d_parts[3],
                                        $d_parts[1]);
                                
                                if($d_parts[0] == '0000-00-00 00:00:00')
                                {
                                        $this->unix = 0;
                                }
 
                                if($d_parts[9] == 'Z')
                                {
                                        $utc->restoreTZ();
                                }
                                else
                                {
                                        $this->timezone->restoreTZ();
                                }
                                break;
 
                        case IL_CAL_DATE:
                                // Pure dates are not timezone sensible.
                                $timezone = ilTimeZone::_getInstance('UTC');
                                $timezone->switchTZ();
                                $unix = strtotime($a_date);
                                $timezone->restoreTZ();
                                if($unix === false)
                                {
                                        $this->log->write(__METHOD__.': Cannot parse date : '.$a_date);
                                        $this->unix = 0;
                                        return false;                                   
                                }
                                $this->unix = $unix;
                                break;
                                
                        case IL_CAL_FKT_GETDATE:
                                if (!isset($a_date['seconds']))
                                {
                                        $a_date['seconds'] = false;
                                }
                                // Format like getdate parameters
                                $this->timezone->switchTZ();
                                $this->unix = mktime(
                                        $a_date['hours'],
                                        $a_date['minutes'],
                                        $a_date['seconds'],
                                        $a_date['mon'],
                                        $a_date['mday'],
                                        $a_date['year']);
                                $this->timezone->restoreTZ();
                                
                                // TODO: choose better error handling
                                if(!$a_date['year'])
                                {
                                        $this->unix = 0;
                                }
                                break;
                                
                        case IL_CAL_TIMESTAMP:
                                if(preg_match("/(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/", $a_date,$d_parts) == false)
                                {
                                        $this->log->write(__METHOD__.': Cannot parse date: '.$a_date);
                                        throw new ilDateTimeException('Cannot parse date.');
                                }
                                $this->timezone->switchTZ();
                                $this->unix = mktime(
                                        isset($d_parts[4]) ? $d_parts[4] : 0, 
                                        isset($d_parts[5]) ? $d_parts[5] : 0,
                                        isset($d_parts[6]) ? $d_parts[6] : 0,
                                        $d_parts[2],
                                        $d_parts[3],
                                        $d_parts[1]);
                                        
                                if($d_parts[0] == '00000000000000' or
                                        $d_parts[0] == '00000000')
                                {
                                        $this->unix = 0;
                                }
                                $this->timezone->restoreTZ();
                                break;
                                
                        case IL_CAL_ISO_8601:
                                $dt = DateTime::createFromFormat(DateTime::ISO8601, $a_date);
                                $this->unix = $dt->getTimeStamp();
                                break;
                                
                }
                return true;
        }

References $timezone, $unix, ilTimeZone\_getInstance(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_FKT_GETDATE, IL_CAL_ISO_8601, IL_CAL_TIMESTAMP, and IL_CAL_UNIX.

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

string

PHP timezone identifier

Exceptions

ilDateTimeException

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

        {
                try
                {
                        $this->timezone = ilTimeZone::_getInstance($a_timezone_identifier);
                        return true;
                }
                catch(ilTimeZoneException $e)
                {
                        $this->log->write('Unsupported timezone given: '.$a_timezone_identifier);
                        throw new ilDateTimeException('Unsupported timezone given. Timezone: '.$a_timezone_identifier);
                }
        }

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().

$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(), and setDate().

$unix

ilDateTime::$unix = 0

protected

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

Referenced by getUnixTime(), increment(), and setDate().

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(), 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 increment(), ilCalendarRecurrenceCalculator\incrementByFrequency(), and ilObjBookingPoolGUI\renderSlots().

---

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

• Services/Calendar/classes/class.ilDateTime.php