Jump to content
ffub

MarkupiCalendar

Recommended Posts

Hi guys,

I've been doing events sections for a few sites and for each I needed to make an iCal feed. I've wrapped up this functionality into a module now to make it a little easier for myself and anyone else that needs to make these feeds.

The module is basically a simple wrapper around the iCalcreator library (a copy is included). It's modelled on the MarkupRSS module from Ryan, so anyone familiar with that should have a feed up and running in no time.

Usage


The module takes a PageArray and creates the feed from that. The [tt]->render[/tt] method will send the output to the browser with a generated filename and will automatically download. Because it will return HTTP headers, it has to be included before any html and is best in its own template or followed up by [tt]exit;[/tt]

<?php

$today = time();
$items = $pages->find("template=event, sort=start_date, start_date>$today");

$ics = $modules->get("MarkupiCalendar");
$ics->title = "Upcoming Events";
$ics->description = "Some upcoming events";
$ics->itemStartDateField = 'start_date';
$ics->itemEndDateField = 'end_date';
$ics->itemLocationField = 'location';
$ics->render($items);

You can use the [tt]->renderFeed[/tt] method to return the output as a string instead, which is particularly useful if you want to debug or write the output to a file.

<?php

$today = time();
$items = $pages->find("template=event, sort=start_date, start_date>$today");

$ics = $modules->get("MarkupiCalendar");
$ics->title = "Upcoming Events";
$ics->description = "Some upcoming events";
$ics->itemStartDateField = 'start_date';
$ics->itemEndDateField = 'end_date';
$ics->itemLocationField = 'location';
$cal = $ics->renderFeed($items);

echo $cal;

I often put RSS and iCal feeds at the top of my listing pages so as not to clutter up the site tree with extra templates. This way /events/ may point to my events page, and /events/ical will point to it's feed. Here is an example:

<?php

// iCal feed
if ($input->urlSegment1 == "ical") {

$today = time();
$items = $page->children("sort=start_date, start_date>$today");

$ics = $modules->get("MarkupiCalendar");
$ics->title = "Upcoming Events";
$ics->description = "Upcoming events for my company";
$ics->itemStartDateField = 'start_date';
$ics->itemEndDateField = 'end_date';
$ics->itemLocationField = 'location';
$ics->url = $page->httpUrl;
$ics->render($items);
exit;

}

// Render the template as normal.
include("./includes/head.inc");

Download and feedback


You can download or fork the module here: https://github.com/f...MarkupiCalendar

At the moment it only supports all day events (as these are all I have dealt with) but I hope to add time based events soon. Any feedback is warmly appreciated and feel free to report bugs or suggestions for improvement.

Stephen

  • Like 5

Share this post


Link to post
Share on other sites

Could be usefull for somes ! thanks for sharing.

Maybe add a link to a demo or live site to see the kind of results you got with that module ?

Share this post


Link to post
Share on other sites

Great job ffub! Nice work with the code and documenting how to use it too. I will add to the modules directory asap. Thanks for your work here. I will definitely be using this module in the future.

Share this post


Link to post
Share on other sites

Thanks, thats great timing, as I was just about to start hacking the rss module to do something similar for an events section.

Can I also suggest another tip that I found useful .

If you want the users to subscribe to the calendar, instead of just downloading it, use the  webcal:// uri scheme - e.g.

webcal://you.com/upcoming/ical

When the user clicks on the link, it should open up in their default calendar application.

Then whenever you update the events section, the users calendar will also get updated.  Nice!

Share this post


Link to post
Share on other sites

Thanks for the feedback everyone. I hope it can be useful. As I said above, the module is still lacking support for times. I'd be curious to know how others are storing events - whether you are using a single field for date and time, or whether you are storing time separately and taking its absence to mean all-day? The main reason I can see for having it as a separate field is it leaves the date picker to work it's magic and thus makes adding events fairly painless for the user.

mjmurphy:

You are right to point out that the webcal: uri is informally used to denote iCal feeds. You can do this with the links in my examples above. While the [tt]->render[/tt] method will send the page as a download when accessed directly, I've tried it out with iCal and Google Calendar and it works just fine as a feed. If you wish to use the feed differently, such as sending different headers then [tt]->renderFeed[/tt] will let you do that. In addition to your suggested webcal:// link I tend to add Google Calendar links as many people use this now. Here's an example:

