Skip to content

feat: implement rfc 7986 properties #801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
provokateurin merged 1 commit into from
Oct 5, 2026
Merged

feat: implement rfc 7986 properties #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions lib/Component/VCalendar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@ class VCalendar extends VObject\Document

// Additions from draft-daboo-calendar-availability-05
'BUSYTYPE' => Property\Text::class,

// RFC 7986 properties
'NAME' => Property\FlatText::class,
'COLOR' => Property\FlatText::class,
];

/**
Expand Down Expand Up @@ -379,6 +383,18 @@ public function getValidationRules(): array

'CALSCALE' => '?',
'METHOD' => '?',

// RFC 7986 calendar properties
'UID' => '?',
'LAST-MODIFIED' => '?',
'URL' => '?',
'REFRESH-INTERVAL' => '?',
'SOURCE' => '?',
'COLOR' => '?',
'NAME' => '*',
'DESCRIPTION' => '*',
'CATEGORIES' => '*',
'IMAGE' => '*',
];
}

Expand Down
3 changes: 3 additions & 0 deletions lib/Component/VEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ public function getValidationRules(): array
'DTSTART' => $hasMethod ? '?' : '1',
'CLASS' => '?',
'CREATED' => '?',
'COLOR' => '?',
'DESCRIPTION' => '?',
'GEO' => '?',
'LAST-MODIFIED' => '?',
Expand All @@ -137,7 +138,9 @@ public function getValidationRules(): array
'ATTENDEE' => '*',
'CATEGORIES' => '*',
'COMMENT' => '*',
'CONFERENCE' => '*',
'CONTACT' => '*',
'IMAGE' => '*',
'EXDATE' => '*',
'REQUEST-STATUS' => '*',
'RELATED-TO' => '*',
Expand Down
2 changes: 2 additions & 0 deletions lib/Component/VJournal.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ public function getValidationRules(): array

'CLASS' => '?',
'CREATED' => '?',
'COLOR' => '?',
'DTSTART' => '?',
'LAST-MODIFIED' => '?',
'ORGANIZER' => '?',
Expand All @@ -78,6 +79,7 @@ public function getValidationRules(): array
'CATEGORIES' => '*',
'COMMENT' => '*',
'CONTACT' => '*',
'IMAGE' => '*',
'DESCRIPTION' => '*',
'EXDATE' => '*',
'RELATED-TO' => '*',
Expand Down
3 changes: 3 additions & 0 deletions lib/Component/VTodo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ public function getValidationRules(): array
'CLASS' => '?',
'COMPLETED' => '?',
'CREATED' => '?',
'COLOR' => '?',
'DESCRIPTION' => '?',
'DTSTART' => '?',
'GEO' => '?',
Expand All @@ -120,7 +121,9 @@ public function getValidationRules(): array
'ATTENDEE' => '*',
'CATEGORIES' => '*',
'COMMENT' => '*',
'CONFERENCE' => '*',
'CONTACT' => '*',
'IMAGE' => '*',
'EXDATE' => '*',
'REQUEST-STATUS' => '*',
'RELATED-TO' => '*',
Expand Down
130 changes: 130 additions & 0 deletions tests/VObject/Component/VCalendarRfc7986Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
<?php

namespace Sabre\VObject\Component;

use PHPUnit\Framework\TestCase;
use Sabre\VObject;

class VCalendarRfc7986Test extends TestCase
{
private function calendar(): VCalendar
{
$calendar = new VCalendar();
$calendar->add('VEVENT', ['DTSTART' => '20261004T120000Z']);

return $calendar;
}

public function testCalendarPropertiesAndRoundTrip(): void
{
$calendar = $this->calendar();
$calendar->add('NAME', 'Company Vacation Days', ['LANGUAGE' => 'en']);
$calendar->add('DESCRIPTION', 'Company holidays', ['LANGUAGE' => 'en']);
$calendar->add('UID', '5FC53010-1267-4F8E-BC28-1D7AE55A7C99');
$calendar->add('LAST-MODIFIED', '20261001T120000Z');
$calendar->add('URL', 'https://example.com/holidays');
$calendar->add('CATEGORIES', ['Holidays', 'Company']);
$calendar->add('REFRESH-INTERVAL', 'P1W', ['VALUE' => 'DURATION']);
$calendar->add('SOURCE', 'https://example.com/holidays.ics', ['VALUE' => 'URI']);
$calendar->add('COLOR', 'turquoise');
$calendar->add('IMAGE', 'https://example.com/images/party.png', [
'VALUE' => 'URI', 'DISPLAY' => ['BADGE', 'THUMBNAIL'], 'FMTTYPE' => 'image/png',
]);
$parsed = VObject\Reader::read($calendar->serialize());
self::assertInstanceOf(VObject\Property\FlatText::class, $parsed->NAME);
self::assertInstanceOf(VObject\Property\FlatText::class, $parsed->COLOR);
self::assertSame('DURATION', $parsed->{'REFRESH-INTERVAL'}->getValueType());
self::assertSame('URI', $parsed->SOURCE->getValueType());
self::assertSame('URI', $parsed->IMAGE->getValueType());
self::assertSame([], $parsed->validate());
self::assertSame($calendar->serialize(), $parsed->serialize());
$json = VObject\Writer::writeJson($calendar);
self::assertSame($json, VObject\Writer::writeJson(VObject\Reader::readJson($json)));
}

public function testPropertiesWithoutDefaultTypesRetainValueParameters(): void
{
$calendar = $this->calendar();
$calendar->add('REFRESH-INTERVAL', 'P1W', ['VALUE' => 'DURATION']);
$calendar->add('SOURCE', 'https://example.com/calendar.ics', ['VALUE' => 'URI']);
$calendar->add('IMAGE', 'image bytes', ['VALUE' => 'BINARY', 'ENCODING' => 'BASE64', 'FMTTYPE' => 'image/png']);
$calendar->VEVENT->add('CONFERENCE', 'https://example.com/meeting', ['VALUE' => 'URI']);
$parsed = VObject\Reader::readJson(VObject\Writer::writeJson($calendar));
self::assertSame('DURATION', (string) $parsed->{'REFRESH-INTERVAL'}['VALUE']);
self::assertSame('URI', (string) $parsed->SOURCE['VALUE']);
self::assertSame('BINARY', (string) $parsed->IMAGE['VALUE']);
self::assertSame('image bytes', $parsed->IMAGE->getValue());
self::assertSame('URI', (string) $parsed->VEVENT->CONFERENCE['VALUE']);
self::assertSame(VObject\Writer::writeJson($calendar), VObject\Writer::writeJson($parsed));
}

public function testCalendarSingletonCardinalities(): void
{
$properties = [
'UID' => ['calendar-id', []],
'LAST-MODIFIED' => ['20261001T120000Z', []],
'URL' => ['https://example.com/calendar', []],
'REFRESH-INTERVAL' => ['P1W', ['VALUE' => 'DURATION']],
'SOURCE' => ['https://example.com/calendar.ics', ['VALUE' => 'URI']],
'COLOR' => ['turquoise', []],
];
foreach ($properties as $name => [$value, $parameters]) {
$calendar = $this->calendar();
$calendar->add($name, $value, $parameters);
self::assertSame([], $calendar->validate(), $name);
$calendar->add($name, $value, $parameters);
self::assertContains(
$name.' MUST NOT appear more than once in a VCALENDAR component',
array_column($calendar->validate(), 'message')
);
}
}

public function testRepeatableCalendarProperties(): void
{
$calendar = $this->calendar();
foreach (['en', 'de'] as $language) {
$calendar->add('NAME', 'Calendar', ['LANGUAGE' => $language]);
$calendar->add('DESCRIPTION', 'Description', ['LANGUAGE' => $language]);
}
$calendar->add('CATEGORIES', ['Company']);
$calendar->add('CATEGORIES', ['Holidays']);
$calendar->add('IMAGE', 'https://example.com/one.png', ['VALUE' => 'URI']);
$calendar->add('IMAGE', 'https://example.com/two.png', ['VALUE' => 'URI']);
self::assertSame([], $calendar->validate());
foreach (['NAME', 'DESCRIPTION', 'CATEGORIES', 'IMAGE'] as $name) {
self::assertCount(2, $calendar->select($name));
}
}

public function testComponentPropertiesAndColorCardinality(): void
{
foreach (['VEVENT', 'VTODO', 'VJOURNAL'] as $name) {
$calendar = new VCalendar();
$component = $calendar->add($name, ['DTSTART' => '20261004T120000Z']);
$component->add('COLOR', 'turquoise');
$component->add('IMAGE', 'https://example.com/one.png', ['VALUE' => 'URI']);
$component->add('IMAGE', 'https://example.com/two.png', ['VALUE' => 'URI']);
if ('VJOURNAL' !== $name) {
$component->add('CONFERENCE', 'https://example.com/meeting', [
'VALUE' => 'URI', 'FEATURE' => ['AUDIO', 'VIDEO'], 'LABEL' => 'Attendee dial-in',
]);
$component->add('CONFERENCE', 'xmpp:chat@example.com', ['VALUE' => 'URI', 'FEATURE' => 'CHAT']);
$component->add('ATTENDEE', 'mailto:opaque-token@example.com', ['EMAIL' => 'person@example.com']);
$parsed = VObject\Reader::read($calendar->serialize());
$parsedComponent = $parsed->{$name};
self::assertSame('URI', $parsedComponent->CONFERENCE->getValueType());
self::assertTrue($parsedComponent->CONFERENCE['FEATURE']->has('VIDEO'));
self::assertSame('Attendee dial-in', (string) $parsedComponent->CONFERENCE['LABEL']);
self::assertSame('person@example.com', (string) $parsedComponent->ATTENDEE['EMAIL']);
self::assertCount(2, $parsedComponent->select('CONFERENCE'));
}
self::assertSame([], $calendar->validate(), $name);
$component->add('COLOR', 'red');
self::assertContains(
'COLOR MUST NOT appear more than once in a '.$name.' component',
array_column($calendar->validate(), 'message')
);
}
}
}
Loading