class.ilDatePresentation.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

include_once('./Services/Calendar/classes/class.ilDate.php');
include_once('./Services/Calendar/classes/class.ilCalendarSettings.php');

class ilDatePresentation
{
        public static $use_relative_dates = true;
        private static $lang = null;
        
        public static $today = null;
        public static $tomorrow = null;
        public static $yesterday = null;
        
        public static function setUseRelativeDates($a_status)
        {
                self::$use_relative_dates = $a_status;
        }
         
        public static function useRelativeDates()
        {
                return self::$use_relative_dates;
        }
        
        public static function setLanguage($a_lng)
        {
                self::$lang = $a_lng;
        }
        
        public static function getLanguage()
        {
                global $lng;
                
                return self::$lang ? self::$lang : $lng;                
        }
        
        public static function resetToDefaults()
        {
                global $lng;
                
                self::setLanguage($lng);
                self::setUseRelativeDates(true);
        }
        
        
        
        public static function formatDate(ilDateTime $date)
        {
                global $lng,$ilUser;
                
                if($date->isNull())
                {
                        return self::getLanguage()->txt('no_date');
                }
                
                $has_time = !is_a($date,'ilDate');
                
                // Converting pure dates to user timezone might return wrong dates
                if($has_time)
                {
                        $date_info = $date->get(IL_CAL_FKT_GETDATE,'',$ilUser->getTimeZone());  
                }
                else
                {
                        $date_info = $date->get(IL_CAL_FKT_GETDATE,'','UTC');
                }
                

                if(self::isToday($date) and self::useRelativeDates())
                {
                        $date_str = self::getLanguage()->txt('today');
                }
                elseif(self::isTomorrow($date) and self::useRelativeDates())
                {
                        $date_str = self::getLanguage()->txt('tomorrow');
                }
                elseif(self::isYesterday($date) and self::useRelativeDates())
                {
                        $date_str = self::getLanguage()->txt('yesterday');
                }
                else
                {
                        include_once('./Services/Calendar/classes/class.ilCalendarUtil.php');
                        $date_str = $date->get(IL_CAL_FKT_DATE,'d').'. '.
                                ilCalendarUtil::_numericMonthToString($date_info['mon'],false).' '.
                                $date_info['year'];
                }
                
                if(!$has_time)
                {
                        return $date_str;
                }
                
                switch($ilUser->getTimeFormat())
                {
                        case ilCalendarSettings::TIME_FORMAT_24:
                                return $date_str.', '.$date->get(IL_CAL_FKT_DATE,'H:i',$ilUser->getTimeZone());
                                
                        case ilCalendarSettings::TIME_FORMAT_12:
                                return $date_str.', '.$date->get(IL_CAL_FKT_DATE,'g:ia',$ilUser->getTimeZone());
                }
        }
        
        public static function formatPeriod(ilDateTime $start,ilDateTime $end)
        {
                global $ilUser;
                
                $has_time = !is_a($start,'ilDate');
                
                // Same day
                if(ilDateTime::_equals($start,$end,IL_CAL_DAY,$ilUser->getTimeZone()))
                {
                        if(!$has_time)
                        {
                                return self::formatDate($start);
                        }
                        else
                        {
                                $date_str = self::formatDate(
                                        new ilDate($start->get(IL_CAL_DATE,'',$ilUser->getTimeZone()),IL_CAL_DATE));
                                
                                // $start == $end
                                if(ilDateTime::_equals($start,$end))
                                {
                                        switch($ilUser->getTimeFormat())
                                        {
                                                case ilCalendarSettings::TIME_FORMAT_24:
                                                        return $date_str.', '.$start->get(IL_CAL_FKT_DATE,'H:i',$ilUser->getTimeZone());
                                                        
                                                case ilCalendarSettings::TIME_FORMAT_12:
                                                        return $date_str.', '.$start->get(IL_CAL_FKT_DATE,'h:i a',$ilUser->getTimeZone());
                                        }
                                }
                                else
                                {
                                        switch($ilUser->getTimeFormat())
                                        {
                                                case ilCalendarSettings::TIME_FORMAT_24:
                                                        return $date_str.', '.$start->get(IL_CAL_FKT_DATE,'H:i',$ilUser->getTimeZone()).' - '.
                                                                $end->get(IL_CAL_FKT_DATE,'H:i',$ilUser->getTimeZone());
                                                        
                                                case ilCalendarSettings::TIME_FORMAT_12:
                                                        return $date_str.', '.$start->get(IL_CAL_FKT_DATE,'g:ia',$ilUser->getTimeZone()).' - '.
                                                                $end->get(IL_CAL_FKT_DATE,'g:ia',$ilUser->getTimeZone());
                                        }
                                }
                        }
                }
                // Different days
                return self::formatDate($start).' - '.self::formatDate($end);
        }



        public static function isToday(ilDateTime $date)
        {
                global $ilUser;
                
                if(!is_object(self::$today))
                {
                        self::$today = new ilDateTime(time(),IL_CAL_UNIX,$ilUser->getTimeZone());
                }
                return ilDateTime::_equals(self::$today,$date,IL_CAL_DAY,$ilUser->getTimeZone());
        }
        
        public static function isYesterday(ilDateTime $date)
        {
                global $ilUser;
                
                if(!is_object(self::$yesterday))
                {
                        self::$yesterday = new ilDateTime(time(),IL_CAL_UNIX,$ilUser->getTimeZone());
                        self::$yesterday->increment(IL_CAL_DAY,-1);
                }
                
                return ilDateTime::_equals(self::$yesterday,$date,IL_CAL_DAY,$ilUser->getTimeZone());
        }

        public static function isTomorrow(ilDateTime $date)
        {
                global $ilUser;
                
                if(!is_object(self::$tomorrow))
                {
                        self::$tomorrow = new ilDateTime(time(),IL_CAL_UNIX,$ilUser->getTimeZone());
                        self::$tomorrow->increment(IL_CAL_DAY,1);
                }
                
                return ilDateTime::_equals(self::$tomorrow,$date,IL_CAL_DAY,$ilUser->getTimeZone());
        }

}
?>