pasoonate/pasoonate-php

v1.1.0 2025-01-03 13:51 UTC

README

Pasoonate is a powerful library that provides advanced date-time methods and supports multiple calendars! 🚀

🛠 Running Tests

composer install
./vendor/bin/phpunit

📥 Installation (via Composer)

composer require pasoonate/pasoonate-php

🎯 Usage

use Pasoonate\Pasoonate;

function pasoonate(): CalendarManager
{
    return Pasoonate::make();
}

// Set timestamp 📌
$date = pasoonate()->setTimestamp(1333857600)->jalali()->format('yyyy-MM-dd');

// Convert Jalali to Gregorian 🌍
$datetime = pasoonate()->jalali('1398/02/01 20:00:00')->gregorian()->getDatetime();

// Get today's date in different calendars 📆
$date = pasoonate()->jalali()->format('yyyy-MM-dd'); // 1403-10-29 🏷️
$date = pasoonate()->gregorian()->format('yyyy-MM-dd'); // 2025-01-18 📅
$date = pasoonate()->islamic()->format('yyyy-MM-dd'); // 1446-07-18 🌙
$date = pasoonate()->shia()->format('yyyy-MM-dd'); // 1446-07-17 ✨

// Date conversion 🔄
$date = pasoonate()->jalali()->addDay(2)->gregorian()->format('yyyy-MM-dd');

// Parse and format dates 📖
pasoonate()->jalali()->parse('yyyy-MM-dd', '1403-10-10')->addDay(3)->format('yyyy-MM-dd'); //1403-10-13

🌍 Supported Calendars

  • 📅 Gregorian
  • 🇮🇷 Jalali
  • 🕌 Islamic
  • Shia

📌 Commonly Used Date Functions in Projects

✅ Get Today's Date

$today = pasoonate()->jalali()->format('Y/m/d');

🔄 Convert Jalali to Gregorian

$gregorianDate = pasoonate()->jalali('1403/10/10')->gregorian()->format('Y-m-d');

🔁 Convert Gregorian to Jalali

$jalaliDate = pasoonate()->gregorian('2025-01-18')->jalali()->format('Y/m/d');

⏳ Get Start and End of the Month

$startOfMonth = pasoonate()->jalali()->startOfMonth()->format('Y/m/d');
$endOfMonth = pasoonate()->jalali()->endOfMonth()->format('Y/m/d');

🕰️ Get Start and End of the Year

$startOfYear = pasoonate()->jalali()->startOfYear()->format('Y/m/d');
$endOfYear = pasoonate()->jalali()->endOfYear()->format('Y/m/d');

📆 Check Leap Year

$isLeap = pasoonate()->jalali()->isLeapYear(); // Returns true or false

🗓️ Get Day of the Week

$dayOfWeek = pasoonate()->jalali()->dayOfWeek(); // 0 = Saturday, 6 = Friday

📅 Get Week Number of the Year

$weekNumber = pasoonate()->jalali()->weekOfYear();

🔑 Basic Methods

  • getTimestamp() 🕰️
  • getTimezoneOffset() 🌎
  • getDatetime()
  • getDate() 📆
  • getTime()
  • getYear() 🎯
  • getMonth() 📅
  • getDay() 🏷️
  • getHour()
  • getMinute() ⏲️
  • getSecond() 🕐
  • setTimestamp($timestampAsSeconds) 🔄
  • setTimezoneOffset($offsetAsMinutes) 🏝️
  • setDatetime($year, $month, $day, $hour, $minute, $second) 🏗️
  • setDate($year, $month, $day)
  • setTime($hour, $minute, $second)
  • setYear($year)
  • setMonth($month)
  • setDay($day)
  • setHour($hour)
  • setMinute($minute)
  • setSecond($second)
  • setUTCDatetime($year, $month, $day, $hour, $minute, $second)
  • setUTCDate($year, $month, $day)
  • setUTCTime($hour, $minute, $second)
  • setUTCYear($year)
  • setUTCMonth($month)
  • setUTCDay($day)
  • setUTCHour($hour)
  • setUTCMinute($minute)
  • setUTCSecond($second)
  • dayOfWeek() (from 0 for Saturday to 6 for Friday)
  • dayOfYear()
  • weekOfMonth()
  • weekOfYear()

➕ Addition & ➖ Subtraction Methods

📅 Add Year

echo $today->jalali('1399/01/15 11:22:00')->addYear(1)->format('Y/m/d H:i:s');
// 🗓️ 1400/01/15 11:22:00

📆 Add Month

echo $today->jalali()->addMonth(1)->format('Y/m/d H:i:s');
// 🗓️ 1400/02/15 11:22:00

📅 Add Day

echo $today->jalali()->addDay(3)->format('Y/m/d H:i:s');
// 🗓️ 1400/02/18 11:22:00

⏳ Add Hour

echo $today->jalali()->addHour(4)->format('Y/m/d H:i:s');
// ⏳ 1400/02/18 15:22:00

⏲️ Add Minute

echo $today->jalali()->addMinute(2)->format('Y/m/d H:i:s');
// ⏲️ 1400/02/18 15:24:00

⏰ Add Second

echo $today->jalali()->addSecond(35)->format('Y/m/d H:i:s');
// ⏰ 1400/02/18 15:24:35

📅 Subtract Year

echo $today->jalali()->subYear(1)->format('Y/m/d H:i:s');
// 📅 1399/02/18 15:24:35

📆 Subtract Month

echo $today->jalali()->subMonth(1)->format('Y/m/d H:i:s');
// 📆 1399/01/18 15:24:35

🗓️ Subtract Day

echo $today->jalali()->subDay(3)->format('Y/m/d H:i:s');
// 🗓️ 1399/01/15 15:24:35

... (and many more!)

🚀 Pasoonate makes date handling in PHP and Laravel super easy! 🔥

💡 Give it a ⭐ on GitHub if you find it useful! 🌟