Server : Apache System : Linux indy02.toastserver.com 3.10.0-962.3.2.lve1.5.85.el7.x86_64 #1 SMP Thu Apr 18 15:18:36 UTC 2024 x86_64 User : palandch ( 1163) PHP Version : 7.1.33 Disable Function : NONE Directory : /home/palandch/public_html/core/components/gcalevents/docs/ |
Please report bugs & feature requests on Github:
https://github.com/eelkevdbos/gCalEvents
/* DESCRIPTION */
gCalEvents is a component that requests a Google Calendar eventfeed. It enables you to easily integrate google calendar items into your website.
It can be used to extract raw data from the feed and optionally parse the data to format it. To speed up the code, caching can be enabled.
Both public and private feeds can be used. For private feeds you can either supply your privateCookie in the snippet call or store it like a setting.
/* BASIC USAGE */
[[!gcalAgendaView &userID=`yourcalendaremail%40yourdomain.tld` &cached=`1` &decay=`86400` &limit=`5`]] // for public calendars and caching enabled (1 day decay)
[[!gcalAgendaView &userID=`yourcalendaremail%40yourdomain.tld` &privateCookie=`cookievalue`]] // for private calendars
[[!gcalAgendaView &useSettings=`1`]] // to use system settings
The same settings can be used for the [[!gcalWeekView]] snippet.
[[!gcalWeekView &useSettings=`1` &includeHeader=`0` &cached=`1`]] // for weekview of agenda defined in settings
/* ADVANCED PARAMETERS */
eventTpl, defines a new template for each event
wrapTpl, defines the wrapper for the events
startDate, to set a minimum startdate, format: Y-m-d\TH:i:s
endDate, to set a maximum enddate, format: see startDate
includeAttendees, to include a list of attendees
cacheSlot, to give each cache item a unique slot for caching, useful when loading multiple agenda's on 1 resource
For detailed documentation, please visit Github wiki:
https://github.com/eelkevdbos/gCalEvents/wiki/
/* GENERAL */
The eventchunk has all the placeholders google calendar specifies in it's feed. A complete list of keys can be found at:
http://code.google.com/intl/nl-NL/apis/calendar/data/2.0/developers_guide_protocol.html#RetrievingEvents
Multi-level feeds are concatenated with a dot as key. The entries are concatenated with a ', ' as separator.
Example:
Feed: {'attendees':[{'displayName':'John Doe'}, {'displayName':'Henry Lloyd'}]}
Placeholder: [[+attendees.displayName]]
Result: John Doe, Henry Lloyd