<?php
$gcalLink = urlencode($pages->get("/")->httpUrl . "events/ical");
echo "<a href='webcal://{$config->httpHost}/events/ical'>Subscribe to Calendar</a><br/>";
echo "<a href='https://www.google.com/calendar/render?cid=$gcalLink'>Add to Google Calendar</a>";

Thanks,

Stephen

Share this post


Link to post
Share on other sites
I'd be curious to know how others are storing events - whether you are using a single field for date and time, or whether you are storing time separately and taking its absence to mean all-day?

Actually there is no such thing as absence of time in unix timestamps (which is what PW uses). Every date is also storing a time. It's just a matter of whether you are using and outputting a time with it. I think that if you only specify a date, then it just uses the earliest possible time from that date (i.e. midnight).

I've developed a module that is somewhat related to yours in the opposite direction, though don't yet have it release ready. But what it does is lets you to query a Google Calendar for date ranges or keywords, and then lets you iterate and output the results like pages.

Share this post


Link to post
Share on other sites

@Ryan

I would be very interested in that Google calendar module. Building an event system can get quite complicated especially when you add on all the extra features that clients normally request like repeating and multiday events. Google calendar would solve all these issues, and give them a highly functional and collaborative calendar. The pw site could then just display the upcoming events. nice and simple

@ffub

I am using two datefields - start and end time. Each field accepts a time string (d/m/Y H:i).

I've not implemented "all day" events functionality, but i think If the date and times are the same, then this could indicate an "all day" event? Another idea might be to have an additional checkbox field which gets ticked if its an "all dayer".

While we are the subject of time (maybe I should move this to another thread), I have been trying to extend the datatime calendar widget to include a nice Time picker. It's just a plugin for the existing jqueryui datepicker

http://trentrichardson.com/examples/timepicker/

I managed to get it sort of working, but it was not saving the correct date. I was also hacking at the core module, which is probably not best practice. Any tips or advice on how to get this working would be welcome.

Thanks,

Michael

Share this post


Link to post
Share on other sites
I would be very interested in that Google calendar module. Building an event system can get quite complicated especially when you add on all the extra features that clients normally request like repeating and multiday events. Google calendar would solve all these issues, and give them a highly functional and collaborative calendar. The pw site could then just display the upcoming events. nice and simple

I agree! I hadn't worked much with Google Calendar before, but am really liking it. I'm looking forward to finishing up this module.

Share this post


Link to post
Share on other sites

@ryan

I realise that unix timestamps include a time as well, but this seems to confuse Google Calendar somewhat as multiple day events where I had not specified a time seemed to begin at 1 in the morning. It may well be something to do with the timezone and/or daylight savings though. I've not had time to debug this so for the sake of ease I am passing the events as dates rather than timestamps, eg:

CREATED:20111005T020915Z
DTSTART;VALUE=DATE:20111028

I used Google Calendar originally on my sites and I really love it. I was pulling the events in via an RSS feed. I will definitely be interested in your new module for my simpler sites now.

@mjmurphy

It's actually from the UX perspective that I have suggested having separate time fields. The datepicker lets you pick a date with relative ease and you can manually amend a time to that. This is a bit confusing for users though. Also, changing the date with the date picker, seems to remove the time. I encourage my users to stick to the jQuery UI picker as we are used to writing d/m/Y here in the UK, which is indistinguishable from m/d/Y to PHP. No amount of prodding or helpful reminders seems to make entering in a different format (such as Y-m-d) stick for them. Your date picker changes look like a very good solution to this problem for me though!

I have considered making a new dates InputType/FieldType for events that more closely mimics Google's excellent one to tackle some of these problems (see attachments). I'm not entirely sure how to go about that though. Aside from date entry, having events in PW is a doddle and presents some great possibilities in terms of linking them with other aspects of a site or providing more than a summary for each event (bookings!).

I would strongly suggest anyone else working on events to check out fullCalendar, a great little jQuery plugin. I pass my events to this with a simple JSON feed in order to make a scrollable calendar widget.

Stephen

post-500-132614279452_thumb.png

post-500-132614279455_thumb.png

  • Like 1

Share this post


Link to post
Share on other sites

See, this is what I love about ProcessWire.

I was just in a meeting, and the question came up whether it was possible to export a list of events and dates as a calender, i.e. in iCal format. I wasn't sure about it, but I took a wild guess that there would be some way to do this. Back at home, checked the modules page, BAM, there you go.

For someone like me who is not able to do "real" PHP coding, this is a life saver. Thank you so much. :)

  • Like 2

Share this post


Link to post
Share on other sites

