datetime.php cleanup

include/datetime.php

@@ -1,8 +1,17 @@
 <?php
+/**
+ * @file include/datetime.php
+ * @brief Some functions for date and time related tasks.
+ */
 
-// two-level sort for timezones.
 
-if(! function_exists('timezone_cmp')) {
+/**
+ * @brief Two-level sort for timezones.
+ *
+ * @param string $a
+ * @param string $b
+ * @return int
+ */
 function timezone_cmp($a, $b) {
 	if(strstr($a,'/') && strstr($b,'/')) {
 		if ( t($a) == t($b)) return 0;
@@ -11,11 +20,16 @@ function timezone_cmp($a, $b) {
 	if(strstr($a,'/')) return -1;
 	if(strstr($b,'/')) return  1;
 	if ( t($a) == t($b)) return 0;
-	return ( t($a) < t($b)) ? -1 : 1;
-}}
 
-// emit a timezone selector grouped (primarily) by continent
+	return ( t($a) < t($b)) ? -1 : 1;
-if(! function_exists('select_timezone')) {
+}
+
+/**
+ * @brief Emit a timezone selector grouped (primarily) by continent
+ * 
+ * @param string $current Timezone
+ * @return string Parsed HTML output
+ */
 function select_timezone($current = 'America/Los_Angeles') {
 
 	$timezone_identifiers = DateTimeZone::listIdentifiers();
@@ -52,13 +66,25 @@ function select_timezone($current = 'America/Los_Angeles') {
 	}
 	$o .= '</optgroup></select>';
 	return $o;
-}}
+}
 
-// return a select using 'field_select_raw' template, with timezones
+
-// groupped (primarily) by continent
+
-// arguments follow convetion as other field_* template array:
+/**
-// 'name', 'label', $value, 'help'
+ * @brief Generating a Timezone selector
-if (!function_exists('field_timezone')){
+ * 
+ * Return a select using 'field_select_raw' template, with timezones
+ * groupped (primarily) by continent
+.* arguments follow convetion as other field_* template array:
+.* 'name', 'label', $value, 'help'
+ * 
+ * @param string $name Name of the selector
+ * @param string $label Label for the selector
+ * @param string $current Timezone
+ * @param string $help Help text
+ * 
+ * @return string Parsed HTML
+ */
 function field_timezone($name='timezone', $label='', $current = 'America/Los_Angeles', $help){
 	$options = select_timezone($current);
 	$options = str_replace('<select id="timezone_select" name="timezone">','', $options);
@@ -69,15 +95,19 @@ function field_timezone($name='timezone', $label='', $current = 'America/Los_Ang
 		'$field' => array($name, $label, $current, $help, $options),
 	));
 
-}}
+}
 
-// General purpose date parse/convert function.
+/**
-// $from = source timezone
+ * @brief General purpose date parse/convert function.
-// $to   = dest timezone
+ *
-// $s    = some parseable date/time string
+ * @param string $from Source timezone
-// $fmt  = output format
+ * @param string $to Dest timezone
-
+ * @param string $s Some parseable date/time string
-if(! function_exists('datetime_convert')) {
+ * @param string $fmt Output format recognised from php's DateTime class
+ *   http://www.php.net/manual/en/datetime.format.php
+ * 
+ * @return string
+ */
 function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d H:i:s") {
 
 	// Defaults to UTC if nothing is set, but throws an exception if set to empty string.
@@ -124,13 +154,18 @@ function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d
 
 	$d->setTimeZone($to_obj);
 	return($d->format($fmt));
