Download the PHP package craftcms/store-hours without Composer
On this page you can find all versions of the php package craftcms/store-hours. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package store-hours
Store Hours for Craft CMS
This plugin adds a new “Store Hours” field type to Craft, for collecting the opening and closing hours (or any other time slots) of an organization for each day of the week.
Requirements
This plugin requires Craft CMS 5.0 or later.
Installation
You can install this plugin from the Plugin Store or with Composer.
From the Plugin Store
Go to the Plugin Store in your project’s Control Panel and search for “Store Hours”. Then press Install in its modal window.
With Composer
Open your terminal and run the following commands:
Customizing Time Slots
Store Hours fields have a setting called “Time Slots” that lets you customize the time columns that will be visible in the field inputs. By default there will be two time slots, “Opening Time” and “Closing Time”, but you can customize those however you like.
Each row you add here will end up adding a new column to the field inputs.
Templating
You can loop through your Store Hours fields to access info for each day of the week (starting with Sunday):
The exact time format that will be used when outputting times with the |time
filter depends on the current application locale. See the Craft documentation for details on how it can be customized.
Showing a Single Day’s Hours
You can get the hours for a single day using the following methods:
Method | Day |
---|---|
getSun() |
Sunday |
getMon() |
Monday |
getTue() |
Tuesday |
getWed() |
Wednesday |
getThu() |
Thursday |
getFri() |
Friday |
getSat() |
Saturday |
getYesterday() |
Yesterday |
getToday() |
Today |
getTomorrow() |
Tomorrow |
Showing a Custom Day Range
To only show certain days of the week (e.g only Monday through Friday), use the getRange()
field method. Pass two integers in to represent the start and end days of the range, using this mapping:
Number | Day |
---|---|
0 |
Sunday |
1 |
Monday |
2 |
Tuesday |
3 |
Wednesday |
4 |
Thursday |
5 |
Friday |
6 |
Saturday |
Showing Grouped Ranges
You can show consolidated list of hours, such as:
11am – 6pm Mon – Fri\ 11am – 5pm Sat – Sun
To do that, use the getGroupedRanges()
field method, which is similar to getRange()
, except the resulting days are grouped by their time slots.
Changing the Week Start Day
You can use the getRange()
field method to return the full list of days with a different week start day. For example, if you want Monday to be the first day of the week, do this:
As a shortcut, you can also skip passing the end day when you want to do this:
Determining Whether All Slots are Blank
You can quickly find out whether all the time slots in a day were left blank using the getIsBlank()
(isBlank
) field method: