https://github.com/alitnk/radon
A library like Carbon but for Iranian (Jalali) calendar
https://github.com/alitnk/radon
carbon iran iranian jalali jalali-date jalali-datetime laravel persian php shamsi shamsi-date
Last synced: 3 months ago
JSON representation
A library like Carbon but for Iranian (Jalali) calendar
- Host: GitHub
- URL: https://github.com/alitnk/radon
- Owner: alitnk
- License: mit
- Created: 2021-07-09T14:07:34.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-16T04:57:01.000Z (over 3 years ago)
- Last Synced: 2025-01-23T10:43:11.076Z (5 months ago)
- Topics: carbon, iran, iranian, jalali, jalali-date, jalali-datetime, laravel, persian, php, shamsi, shamsi-date
- Language: PHP
- Homepage:
- Size: 65.4 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Radon
[](https://packagist.org/packages/alitnk/radon)
[](https://packagist.org/packages/alitnk/radon)
[](https://packagist.org/packages/alitnk/radon)
A library like [Carbon](https://github.com/briannesbitt/Carbon) but for Iranian (Jalali) calendar
## Installation
Via Composer
``` bash
$ composer require alitnk/radon
```
## Usage
### Create new instance
Just like when you would do `now()` and get a Carbon instance, you can do `jnow()` and get a Radon instance for the current time.
To make a new instance based on the given datetime, you can use `radon($datetimeString)` like:
`$r = radon('1401-12-28 06:15')`
and get a new instance for that datetime
### Conversions
To convert Carbon instances to Radon instances, do:
```
$carbonInstance->toJalali(); // returns Radon instance and converts the date from gregorian to jalali
```
To do the vice versa (Radon to Carbon), do:
```
$radonInstance->toGregorian(); // returns Carbon instance and converts the date from jalali to gregorian
```
### Methods
You can use most of the carbon's methods on a Radon instance. e.g. `$radonInstance->diffForHumans()`, `$radonInstance->addDay(10)`, `$radonInstance->setDay(1)`
### Eloquent / Querying
Radon introduces new querying features for Jalali dates. Available methods are:
#### whereBetweenJalali
Note that this method is also available on `Collection` objects.
Example:
```php
Product::whereBetweenJalali('created_at', [radon('1398-10-12'), radon('1398-11-12')])->get();
```
#### orWhereBetweenJalali
This method is like `orWhereBetween` but for Jalali dates.
#### whereDateJalali
```php
Comment::whereDateJalali('created_at', radon('1400-01-01'))->get(); // Gets all the comments for first day of 1400
```
#### whereDayJalali
Compares the day
```php
Comment::whereDayJalali('created_at', 31); // Gets all comments for 31th
```
#### whereMonthJalali
Compares the month
```php
Comment::whereMonthJalali('created_at', 1); // Gets all of Farvardin's comments
```
#### whereYearJalali
Compares the year
```php
Comment::whereYearJalali('created_at', 1400); // Gets all of 1400's comments
```
### Casts
You can use the Radon cast to make the conversion process easier. To use the cast, add the cast to your field in the respective model:
```php
use Wama\Radon\Casts\JalaliDatetime;
class Product extends Model {
protected $casts = [
'sales_ends_at' => JalaliDatetime::class,
'updated_at' => JalaliDatetime::class,
'created_at' => JalaliDatetime::class,
];
}
```
and get a Radon instance every time you get the field.
`$product->sales_ends_at // returns a Radon instance`
you can also update the model without having to worry about the datetime conversions:
```php
$product->update([
'sales_ends_at' => radon('1401-01-14 23:00'), // Sales will end at Farvardin 14th
]);
```
or
```php
$product->sales_ends_at->addMonth();
$product->save();
```
## Expansion
Radon tries to support most of the Carbon methods, but keep in mind that some of the Carbon methods are not supported _yet_ and might be added in the next versions.
This package uses [Verta](https://github.com/hekmatinasser/verta) under the hood and therefore, expanding some functionalities might demand on the expansion of Verta.
## Change log
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [contributing.md](contributing.md) for details and a todolist.
## Security
If you discover any security related issues, please email author email instead of using the issue tracker.
## Credits
- [Alireza Zamani][link-author]
- [All Contributors][link-contributors]
## License
license. Please see the [license file](LICENSE) for more information.
[link-packagist]: https://packagist.org/packages/alitnk/radon
[link-downloads]: https://packagist.org/packages/alitnk/radon
[link-travis]: https://travis-ci.org/alitnk/radon
[link-styleci]: https://styleci.io/repos/12345678
[link-author]: https://github.com/alitnk
[link-contributors]: ../../contributors