geniusts/hijri-dates

PHP library to convert Gregorian date to Hijri date and vice versa

1.2 2024-11-05 14:20 UTC

Requires

• php: >=7.1
• nesbot/carbon: ^2.16|^1.22|^3.0

MIT

• Abdul-Kader Zein-Eddin

README

a PHP library to convert Gregorian date to Hijri date and vice versa.

It's based on nesbot/carbon package.

Installation

	composer require geniusts/hijri-dates

Usage

• you can immediatly get the hijri date with Date class function.

	$now = \GeniusTS\HijriDate\Date::now();
	$today = \GeniusTS\HijriDate\Date::today();
	$tomorrow = \GeniusTS\HijriDate\Date::tomorrow();
	$yesterday = \GeniusTS\HijriDate\Date::yesterday();

• to convert from Gregorian date to Hijri Date.

	$date = \GeniusTS\HijriDate\Hijri::convertToHijri('2017-05-05');

• to convert from Hijri date to Gregorian Date.

	// This function return a Carbon instance.
	$date = \GeniusTS\HijriDate\Hijri::convertToGregorian(8, 8, 1438);

• get date formated string.

	use GeniusTS\HijriDate\Date;

	$today = Date::today();

	// use the second parameter to return indian numbers
	echo $today->format('l d F o', Date::INDIAN_NUMBERS);

Configurations

• Changing the adjustment days.

	\GeniusTS\HijriDate\Hijri::setDefaultAdjustment(1);

• Changing the translation language.

	use GeniusTS\HijriDate\Translations\Arabic;

	\GeniusTS\HijriDate\Date::setTranslation(new Arabic);

• Changing the default toString format language.

	\GeniusTS\HijriDate\Date::setToStringFormat('l d F o');

• Changing the default numeric system.

	use GeniusTS\HijriDate\Date;

	Date::setDefaultNumbers(Date::INDIAN_NUMBERS);

There is some methods from Carbon class you can use it with Date class.

License

This package is free software distributed under the terms of the MIT license.