Skip to content

Latest commit

 

History

History
105 lines (74 loc) · 3.26 KB

ArDateTime.md

File metadata and controls

105 lines (74 loc) · 3.26 KB
Raw

ArDateTime

Date utility for Hijri Date conversion and calendar built on top of Carbon and ar-php

Basic Usage

Create DateTime from Hijri date:

require_once __DIR__ . '/vendor/autoload.php';

use ArUtil\ArUtil;

$arD =  ArUtil::date()->arCreateFromDate(1405, 8, 10);
echo $arD->arToDateString();     // 1405-08-10
echo $arD->ToDateString();       // 1985-05-01

$arD is an instance of ArDateTime which extends Carbon.

In addition to the methods available from Carbon, ArDateTime provides some methods to deal with Hijri Date:

Create methods:

$arD = ArUtil::date()->arCreate($arYear, $arMonth, $arDay, $hour, $minute, $second, $tz); 
$arD = ArUtil::date()->arCreateFromDate(1405, 8, 10);
$arD = ArUtil::date()->arCreateFromDateString('1438-10-19', 'Asia/Riyadh');
$arD = ArUtil::date()->arCreateFromDateTimeString('1438-10-19 4:30:45');
$arD = ArUtil::date()->arCreateFromFormat('Y/m/d', '1430/10/01');

Getters methods:


echo sprintf('Toady is AH %s', ArUtil::date()->arToDateString());
// Toady is AH 1438-10-19

echo sprintf('Toady is %s', ArUtil::date()->ToDateString());
// Toady is 2017-07-14

echo sprintf('تاريخ اليوم %sهـ', ArUtil::date()->arFormat('Y/m/d'));
// تاريخ اليوم 1438/10/19هـ

$arD = ArUtil::date()->arCreate(1438, 10, 19, 02, 21, 39); 

echo $arD->arFormat('l dS F Y h:i:s A');
 // 'الجمعة 19 شوال 1438 02:21:39 صباحاً' 
 
 echo $arD->arToDateTimeString();
 // '1438-10-19 20:21:39'
 
 echo $arD->arToDateString();
 // '1438-10-19'

echo $arD->arToDayDateTimeString();
//  'الجمعة, شوال 19, 1438 8:21 مساءً'

Set the output of the date format:

$arD = ArUtil::date()->arCreate(1438, 10, 19, 2, 15, 30);

echo $arD->arFormat('l dS F Y h:i:s A');
 // 'الجمعة 19 شوال 1438 02:21:39 صباحاً' 

$arD->setOutputMode(ArDateTime::ALGERIA_AND_TUNIS);
echo $arD->arFormat('l dS F Y h:i:s A');
 // 'الجمعة 14 جويلية 2017 02:15:30 صباحاً' 
 
$arD->setOutputMode(ArDateTime::ARABIC_AND_TRANSLITERATION);
echo $arD->arFormat('l dS F Y h:i:s A');
 // 'الجمعة 14 تموز/يوليو 2017 02:15:30 صباحاً' 
 
$arD->setOutputMode(ArDateTime::ARABIC_MONTH_NAMES);
echo $arD->arFormat('l dS F Y h:i:s A');
 // 'الجمعة 14 تموز 2017 02:15:30 صباحاً' 
 
$arD->setOutputMode(ArDateTime::HIJRI_FORMAT_IN_ENGLISH);
echo $arD->arFormat('l dS F Y h:i:s A');
 // 'Friday 19 Shawwal 1438 02:15:30 AM' 
 
$arD->setOutputMode(ArDateTime::MOROCCO_STYLE);
echo $arD->arFormat('l dS F Y h:i:s A');
// 'الجمعة 14 يوليوز 2017 02:15:30 صباحاً'

$arD->setOutputMode(ArDateTime::LIBYA_STYLE);
echo $arD->arFormat('l dS F Y h:i:s A');
// 'الجمعة 14 ناصر 1385 02:15:30 صباحاً'

$arD->setOutputMode(ArDateTime::ARABIC_TRANSLITERATION);
echo $arD->arFormat('l dS F Y h:i:s A');
// 'الجمعة 14 يوليو 2017 02:15:30 صباحاً'

Date Conversion Correction:

Because of the hijri calendar is calculated, there is an error margin of -/+1 when converting from Hijri calendar to Gregorian calendar.

All The create methods accept a correction parameters to deal with this error.

    $arD = ArUtil::date()->arCreateFromDate(1430, 10, 15, $tz = null, $correction = -1);