xp-forge/ical

iCalendar

Maintainers

Details

github.com/xp-forge/ical

Homepage

Source

Issues

Installs: 2 932

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

v4.2.0 2024-03-24 10:45 UTC

Requires

Requires (Dev)

BSD-3-Clause 147ae63507c8750315c20320675ee25f5e3807c7

modulexp

This package is auto-updated.

Last update: 2024-10-24 12:05:27 UTC

README

Build status on GitHub XP Framework Module BSD Licence Requires PHP 7.0+ Supports PHP 8.0+ Latest Stable Version

I/O

Calendars can be read and written using the ICalendar class

use text\ical\ICalendar;
use util\cmd\Console;
use io\File;

$ical= new ICalendar();

$calendar= $ical->read('BEGIN:VCALENDAR...');
$calendar= $ical->read(Console::$in->stream());
$calendar= $ical->read(new File('meeting.ics'));

$ical->write($calendar, Console::$out->stream());
$ical->write($calendar, new File('meeting.ics'));

Events

Typically a calendar contains one event, though the format allows any number, including none at all.

Using first event, typical use-case:

$event= $calendar->events()->first();

To prevent a lang.ElementNotFoundException when no event is present, check first:

$events= $calendar->events(); 
if ($events->present()) {
  $event= $events->first();
} else {
  // Handle situation when no events are inside calendar
}

Process all events:

foreach ($calendar->events() as $event) {
  // ...
}

Creation

Calendar instances can be created using a fluent interface

use text\ical\{
  Calendar,
  Event,
  Organizer,
  Attendee,
  IDate,
  Text,
  Method,
  Role,
  PartStat
};

$calendar= Calendar::with()
  ->method(Method::REQUEST)
  ->prodid('Microsoft Exchange Server 2010')
  ->version('2.0')
  ->events([Event::with()
    ->organizer(new Organizer('The Organizer', 'MAILTO:organizer@example.com'))
    ->attendees([
      Attendee::with()
        ->role(Role::CHAIR)
        ->partstat(PartStat::NEEDS_ACTION)
        ->rsvp('TRUE')
        ->cn('The Attendee 1')
        ->value('MAILTO:attendee2@example.com')
        ->create()
      ,
      Attendee::with()
        ->role(Role::REQ_PARTICIPANT)
        ->partstat(PartStat::NEEDS_ACTION)
        ->rsvp('TRUE')
        ->cn('The Attendee 2')
        ->value('MAILTO:attendee3@example.com')
        ->create()
    ])
    ->dtstart(new IDate(null, '20160524T183000Z'))
    ->dtend(new IDate(null, '20160524T190000Z'))
    ->location(new Text('de-DE', 'BS 50 EG 0102'))
    ->summary(new Text('de-DE', 'Treffen'))
    ->create()
  ])
  ->create()
;