Jump to content
joshuag

Recurme – Processwire Recurring Dates Field & Custom Calendar Module.

Recommended Posts

Introducing our newest [commercial] module:

Recurme
Processwire Recurring Dates Field & Custom Calendar Module.

http://www.99lime.com/modules/recurme/

One Field to Recur them ALL…
A Recurring Dates InputField for your Processwire templates. The InputField you’ve been waiting for.
Complex RRule date repeating in a simple and fast user interface.

Use the super simple, & powerful API to output them into your templates.

example:

<?
	// easy to get recurring events
	$events = $recurme->find();
	// events for this day
	$events = $recurme->day();
	// events for this week
	$events = $recurme->week();
	// events for this month
	$events = $recurme->month();
?>
<?
	// Loop through your events
	foreach($events as $event){
		echo $event->title;
		echo $event->start_date;
		echo $event->rrule;
		echo $event->original->url;
		...
	}
?>

Unlimited Custom Calendars.
Imagine you could create any calendar you wanted on your website. Use recurring events with the Recurme field, or use your own Processwire pages and date fields to render calendars… it’s up to you. Fully customizable. Make as many calendars as you like. Get events from anywhere. Recurme does all the hard date work for you.

Unlimited Custom Admin Calendars too.

Hope you like it :) ,

 Joshua & Eduardo from 99Lime.

 

ss-recurme.png

Unknown.png

ss-admin1.png

ss-recurme5.png

ss-admin5.thumb.png.434d6cd178d8fab47f3efa4e3437f604.png

 

## [1.0.1] - 2017-05-29
### changed
- Fixed $options[weekStartDay] offset in Calendar
- Fixed ->renderCalendar() Blank Days
- Fixed missing ->renderList() [renderMonth][xAfter]
- Removed ->renderCalendar() <table> attributes border, border-spacing
- Fixed ->renderCalendar() excluded dates
- Fixed rrule-giu.js exclude dates
- Fixed ->renderList missing space in attr ID
(shout out to @Juergen for multiple suggestions & feedback).

  • Like 28

Share this post


Link to post
Share on other sites

Wow, this looks amazing! I've been wishing someone would make a full-featured PW calendar module for a while now and this looks like it fits the bill. So thanks! :)

A question: it looks like it's possible to disable an occurrence of an event, but is it possible to create a one-off variation of an occurrence? For example, if there is a weekly yoga class on a Tuesday but on one particular week it has to move to Wednesday, can I locate that occurrence and edit it individually? Similar to this, from Lightning calendar...

2017-05-20_125245.png.8ec96d1912393353f600b311fd99c5e1.png

 

P.S. the links on the 99lime.com home page to "Responsive Menu" and "ProcessWire Go" are non-functional.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Robin,

Thanks for your kind words. 

To answer your question, no there is no "edit this occurance" button... although we have gone back and forth on that one for a while. However, you can still get the desired effect by duplicating your event for just that special instance and removing the occurance from the original. You basically are just doing the job of the "edit this occurance" button manually. 

The next release of Recurme will include selecting multiple additional dates to add to a recurrence. That will also solve your needs nicely. :)

Hope that makes sense. 

Happy coding. 

  • Like 2

Share this post


Link to post
Share on other sites

great job!

i already did a calendar using https://fullcalendar.io/ but without recurring events (thats a lot more difficult do implement and i see you also had to set a hard max of 2800 so far...). i guess you can count me to your customers before end of may ;)

1) is the calendar custom css? can it easily be adopted to other styles/themes?

2) is there drag&drop support for events? i build this on fullcalendar+pw. but it's not a must have...

  • Like 1

Share this post


Link to post
Share on other sites

Hi bernhard, 

Super easy to style via CSS or override any CSS you want. All interactions are CSS animations or transitions as well. Or use custom HTML. Also, no need to use the built in calendar. You could easily use recurring events with fullcalendar using the event API. No drag and drop support on the recurme calendar. The calendar is more for displaying your events than managing them... although it has modal window event editing. 

We have a solution in the works for beating the 2800 limit we set. Hope to get that out in the next couple updates. 

Happy coding!

Share this post


Link to post
Share on other sites

Looks really amazing.

One question: Is there the possibility to limit an event to a certain endtime or to a certain date? Fe event starts at 6am and ends at 9am or an event goes over midnight (multiple days event)

From the images above it seems that it will always be a whole day event.

Best regards and respect for this work.

  • Like 1

Share this post


Link to post
Share on other sites