-}}
+}
 
 
-// wrapper for date selector, tailored for use in birthday fields
+/**
-
+ * @brief Wrapper for date selector, tailored for use in birthday fields.
+ *
+ * @param string $dob Date of Birth
+ * @return string
+ */
 function dob($dob) {
 	list($year,$month,$day) = sscanf($dob,'%4d-%2d-%2d');
+
 	$f = get_config('system','birthday_input_format');
 	if(! $f)
 		$f = 'ymd';
@@ -138,62 +173,69 @@ function dob($dob) {
 		$value = '';
 	else
 		$value = (($year) ? datetime_convert('UTC','UTC',$dob,'Y-m-d') : datetime_convert('UTC','UTC',$dob,'m-d'));
+
 	$o = '<input type="text" name="dob" value="' . $value . '" placeholder="' . t('YYYY-MM-DD or MM-DD') . '" />';
+
 //	if ($dob && $dob != '0000-00-00')
 //		$o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),mktime(0,0,0,$month,$day,$year),'dob');
 //	else
 //		$o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),false,'dob');
+
 	return $o;
 }
 
 /**
- * returns a date selector
+ * @brief Returns a date selector
- * @param $format
+ * 
- *  format string, e.g. 'ymd' or 'mdy'. Not currently supported
+ * @param string $format
- * @param $min
+ *  Format string, e.g. 'ymd' or 'mdy'. Not currently supported
- *  unix timestamp of minimum date
+ * @param string $min
- * @param $max
+ *  Unix timestamp of minimum date
- *  unix timestap of maximum date
+ * @param string $max
- * @param $default
+ *  Unix timestap of maximum date
- *  unix timestamp of default date
+ * @param string $default
- * @param $id
+ *  Unix timestamp of default date
- *  id and name of datetimepicker (defaults to "datetimepicker")
+ * @param string $id
+ *  ID and name of datetimepicker (defaults to "datetimepicker")
+ * 
+ * @return string Parsed HTML output.
  */
-if(! function_exists('datesel')) {
 function datesel($format, $min, $max, $default, $id = 'datepicker') {
 	return datetimesel($format,$min,$max,$default,$id,true,false, '','');
-}}
+}
 
 /**
- * returns a time selector
+ * @brief Returns a time selector
- * @param $format
+ * 
- *  format string, e.g. 'ymd' or 'mdy'. Not currently supported
+ * @param string $format
+ *  Format string, e.g. 'ymd' or 'mdy'. Not currently supported
  * @param $h
- *  already selected hour
+ *  Already selected hour
  * @param $m
- *  already selected minute
+ *  Already selected minute
- * @param $id
+ * @param string $id
- *  id and name of datetimepicker (defaults to "timepicker")
+ *  ID and name of datetimepicker (defaults to "timepicker")
+ * 
+ * @return string Parsed HTML output.
  */
-if(! function_exists('timesel')) {
 function timesel($format, $h, $m, $id='timepicker') {
 	return datetimesel($format,new DateTime(),new DateTime(),new DateTime("$h:$m"),$id,false,true);
-}}
+}
 
 /**
  * @brief Returns a datetime selector.
  *
- * @param $format
+ * @param string $format
  *  format string, e.g. 'ymd' or 'mdy'. Not currently supported
- * @param $min
+ * @param string $min
  *  unix timestamp of minimum date
- * @param $max
+ * @param string $max
  *  unix timestap of maximum date
- * @param $default
+ * @param string $default
  *  unix timestamp of default date
  * @param string $id
  *  id and name of datetimepicker (defaults to "datetimepicker")
- * @param boolean $pickdate
+ * @param bool $pickdate
  *  true to show date picker (default)
  * @param boolean $picktime
  *  true to show time picker (default)
@@ -201,17 +243,15 @@ function timesel($format, $h, $m, $id='timepicker') {
  *  set minimum date from picker with id $minfrom (none by default)
  * @param $maxfrom
  *  set maximum date from picker with id $maxfrom (none by default)
- * @param boolean $required default false
+ * @param bool $required default false
+ * 
  * @return string Parsed HTML output.
  *
  * @todo Once browser support is better this could probably be replaced with
  * native HTML5 date picker.
  */
