README

This Package helps developers to easily work with Jalali (Shamsi or Iranian) dates in lumen 5.5+ applications.

Installation

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

    "kakajan/lumen-jalali": "1.0"

Run the Composer update comand

$ composer update

Or just run command

$ composer require kakajan/lumen-jalali

In your bootstrap/app.php add $app->register(jDate\Jalali\JalaliServiceProvider::class); for registring service provider.

    
    $app->register(App\Providers\AppServiceProvider::class);
    $app->register(App\Providers\AuthServiceProvider::class);
    .
    .
    $app->register(jDate\Jalali\JalaliServiceProvider::class);

In your bootstrap/app.php add class_alias('jDate\Jalali\jDate', 'jDate'); before return $app;

    
    class_alias('jDate\Jalali\jDate', 'jDate');
    return $app;

Basic Usage

Examples

Some Examples

// 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.

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 by Scott Travis (MIT Licensed).
• Jalali (Shamsi) DateTime class included in the package is created by Sallar Kaboli and is released under the MIT License.
• This package was originally created by Milad Rey and is released under the MIT License.
• Updated for lumen 5.5+ by kakajn - https://aykam.org.