itsnubix/nowcal

A modern PHP library for generating iCalendar v2.0 events

1.2.5 2024-05-05 04:06 UTC

Requires

• php: >8.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^7.1.5|^9.5

MIT

• Kyle Milloy

• calendar
• iCalendar
• ics

README

A modern PHP library for generating iCalendar v2.0 events.

Getting Started

Installation

Install with composer using composer require itsnubix/nowcal

Basic usage

use NowCal\NowCal;

$event = NowCal::create(['start' => 'October 5, 2019 6:03PM']))
  ->summary('Daft Punk is playing')
  ->location('My House');

API

Properties

The following properties can be get/set on the NowCal instance. Users can take advantage of the set property helpers in the class, i.e.: $nowcal->location('Event Location'); as they provide a nice syntax to string multiple calls together and support callbacks if necessary.

Property	Description
uid	A globally unique ID. NOTE: passing the same ICS file into a calendar app with the same UI allows you to update the existing invite
start	A string parseable by DateTime
timezone	A string parseable by DateTimeZone
end	A string parseable by DateTime, as per RFC 5545, only an end value or duration value may be used
duration	A string parseable by DateInterval, as per RFC 5545, only an end value or duration value may be used
summary	A short description of the event
location	The location where the event is taking place
sequence	An integer that represents the version number
method	send if required, publish/cancel/etc

Methods

$props = [
  'start' => 'now',
  'end' => 'now + 1 hour',
  // OR
  'duration' => '28d 6h 42m 12s',
  'summary' => 'Daft Punk is playing',
  'location' => 'My House',
];

// Creates a NowCal instance
$nowcal = new NowCal($props); // or NowCal::create($props);

// Exports a raw output array
$nowcal->raw; // or NowCal::raw($props)

// Exports a plain text version
$nowcal->plain; // or NowCal::plain($props)

// Exports a path to a tempfile
$nowcal->file; // or NowCal::file($props)