@Juergen Currently, you can set the event start date and hour, but there is no end time field for a specific event. You can add an end_time field to your event (or whatever it's called) template if you wanted to output that it starts at 6pm and ends at 9pm, for example. 

 There are no facilities for spanning multiple days with a single event. In most cases such as a 3 day event, we just repeat the event for those 3 days in a row so that it displays on the calendar for the 3 consecutive days. Then In our event template we create a description field to describe the exact details of the event.

You can add any fields you want to your template. 

With a little custom CSS for your event, you could make it very clear that it's a unified event that spans more than one day  

I am very interested in coming up with a way to include spanning multiple days with the recurme interface in an easy to use format, but for now, repeating the event has covered our use cases pretty well. Maybe that would work for you. 

Share this post


Link to post
Share on other sites

Only just a thought:

It would make more sense to offer only the possibillity to enter just a start date without a time. If there is a start time, there should also be an endtime. So if you remove the time setting from the inputfield for the date it means there is an event on that date which is all day long.

If there is a need to restrict an event via a start and end time we can add 2 PW time fields to the template. This is the case if there is fe a course the starts and ends at a certain time. This looks better than using the time field from the module field for the starting time and another time field from another PW field type for the endtime (2 different fieldtypes with different looks).

Another case would be that a store is fe closed on that day (inventory or something else). The shop is closed the whole day. So there is no need to enter a start time - it is an all day event. We dont need a start time in this case.

Conclusion: I think a date only field without the possibility to add the time would be a better fitting solution in this case. If you want you can add 2 time fields to the template or not (depending on your needs). No mixin of 2 different fields necessary.

Best regards

 

 

  • Like 1

Share this post


Link to post
Share on other sites

Is modifying the recurring tabular list below the RRule definition currently the only way to exclude dates in the exclusion? We pay for a (rather poorly implemented) calendar that has a GUI mini-calendar selection to create a list of dates to exclude. Love this calendar, but I'd be fearful of removing/changing something that our staff (not highly computer literate) is used to - so just curious.

Thanks for providing this! RRule is a confusing thing to implement in a database!

  • Like 1

Share this post


Link to post
Share on other sites

Yes, currently it is the only way. I dislike how it is currently refreshing the whole recurme field when a date is excluded. Something that I have on my list to improve. Even so, we have had really good success with our users (clients) excluding dates this way.

Have you tried the live example of the Recurme field on the website? 
http://www.99lime.com/modules/recurme/iframe-demo/

Now, you have given me a new idea for handling exclusions that I think could be more elegant. Thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Hi @joshuag, I'm noticing strange behaviour when I create a recurring event.

For some reason the initial event occurs on the start date, but then another event is added the following day and all the recurrences are based on that second event. See the screenshots below where the intial event is set for a Tuesday and to recur every 7 days but the events recur on a Wednesday.

2017-05-28_163749.thumb.png.5ed2b8b59b183f9d18ededcf724c7bdd.png

2017-05-28_163849.thumb.png.24358704483663c55c18cbadc0151080.png

Share this post


Link to post
Share on other sites

Sorry, but I cannot confirm this behavior. Do you have set $config->timezone correctly in your config.php? In my case the dates will be calculated correctly.

Share this post


Link to post
Share on other sites

Here is a little Hook that I use to add the last date of recurring events to the end of publication field.

Please copy this piece of code into your ready.php file.

//dates = name of your recurring field - please change it to your field name
//publish_until = name of your end of publication field - please change it to your field name


// hook to add the publish_until date according to the last event date
$pages->addHookAfter('saveReady', function($event)
{
    $page = $event->arguments[0];
    if ($page->hasField('dates')) {
      $dates = $page->getDates(); 
      if($dates){    
      foreach($dates as $key=>$date){
         if ($key === key($dates))
        $enddateunformatted = $date;
      }
      $page->publish_until = $enddateunformatted;
      $enddateformatted = date('d-m-Y', $date);
      $this->message($this->_("The end date of the publication was set to {$enddateformatted}."));
      }
    }
});

In my case I use the the SchedulePagesModule to unpublish pages after a certain date. In this case the date field for unpublishing pages is called "publish_until". My recurme field in this case is called "dates". You have to add both fields to your template.

Now I want to copy the last date of the recurring events to the "publish_until" field, so that the article will be unpublished after the last recurrence.

For this purpose you have to add the code above to your ready.php file. If you have named the fields differently than "publish_until" and "dates" you have to replace this by your names.

In a first step I check if the template has the recurme field "dates". If yes then I check if there are events generated. The last step is to grab the last occurence and add this date to the end of the publication field ("publish_until") - finished!

After pressing the save button the last ocurrence date will be saved in the publish_until field and the article will be unpublished after this date.

Best regards

  • Like 6

Share this post


Link to post
Share on other sites

@Robin S  setting your $config->timezone should resolve this problem as mentioned. If not, let me know and I can take a look at your specific setup with you, just send me a pm. 

@Juergen that is a very cool trick! Thanks for sharing :)

Share this post


