Jump to content
joshuag

Recurme – Processwire Recurring Dates Field & Custom Calendar Module.

Recommended Posts

Me again 🙂

From what I can tell, the find() method only works with recurring dates, or single date events that had the repeat toggle on at some point such that the "dates" json property is populated even if repeat is no longer on.

Is there a way to find single date, non-repeating events? This is obviously a critical feature, but from what I can tell the find method's converted selector before being passed to $pages->find only looks for W months/years.

Thanks for any help to explain what I am missing here.

Share this post


Link to post
Share on other sites

Hey @joshuag - I really need to bump this find() only working on recurring dates issue. Can you please at least confirm that this is definitely the case because I need to start figuring out an alternative. I don't see how this module can be used without it. How can you generate a list of upcoming events when some are recurring and some are not if the find() method only finds the recurring ones.

Thanks.

  • Thanks 1

Share this post


Link to post
Share on other sites
4 hours ago, adrian said:

Hey @joshuag - I really need to bump this find() only working on recurring dates issue. Can you please at least confirm that this is definitely the case because I need to start figuring out an alternative. I don't see how this module can be used without it. How can you generate a list of upcoming events when some are recurring and some are not if the find() method only finds the recurring ones.

Thanks.

Hey Adrian, thanks for all the good feedback in the last few posts. I am working on some fixes. I have confirmed that non-recurring dates are not showing up in find() in my latest version. I will fix this tomorrow and post an update here. 

I appreciate your feedback. 

  • Like 1

Share this post


Link to post
Share on other sites
33 minutes ago, joshuag said:

I will fix this tomorrow and post an update here. 

Thank you very much!

Share this post


Link to post
Share on other sites

@joshuag - while you are working on things, could you please make sure it's possible to return all events sorted by start date such that recurring and non-recurring events are returned interspersed with each other. Could you also explain what would go in the $selector part of the $recurme->find() to make this work? I haven't tested this yet, but can you please also confirm that "start" works in the selector with $recurme->find() so we can return paginated / ajax loaded events.

Thanks again!

Share this post


Link to post
Share on other sites

hi,

I'm stucking with outputting some events.🤔


in my project i use one page to show all available events as an overview. the pagestructure is as follows:
- courses
   - course1
   - course2
   - course3

How can i get the course - dates/times while looping throw the course pages
My code:

$courses = $pages->find("template=event");
foreach($courses as $course)
{
  $outEventList .= "$course->title";
  $outEventList .= "$course->courseData"; // the recurme-field within the course - template
}


i also tried this within the foreach without results:
 

$optionsCourse = array(
	'selector'		=> 'id='.$course->id
);

$eventDate = $recurme->find($optionsCourse);


Any ideas how to access to the specific data for any course?

Many thanks!

Share this post


Link to post
Share on other sites
On 6/4/2018 at 10:50 PM, joshuag said:

Hey Adrian, thanks for all the good feedback in the last few posts. I am working on some fixes. I have confirmed that non-recurring dates are not showing up in find() in my latest version. I will fix this tomorrow and post an update here. 

I appreciate your feedback. 

Where these updates published somewhere?

Share this post


Link to post
Share on other sites
6 hours ago, cstevensjr said:

Where these updates published somewhere?

Yes, you can download the latest copy of Recurme from your original download link. I also send out an email to everyone that has purchased each update. Just in case you don't have it, I have PM'd you a copy of the latest version. Happy Coding.

  • Like 1

Share this post


Link to post
Share on other sites

Does anybody know how to format the end time of an event?

'timeFormat'  => '%H', does the job fine

'timeEndFormat'  => '%H', does nothing so timeEnd keeps the standard setting of 11:00pm where I want it to be 23u (Belgian/Dutch).

Share this post


Link to post
Share on other sites
On 7/21/2018 at 8:21 AM, BFD Calendar said:

Does anybody know how to format the end time of an event?

'timeFormat'  => '%H', does the job fine

'timeEndFormat'  => '%H', does nothing so timeEnd keeps the standard setting of 11:00pm where I want it to be 23u (Belgian/Dutch).

sending you an inbox

Share this post


Link to post
Share on other sites

Hi @joshuag

is it possible to have 2 or more Timeperiods within 1 recurme-field?

For example:
Course1 ( template: Event with one recurme-field) takes place on two Times
Thu 9:30 - 11am
Wed 05:00 - 6:30pm

How could i solve this?


Many Thanks!!

Share this post


Link to post
Share on other sites

