Browse by Event Dates
This option allows you to provide the User with links to months when Events are happening - or let them Search between any two dates.
- You've installed the Events Module
- You've updated your System Files to at least version 2.4.4.0
This article will show:
- How to add a parameter to the main Events Module "include" Liquid Tag to enable advanced filtering by Event Start and Event End dates.
- How to include the Archive Navigation Feature
- An explanation of the three main sub-Layouts available in in the Default Layout: (1) Search Between Two Dates (2) Browse By Months (3) Browse by Months under Year Header.
- How to give User Feedback about Search Results
The "use_adv_search" parameter is needed to allow filtering from the URL to apply to your Event Items, this can be added to the include for Event List like so:
By default, the List View will show all Events that are enabled, released and not yet expired. If you just want to filter the List so it either shows Events that have already happened in the Past- or those Events which will happen in the Future, it may not be necessary to include the entire Archive Feature.
Firstly, you will need to provide the following Liquid to include your Archive layout:
- archive_layout-The layout parameter refers to the main layout folder followed by a path to the folder storing any archive layouts you are using. In the example, an /archive folder is used.
- archive_layout_type- The type parameter refers to the name of the Archive Layout file.
In the default/archive/ folder we have 3 different optional types of Archive Layout you can choose by entering their names in the type parameter. We will show the liquid tag for including each.
Include: Browse By Months
Include: Browse By Months Under Years Header
Include: Search Events Between Two Dates
The following examples will take you through the different options:
In this example, we use the events_archive_months object and loop over the array. For each iteration, a URL link is outputted which has three range parameters:
- `range_gte` = An epoch format date for midnight on the beginning of the first day of the selected month
- range_lt = The date above + 1 month. We don't use lte because the date is the first valid date in the next month- we want every date up until then.
- range_field =events - This parameter is important as it makes sure that the Event Start and Event End fields are used instead of Release Date for the filtering.
This Layout does not just organise the Months available under the relevant Year Headers, it also will skip any Years without an Event.
This example uses the same links as the previous one. However, it also organises the links into the years in which they belong by first looping over the years in the events_archive_years and then using the group_by liquid filter and another loop to output the month links grouped under the current iteration's year. Learn more about this Liquid at the pOS docs:
In the Default Layout, this Option also includes the Previous "Browse by Months Organised into Years" Option for convenience- though the code can be simply removed if you prefer. We have removed it in this article's example. It also adds a Form for directly manipulating the URL parameters to find the exact dates the User is interested in.
In this example a form is used to take user input. The Siteglide function automatically adds the dates to the URL parameters in the correct format. You can rewrite the error function to customise the way the form handles invalid dates entered.
A note about Date Entry Inputs on different Browsers Different Browsers may display the Date Input fields very differently. 3rd party Javascript Plugins are available for making sure these display with your desired Design.
This is a relatively complex feature, so some understanding of Liquid will be necessary to understand how to create a Custom Layout. The best way to start would be to copy one of the Default layouts and edit it to provide the changes you need.
Any Layouts included with the above Liquid will get access to the events_archive_years and events_archive_monthsarrays, which contain detailed data about the years and months respectively which contain valid Events. This can be used to generate dynamic buttons to the User so they can browse.
events_archive_years
events_archive_months
In order to filter the Events List by date, you need to refresh the Page URL with parameters in the Unix Epoch time format.
The following URL Parameters will cause Results in the List to Filter:
- range_gt - greater than
- range_gte - greater than or equal to
- range_lt - less than
- range_lte - less than or equal to
For the above to work, remember to set the use_adv_search: true parameter (see start of article)!
The pOS documentation website has some useful tips on how to use liquid to convert date formats and manipulate dates and times. See the following useful filters, and browse the docs for more:
- localize
- date
- add_to_time
In the examples, you may notice another URL parameter is used: range_type. The s_events_date_search Siteglide function for filtering Events by user-inputted dates adds the parameter range_type="between". This would allow the following liquid on the List Layout to identify that this search is between two dates:
Whereas, you could use another range_type to indicate that different feedback should be given to the User. e.g. the parameter month in this example changes the sentence structure from "Events between" to "Events in" to communicate the different kind of filtering that is now taking place.
Note- in both of these examples- the gte and gt dates are both outputted- this is because only one is expected to be available. The Layout is designed to accept either