At the moment it only supports all day events (as these are all I have dealt with) but I hope to add time based events soon.

Any chance of adding this any time soon? :)

My suggestion would be to point to this thread in the module documentation. It may be because I'm not a skilled PHP coder, but I got along much better once I read your posts here.

Share this post


Link to post
Share on other sites

this thread was helpful in setting up the ical and google calendar feeds.

i changed the module a bit to get it to support the time start and end of events, otherwise your events will always appear to be all day, if you use this module.

It's a bit hackish, in that it determines whether to use the all-day style, or the actual time style by checking if the time is set to midnight, which it would be if you were not specifying a time; though this could be a problem if you had an event that started at midnight.

it might work to have a separate checkbox to indicate "all day" and then use that to conditionally output the date with or without time, if you wanted it more foolproof;

here are the relevant changes:

$start = $event->getUnformatted($this->itemStartDateField);
if( date('His', $start) == "000000"  ) {
	$vevent->setProperty('dtstart', $this->ical_date($event->getUnformatted($this->itemStartDateField)),array("VALUE" => "DATE"));
} else {
	$vevent->setProperty('dtstart', $this->ical_date($event->getUnformatted($this->itemStartDateField)));
}
			
if($event->get($this->itemEndDateField)) {
	$end = $event->getUnformatted($this->itemEndDateField);
	if( date('His', $end) == "000000"  ) {
		$vevent->setProperty('dtend', $this->ical_date($event->getUnformatted($this->itemEndDateField)),array("VALUE" => "DATE"));
	} else {
		$vevent->setProperty('dtend', $this->ical_date($event->getUnformatted($this->itemEndDateField)));
	}
}

since this module also includes the full iCalcreator library, it could be extended to support repeating events and other cool things.. might experiment with it this summer;

They mention processwire, this module, also, on the main page http://kigkonsult.se/iCalcreator/index.php

Another thing that came up was the existence of special characters in the titles of the events.

The title field needed to be decoded or you end up with &amp\; in your feed:

$summary = html_entity_decode($event->get($this->itemSummaryField), ENT_QUOTES);
$vevent->setProperty('summary',$summary);
//$vevent->setProperty('summary',$event->get($this->itemSummaryField));

Share this post


Link to post
Share on other sites
They mention processwire, this module, also, on the main page http://kigkonsult.se/iCalcreator/index.php

cool link there is a former used addon linked from a php develloper i tested addon some years ago. Have used this one on a local township site for years now:

https://github.com/phpManufaktur/kitEvent

It has a lot of thirdparty requirements but repeating events, creates ical links, creates QR-codes on events, reusing "events" for new ones...like presets...but it just a element of a real big CRM application of my former used cms "kit" is called "Keep In Touch"...so events was a part of that app.....just funny to find such a old connection to the past....;)

Share this post


Link to post
Share on other sites
On 10/13/2011 at 12:44 PM, ffub said:

You are right to point out that the webcal: uri is informally used to denote iCal feeds. You can do this with the links in my examples above. While the [tt]->render[/tt] method will send the page as a download when accessed directly, I've tried it out with iCal and Google Calendar and it works just fine as a feed. If you wish to use the feed differently, such as sending different headers then [tt]->renderFeed[/tt] will let you do that. In addition to your suggested webcal:// link I tend to add Google Calendar links as many people use this now. Here's an example:


<?php
$gcalLink = urlencode($pages->get("/")->httpUrl . "events/ical");
echo "<a href='webcal://{$config->httpHost}/events/ical'>Subscribe to Calendar</a><br/>";
echo "<a href='https://www.google.com/calendar/render?cid=$gcalLink'>Add to Google Calendar</a>";
 

I've just implemented the module on a new site after replacing the iCalcreator library with the latest one as the bundled one doesn't work on PHP 7. 
I've done it the URL segment way suggested in the first post and used the ->render method.
A few notes to the subscription links to save you some time:

  • webcal:// links worked on my Mac in Safari offering to subscribe in the Calendar app. When using https://, Safari just downloads the .ics file instead.
  • For iOS the link must be https://, not webcal:// and also had to modify the URL segment to "ical.ics" to be properly recognised.
    iOS tries to add the events, not the subscription without the .ics extension. Webcal:// links did not do anything when tapped on iOS13, simply nothing happened.
  • The Google Calendar link must contain an ULR encoded HTTP:// link, https links will give an error message and won't work.

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory (alpha version only available via GitHub) SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...