diff options
Diffstat (limited to 'includes/composer/vendor/om/icalparser/readme.md')
| -rw-r--r-- | includes/composer/vendor/om/icalparser/readme.md | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/includes/composer/vendor/om/icalparser/readme.md b/includes/composer/vendor/om/icalparser/readme.md new file mode 100644 index 0000000..6666c10 --- /dev/null +++ b/includes/composer/vendor/om/icalparser/readme.md @@ -0,0 +1,79 @@ +# PHP iCal Parser + +[](https://github.com/OzzyCzech/icalparser/actions/workflows/php.yml) +[](https://packagist.org/packages/om/icalparser) +[](https://packagist.org/packages/om/icalparser) +[](https://packagist.org/packages/om/icalparser) +[](https://packagist.org/packages/om/icalparser) + +Internet Calendaring Parser [rfc2445](https://www.ietf.org/rfc/rfc2445.txt) or iCal parser is simple PHP class for parsing format into array. + +[](https://www.buymeacoffee.com/ozzyczech) + +## How to install + +The recommended way to is via Composer: + +```shell script +composer require om/icalparser +``` + +## Usage and example + +```php +<?php +use om\IcalParser; +require_once '../vendor/autoload.php'; + +$cal = new IcalParser(); +$results = $cal->parseFile( + 'https://www.google.com/calendar/ical/cs.czech%23holiday%40group.v.calendar.google.com/public/basic.ics' +); + +foreach ($cal->getEvents()->sorted() as $event) { + printf('%s - %s' . PHP_EOL, $event['DTSTART']->format('j.n.Y'), $event['SUMMARY']); + +} +``` + +Each property of each event is available using the property name (in capital letters) as a key. +There are some special cases: + +- multiple attendees with individual parameters: use `ATTENDEES` as key to get all attendees in the following scheme: +```php +[ + [ + 'ROLE' => 'REQ-PARTICIPANT', + 'PARTSTAT' => 'NEEDS-ACTION', + 'CN' => 'John Doe', + 'VALUE' => 'mailto:john.doe@example.org' + ], + [ + 'ROLE' => 'REQ-PARTICIPANT', + 'PARTSTAT' => 'NEEDS-ACTION', + 'CN' => 'Test Example', + 'VALUE' => 'mailto:test@example.org' + ] +] +``` +- organizer's name: the *CN* parameter of the organizer property can be retrieved using the key `ORGANIZER-CN` + +You can run example with [PHP Built-in web server](https://www.php.net/manual/en/features.commandline.webserver.php) as follow: + +```shell +php -S localhost:8000 -t example +``` + +## Requirements + +- PHP 8.0+ + +## Run tests + +iCal parser using [Nette Tester](https://github.com/nette/tester). The tests can be invoked via [composer](https://getcomposer.org/). + +```shell script +composer update +composer test +``` + |