Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chengkangzai/laravel-office-holidays
A Laravel Package that list out holiday that Scraped from https://www.officeholidays.com/countries/
https://github.com/chengkangzai/laravel-office-holidays
Last synced: 24 days ago
JSON representation
A Laravel Package that list out holiday that Scraped from https://www.officeholidays.com/countries/
- Host: GitHub
- URL: https://github.com/chengkangzai/laravel-office-holidays
- Owner: chengkangzai
- License: mit
- Created: 2024-05-12T12:10:44.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-11T05:36:59.000Z (3 months ago)
- Last Synced: 2024-11-20T18:16:49.127Z (about 1 month ago)
- Language: HTML
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# A Laravel Package that list out office's Holiday that Scraped from https://www.officeholidays.com/countries
[](https://packagist.org/packages/chengkangzai/laravel-office-holidays)
[](https://github.com/chengkangzai/laravel-office-holidays/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/chengkangzai/laravel-office-holidays/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/chengkangzai/laravel-office-holidays)
This package is a Laravel Package that list out office's Holiday that Scraped from https://www.officeholidays.com/.
The underlying package that is used to scrape the data is using [Saloon](https://docs.saloon.dev/).
## Installation
You can install the package via composer:
```bash
composer require chengkangzai/laravel-office-holidays
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="laravel-office-holidays-config"
```
This is the contents of the published config file:
```php
return [
'cache' => [
'driver' => 'file',
'duration' => 60 * 60 * 24 * 7 // 1 week
]
];
```
## Usage
### Get All Holidays for a specific country with its year
```php
$laravelOfficeHolidays = new CCK\LaravelOfficeHolidays();
app(LaravelOfficeHolidays::class)->getAllHolidays('malaysia', 2024)
```
### Get All Holidays for a specific state of the country with its year
```php
$laravelOfficeHolidays = new CCK\LaravelOfficeHolidays();
app(LaravelOfficeHolidays::class)->getHolidaysByState('malaysia', 2024, 'johor')
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ching Cheng Kang](https://github.com/chengkangzai)
- [All Contributors](../../contributors)
## Alternatives
[MalaysiaHoliday](https://github.com/afiqiqmal/MalaysiaHoliday) -> This project was inspired by [Hafiq](https://github.com/afiqiqmal), his package [MalaysiaHoliday](https://github.com/afiqiqmal/MalaysiaHoliday) is a great alternative for Malaysian Holidays, this package does not limit the usage for laravel.
[Spatie Holidays](https://github.com/spatie/holidays) -> This package is a great alternative for holidays from spatie, it is more robust and does not rely on scraping data from the internet.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.