Link to post
Share on other sites
11 hours ago, joshuag said:

setting your $config->timezone should resolve this problem as mentioned

Yes, I have my timezone set correctly in config.

Not sure what caused that issue but after removing the Recurme field from the template, adding it back again and setting up the event again it is working normally now. So case closed for now, thanks. :)

Share this post


Link to post
Share on other sites

@Robin S thanks for letting us know. I will experiment And see if I can reproduce this behavior. 

Glad it's working correctly :)

  • Like 1

Share this post


Link to post
Share on other sites
On 5/24/2017 at 0:27 AM, Juergen said:

Only just a thought:

It would make more sense to offer only the possibillity to enter just a start date without a time. If there is a start time, there should also be an endtime. So if you remove the time setting from the inputfield for the date it means there is an event on that date which is all day long.

If there is a need to restrict an event via a start and end time we can add 2 PW time fields to the template. This is the case if there is fe a course the starts and ends at a certain time. This looks better than using the time field from the module field for the starting time and another time field from another PW field type for the endtime (2 different fieldtypes with different looks).

Another case would be that a store is fe closed on that day (inventory or something else). The shop is closed the whole day. So there is no need to enter a start time - it is an all day event. We dont need a start time in this case.

Conclusion: I think a date only field without the possibility to add the time would be a better fitting solution in this case. If you want you can add 2 time fields to the template or not (depending on your needs). No mixin of 2 different fields necessary.

Best regards

 

 

I agree with @Juergen on the start/end time input workflow with separate time input fields.

Would like to use this module for a room occupancy calendar. @joshuag Is it possible with your module to have multiple events for one day with start and end times that recur daily/weekly/monthly? E.g.
17.00 - 19.00 every Monday
19.00 - 21.00 twice a month on Mondays
etc.

  • Like 1

Share this post


Link to post
Share on other sites

hello @gebeer

it is possible to add as much dates as you want to one day (fe. 100 or more if you want). You only have to create one event (page) for each of your events and make them recurring to your needs. So from the module there are no restrictions. It also doesnt matter if the starting and ending time of several events are the same on the same day. On the calendar view only few events are displayed for this day (depending on the space in the calendar row - see next image on the 6th). All others will be overflown.

Screenshot_2.jpg.c1a707711ac4e46b408ed85e44f9e623.jpg

After hovering the calendar cell all events on that day will be displayed.

Screenshot_3.jpg.7bcbf8b105828b3088ed75ef56fbb298.jpg

If you are entering fe 100 events on that day (and I am sure you would probably not ;)) the list will be very long, but technically it would be possible.

There are a lot of recurrence possiblilities fe. the first and the last day of a month every second monday every month,.... take look at the documentation.

Jürgen

  • Like 4

Share this post


Link to post
Share on other sites

Hi @gebeer

like @Juergen said, you should have no problem doing what you need with Recurme. Perfect use case for this module :)

i am experimenting with an adjustment to the Recurme interface to account for all day events and time-end field. Hoping to release an update that addresses that need this week. 

  • Like 4

Share this post


Link to post
Share on other sites

@joshuag 

I wonder if there is a possibility to switch views in the frontend, say a weeks or days calendar instead of month and/or list?

Thanks

Share this post


Link to post
Share on other sites

You can realize this by creating own templates with the different views and call them via Ajax. There is no out of the box solution for this.

  • Like 1

Share this post


Link to post
Share on other sites

@totoff Great question. You could actually use Recurme with full calendar if you like. 

Example event object from full calendar: https://fullcalendar.io

$('#calendar').fullCalendar({
    events: [
        {
            title  : 'event1',
            start  : '2010-01-01'
        },
        {
            title  : 'event2',
            start  : '2010-01-05',
            end    : '2010-01-07'
        },
        {
            title  : 'event3',
            start  : '2010-01-09T12:30:00',
            allDay : false // will make the time show
        }
    ]
});

This would be easy to output with recurme using the API:

$FCEvents = array();
$events = $recurme->day();
foreach($events as $event){
	$FCEvents[] = array(
		'title' =>  $event->title,
		'start' => 	$event->start_date,
	);
}

Print your array as javascript. And use the built in views in full calendar. 

  • Like 3

Share this post


Link to post
Share on other sites

Works also with UiKit calendar and Bootstrap calendar if you are using a framwork. If you are using UiKit calendar you can make fe a template which outputs all the calendar dates in a json array. Then you can load this template (or lets say the event dates) via ajax into the UiKit calendar template engine. Its very easy.

  • Like 2

Share this post


Link to post
Share on other sites
14 hours ago, joshuag said:

Great question. You could actually use Recurme with full calendar if you like. 

actually, I set up a fullcalendar yesterday after my post here :-)

  • Like 1

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-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 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...