Recurme is no longer supported. Even though it still works as intended, I will no longer able to provide updates or support.
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. Go on – make some plans.
<?
// 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;
...
}
?>
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.
<?php
// set calendar options
$options = array(
'selector' => '',
'month' => date('m'),
'year' => date('Y'),
'weekStart' => 0, // 0 sunday, 1 monday
'showArrows' => true,
'mini' => false,
'dateField' => 'recurme',
'renderEvent' => array(...)
...
);
echo $recurme->renderCalendar($options);
?>
A quick way to output an organized list of dates and recurring events on your site.
<?php
// get some events
$events = $recurme->find('Aug 01 2017', 'Aug 12 2017');
// set list options
$options = array(
'selector' => '',
'monthFormat' => 'F',
'dateField' => 'recurme',
'renderEvent' => array(...),
'renderDay' => array(...),
'renderMonth' => array(...),
'cache' => true,
'cacheName' => '',
'noEvents' => 'No events to show.
'
);
echo $recurme->renderList($events, $options);
?>
Once you have a couple recurring events, you can use the API to output them into your templates.
<link>
tag for your CSS.href="<?=$recurme->css?>"
.<head>
tag.<script></script>
tag in your template.src="<?=$recurme->js?>"
.$recurme->renderCalendar();
$recurme->renderList();
Methods | ||
---|---|---|
Get a single recurring event.
Render a single event.
Force delete all Recurme Calendar & List cache. Cache is handled automatically, but sometimes you might want to just kill it.
Turn on debug output for all calendars and lists.
Returns the path to recurme-default-theme.css.
Returns the path to recurme.js. |
[Required] $page/Page | id (int) | PW selector (string) Returns a single $event/Page. DOES NOT return PageArray.
[Optional] Array
|
|
Methods | ||
---|---|---|
Use this method to find recurring events between any date range. Optionally filtered by a PW selector.
Get recurring events on specific day. Default: Today (php time())
Get recurring events in a specific week from Mon-Sun. Default: This week
Get recurring events in a specific month, starting from the 1st of the month to the the last day of the month. Default: This month |
[Optional] unix timestamp (int) | php date (string) ie. today, tomrorrow, +1 month, last month, Aug 1 2017, 12-13-2017
[Optional] unix timestamp (int) | php date (string) ie. today, tomrorrow, +1 month, last month, Aug 1 2017, 12-13-2017
[Optional] unix timestamp (int) | php date (string) ie. today, tomrorrow, +1 month, last month, Aug 1 2017, 12-13-2017
[Optional] Any Processwire Selector (string) ie. 'template=events, images.count>0' |
|
Methods | ||
---|---|---|
Render single month calendar with or without events. Events can be any PageArray, if they are not Recurme Events, simply provide a date field in the options:
|
[Optional] Array
|
|
Methods | ||
---|---|---|
Given a list of recurring events or PageArray; renders an HTML List of month -> day -> events. Events can be any PageArray, if they are not Recurme Events, simply provide a date field in the options:
|
[Optional] Array
|
|
Perfect for single designer/developer
with a single project/website.
Perfect for single designer/developer
with multiple projects.
Perfect for agencies with multiple designers/developers and multiple projects.
==================================== Recurme [version] License Summary ==================================== • License does not expire. • Can be distributed in [X] project(s) • Can be distributed and / or packaged as a code or binary product (sub-licensed) • Commercial use allowed • Can modify source-code but cannot distribute modifications (derivative works) • Parts of the software are provided under separate licenses, as follows: - moment.js - version : 2.18.1, authors : Tim Wood, Iskren Chernev, Moment.js contributors, license : MIT. - rrule.js - https://github.com/jkbrzt/rrule, Copyright 2010, Jakub Roztocil and Lars Schooling, Licensed under the BSD licence.https://github.com/jkbrzt/rrule/blob/master/LICENCE. Based on: python-dateutil Extensions to the standard Python datetime module.Copyright (c) 2003-2011 - Gustavo Niemeyer Copyright (c) 2012 - Tomi Pieviläinen ==================================== Recurme - Terms and conditions ==================================== -------------------------------------------- 1. Preamble: -------------------------------------------- This Agreement governs the relationship between Purchaser, a Business Entity, (hereinafter: Licensee) and 99lime, a private person whose principal place of business is Calle 8, #124, 9 y 11, Montecristo, Merida, Yucatan 97133 (hereinafter: Licensor). This Agreement sets the terms, rights, restrictions and obligations on using Recurme (hereinafter: The Software) created and owned by Licensor, as detailed herein -------------------------------------------- 2. License Grant: -------------------------------------------- Licensor hereby grants Licensee a Sub-licensable, Assignable, Perpetual, Commercial, Royalty free, Including the rights to create but not distribute derivative works, Non-exclusive license, all with accordance with the terms set forth and other legal restrictions set forth in 3rd party software used while running Software. 2.1. Limited: Licensee may use Software for the purpose of: 2.1.1. Running Software on Licensee’s Website[s] and Server[s]; 2.1.2. Allowing 3rd Parties to run Software on Licensee’s Website[s] and Server[s]; 2.1.3. Publishing Software’s output to Licensee and 3rd Parties; 2.1.4. Distribute verbatim copies of Software’s output (including compiled binaries); 2.1.5. Modify Software to suit Licensee’s needs and specifications. 2.2. This license is granted perpetually, as long as you do not materially breach it. 2.3. Binary Restricted: Licensee may sublicense Software as a part of a larger work containing more than Software, distributed solely in Object or Binary form under a personal, non-sub-licensable, limited license. Such redistribution shall be limited to [x] codebases. 2.4. Assignable: Licensee may assign his rights and duties under this license as long as the party who Licensee assigns the license accepts the license in full, and provides Licensor with a written confirmation of Assignment 2.5. Commercial, Royalty Free: Licensee may use Software for any purpose, including paid-services, without any royalties 2.6. Including the Right to Create Derivative Works: Licensee may create derivative works based on Software, including amending Software’s source code, modifying it, integrating it into a larger work or removing portions of Software, as long as no distribution of the derivative works is made -------------------------------------------- 3. Term & Termination: -------------------------------------------- The Term of this license shall be until terminated. Licensor may terminate this Agreement, including Licensee’s license in the case where Licensee : 3.1. became insolvent or otherwise entered into any liquidation process; or 3.2. exported The Software to any jurisdiction where licensor may not enforce his rights under this agreements in; or 3.3. Licensee was in breach of any of this license's terms and conditions and such breach was not cured, immediately upon notification; or 3.4. Licensee in breach of any of the terms of clause 2 to this license; or 3.5. Licensee otherwise entered into any arrangement which caused Licensor to be unable to enforce his rights under this License. -------------------------------------------- 4. Payment: -------------------------------------------- In consideration of the License granted under clause 2, Licensee shall pay Licensor a fee, via Credit-Card, PayPal or any other mean which Licensor may deem adequate. Failure to perform payment shall construe as material breach of this Agreement. -------------------------------------------- 5. Upgrades, Updates and Fixes: -------------------------------------------- Licensor may provide Licensee, from time to time, with Upgrades, Updates or Fixes, as detailed herein and according to his sole discretion. Licensee hereby warrants to keep The Software up-to-date and install all relevant updates and fixes, and may, at his sole discretion, purchase upgrades, according to the rates set by Licensor. Licensor shall provide any update or Fix free of charge; however, nothing in this Agreement shall require Licensor to provide Updates or Fixes. 5.1. Upgrades: for the purpose of this license, an Upgrade shall be a material amendment in The Software, which contains new features and or major performance improvements and shall be marked as a new version number. For example, should Licensee purchase The Software under version 1.X.X, an upgrade shall commence under number 2.0.0. 5.2. Updates: for the purpose of this license, an update shall be a minor amendment in The Software, which may contain new features or minor improvements and shall be marked as a new sub-version number. For example, should Licensee purchase The Software under version 1.1.X, an upgrade shall commence under number 1.2.0. 5.3. Fix: for the purpose of this license, a fix shall be a minor amendment in The Software, intended to remove bugs or alter minor features which impair the The Software's functionality. A fix shall be marked as a new sub-sub-version number. For example, should Licensee purchase Software under version 1.1.1, an upgrade shall commence under number 1.1.2. -------------------------------------------- 6. Support: -------------------------------------------- Software is provided under an AS-IS basis and without any support, updates or maintenance. Nothing in this Agreement shall require Licensor to provide Licensee with support or fixes to any bug, failure, mis-performance or other defect in The Software. 6.1. Bug Notification: Licensee may provide Licensor of details regarding any bug, defect or failure in The Software promptly and with no delay from such event; Licensee shall comply with Licensor's request for information regarding bugs, defects or failures and furnish him with information, screenshots and try to reproduce such bugs, defects or failures. 6.2. Feature Request: Licensee may request additional features in Software, provided, however, that (i) Licensee shall waive any claim or right in such feature should feature be developed by Licensor; (ii) Licensee shall be prohibited from developing the feature, or disclose such feature request, or feature, to any 3rd party directly competing with Licensor or any 3rd party which may be, following the development of such feature, in direct competition with Licensor; (iii) Licensee warrants that feature does not infringe any 3rd party patent, trademark, trade-secret or any other intellectual property right; and (iv) Licensee developed, envisioned or created the feature solely by himself. -------------------------------------------- 7. Liability: -------------------------------------------- To the extent permitted under Law, The Software is provided under an AS-IS basis. Licensor shall never, and without any limit, be liable for any damage, cost, expense or any other payment incurred by Licensee as a result of Software’s actions, failure, bugs and/or any other interaction between The Software and Licensee’s end-equipment, computers, other software or any 3rd party, end-equipment, computer or services. Moreover, Licensor shall never be liable for any defect in source code written by Licensee when relying on The Software or using The Software’s source code. -------------------------------------------- 8. Warranty: -------------------------------------------- 8.1. Intellectual Property: Licensor hereby warrants that The Software does not violate or infringe any 3rd party claims in regards to intellectual property, patents and/or trademarks and that to the best of its knowledge no legal action has been taken against it for any infringement or violation of any 3rd party intellectual property rights. 8.2. No-Warranty: The Software is provided without any warranty; Licensor hereby disclaims any warranty that The Software shall be error free, without defects or code which may cause damage to Licensee’s computers or to Licensee, and that Software shall be functional. Licensee shall be solely liable to any damage, defect or loss incurred as a result of operating software and undertake the risks contained in running The Software on License’s Server[s] and Website[s]. 8.3. Prior Inspection: Licensee hereby states that he inspected The Software thoroughly and found it satisfactory and adequate to his needs, that it does not interfere with his regular operation and that it does meet the standards and scope of his computer systems and architecture. Licensee found that The Software interacts with his development, website and server environment and that it does not infringe any of End User License Agreement of any software Licensee may use in performing his services. Licensee hereby waives any claims regarding The Software's incompatibility, performance, results and features, and warrants that he inspected the The Software. -------------------------------------------- 9. No Refunds: -------------------------------------------- Licensee warrants that he inspected The Software according to clause 7(c) and that it is adequate to his needs. Accordingly, as The Software is intangible goods, Licensee shall not be, ever, entitled to any refund, rebate, compensation or restitution for any reason whatsoever, even if The Software contains material flaws. -------------------------------------------- 10. Indemnification: -------------------------------------------- Licensee hereby warrants to hold Licensor harmless and indemnify Licensor for any lawsuit brought against it in regards to Licensee’s use of The Software in means that violate, breach or otherwise circumvent this license, Licensor's intellectual property rights or Licensor's title in The Software. Licensor shall promptly notify Licensee in case of such legal action and request Licensee’s consent prior to any settlement in relation to such lawsuit or claim. -------------------------------------------- 11. Governing Law, Jurisdiction: -------------------------------------------- Licensee hereby agrees not to initiate class-action lawsuits against Licensor in relation to this license and to compensate Licensor for any legal fees, cost or attorney fees should any claim brought by Licensee against Licensor be denied, in part or in full.
Recurme works with PW version 3+ (because it uses the Processwire namespace). If you are running an older version of Processwire either upgrade your Processwire install, or send us an error report and we can see if there is a simple solution.
Please make sure that you have set $config->timezone
in your /site/config.php file. If your computer's clock is
malfunctioning or set incorrectly – you might have problems with the default time inputs in recurme,
however you should still be able to set the correct times.
Please make sure that your site contains a hidden page home/recurme-ajax/
using the template "recurme-ajax"
and that you have a matching file in your site/templates/ folder. IF for some reason this file is missing, you can copy
the template file from the InputfieldRecur/templates/recurme-ajax.php.
When you choose "End: Never", it actually repeats up to a maximum of 2800 times. We did this to optimize space, storage, and speed. However this is a loooong time. We are currently working on a solution to automatically update recurring events after the final 2800th event... we think we can find an optimal solution before 7 years is up ;)
Example Recurring Time:
Short answer: Super fast! Recurme is optimized to be as fast as possible. An example calendar with 220 recurring events has a processing time of
between 1–1.5 seconds without cache and <1 second with automatic cache. You can view your calendar and list rendering
times by either turning on global $recurme->debug = true;
or by passing $options['debug'] = true;
to your calendar or list options.
Your license is valid forever and includes 1 year of free updates and version upgrades.
If you are not completely happy with Recurme, we will give your money back. No conditions. Period.
We answer all our email, usually within 24 hours max. Email Us. We do not offer phone support. You can also ask questions and find support in the Processwire forums (Recurme Thread).