README

Simple API implementation of Hebcal.com Jewish holiday calendars for Laravel

This package implements:

Jewish calendar REST API
Hebrew Date Converter REST API
Shabbat times REST API
Zmanim (halachic times) API
Yahrzeit + Anniversary API

Installation

composer require ivy47/hebcal-api

or add it to your composer.json and run composer update ivy47/hebcal-api

Publish Config File

The vendor:publish commmand will publish a file named hebcal.php within your laravel project config folder config/hebcal.php.

php artisan vendor:publish --provider="Ivy47\HebcalApi\HebcalServiceProvider"

Published Config File Contents

/*
     * Base Hebcal REST API uri
     * */
    'base_uri' => 'https://www.hebcal.com',

    /*
     * Jewish calendar REST API uri's
     * */
    'hebcal_uri' => '/hebcal/',
    'converter_uri' => '/converter/',
    'shabbat_uri' => '/shabbat/',
    'zmanim_uri' => '/zmanim/',
    'yahrzeit_uri' => '/yahrzeit/',


    /*
     * Use laravel cache
     * */
    'use_cache' => false,

    /*
     * Cache store driver
     * Check cache configuration file at config/cache.php to see posible options
     * */
    'cache_store' => 'file'

To enable hebcal api requests cache - change use_cache value to true. Also, you can set the cache store driver. For more details check Laravel driver-prerequisites documentation

Usage

Jewish calendar

Use HebcalApi Facade. To get the holidays use the HebcalApi method getHolidays($params)

use Ivy47\HebcalApi\Facades\HebcalApiFacade as HebcalApi;

$params = [
            'v' => 1,
            'maj' => 'on',
            'min' => 'on',
            'mod' => 'on',
            'nx' => 'on',
            'month' => 'x',
            'ss' => 'on',
            'mf' => 'on',
            'c' => 'on',
            ...
            ];

$hebcalCalendarResponse = HebcalApi::getHolidays($params);

To see more details about params check Jewish calendar REST API documentation

To get hebcal items use $hebcalCalendarResponse->getItems() method

If you need to get the holidays only for specific category, use categories filter & HebcalHelper category constants:

use Ivy47\HebcalApi\Helpers\HebcalHelper;

$hebcalCalendarResponseItems = $hebcalCalendarResponse->getItems([
            HebcalHelper::HEBCAL_CATEGORY_CANDLES,
            HebcalHelper::HEBCAL_CATEGORY_HOLIDAY,
        ]);

Hebrew Date Converter

To convert date use HebcalApi method convertDate($params)

use Ivy47\HebcalApi\Facades\HebcalApiFacade as HebcalApi;

$params = [
            'gy' => 2011,
            'gm' => 6,
            'gd' => 2,
            'g2h' => 1,
            ...
            ];

$hebrewDateResponse = HebcalApi::convertDate($params);

To see more details about params check Hebrew Date Converter REST API

Shabbat times

To get just this week’s Shabbat times and Torah Portion use HebcalApi method getShabbatTimes($params)

use Ivy47\HebcalApi\Facades\HebcalApiFacade as HebcalApi;

$params = [
            'geonameid' => '3448439',
            'M' => 'on'
            ...
            ];

$shabbatResponse = HebcalApi::getShabbatTimes($params);

To see more details about params check Shabbat times REST API

Zmanim (halachic times)

To calculate zmanim (halachic times) for a given location use HebcalApi method getZmanim($params)

use Ivy47\HebcalApi\Facades\HebcalApiFacade as HebcalApi;

$params = [
            'geonameid' => '3448439',
            'date' => '2021-03-23'
            ...
            ];

$zmanimResponse = HebcalApi::getZmanim($params);

To see more details about params check Zmanim (halachic times) API

Yahrzeit + Anniversary

To generate a list of Yahrzeit dates, Hebrew Birthdays, and Hebrew Anniversaries use HebcalApi method generateYahrzeit($params)

use Ivy47\HebcalApi\Facades\HebcalApiFacade as HebcalApi;

$params = [
            'v' => 'yahrzeit',
            'years' => 3,
            'hebdate' => 'on',
            'yizkor' => 'on',
            'y1' => 1983,
            'm1' => 4,
            'd1' => 15,
            's1' => 'on',
            't1' => 'Yahrzeit',
            'n1' => 'Example 1'
            ...
            ];

$yahrzeitResponse = HebcalApi::generateYahrzeit($params);

To see more details about params check Yahrzeit + Anniversary API

Important

cfg param default value is 'json' and can't be changed

API Resources

This package provides Laravel API Resources of Hebcal ready to use

To get the api resource use getResource() method, on any HebcalResponse

// HebcalCalendarResponse example

/** @var \Ivy47\HebcalApi\Http\Resources\HebcalCalendar\HebcalCalendarResource $hebcalCalendarResource */
$hebcalCalendarResource = $hebcalCalendarResponse->getResource();

But if you need raw (body) or decoded response data use:

$body = $hebcalCalendarResponse->getBody();
$decoded = $hebcalCalendarResponse->getDecoded();

or use the original response:

$response = $hebcalCalendarResponse->getResponse();

ivy47 / hebcal-api

Maintainers

Details