File Source for Mktime.php

<?php
/**
* ----------------------------------------------------------------------
*
* Copyright (c) 2006-2013 Khaled Al-Sham'aa.
*
* http://www.ar-php.org
*
* PHP Version 5
*
* ----------------------------------------------------------------------
*
* LICENSE
*
* This program is open source product; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License (LGPL)
* as published by the Free Software Foundation; either version 3
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/lgpl.txt>.
*
* ----------------------------------------------------------------------
*
* Class Name: Arabic Maketime
*
* Filename: Mktime.php
*
* Original Author(s): Khaled Al-Sham'aa <khaled@ar-php.org>
*
* Purpose: Arabic customization for PHP mktime function
*
* ----------------------------------------------------------------------
*
* Arabic Maketime
*
* PHP class for Arabic and Islamic customization of PHP mktime function.
* It can convert Hijri date into UNIX timestamp format
*
* Unix time() value:
*
* Development of the Unix operating system began at Bell Laboratories in 1969 by
* Dennis Ritchie and Ken Thompson, with the first PDP-11 version becoming
* operational in February 1971. Unix wisely adopted the convention that all
* internal dates and times (for example, the time of creation and last modification
* of files) were kept in Universal Time, and converted to local time based on a
* per-user time zone specification. This far-sighted choice has made it vastly
* easier to integrate Unix systems into far-flung networks without a chaos of
* conflicting time settings.
*
* The machines on which Unix was developed and initially deployed could not support
* arithmetic on integers longer than 32 bits without costly multiple-precision
* computation in software. The internal representation of time was therefore chosen
* to be the number of seconds elapsed since 00:00 Universal time on January 1, 1970
* in the Gregorian calendar (Julian day 2440587.5), with time stored as a 32 bit
* signed integer (long in the original C implementation).
*
* The influence of Unix time representation has spread well beyond Unix since most
* C and C++ libraries on other systems provide Unix-compatible time and date
* functions. The major drawback of Unix time representation is that, if kept as a
* 32 bit signed quantity, on January 19, 2038 it will go negative, resulting in
* chaos in programs unprepared for this. Modern Unix and C implementations define
* the result of the time() function as type time_t, which leaves the door open for
* remediation (by changing the definition to a 64 bit integer, for example) before
* the clock ticks the dreaded doomsday second.
*
* mktime -- Get Unix timestamp for a date
* int mktime (int hour, int minute, int second, int month, int day, int year);
*
* Warning: Note the strange order of arguments, which differs from the order of
* arguments in a regular Unix mktime() call and which does not lend itself well to
* leaving out parameters from right to left (see below). It is a common error to
* mix these values up in a script.
*
* Returns the Unix timestamp corresponding to the arguments given. This timestamp
* is a long integer containing the number of seconds between the Unix Epoch
* (January 1 1970) and the time specified.
*
* Example:
* <code>
* date_default_timezone_set('UTC');
*
* include('./I18N/Arabic.php');
* $obj = new I18N_Arabic('Mktime');
*
* $time = $obj->mktime(0,0,0,9,1,1427);
*
* echo "<p>Calculated first day of Ramadan 1427 unix timestamp is: $time</p>";
*
* $Gregorian = date('l F j, Y',$time);
*
* echo "<p>Which is $Gregorian in Gregorian calendar</p>";
* </code>
*
* @category I18N
* @package I18N_Arabic
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
* @copyright 2006-2013 Khaled Al-Sham'aa
*
* @license LGPL <http://www.gnu.org/licenses/lgpl.txt>
* @link http://www.ar-php.org
*/
// New in PHP V5.3: Namespaces
// namespace I18N\Arabic;
//
// $obj = new I18N\Arabic\Mktime();
//
// use I18N\Arabic;
// $obj = new Arabic\Mktime();
//
// use I18N\Arabic\Mktime as Mktime;
// $obj = new Mktime();
/**
* This PHP class is an Arabic customization for PHP mktime function
*
* @category I18N
* @package I18N_Arabic
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
* @copyright 2006-2013 Khaled Al-Sham'aa
*
* @license LGPL <http://www.gnu.org/licenses/lgpl.txt>
* @link http://www.ar-php.org
*/
class I18N_Arabic_Mktime
{
/**
* Loads initialize values
*
* @ignore
*/
public function __construct()
{
}
/**
* This will return current Unix timestamp
* for given Hijri date (Islamic calendar)
*
* @param integer $hour Time hour
* @param integer $minute Time minute
* @param integer $second Time second
* @param integer $hj_month Hijri month (Islamic calendar)
* @param integer $hj_day Hijri day (Islamic calendar)
* @param integer $hj_year Hijri year (Islamic calendar)
* @param integer $correction To apply correction factor (+/- 1-2)
* to standard Hijri calendar
*
* @return integer Returns the current time measured in the number of
* seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
*/
public function mktime(
$hour, $minute, $second, $hj_month, $hj_day, $hj_year, $correction = 0
) {
list($year, $month, $day) = $this->convertDate($hj_year, $hj_month, $hj_day);
$unixTimeStamp = mktime($hour, $minute, $second, $month, $day, $year);
$unixTimeStamp = $unixTimeStamp + 3600*24*$correction;
return $unixTimeStamp;
}
/**
* This will convert given Hijri date (Islamic calendar) into Gregorian date
*
* @param integer $Y Hijri year (Islamic calendar)
* @param integer $M Hijri month (Islamic calendar)
* @param integer $D Hijri day (Islamic calendar)
*
* @return array Gregorian date [int Year, int Month, int Day]
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
*/
protected function convertDate($Y, $M, $D)
{
if (function_exists('GregorianToJD')) {
$str = JDToGregorian($this->islamicToJd($Y, $M, $D));
} else {
$str = $this->jdToGreg($this->islamicToJd($Y, $M, $D));
}
list($month, $day, $year) = explode('/', $str);
return array($year, $month, $day);
}
/**
* This will convert given Hijri date (Islamic calendar) into Julian day
*
* @param integer $year Hijri year
* @param integer $month Hijri month
* @param integer $day Hijri day
*
* @return integer Julian day
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
*/
protected function islamicToJd($year, $month, $day)
{
$jd = (int)((11 * $year + 3) / 30) + (int)(354 * $year) + (int)(30 * $month)
- (int)(($month - 1) / 2) + $day + 1948440 - 385;
return $jd;
}
/**
* Converts Julian Day Count to Gregorian date
*
* @param integer $julian A julian day number as integer
*
* @return integer The gregorian date as a string in the form "month/day/year"
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
*/
protected function jdToGreg($julian)
{
$julian = $julian - 1721119;
$calc1 = 4 * $julian - 1;
$year = floor($calc1 / 146097);
$julian = floor($calc1 - 146097 * $year);
$day = floor($julian / 4);
$calc2 = 4 * $day + 3;
$julian = floor($calc2 / 1461);
$day = $calc2 - 1461 * $julian;
$day = floor(($day + 4) / 4);
$calc3 = 5 * $day - 3;
$month = floor($calc3 / 153);
$day = $calc3 - 153 * $month;
$day = floor(($day + 5) / 5);
$year = 100 * $year + $julian;
if ($month < 10) {
$month = $month + 3;
} else {
$month = $month - 9;
$year = $year + 1;
}
/*
Just to mimic the PHP JDToGregorian output
If year is less than 1, subtract one to convert from
a zero based date system to the common era system in
which the year -1 (1 B.C.E) is followed by year 1 (1 C.E.)
*/
if ($year < 1) {
$year--;
}
return $month.'/'.$day.'/'.$year;
}
/**
* Calculate Hijri calendar correction using Um-Al-Qura calendar information
*
* @param integer $m Hijri month (Islamic calendar)
* @param integer $y Hijri year (Islamic calendar), valid range [1420-1459]
*
* @return integer Correction factor to fix Hijri calendar calculation using
* Um-Al-Qura calendar information
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
*/
public function mktimeCorrection ($m, $y)
{
if ($y >= 1420 && $y < 1460) {
$calc = $this->mktime(0, 0, 0, $m, 1, $y);
$file = dirname(__FILE__).'/data/um_alqoura.txt';
$content = file_get_contents($file);
$offset = (($y-1420) * 12 + $m) * 11;
$d = substr($content, $offset, 2);
$m = substr($content, $offset+3, 2);
$y = substr($content, $offset+6, 4);
$real = mktime(0, 0, 0, $m, $d, $y);
$diff = (int)(($real - $calc) / (3600 * 24));
} else {
$diff = 0;
}
return $diff;
}
/**
* Calculate how many days in a given Hijri month
*
* @param integer $m Hijri month (Islamic calendar)
* @param integer $y Hijri year (Islamic calendar), valid
* range[1320-1459]
* @param boolean $umAlqoura Should we implement Um-Al-Qura calendar correction
* in this calculation (default value is true)
*
* @return integer Days in a given Hijri month
* @author Khaled Al-Sham'aa <khaled@ar-php.org>
*/
public function hijriMonthDays ($m, $y, $umAlqoura = true)
{
if ($y >= 1320 && $y < 1460) {
$begin = $this->mktime(0, 0, 0, $m, 1, $y);
if ($m == 12) {
$m2 = 1;
$y2 = $y + 1;
} else {
$m2 = $m + 1;
$y2 = $y;
}
$end = $this->mktime(0, 0, 0, $m2, 1, $y2);
if ($umAlqoura === true) {
$c1 = $this->mktimeCorrection($m, $y);
$c2 = $this->mktimeCorrection($m2, $y2);
} else {
$c1 = 0;
$c2 = 0;
}
$days = ($end - $begin) / (3600 * 24);
$days = $days - $c1 + $c2;
} else {
$days = false;
}
return $days;
}
}

Source for file Mktime.php