-if(! function_exists('datetimesel')) {
 function datetimesel($format, $min, $max, $default, $id = 'datetimepicker', $pickdate = true, $picktime = true, $minfrom = '', $maxfrom = '', $required = false) {
 
-	$a = get_app();
-
 	// First day of the week (0 = Sunday)
 	$firstDay = get_pconfig(local_user(),'system','first_day_of_week');
 	if ($firstDay === false) $firstDay=0;
@@ -224,43 +264,58 @@ function datetimesel($format, $min, $max, $default, $id = 'datetimepicker', $pic
 
 	$o = '';
 	$dateformat = '';
+
 	if($pickdate) $dateformat .= 'Y-m-d';
 	if($pickdate && $picktime) $dateformat .= ' ';
 	if($picktime) $dateformat .= 'H:i';
+
 	$minjs = $min ? ",minDate: new Date({$min->getTimestamp()}*1000), yearStart: " . $min->format('Y') : '';
 	$maxjs = $max ? ",maxDate: new Date({$max->getTimestamp()}*1000), yearEnd: " . $max->format('Y') : '';
 
 	$input_text = $default ? 'value="' . date($dateformat, $default->getTimestamp()) . '"' : '';
 	$defaultdatejs = $default ? ",defaultDate: new Date({$default->getTimestamp()}*1000)" : '';
+
 	$pickers = '';
 	if(!$pickdate) $pickers .= ',datepicker: false';
 	if(!$picktime) $pickers .= ',timepicker: false';
+
 	$extra_js = '';
 	$pickers .= ",dayOfWeekStart: ".$firstDay.",lang:'".$lang."'";
 	if($minfrom != '')
 		$extra_js .= "\$('#$minfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#$id').data('xdsoft_datetimepicker').setOptions({minDate: currentDateTime})}})";
 	if($maxfrom != '')
 		$extra_js .= "\$('#$maxfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#$id').data('xdsoft_datetimepicker').setOptions({maxDate: currentDateTime})}})";
+
 	$readable_format = $dateformat;
 	$readable_format = str_replace('Y','yyyy',$readable_format);
 	$readable_format = str_replace('m','mm',$readable_format);
 	$readable_format = str_replace('d','dd',$readable_format);
 	$readable_format = str_replace('H','HH',$readable_format);
 	$readable_format = str_replace('i','MM',$readable_format);
+
 	$o .= "<div class='date'><input type='text' placeholder='$readable_format' name='$id' id='$id' $input_text />";
 	$o .= '</div>';
 	$o .= "<script type='text/javascript'>";
 	$o .= "\$(function () {var picker = \$('#$id').datetimepicker({step:5,format:'$dateformat' $minjs $maxjs $pickers $defaultdatejs}); $extra_js})";
 	$o .= "</script>";
+
 	return $o;
-}}
+}
 
-// implements "3 seconds ago" etc.
+/**
-// based on $posted_date, (UTC).
+ * @brief Returns a relative date string.
-// Results relative to current timezone
+ *
-// Limited to range of timestamps
+ * Implements "3 seconds ago" etc.
-
+ * Based on $posted_date, (UTC).
-if(! function_exists('relative_date')) {
+ * Results relative to current timezone.
+ * Limited to range of timestamps.
+ *
+ * @param string $posted_date
+ * @param string $format (optional) Parsed with sprintf()
+ *    <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
+ * 
+ * @return string with relative date
+ */
 function relative_date($posted_date,$format = null) {
 
 	$localtime = datetime_convert('UTC',date_default_timezone_get(),$posted_date);
@@ -300,23 +355,33 @@ function relative_date($posted_date,$format = null) {
 			// translators - e.g. 22 hours ago, 1 minute ago
 			if(! $format)
 				$format = t('%1$d %2$s ago');
+
 			return sprintf( $format,$r, (($r == 1) ? $str[0] : $str[1]));
 		}
 	}
-}}
+}
-
-
-
-// Returns age in years, given a date of birth,
-// the timezone of the person whose date of birth is provided,
-// and the timezone of the person viewing the result.
-// Why? Bear with me. Let's say I live in Mittagong, Australia, and my
-// birthday is on New Year's. You live in San Bruno, California.
-// When exactly are you going to see my age increase?
-// A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start
-// celebrating and become a year older. If you wish me happy birthday
-// on January 1 (San Bruno time), you'll be a day late.
 
+/**
+ * @brief Returns timezone correct age in years.
+ *
+ * Returns the age in years, given a date of birth, the timezone of the person
+ * whose date of birth is provided, and the timezone of the person viewing the
+ * result.
+ *
+ * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday
+ * is on New Year's. You live in San Bruno, California.
+ * When exactly are you going to see my age increase?
+ *
+ * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating
+ * and become a year older. If you wish me happy birthday on January 1
+ * (San Bruno time), you'll be a day late.
+ *
+ * @param string $dob Date of Birth
+ * @param string $owner_tz (optional) Timezone of the person of interest
+ * @param string $viewer_tz (optional) Timezone of the person viewing
+ * 
+ * @return int
+ */
 function age($dob,$owner_tz = '',$viewer_tz = '') {
 	if(! intval($dob))
 		return 0;
@@ -333,18 +398,21 @@ function age($dob,$owner_tz = '',$viewer_tz = '') {
 
 	if(($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day)))
 		$year_diff--;
+
 	return $year_diff;
 }
 
