Installation

You can install the package via Composer:

composer require asorasoft/chhankitek

The package will automatically register its service provider. No additional configuration is needed.

Basic Usage

Using the Trait

In your Laravel controller, use the HasChhankitek trait:

use Asorasoft\Chhankitek\Traits\HasChhankitek;
use Carbon\CarbonImmutable;

class YourController extends Controller
{
    use HasChhankitek;

    public function index()
    {
        $lunarDate = $this->chhankiteck(
            CarbonImmutable::now()->setTimezone('Asia/Phnom_Penh')
        );

        echo $lunarDate->toString();
        // Output: ថ្ងៃច័ន្ទ ៤ រោច ខែបឋមាសាឍ ឆ្នាំឆ្លូវ ត្រីស័ក ពុទ្ធសករាជ ២៥៦៥
    }
}

Using the Helper Function

Alternatively, you can use the global toLunarDate helper:

use Carbon\CarbonImmutable;

$lunarDate = toLunarDate(
    CarbonImmutable::now()->setTimezone('Asia/Phnom_Penh')
);

echo $lunarDate->toString();

Available Methods

The KhmerLunarDate object provides the following methods:

$lunarDate->getDayOfWeek(); // អាទិត្យ, ច័ន្ទ, អង្គារ, ពុធ, ព្រហស្បតិ៍, សុក្រ, សៅរ៍

$lunarDate->getLunarDay(); // ១កើត, ២កើត, ១៤រោច, etc.

$lunarDate->getLunarMonth(); // ចេត្រ, ពិសាខ, ជេស្ឋ, អាសាឍ, etc.

$lunarDate->getLunarZodiac(); // ជូត, ឆ្លូវ, ខាល, ថោះ, រោង, ម្សាញ់, មមី, មមែ, វក, រកា, ច, កុរ

$lunarDate->getLunarEra(); // ត្រីស័ក, ចត្វាស័ក, បញ្ចស័ក, etc.

$lunarDate->getLunarYear(); // ២៥៦៥, ២៥៦៦, etc.

$lunarDate->toString();
// ថ្ងៃច័ន្ទ ៤ រោច ខែបឋមាសាឍ ឆ្នាំឆ្លូវ ត្រីស័ក ពុទ្ធសករាជ ២៥៦៥

Caching

The Chhankitek package implements automatic caching to improve performance:

• Each converted date is cached automatically
• Cache duration: 365 days
• Uses Laravel's default cache driver (configured in your application)
• No manual cache management required

Requirements

Examples

Example 1: Convert Current Date

$today = toLunarDate(
    CarbonImmutable::now()->setTimezone('Asia/Phnom_Penh')
);

echo "Day: " . $today->getDayOfWeek();
echo "Lunar Day: " . $today->getLunarDay();
echo "Month: " . $today->getLunarMonth();
echo "Year: " . $today->getLunarYear();

Example 2: Convert Specific Date

$date = CarbonImmutable::createFromFormat(
    'Y-m-d',
    '2024-04-14'
)->setTimezone('Asia/Phnom_Penh');

$lunarDate = toLunarDate($date);
echo $lunarDate->toString();

Example 3: Display in Blade Template

// In Controller
public function index()
{
    $lunarDate = toLunarDate(
        CarbonImmutable::now()->setTimezone('Asia/Phnom_Penh')
    );

    return view('welcome', compact('lunarDate'));
}

// In Blade (welcome.blade.php)
<div>
    <h1>{{ $lunarDate->toString() }}</h1>
    <p>Animal Year: {{ $lunarDate->getLunarZodiac() }}</p>
</div>

Example 4: Using in API

Route::get('/api/lunar-date', function (Request $request) {
    $date = $request->input('date')
        ? CarbonImmutable::parse($request->input('date'))
        : CarbonImmutable::now();

    $date = $date->setTimezone('Asia/Phnom_Penh');
    $lunarDate = toLunarDate($date);

    return response()->json([
        'gregorian' => $date->format('Y-m-d'),
        'lunar' => [
            'full' => $lunarDate->toString(),
            'day_of_week' => $lunarDate->getDayOfWeek(),
            'lunar_day' => $lunarDate->getLunarDay(),
            'month' => $lunarDate->getLunarMonth(),
            'zodiac' => $lunarDate->getLunarZodiac(),
            'era' => $lunarDate->getLunarEra(),
            'year' => $lunarDate->getLunarYear(),
        ],
    ]);
});

Understanding the Khmer Calendar

Lunar Months

The Khmer lunar calendar has 12 standard months. In leap years, an additional month (បឋមាសាឍ) is added:

Lunar Days

Each lunar month is divided into two phases:

• កើត (Kaet): Waxing moon (days 1-15)
• រោច (Roch): Waning moon (days 1-15)

Zodiac Animals (12-year cycle)

Leap Years

The Khmer calendar has two types of leap years:

• Leap Month Year (Adhikameas): An extra 13th month (បឋមាសាឍ) is added, making the year 384 days long
• Leap Day Year: An extra day is added to the month of ជេស្ឋ, making the year 355 days long
• Regular Year: 354 days with 12 months

API Reference

HasChhankitek Trait

chhankiteck(CarbonImmutable $target): KhmerLunarDate

Converts a Gregorian date to Khmer lunar date format.

Helper Function

toLunarDate(CarbonImmutable $target): KhmerLunarDate

Global helper function for date conversion.

KhmerLunarDate Methods