Hi @joshuag we're having some problems. Background info, we have an "event_date" recurme field on the "event" template. Simple case studies, I have three event pages.

  • start_end - a one day event with a start and end time
  • all_day - a one day, all day, event
  • three_days - a recurring event that has a start/end time, repeated every day for three days in a row.

oddity #1 - "data"

when you land on their respective pages, <?= $page->event_date; ?> yields a json object (expected). the "dates" key in that object is populated with an array of three dates for the three_days event. however, with the other two pages where you'd maybe expect one date in the array, there's hundreds, stretching for about eight years. https://pastebin.com/1URSn6pF

oddity #2 - $event->start_date

as noted in the documentation, one is expected to get the event data using $event = $recurme->event($page); Now that we've acquired the recurme event object, I would expect access to the date of the event once the user is on the page of the event.

  • start_end <?= var_dump ($event->start_date); ?> == NULL
  • all_day  <?= var_dump ($event->start_date); ?> == NULL
  • three_days <?= var_dump ($event->start_date); ?> == int(1534968000)

The first two single day events being expected to return a result considering there is only one set. The null problem extends to other properties of $event, eg: *->orig_date, *->date, *->month, etc. with the expected strings only existing in the recurring event page.

working off this problem...

oddity#3 - $event->start_date for recurring events

Your $recurme->renderCalendar() or $recurme->renderList() methods render links for the event pages, and taks on a querystring which seems to indicate the start date of the events. However, like the above, the start_end and all_day pages, with querystrings still yield nothing when trying to extract the date conveniently from the $event object. 

Furthermore, with recurring event three_days is on the 22nd of august, 23rd, and 24th. Landing on the the page, with its respective querystring, yields the wrong date. for example:

  • foo.com/events/three_days/?date=1535140800

One would arrive at the above page from clicking through from the rendered list, or rendered calendar. However, now echoing the date for the event <?= var_dump ($event->start_date); ?> you would expect to see the integer/date strings for the august 24th date, but you actually get the original from aug 22.

This problem extends into all the respective strings. eg:

  • foo.com/events/three_days/ <?= $event->date ?> == "Aug 22, 2018 @ 1:00 pm"
  • foo.com/events/three_days/?date=1534968000 <?= $event->date ?> == "Aug 22, 2018 @ 1:00 pm"
  • foo.com/events/three_days/?date=1535054400 <?= $event->date ?> == "Aug 22, 2018 @ 1:00 pm"
  • foo.com/events/three_days/?date=1535140800 <?= $event->date ?> == "Aug 22, 2018 @ 1:00 pm"

The first two being expected/correct. The latter two I would expect to be Aug 23 and 24 respectively considering these links were generated through the calendar.

---

I'm not sure how to proceed exactly. Certainly I can jump through some hoops on my own end and grab the query string if it exists, or output arrays of dates if it doesn't, and parse json for single day events with no recurrences... but it seems like I am spending more time testing and debugging contingencies than having the field work in ways I expect it to.

