https://github.com/sssurii/laravel-ics

Laravel package to create iCalendar/ICS files. Send new event invitations or cancel already sent invitation.
https://github.com/sssurii/laravel-ics

icalendar ics ics-files invitation laravel-ics

Last synced: 3 months ago
JSON representation

Laravel package to create iCalendar/ICS files. Send new event invitations or cancel already sent invitation.

• Host: GitHub
• URL: https://github.com/sssurii/laravel-ics
• Owner: sssurii
• Created: 2019-08-24T13:54:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-18T06:02:49.000Z (about 1 year ago)
• Last Synced: 2024-08-31T07:47:35.510Z (6 months ago)
• Topics: icalendar, ics, ics-files, invitation, laravel-ics
• Language: PHP
• Homepage:
• Size: 15.6 KB
• Stars: 13
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# laravel-ics

Laravel package to create iCalendar/ICS files. Send new event invitations via Email and can cancel or update already sent invitation.

## Installation

Install using composer:

	`composer require sssurii/laravel-ics`

To publish the config, run the vendor publish command:

	`php artisan vendor:publish --provider="INSAN\ICS\ICSServiceProvider" --tag=config`

## Usage

1. For Laravel 5.6 or above, simply load class:

	`use INSAN\ICS\ICS;`

2. For laravel 5.5 or below, open your `config/app.php` and add below line under 'providers':

```

/*

 * Package Service Providers...

 */

INSAN\ICS\ICSServiceProvider::class,

```

Then simply load class as in step 1.

3. Use package class as below:

Set various event details, pass properties as array while initializing class:

```

	$event_properties = [

            'uid' => uniqid(),

            'sequence' => 0,

            'description' => 'Event Invitation via email.',

            'dtstart' => date('Y-m-d 09:00'),

            'dtend' => date('Y-m-d 10:00'),

            'summary' => 'This is an event invitation sent through email.',

            'location' => 'VR Punjab, S.A.S Nagar, Chandigarh',

            'url' => 'www.example.com',

        ];

	$ics_file = new ICS($event_properties);

	return $ics_file->toString();

```

Some optional properties can be set as below, like set organizer details

```

	//Optional

	$ics_file->setOrganizer('Surinder', '[email protected]');

```

If you want cancel already sent invitation, use additional code to above:

```

	//Optional

	$ics_file->markEventCancel();

```

**Note:** If want to cancel an already sent invitation, you must use same `uid` which was used in invitation you need to cancel.

## Help / Support

For bug reports, please [open an issue on GitHub](https://github.com/sssurii/laravel-ics/issues/new).