Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/callmeahmedr/urdu-date-time-library
Urdu-PHP Date and Time Library
https://github.com/callmeahmedr/urdu-date-time-library
Last synced: 10 days ago
JSON representation
Urdu-PHP Date and Time Library
- Host: GitHub
- URL: https://github.com/callmeahmedr/urdu-date-time-library
- Owner: callmeahmedr
- License: mit
- Created: 2024-09-06T23:49:56.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:21:26.000Z (about 2 months ago)
- Last Synced: 2024-10-10T00:40:58.067Z (27 days ago)
- Language: PHP
- Size: 70.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Urdu Date Time Library
The Urdu Date Time Library is a PHP library designed to handle various date and time operations with Urdu localization. It includes functionalities for converting Gregorian dates to Hijri, calculating date differences, formatting times, and providing relative times, all in Urdu.
## Installation
### Method 1
Use composer to install the `urdu-date-time-library` package
```bash
composer require callmeahmedr/urdu-date-time-library
```
### Method 2
Clone the Repository
```bash
git clone https://github.com/callmeahmedr/urdu-date-time-library.git
```
Install Dependencies
```bash
composer install
```
## Usage
Here's a simple example demonstrating how to use the Urdu Date Time Library in your project:
```php
convertToHijri($gregorianDate) . "
";
```
### `getIslamicEvent($hijriDate)`:
Retrieves the Islamic event for a given Hijri date. The Hijri date format should be `MM-DD`.
```php
// Islamic Event
$hijriDate = '12-10'; // Example Hijri date format
echo "Islamic Event for Hijri Date $hijriDate: " . $urduDate->getIslamicEvent($hijriDate) . "
";
```
### `getDateDifference($date1, $date2)`:
Calculates the difference between two Gregorian dates and returns it in Urdu.
```php
// Date Difference
$date1 = '2024-09-01';
$date2 = '2024-09-07';
echo "Date Difference between $date1 and $date2: " . $urduDate->getDateDifference($date1, $date2) . "
";
```
### `formatTimeInUrdu($time)`:
Formats a time string (in `HH:MM` format) into its Urdu representation.
```php
// Time Formatting
$time = '14:30';
echo "Formatted Time in Urdu for $time: " . $urduDate->formatTimeInUrdu($time) . "
";
```
### `relativeTime($date)`:
Provides a relative time description for a given date compared to the current date, such as "1 دن پہلے" (1 day ago) in Urdu.
```php
// Relative Time
$pastDate = '2024-09-06';
echo "Relative Time for $pastDate: " . $urduDate->relativeTime($pastDate) . "
";
```
### `getUrduMonthDayName($gregorianDate)`:
Returns the Urdu representation of a Gregorian date, including day, month, and year. The date should be formatted as `YYYY-MM-DD`.
```php
// Urdu Month/Day Name
echo "Urdu Month/Day Name for Gregorian Date $gregorianDate: " . $urduDate->getUrduMonthDayName($gregorianDate) . "
";
```
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your changes. Ensure that your code adheres to the existing coding style and includes relevant tests.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/callmeahmedr/urdu-date-time-library/blob/main/LICENSE) file for details.
Happy Coding ❤️