Is there maybe something I can do to think about this in a different way, or perhaps some sort of new version (i'm using 1.0.3 and a new dev version of PW)?

Thank you!

 

 

 

Share this post


Link to post
Share on other sites
On 8/2/2018 at 11:54 AM, itsberni said:

Hi @joshuag

is it possible to have 2 or more Timeperiods within 1 recurme-field?

For example:
Course1 ( template: Event with one recurme-field) takes place on two Times
Thu 9:30 - 11am
Wed 05:00 - 6:30pm

How could i solve this?


Many Thanks!!

Any Ideas?

 

THX

Share this post


Link to post
Share on other sites

@joshuag, when I do...

$event = $recurme->event($page);

...where $page is a page with a Recurme field on it, I get the following notice:

Undefined property: stdClass::$timeEndUnix in ...\site\modules\FieldtypeRecurme\MarkupRecurme.module:851

MarkupRecurme.module version 103. Is this the latest version? I think maybe you don't always bump up the version number as you make fixes? As I've mentioned to you previously via PM, when I purchased Recurme I never received a link to download the latest version so I'm always wondering if I'm using an older version with bugs that have already been fixed.

Also, I think one area where the documentation needs more detail is how event data should be accessed when you are viewing an event page itself. For example, the calendar creates links to events like this:

/path/to/eventpage/?date=1534366800

The date variable is a timestamp for the relevant date, but how is that to be used? Does the Recurme module use this so we can get the equivalent date somehow from $event? Or are we meant to just get that timestamp from $input and convert it to a date, in which case how do we validate that the timestamp is in fact a valid date for that event?

Share this post


Link to post
Share on other sites

@joshuag, is there a Recurme method to find the next n events, regardless of date? For example, if I want a listing showing the next 5 events.

Another thing: the docs say that the $dateFrom and $dateTo arguments for the find() method are optional, but when I leave either of them out no events are returned. Edit: I worked this one out by looking at the module code. $dateFrom and $dateTo are set to today if not supplied (I was expecting no $dateFrom/$dateTo limits if not supplied).

$events = $recurme->find(); // empty PageArray
$events = $recurme->find('today'); // empty PageArray

 

Share this post


Link to post
Share on other sites

The $dateFrom and $dateTo arguments aren't working with some date strings that are valid for strtotime().

// Not working
$events = $recurme->find('01-08-2018', '31-08-2018');
// Also not working
$events = $recurme->find('08/01/2018', '08/31/2018');

These are being converted by Recurme to the timestamp for "January 1 1970".

  • Like 1

Share this post


Link to post
Share on other sites

@Robin S @chcs foo.com/events/three_days/?date=1534968000

The date get variable ie. ?date= that is part of the calendar or list href is the day that the link is on. Since an event page holds all the recurrences, you can use this date to show the current date in your event view when visited from a calendar. That is all it's for and is optional. It will always be the date the link is on. No need to 'verify' this date. it's going to be correct, otherwise it wouldn't have shown up on that day in the calendar or list. We use it all the time to highlight this day in the event view when you click a link. It is not used internally. 

@chcs use $event = $recurme->event($page)

@Robin S 

  • I will try to reproduce the error you are having with stdClass::$timeEndUnix. The last set of files I sent you were my dev version. 
  • Find will return the events of TODAY if there are no dates supplied. If there are no events TODAY then it will be empty.
  • I will PM you a New link to download updates. I suspect my emails to you go to your junk. 
  • As for date strings, take a look at 137 - 148 in MarkupRecurme.module. You will see that I am actually passing the dates straight to strtotime().

 

 

Share this post


Link to post
Share on other sites

@joshuag I did use that, I know the post was a bit verbose but it listed all the steps I took and all the problems I found using recurme in three different event/date scenarios

Quote

oddity #2 - $event->start_date

as noted in the documentation, one is expected to get the event data using $event = $recurme->event($page); Now that we've acquired the recurme event object, I would expect...

 

Quote

The date get variable ... It is not used internally

I see, but it leads to an issue when you get to an event page. Let's say ROCKBAND is in town and they are playing 4 nights in a row. On the "events" page you see the 4 dates, and click one of them. As a user you now expect to ge to the event page to get details for the date you clicked... the question becomes how do I output "ROCKBAND, Super Arena, October 3, 2018 8pm" as that is what the user clicked on from the calendar. If it was used internally I'd expect $recurme->event($page)->date to properly output the string, but it doesn't. There is thus no elegant way to access it from the object, requiring us to check for the get string and handle it ourselves, correct? Effectively it makes the ->date property inaccurate and makes me question why I would ever rely on it and why it exists in the first place.

Since the recurme object is generating the calendar, and making the link, and then hopefully getting the date data when I generate the output.. I would expect it to handle it rather than adding my own logic in.

 

 

Share this post


Link to post
Share on other sites
On 8/30/2018 at 1:18 AM, joshuag said:

Since an event page holds all the recurrences, you can use this date to show the current date in your event view when visited from a calendar. That is all it's for and is optional. It will always be the date the link is on. No need to 'verify' this date. it's going to be correct, otherwise it wouldn't have shown up on that day in the calendar or list.

Yes, but it can be set by anyone linking to your site, so I think it definitely needs to be verified. If you just display the event date from the GET variable without verifying it then any third party can create a link to your site that causes your event page to display any date of their choosing. I solved it like this:

$req_date = $input->get->int('date');
$event = $recurme->find($req_date, $req_date, "id=$page->id")->first();
if(!$event) {
    // $req_date is invalid for this event
    // ...
}

 

On 8/30/2018 at 1:18 AM, joshuag said:

I will try to reproduce the error you are having with stdClass::$timeEndUnix. The last set of files I sent you were my dev version. 

rrule-gui.js needs updating in this package to account for the timeEndUnix property.

 

On 8/30/2018 at 1:18 AM, joshuag said:

As for date strings, take a look at 137 - 148 in MarkupRecurme.module. You will see that I am actually passing the dates straight to strtotime().

Not quite. You are first passing the string through date()...

// ...
if(date('U',$date)){ $date = $date; }
// ...

...which does not handle those example date strings correctly.

  • Like 1

Share this post


Link to post
Share on other sites

@chcs You are right, you would have to "manually" use the date from the get variable. I did it this way because I didn't want to make any assumptions about how to use the event data. the event/page Recurme data contains ALL the dates for an event/page. SO, by passing the calendar day date in the url, you are able to highlight the correct day in your template however you want. 

The way we use this on most of our applications is that an event/page will actually list all it's event dates/days and highlight the one that you are currently looking at (by comparing it to the get variable). That is just one way to use it. 

I think you are right, that in some cases, mutating the event/page data internally depending on the date variable could be more convenient in some cases, but what if you don't want to do that? What if there is no date variable in the URL. Either way, you have to make some considerations of how your logic is for your event/page depending on how you are viewing it. The link with the date, is suppose to be an easy and convenient way to have some flexibility. 

Sometimes we have multiple lists and calendars pointing to the same event/page but for different dates. All those links go to the same event/page. 

The ->date property is the original event date. Useful for a number of cases in conjunction with the currently viewed date variable in the url. Maybe the right answer is to have a ->currentDate property or something along those lines for those that want to use it. Default to the original even date if there is no currentDate? or False, will have to think this through. 

Thanks for the great feedback. 

 

Share this post


Link to post
Share on other sites

@Robin S

Quote

 Yes, but it can be set by anyone linking to your site, so I think it definitely needs to be verified. If you just display the event date from the GET variable without verifying it then any third party can create a link to your site that causes your event page to display any date of their choosing. I solved it like this:

Oh that is a good point. I never thought of that. 

Quote

Not quite. You are first passing the string through date()...

 

On 9/2/2018 at 2:57 AM, Robin S said:

// ... if(date('U',$date)){ $date = $date; } // ...

ok, I am going to write a test for this line for your 2 examples. I need a better way to test for a unix timestamp. 

 

  • Like 1

Share this post


Link to post
Share on other sites

@joshuag, currently when an event has no start time or end time entered, Recurme populates "time" and "timeEnd" with "12:00 am". This makes it difficult to distinguish between events that have those fields empty (can often be the case for end time in particular) and events that happen to actually have 12:00 am entered as their start time or end time.

Do you think you could populate "time" and "timeEnd" with "false" or something else recognisable if start time or end time is left empty for an event? 

Share this post


Link to post
Share on other sites

@joshuag, how can I configure Recurme permissions so that users can see and use existing calendar(s) in admin, but not configure/delete/add new calendars? I figure what I've described is the most commonly needed scenario, where the developer creates and configures calendars but users can use them to see/edit/add events.

It seems that if I give the recurme-calendar permission to a role then the user gets too much freedom to create disaster, but if I don't give them the permission then they cannot see/use the calendar.

To clarify, in the first screenshot it is the cog icon I want to hide, not the calendar itself.

 2018-09-07_134800.png.f35cbc5e2e009c1de6b078babb1a4968.png2018-09-07_134950.png.651e8286a5535075702ca5935c9ccab5.png

 

Edit: I see now that you can't add new events from the admin calendar. Feature request: it would be cool if you could though, so that hovering a day showed an "Add new" link that started the process of adding a new event with the start date pre-filled.

Share this post


Link to post
Share on other sites
On 9/3/2018 at 8:18 AM, joshuag said:

I did it this way because I didn't want to make any assumptions about how to use the event data.

I definitely understand the line one has to draw when making assumptions for the user, but it seems that in some instances you do make those assumptions already -- which is why those properties of the object feel really inconsistent and confusing. I think that issue is driving some of the posts in this thread that ask about those properties and why they don't seem to output what we expect.  Depending on whether it's a one time event, an all day event, or a recurring event, they behave a bit differently or in unexpected ways.

It's almost that I would prefer you to make a consistent assumption, but provide the tools to make an alternative output for myself. Right now it seems that the implementation relies much more heavily on simply understanding what I need to do to get the simple output that I expected to get.

It's not an easy question to answer, but I hope you have an understanding of where I (and others?) see the confusion. The admin field, screens, and some of the tools you provide are very slick... but the object for custom output is harder to figure out, or simply not that useful depending on the nature of recurrence (or not).

Thanks!

 

  • Like 4

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.0)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM... one of those three or four letter acronyms anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework", since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no JavaScript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode. There are 4 different view modes.
      View mode "Day" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records. View mode "Month" shows the total of all visitors per day from the first to the last day of the selected month. View mode "Year" shows the total of all visitors per month from the first to the last month of the selected year. View mode "Total" shows the total of all visitors per year for all recorded years. Please note that multiple visits from the same IP address within the selected period are counted as a single visitor.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).
       
    • By MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
×
×
  • Create New...