README

A Laravel package to convert dates to Lunar (Chhankitek) format. Learn more about Khmer calendar.

🇰🇭 Stand with Cambodia • កម្ពុជា

🕊️ Cambodia Needs Peace 🕊️

We stand in solidarity with our brave soldiers defending Cambodia's sovereignty and territorial integrity. Our hearts are with those protecting our homeland during these challenging times. We call upon the international community to support peaceful resolution and respect for Cambodia's borders.

🙏 កម្ពុជាត្រូវការសន្តិភាព • Together we stand for peace and sovereignty

Documentation

For detailed documentation, please visit https://chhankitek.netlify.app

Installation

You can install the package via composer:

composer require asorasoft/chhankitek

Usage

// In your Laravel controller, use this trait
use HasChhankitek;

// Convert a date to lunar format
$toLunarDate = $this->chhankiteck(Carbon\CarbonImmutable::now()->setTimezone('Asia/Phnom_Penh'));
$toLunarDate->toString(); // ថ្ងៃច័ន្ទ ៤ រោច ខែបឋមាសាឍ ឆ្នាំឆ្លូវ ត្រីស័ក ពុទ្ធសករាជ ២៥៦៥

Available Methods

// In your Laravel controller, use this trait
use HasChhankitek;

$toLunarDate = $this->chhankiteck(Carbon\CarbonImmutable::now()->setTimezone('Asia/Phnom_Penh'));

// Get specific lunar date components
$toLunarDate->getDayOfWeek(); // អាទិត្យ, ច័ន្ទ...
$toLunarDate->getLunarDay(); // ១កើត, ២កើត...
$toLunarDate->getLunarMonth(); // ចេត្រ...
$toLunarDate->getLunarZodiac(); // ជូត, ឆ្លូវ...
$toLunarDate->getLunarEra(); // ត្រីស័ក...
$toLunarDate->getLunarYear(); // ២៥៦៥, ២៥៦៦..

Alternatively, you can use the toLunarDate helper function:

toLunarDate(Carbon\CarbonImmutable::now()->setTimezone('Asia/Phnom_Penh')); // ថ្ងៃច័ន្ទ ៤ រោច ខែបឋមាសាឍ ឆ្នាំឆ្លូវ ត្រីស័ក ពុទ្ធសករាជ ២៥៦៥

Caching

The Chhankitek package implements caching to improve performance when converting dates to lunar format. When you convert a date using the package, the result is cached for one year (365 days) to minimize computational overhead for frequently accessed dates.

How caching works

• Each converted date is cached
• Cache duration: 365 days (60 * 60 * 24 * 365 seconds)
• The package leverages Laravel's cache system, so it will use whatever cache driver you've configured for your application

Testing

composer test

Changelog

Please see CHANGELOG for more information about recent changes.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email mabhelitc@gmail.com instead of using the issue tracker.

Support

If you like this package and want to support me, you can buy me a coffee ☕

Credits

• Mab Hel
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Authors and Acknowledgment

This library would not exist without the hard work of these people:

1. Based on the algorithm by Mr. Phylypo Tum from Khmer Calendar
2. Ported from momentkh by ThyrithSor into Java
3. Khmer New Year Time Calculation
4. Ported from MetheaX/khmer-chhankitek-calendar by MetheaX into a Laravel Package