https://github.com/miladr/jalali

This Package helps developers to easily work with Jalali (Shamsi or Iranian) dates in Laravel 4 applications, based on Jalali (Shamsi) DateTime class. This Package is based on a Laravel 3 bundle "sallar/laravel-jdate" by Sallar Kaboli.
https://github.com/miladr/jalali

Last synced: 3 months ago
JSON representation

This Package helps developers to easily work with Jalali (Shamsi or Iranian) dates in Laravel 4 applications, based on Jalali (Shamsi) DateTime class. This Package is based on a Laravel 3 bundle "sallar/laravel-jdate" by Sallar Kaboli.

• Host: GitHub
• URL: https://github.com/miladr/jalali
• Owner: miladr
• License: mit
• Created: 2013-08-26T00:56:47.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-09T10:34:57.000Z (6 months ago)
• Last Synced: 2024-07-19T06:50:24.794Z (4 months ago)
• Language: PHP
• Homepage:
• Size: 26.4 KB
• Stars: 47
• Watchers: 7
• Forks: 120
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-persian - miladr/jalali - Jalali (Shamsi or Iranian) dates in Laravel 4 applications, based on Jalali (Shamsi) DateTime class. (Jalali Date)

README

        
miladr/jalali

======

This Package helps developers to easily work with Jalali (Shamsi or Iranian) dates in Laravel 4 applications, based on Jalali (Shamsi) DateTime class. This Package is based on a Laravel 3 bundle [sallar/laravel-jdate](https://github.com/sallar/laravel-jdate) by [Sallar Kaboli](http://sallar.me).



## Installation

In the `require` key of `composer.json` file add the following

```yml

    "miladr/jalali": "dev-master"

```

Run the Composer update comand

    $ composer update

In your `config/app.php` add `'Miladr\Jalali\JalaliServiceProvider'` to the end of the `$providers` array

```php

    'providers' => array(

        'Illuminate\Foundation\Providers\ArtisanServiceProvider',

        'Illuminate\Auth\AuthServiceProvider',

        ...

        'Miladr\Jalali\JalaliServiceProvider',

    ),

```



## Basic Usage

## Examples ##

Some Examples (based on examples provided by Sallar)

```php

// default timestamp is now

$date = jDate::forge();

// pass timestamps

$date = jDate::forge(1333857600);

// pass strings to make timestamps

$date = jDate::forge('last sunday');

// get the timestamp

$date = jDate::forge('last sunday')->time(); // 1333857600

// format the timestamp

$date = jDate::forge('last sunday')->format('%B %d، %Y'); // دی 02، 1391

// get a predefined format

$date = jDate::forge('last sunday')->format('datetime'); // 1391-10-02 00:00:00

$date = jDate::forge('last sunday')->format('date'); // 1391-10-02

$date = jDate::forge('last sunday')->format('time'); // 00:00:00

// amend the timestamp value, relative to existing value

$date = jDate::forge('2012-10-12')->reforge('+ 3 days')->format('date'); // 1391-07-24

// get relative 'ago' format

$date = jDate::forge('now - 10 minutes')->ago() // ۱۰ دقیقه پیش

```

## Formatting ##

For help in building your formats, checkout the [PHP strftime() docs](http://php.net/manual/en/function.strftime.php).

## Notes ##

The class relies on ``strtotime()`` to make sense of your strings, and ``strftime()`` to make the format changes.  Just always check the ``time()`` output to see if you get false timestamps... which means the class couldn't understand what you were telling it.

## License ##

- This bundle is created based on [Laravel-Date](https://github.com/swt83/laravel-date) by [Scott Travis](https://github.com/swt83) (MIT Licensed).  

- [Jalali (Shamsi) DateTime](https://github.com/sallar/jDateTime) class included in the package is created by [Sallar Kaboli](http://sallar.me) and is released under the MIT License. 

- This package was created by [Milad Rey](http://milad.io) and is released under the MIT License.