-
+/**
-
+ * @brief Get days of a month in a given year.
-// Get days in month
+ *
-// get_dim($year, $month);
+ * Returns number of days in the month of the given year.
-// returns number of days.
+ * $m = 1 is 'January' to match human usage.
-// $month[1] = 'January'; 
+ *
-//   to match human usage.
+ * @param int $y Year
-
+ * @param int $m Month (1=January, 12=December)
-if(! function_exists('get_dim')) {
+ * 
+ * @return int Number of days in the given month
+ */
 function get_dim($y,$m) {
 
 	$dim = array( 0,
@@ -353,34 +421,46 @@ function get_dim($y,$m) {
 
 	if($m != 2)
 		return $dim[$m];
+
 	if(((($y % 4) == 0) && (($y % 100) != 0)) || (($y % 400) == 0))
 		return 29;
+
 	return $dim[2];
-}}
+}
 
-
+/**
-// Returns the first day in month for a given month, year
+ * @brief Returns the first day in month for a given month, year.
-// get_first_dim($year,$month)
+ *
-// returns 0 = Sunday through 6 = Saturday
+ * Months start at 1.
-// Months start at 1.
+ *
-
+ * @param int $y Year
-if(! function_exists('get_first_dim')) {
+ * @param int $m Month (1=January, 12=December)
+ * 
+ * @return string day 0 = Sunday through 6 = Saturday
+ */
 function get_first_dim($y,$m) {
 	$d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
+
 	return datetime_convert('UTC','UTC',$d,'w');
-}}
+}
 
-// output a calendar for the given month, year.
+/**
-// if $links are provided (array), e.g. $links[12] => 'http://mylink' , 
+ * @brief Output a calendar for the given month, year.
-// date 12 will be linked appropriately. Today's date is also noted by
+ *
-// altering td class.
+ * If $links are provided (array), e.g. $links[12] => 'http://mylink' ,
-// Months count from 1.
+ * date 12 will be linked appropriately. Today's date is also noted by
-
+ * altering td class.
-
+ * Months count from 1.
-/// @TODO Provide (prev,next) links, define class variations for different size calendars
+ *
-
+ * @param int $y Year
-
+ * @param int $m Month
-if(! function_exists('cal')) {
+ * @param bool $links (default false)
+ * @param string $class
+ * 
+ * @return string
+ *
+ * @todo Provide (prev,next) links, define class variations for different size calendars
+ */
 function cal($y = 0,$m = 0, $links = false, $class='') {
 
 
@@ -415,11 +495,13 @@ function cal($y = 0,$m = 0, $links = false, $class='') {
 	$o .= "<caption>$str_month $y</caption><tr>";
 	for($a = 0; $a < 7; $a ++)
 		$o .= '<th>' . mb_substr(day_translate($dn[$a]),0,3,'UTF-8') . '</th>';
+
 	$o .= '</tr><tr>';
 
 	while($d <= $l) {
 		if(($dow == $f) && (! $started))
 			$started = true;
+
 		$today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
 		$o .= "<td $today>";
 		$day = str_replace(' ','&nbsp;',sprintf('%2.2d', $d));
@@ -428,10 +510,12 @@ function cal($y = 0,$m = 0, $links = false, $class='') {
 				$o .=  "<a href=\"{$links[$d]}\">$day</a>";
 			else
 				$o .= $day;
+
 			$d ++;
-    }
+		} else {
-    else
 			$o .= '&nbsp;';
+		}
+
 		$o .= '</td>';
 		$dow ++;
 		if(($dow == 7) && ($d <= $l)) {
@@ -442,12 +526,17 @@ function cal($y = 0,$m = 0, $links = false, $class='') {
 	if($dow)
 		for($a = $dow; $a < 7; $a ++)
 			$o .= '<td>&nbsp;</td>';
+
 	$o .= '</tr></table>'."\r\n";
 
 	return $o;
-}}
+}
-
 
+/**
+ * @brief Create a birthday event.
+ *
+ * Update the year and the birthday.
+ */
 function update_contact_birthdays() {
 
 	// This only handles foreign or alien networks where a birthday has been provided.
@@ -474,8 +563,6 @@ function update_contact_birthdays() {
 			$bdtext = sprintf( t('%s\'s birthday'), $rr['name']);
 			$bdtext2 = sprintf( t('Happy Birthday %s'), ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]') ;
 
-
-
 			$r = q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`)
 				VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ",
 				intval($rr['uid']),