This class generates birthday calendars. More...

Collaboration diagram for Sabre\VObject\BirthdayCalendarGenerator:

Public Member Functions
	__construct ($objects=null)
	Creates the generator. More...

	setObjects ($objects)
	Sets the input objects. More...

	setFormat ($format)
	Sets the output format for the SUMMARY. More...

	getResult ()
	Parses the input data and returns a VCALENDAR. More...

Data Fields
const	DEFAULT_YEAR = 2000
	Default year. More...

Protected Attributes
	$objects = []

	$format = '%1$s\'s Birthday'

Detailed Description

This class generates birthday calendars.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Dominik Tobschall (http://tobschall.de/) http://sabre.io/license/ Modified BSD License

Definition at line 14 of file BirthdayCalendarGenerator.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\VObject\BirthdayCalendarGenerator::__construct ( $objects = null )

Creates the generator.

Check the setTimeRange and setObjects methods for details about the arguments.

Parameters

mixed $objects

Definition at line 44 of file BirthdayCalendarGenerator.php.

References Sabre\VObject\BirthdayCalendarGenerator\$objects, and Sabre\VObject\BirthdayCalendarGenerator\setObjects().

                                           {
 
         if ($objects) {
             $this->setObjects($objects);
         }
 
     }

Here is the call graph for this function:

Member Function Documentation

◆ getResult()

Sabre\VObject\BirthdayCalendarGenerator::getResult ( )

Parses the input data and returns a VCALENDAR.

Returns: Component/VCalendar

Definition at line 112 of file BirthdayCalendarGenerator.php.

References $calendar, Sabre\VObject\DateTimeParser\parseVCardDateTime(), and Sabre\VObject\Document\VCARD40.

                          {
 
         $calendar = new VCalendar();
 
         foreach ($this->objects as $object) {
 
             // Skip if there is no BDAY property.
             if (!$object->select('BDAY')) {
                 continue;
             }
 
             // We've seen clients (ez-vcard) putting "BDAY:" properties
             // without a value into vCards. If we come across those, we'll
             // skip them.
             if (empty($object->BDAY->getValue())) {
                 continue;
             }
 
             // We're always converting to vCard 4.0 so we can rely on the
             // VCardConverter handling the X-APPLE-OMIT-YEAR property for us.
             $object = $object->convert(Document::VCARD40);
 
             // Skip if the card has no FN property.
             if (!isset($object->FN)) {
                 continue;
             }
 
             // Skip if the BDAY property is not of the right type.
             if (!$object->BDAY instanceof Property\VCard\DateAndOrTime) {
                 continue;
             }
 
             // Skip if we can't parse the BDAY value.
             try {
                 $dateParts = DateTimeParser::parseVCardDateTime($object->BDAY->getValue());
             } catch (InvalidDataException $e) {
                 continue;
             }
 
             // Set a year if it's not set.
             $unknownYear = false;
 
             if (!$dateParts['year']) {
                 $object->BDAY = self::DEFAULT_YEAR . '-' . $dateParts['month'] . '-' . $dateParts['date'];
 
                 $unknownYear = true;
             }
 
             // Create event.
             $event = $calendar->add('VEVENT', [
                 'SUMMARY' => sprintf($this->format, $object->FN->getValue()),
                 'DTSTART' => new \DateTime($object->BDAY->getValue()),
                 'RRULE'   => 'FREQ=YEARLY',
                 'TRANSP'  => 'TRANSPARENT',
             ]);
 
             // add VALUE=date
             $event->DTSTART['VALUE'] = 'DATE';
 
             // Add X-SABRE-BDAY property.
             if ($unknownYear) {
                 $event->add('X-SABRE-BDAY', 'BDAY', [
                     'X-SABRE-VCARD-UID' => $object->UID->getValue(),
                     'X-SABRE-VCARD-FN'  => $object->FN->getValue(),
                     'X-SABRE-OMIT-YEAR' => self::DEFAULT_YEAR,
                 ]);
             } else {
                 $event->add('X-SABRE-BDAY', 'BDAY', [
                     'X-SABRE-VCARD-UID' => $object->UID->getValue(),
                     'X-SABRE-VCARD-FN'  => $object->FN->getValue(),
                 ]);
             }
 
         }
 
         return $calendar;
 
     }

Here is the call graph for this function:

◆ setFormat()

Sabre\VObject\BirthdayCalendarGenerator::setFormat ( $format )

Sets the output format for the SUMMARY.

Parameters

string $format

Returns: void

Definition at line 101 of file BirthdayCalendarGenerator.php.

References Sabre\VObject\BirthdayCalendarGenerator\$format.

                                 {
 
         $this->format = $format;
 
     }

◆ setObjects()

Sabre\VObject\BirthdayCalendarGenerator::setObjects ( $objects )

Sets the input objects.

You must either supply a vCard as a string or as a Component/VCard object. It's also possible to supply an array of strings or objects.

Parameters

mixed $objects

Returns: void

Definition at line 62 of file BirthdayCalendarGenerator.php.

References Sabre\VObject\BirthdayCalendarGenerator\$objects, and Sabre\VObject\Reader\read().

Referenced by Sabre\VObject\BirthdayCalendarGenerator\__construct().

                                   {
 
         if (!is_array($objects)) {
             $objects = [$objects];
         }
 
         $this->objects = [];
         foreach ($objects as $object) {
 
             if (is_string($object)) {
 
                 $vObj = Reader::read($object);
                 if (!$vObj instanceof Component\VCard) {
                     throw new \InvalidArgumentException('String could not be parsed as \\Sabre\\VObject\\Component\\VCard by setObjects');
                 }
 
                 $this->objects[] = $vObj;
 
             } elseif ($object instanceof Component\VCard) {
 
                 $this->objects[] = $object;
 
             } else {
 
                 throw new \InvalidArgumentException('You can only pass strings or \\Sabre\\VObject\\Component\\VCard arguments to setObjects');
 
             }
 
         }
 
     }