BirthdayCalendarGenerator.php

Go to the documentation of this file.

<?php
 
namespace Sabre\VObject;
 
use Sabre\VObject\Component\VCalendar;
 
class BirthdayCalendarGenerator {
 
    protected $objects = [];
 
    const DEFAULT_YEAR = 2000;
 
    protected $format = '%1$s\'s Birthday';
 
    function __construct($objects = null) {
 
        if ($objects) {
            $this->setObjects($objects);
        }
 
    }
 
    function setObjects($objects) {
 
        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');
 
            }
 
        }
 
    }
 
    function setFormat($format) {
 
        $this->format = $format;
 
    }
 
    function getResult() {
 
        $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;
 
    }
 
}