BirthdayCalendarGenerator
in package
This class generates birthday calendars.
Tags
Table of Contents
- DEFAULT_YEAR = 2000
- Default year.
- $format : string
- Output format for the SUMMARY.
- $objects : array<string|int, mixed>
- Input objects.
- __construct() : mixed
- Creates the generator.
- getResult() : mixed
- Parses the input data and returns a VCALENDAR.
- setFormat() : mixed
- Sets the output format for the SUMMARY.
- setObjects() : mixed
- Sets the input objects.
Constants
DEFAULT_YEAR
Default year.
public
mixed
DEFAULT_YEAR
= 2000
Used for dates without a year.
Properties
$format
Output format for the SUMMARY.
protected
string
$format
= '%1$s's Birthday'
$objects
Input objects.
protected
array<string|int, mixed>
$objects
= []
Methods
__construct()
Creates the generator.
public
__construct([mixed $objects = null ]) : mixed
Check the setTimeRange and setObjects methods for details about the arguments.
Parameters
- $objects : mixed = null
Return values
mixed —getResult()
Parses the input data and returns a VCALENDAR.
public
getResult() : mixed
Return values
mixed —setFormat()
Sets the output format for the SUMMARY.
public
setFormat(string $format) : mixed
Parameters
- $format : string
Return values
mixed —setObjects()
Sets the input objects.
public
setObjects(mixed $objects) : mixed
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
- $objects : mixed