Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markuspoerschke/iCal
iCal-creator for PHP
https://github.com/markuspoerschke/iCal
calendar composer hacktoberfest ical ics php rfc-5545
Last synced: 1 day ago
JSON representation
iCal-creator for PHP
- Host: GitHub
- URL: https://github.com/markuspoerschke/iCal
- Owner: markuspoerschke
- License: mit
- Created: 2012-09-10T16:12:39.000Z (about 12 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-10-25T11:44:35.000Z (11 days ago)
- Last Synced: 2024-10-29T10:24:28.343Z (7 days ago)
- Topics: calendar, composer, hacktoberfest, ical, ics, php, rfc-5545
- Language: PHP
- Homepage: https://ical.poerschke.nrw
- Size: 2.61 MB
- Stars: 1,127
- Watchers: 32
- Forks: 162
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- stars - markuspoerschke/iCal - iCal-creator for PHP (PHP)
README
# 📅 eluceo — iCal 2
[](https://github.com/markuspoerschke/iCal/actions/workflows/ci.yml)
[](https://codecov.io/gh/markuspoerschke/iCal)
[](https://shepherd.dev/github/markuspoerschke/ical)
[](https://packagist.org/packages/eluceo/ical)
[](https://packagist.org/packages/eluceo/ical)
[](https://packagist.org/packages/eluceo/ical)
[](https://infection.github.io)
This package offers an abstraction layer for creating iCalendars files.
By using this PHP package, you can create `*.ics` files without the knowledge of the underling format.
The output itself will follow [RFC 5545](https://www.ietf.org/rfc/rfc5545.html) as good as possible.
## Navigate through the project
- 📖 [read the documentation](https://ical.poerschke.nrw)
- 🐛 [report a bug or suggest a feature](https://github.com/markuspoerschke/iCal/issues)
- 🙋 [raise a question](https://github.com/markuspoerschke/iCal/discussions/categories/q-a)
- 💬 [start a discussion](https://github.com/markuspoerschke/iCal/discussions)
## Installation
You can install this package by using [Composer](http://getcomposer.org), running the following command:
```sh
composer require eluceo/ical
```
## Version / Upgrade
The initial version was released back in 2012.
The version 2 of this package is a complete rewrite of the package and is not compatible to older version.
Please see the upgrade guide if you want to migrate from version `0.*` to `2.*`.
If you just start using this package, you should install version 2.
| Version | PHP Version |
| ------- | ----------- |
| 2.\* | 7.4 - 8.3 |
| 0.16.\* | 7.0 - 8.2 |
| 0.11.\* | 5.3.0 - 7.4 |
## Documentation
Visit [ical.poerschke.nrw](https://ical.poerschke.nrw/) for complete documentation.
## Usage
The classes within this package are grouped into two namespaces:
- The `Domain` contains the information about the events.
- The `Presentation` contains the transformation from `Domain` into a `*.ics` file.
To create a calendar, the first step will be to create the corresponding domain objects.
Then these objects can be transformed into a iCalendar PHP representation, which can be cast to string.
### Empty event
In this very basic example, that renders an empty event.
You will learn how to create an event domain object, how to add it to a calendar and how to transform it to a iCalendar component.
#### 1. Create an event domain entity
```PHP
$event = new \Eluceo\iCal\Domain\Entity\Event();
```
#### 2. Create a calendar domain entity
```PHP
$calendar = new \Eluceo\iCal\Domain\Entity\Calendar([$event]);
```
#### 3. Transform calendar domain object into a presentation object
```PHP
$iCalendarComponent = (new \Eluceo\iCal\Presentation\Factory\CalendarFactory())->createCalendar($calendar);
```
#### 4. a) Save to file
```PHP
file_put_contents('calendar.ics', (string) $iCalendarComponent);
```
#### 4. b) Send via HTTP
```PHP
header('Content-Type: text/calendar; charset=utf-8');
header('Content-Disposition: attachment; filename="cal.ics"');
echo $iCalendarComponent;
```
### Full example
The following example will create a single day event with a summary and a description.
More examples can be found in the [examples/](examples) folder.
```php
setSummary('Christmas Eve')
->setDescription('Lorem Ipsum Dolor...')
->setOccurrence(
new Eluceo\iCal\Domain\ValueObject\SingleDay(
new Eluceo\iCal\Domain\ValueObject\Date(
\DateTimeImmutable::createFromFormat('Y-m-d', '2030-12-24')
)
)
);
// 2. Create Calendar domain entity
$calendar = new Eluceo\iCal\Domain\Entity\Calendar([$event]);
// 3. Transform domain entity into an iCalendar component
$componentFactory = new Eluceo\iCal\Presentation\Factory\CalendarFactory();
$calendarComponent = $componentFactory->createCalendar($calendar);
// 4. Set headers
header('Content-Type: text/calendar; charset=utf-8');
header('Content-Disposition: attachment; filename="cal.ics"');
// 5. Output
echo $calendarComponent;
```
## License
This package is released under the [**MIT license**](LICENSE).