DateUtils Class Reference

DateUtils - provides support for date/time manipulation. More...

Public Member Functions
	DateUtils ()

Static Public Member Functions
static	getMonthDays ($m, $y)
	Returns the number of days in the specified month. More...
static	getMonthWeekDays ($month, $year)
	Get the number of week days in the specified month. More...
static	formatStartDateToEndDate ($start, $end)
static	addMonths (&$date, $months)
	DateTime will fail to increment month correctly when current date is last day of 31 day month. More...
static	addYears (&$date, $years)
	DateTime will fail to increment year correctly in some instances. More...
static	fuzzyDate ($date)
	Fuzzy approximates of some time in the past. More...
static	getMonths ()
	Return an array of month names in the currently selected locale, indexed by month number. More...

Detailed Description

DateUtils - provides support for date/time manipulation.

Definition at line 38 of file date_utils.inc.

Member Function Documentation

addMonths()

static DateUtils::addMonths ( &  $date,   $months  )

static

DateTime will fail to increment month correctly when current date is last day of 31 day month.

Use addMonths instead.

Parameters

	DateTime	object $date
Number	$months	(can be positive or negative)

Definition at line 126 of file date_utils.inc.

     {
        $init = clone $date;
        $modifier = $months.' months';
        $back_modifier = -$months.' months';
       
        $date->modify($modifier);
        $back_to_init = clone $date;
        $back_to_init->modify($back_modifier);
       
        while($init->format('m') != $back_to_init->format('m'))
        {
          $date->modify('-1 day');
          $back_to_init = clone $date;
          $back_to_init->modify($back_modifier);   
          }
     }

addYears()

static DateUtils::addYears ( &  $date,   $years  )

static

DateTime will fail to increment year correctly in some instances.

Parameters

	DateTime	object $date
Number	$years	(can be positive or negative)

Definition at line 151 of file date_utils.inc.

    {   
        $init = clone $date;
        $modifier = $years.' years';
        $date->modify($modifier);
       
        while($date->format('m')!=$init->format('m'))
        {
          $date->modify('-1 day');
        }
    }     

DateUtils()

DateUtils::DateUtils

(

)

Definition at line 40 of file date_utils.inc.

     {
          
     }

formatStartDateToEndDate()

static DateUtils::formatStartDateToEndDate (   $start,   $end  )

static

Definition at line 94 of file date_utils.inc.

     {
          $yyyy = substr($start,0,4);
          $yyyy_2 = substr($end,0,4);
          $mm   = substr($start,5,2);
          $mm_2   = substr($end,5,2);
          $dd   = substr($start,8,2);
          $dd_2   = substr($end,8,2);
               
          if($yyyy != $yyyy_2 || $mm != $mm_2 || $dd != $dd_2)
          {
               return formatDateTime12Hr($start) ." – ". formatDateTime12Hr($end);
          }
          else
          {
               $hh   = substr($start,11,2);
               $mi   = substr($start,14,2);
               $hh_2   = substr($end,11,2);
               $mi_2   = substr($end,14,2);
               $s_time = date("g:ia", mktime($hh,$mi));
               $e_time = date("g:ia", mktime($hh_2,$mi_2));
               return formatDateShort($start) . " $s_time – $e_time";
          }    
     }

fuzzyDate()

static DateUtils::fuzzyDate (   $date )

static

Fuzzy approximates of some time in the past.

Parameters

unknown

$date

Returns

string

Definition at line 168 of file date_utils.inc.

    {
     $time = strtotime($date);
     $now = time();
     $ago = $now - $time;
     if ($ago < 60)
     {
          $when = round($ago);
          $s = ($when == 1)?"second":"seconds";
          return "$when $s ago";
     }
     else if ($ago < 3600)
     {
          $when = round($ago / 60);
          $m = ($when == 1)?"minute":"minutes";
          return "$when $m ago";
     }
     else if ($ago >= 3600 && $ago < 86400)
     {
              $when = round($ago / 60 / 60);
              $h = ($when == 1)?"hour":"hours";
              return "$when $h ago";
     }
     else if ($ago >= 86400 && $ago < 2629743.83)
     {
              $when = round($ago / 60 / 60 / 24);
              $d = ($when == 1)?"day":"days";
              return "$when $d ago";
     }
     else if ($ago >= 2629743.83 && $ago < 31556926)
     {
              $when = round($ago / 60 / 60 / 24 / 30.4375);
              $m = ($when == 1)?"month":"months";
              return "$when $m ago";
     }
     else
     {
              $when = round($ago / 60 / 60 / 24 / 365);
              $y = ($when == 1)?"year":"years";
              return "$when $y ago";
     }
    }

getMonthDays()

static DateUtils::getMonthDays (   $m,   $y  )

static

Returns the number of days in the specified month.

Parameters

number	$m	the month number
number	$y	the year

Returns

number the number of days in that month

Definition at line 52 of file date_utils.inc.

     {
          $monthDays = array(31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31);
          $d = $monthDays[$m - 1];
          if ($m == 2 && ($y % 4) == 0 && ($y % 100) != 0) $d++;
     
          return $d;
     }

getMonths()

static DateUtils::getMonths ( )

static

Return an array of month names in the currently selected locale, indexed by month number.

This is a format suitable for use with a SelectFieldRenderer

Returns

array month names indexed by month number

Definition at line 216 of file date_utils.inc.

    {
     $months = array();
     for($i = 1; $i < 13; ++$i)
     {
          $months[$i] = date("F", mktime(0, 0, 0, $i, 10));
     }
     return $months;
    }

getMonthWeekDays()

static DateUtils::getMonthWeekDays (   $month,   $year  )

static

Get the number of week days in the specified month.

Parameters

number	$m	the month number
number	$y	the year

Returns

number the number of week days in that month

Definition at line 68 of file date_utils.inc.

     {
          $weekDaysInMonth = array
          (
               28   =>   array(20, 20, 20, 20, 20, 20, 20),
               29   =>   array(21, 21, 21, 21, 21, 20, 20),
               30   =>   array(22, 22, 22, 22, 21, 20, 21),
               31   =>   array(23, 23, 23, 22, 21, 21, 22)
          );
     
          $days = getMonthDays($month, $year);
          $date = strtotime("$year-$month-01");
     
          $first = date("N", $date) - 1;
          return $weekDaysInMonth[$days][$first];
     }    

---

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

• C:/code/cms.sonjara.com/framework/date_utils.inc