Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomshaw/laravel-calendar-table
A Laravel calendar table database migration and console command.
https://github.com/tomshaw/laravel-calendar-table
Last synced: 11 days ago
JSON representation
A Laravel calendar table database migration and console command.
- Host: GitHub
- URL: https://github.com/tomshaw/laravel-calendar-table
- Owner: tomshaw
- License: mit
- Created: 2023-10-21T13:11:13.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-03T15:23:17.000Z (8 months ago)
- Last Synced: 2024-04-14T04:44:29.026Z (7 months ago)
- Language: PHP
- Size: 49.8 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Calendar Table 📈 📊
[](https://github.com/tomshaw/laravel-calendar-table/blob/master/LICENSE)
A **calendar table**, also known as a **date dimension table**, is a table in a database that is designed to help with date-related queries and reporting. It contains a row for each date within a certain range, often many years into the past and future. Each row contains various fields about the date, such as the day, month, year, quarter, day of the week, is it a weekend or a weekday, is it a holiday, etc.
The usefulness of a calendar table in database reporting comes from its ability to simplify and optimize date-related queries. Here are some of its benefits:
1. **Simplifying Queries**: Without a calendar table, extracting components of a date usually involves complex functions and calculations. With a calendar table, you can simply join your data with the calendar table to get these components.
2. **Improving Performance**: Date calculations can be CPU-intensive and slow down your queries. By moving these calculations into a calendar table, you can improve query performance.
3. **Consistency**: A calendar table ensures that date information is handled consistently across all queries and reports.
4. **Flexibility**: You can add custom fields to your calendar table to suit your business needs. For example, you could add fields for your company's fiscal periods or specific business events.
5. **Handling Missing Dates**: If your data has missing dates, those gaps can cause problems in reporting. A calendar table can help ensure continuity in your reports.
In summary, a calendar table is an extremely useful tool for anyone who frequently works with dates in their database.
## Installation
Require the package with composer using the following command:
```
composer require tomshaw/laravel-calendar-table
```
Publish the configuration if you wish to change the command defaults.
```
php artisan vendor:publish --provider="TomShaw\CalendarTable\Providers\CalendarTableServiceProvider" --tag=config
```
## Database Migration
Run the database migration to create the calendar table.
```
php artisan migrate
```
## Console Command
The calendar table command accepts two optional parameters. If no **start** year is specified you will be prompted to enter one. If no **end** year is specified the current year will be used.
> Note: If the table has been pre-filled you will be given the option to truncate.
```
php artisan calendar:table --start=2000 --end=2030
```
Sure, here's a README.md section that explains the configuration options for your Laravel Calendar Table package:
## Configuration
The Laravel Calendar Table package provides several configuration options that you can adjust to suit your needs. You can find these options in the `config.php` file.
### Table Name
The `table_name` option allows you to define a custom table name for the database records. By default, it is set to `'date_dimension'`.
```php
'table_name' => 'date_dimension',
```
### Seasons
The `seasons` array allows you to define the start month for each season. By default it is configured for the meteorological seasons of the Northern Hemisphere:
- Spring starts in March
- Summer starts in June
- Autumn starts in September
- Winter starts in December
```php
'seasons' => [
'Spring' => 3,
'Summer' => 6,
'Autumn' => 9,
'Winter' => 12,
],
```
If you are in the Southern Hemisphere, you should reconfigure the seasons to start approximately six months later:
- Spring starts in September
- Summer starts in December
- Autumn starts in March
- Winter starts in June
```php
'seasons' => [
'Spring' => 9,
'Summer' => 12,
'Autumn' => 3,
'Winter' => 6,
],
```
### Fiscal Year Start Month
The `fiscal_year_start_month` option allows you to define the start month of the fiscal year. The value should be an integer between 1 (January) and 12 (December). By default, it is set to 10, meaning the fiscal year starts in October.
```php
'fiscal_year_start_month' => 10,
```
### Date Range
The `date_range` array allows you to define the valid start and end year range for populating the calendar table.
- `start_year`: This option defines the earliest start year. Defaults to 20 years before the current year.
- `end_year`: This option defines the latest end year. Defaults to 20 years after the current year.
```php
'date_range' => [
'start_year' => Carbon\Carbon::now()->subYears(20)->year,
'end_year' => Carbon\Carbon::now()->addYears(20)->year,
],
```
## Requirements
The package is compatible with Laravel 10 or later.
## Support
If you have any issues or questions please send a pull request.
## License
The MIT License (MIT). Please see [License](LICENSE) for more information.