README

NepaliDate is a PHP package that allows you to seamlessly convert English (AD) dates to Nepali (Bikram Sambat - BS) dates. This package provides an easy-to-use interface to work with Nepali dates, supporting features like retrieving individual date components (year, month, day) and handling complex date formatting.

Features

Convert AD date to BS (Bikram Sambat) format.
Flexible interface for working with date conversions in a clean, readable syntax.
Handles chaining function. Eg: NepaliDate::tomorrow()->nextWeek()->afterDays(4)->nextMonth();
Handles leap years and varying month lengths in the Nepali calendar.

Installation

You can install the package via Composer:

composer require nivesh/nepali-date

Usage

use Nivesh\NepaliDate\NepaliDate;

echo NepaliDate::convertToBs(); // Outputs "2081-06-09"
echo NepaliDate::convertToBs('2024-09-25', "{Y}-{M}-{d}, {w}"); // Outputs "2081-Asoj-09, Wednesday"
echo NepaliDate::today("{%d} {%M} {%Y}"); // Outputs "०९ असोज २०८१"
echo NepaliDate::previousQuarter(); // Outputs "Q4"
echo NepaliDate::nextMonth("{Mq}"); // Outputs "M2"
echo NepaliDate::currentYear(); // Outputs "2081"
echo NepaliDate::convertToAd("2081-08-25"); // Outputs "2024-12-10"

Available Methods

Method	Params	Return	Remarks
`convertToBs(string $date, string $format)`	date `default:today` format `default:{Y}-{m}-{d}`	`obj\|string`	Arg `$date`:compatible formats YYYY-MM-DD or YYYY/MM/DD
`convertToAd(string $date)`	date	`string`	date should be passed on YYYY-MM-DD format
`nepaliDate(string $date, string $format)`	date format `default:{Y}-{m}-{d}`	`obj\|string`	date should be passed on YYYY-MM-DD format
`today(string $format)`	format `default:{Y}-{m}-{d}`	`obj\|string`
`yesterday(string $format)`	format `default:{Y}-{m}-{d}`	`obj\|string`
`tomorrow(string $format)`	format `default:{Y}-{m}-{d}`	`obj\|string`
`daysBefore(int $days, string $format)`	days `required` format `default:{Y}-{m}-{d}`	`obj\|string`
`daysAfter(int $days, string $format)`	days `required` format `default:{Y}-{m}-{d}`	`obj\|string`
`nextWeek(string $format)`	format `default:{Y}-{m}-{d}`	`obj\|string`
`previousWeek(string $format)`	format `default:{Y}-{m}-{d}`	`obj\|string`
`currentMonth(string $format)`	format `default:{m}`	`obj\|string`	Only month formatters
`nextMonth(string $format)`	format `default:{m}`	`obj\|string`	Only month formatters
`previousMonth(string $format)`	format `default:{m}`	`obj\|string`	Only month formatters
`currentQuarter(string $format)`	format `default:{Q}`	`obj\|string`	Only quarter formatters
`nextQuarter(string $format)`	format `default:{Q}`	`obj\|string`	Only quarter formatters
`previousQuarter(string $format)`	format `default:{Q}`	`obj\|string`	Only quarter formatters
`currentYear(string $format)`	format `default:{Y}`	`obj\|string`	Only year formatters
`nextYear(string $format)`	format `default:{Y}`	`obj\|string`	Only year formatters
`previousYear(string $format)`	format `default:{Y}`	`obj\|string`	Only year formatters
`isLastDayOfMonth()`		`boolean`
`isLastDayOfQuarter()`		`boolean`
`isLastDayOfYear()`		`boolean`

Formatters

Formatters	Details	Example	Remarks
`{Y}`	4 digit year	`2081`	Falls under `year formatters`
`{y}`	2 digit year	`81`	Falls under `year formatters`
`{m}`	Month digit	`01` for Baisakh	Falls under `month formatters`
`{ms}`	No leading 0 in month	`1`	Falls under `month formatters`
`{M}`	Full month name	`Asoj`	Falls under `month formatters`
`{d}`	2 digit day	`09`
`{ds}`	No leading 0 day	`9`
`{w}`	Full weekday	`Sunday`
`{ws}`	Shorthand weekday	`Sun`
`{wi}`	Weekday index	`0-6` 0 for Sunday
`{F}`	Fiscal year	`2081/82`	Falls under `year formatters`
`{Q}`	Quarter	`Q1`	Falls under `quarter formatters`
`{Qi}`	Quarter index	`4` for Q4	Falls under `quarter formatters`
`{Mq}`	Month in quarter	`M3`	Falls under `month formatters`
`{Mqi}`	Month index in quarter	`1` for M1	Falls under `month formatters`
`{%Y}`	4 digit year in Nepali	`२०८१`	Falls under `year formatters`
`{%y}`	2 digit year in Nepali	`८१`	Falls under `year formatters`
`{%m}`	Month digit in Nepali	`०९`	Falls under `month formatters`
`{%ms}`	No leading 0 month in Nepali	`९`	Falls under `month formatters`
`{%M}`	Full month name in Nepali	`असोज`	Falls under `month formatters`
`{%d}`	2 digit day in Nepali	`०९`
`{%ds}`	No leading 0 day in Nepali	`९`
`{%w}`	Full weekday in Nepali	`आइतबार`
`{%ws}`	Shorthand weekday in Nepali	`आइत`
`{%wi}`	Weekday index in Nepali	`०-६` ० for आइतबार
`{%F}`	Fiscal year in Nepali	`२०८१/८२`	Falls under `year formatters`
`{%Qi}`	Quarter index in Nepali	`२` for Q2	Falls under `quarter formatters`
`{%Mqi}`	Month index in quarter in Nepali	`२` for M2	Falls under `month formatters`
`#`	Escape Character	`{#Y}`	`echo NepaliDate::convertToBs("2024-09-25", "{#Y} means year. Eg: {Y}");` `//Outputs: {Y} means year. Eg: 2081`

License

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

nivesh / nepali-date

Maintainers

Package info

Statistics

Security