Jump to content
thuijzer

Fieldtype Business Hours

Recommended Posts

https://github.com/thuijzer/processwire-FieldtypeBusinessHours

Fieldtype Business Hours

ProcessWire Fieldtype for entering business hours (opening hours)

 

Input format

Leave a day empty when closed on that day

Times are in 24 hour format.

9:00-12:00
9:00-12:00, 13:00-17:30
16:00-2:00

 

Usage in templates

Days are from 1 to 7 where 1 is Monday and 7 is Sunday (ISO-8601)

echo $page->field_name->isNowOpen() ? 'Now open' : 'Now closed';
if($page->field_name[1] == null) { echo 'Closed on Monday'; }
if($page->field_name[2]->inRange('11:00')) { echo 'Tuesday at 11:00 open'; }
echo $page->field_name[1];
echo $page->field_name[1]->getEntries()->getFrom()->format('H:i');

 

  • Like 14
  • Thanks 2

Share this post


Link to post
Share on other sites

Thanks for the module! I will have to give it a try this week. In the past I have just use the Pro Fields: Textarea module to create "fields" for each day, which was quite convenient. However, this looks promising and quite straight forward. 

 

** Just in case, I added a screenshot of the layout using dummy times.

Screen Shot 2018-01-18 at 2.48.24 PM.png

  • Like 1

Share this post


Link to post
Share on other sites

hi thuijzer,

would you mind adding a screenshot to get an instant first impression of how it looks like?

  • Like 5

Share this post


Link to post
Share on other sites

@louisstephens Thank you for the screenshot! Note that a 24 hour input is used. So on Saturday you will be open from 3:00-6:00AM and 10:30-12:00AM.

Share this post


Link to post
Share on other sites

Hello thuijzer, I always get this error message after calling

echo $page->field_name[1]->entries[0]->getFrom()->format('H:i');

in template:

Cannot access private property ProcessWire\BusinessHoursDay::$entries

Best regards

Share this post


Link to post
Share on other sites
On 19-1-2018 at 8:57 PM, Juergen said:

Hello thuijzer, I always get this error message after calling


echo $page->field_name[1]->entries[0]->getFrom()->format('H:i');

in template:

Cannot access private property ProcessWire\BusinessHoursDay::$entries

Best regards

My bad. The documentation is wrong.

I like to use immutable objects so I created a getter function for the enries: getEntries()

The readme is now updated.

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Hello @thuijzer,

I dont know if others agree with me, but I would find it useful if an extra input field for public holidays will be added after Sunday. Fe in the gastronomy there is often the scenario that the business is open on public holidays. Here in Austria most of the time restaurants are closed on Monday, but if it falls on a public holiday they are open. So an extra field will take care of this. If the field will be left blank business is closed on a public holiday.

Best regards

  • Like 1

Share this post


Link to post
Share on other sites
17 minutes ago, Juergen said:

Hello @thuijzer,

I dont know if others agree with me, but I would find it useful if an extra input field for public holidays will be added after Sunday. Fe in the gastronomy there is often the scenario that the business is open on public holidays. Here in Austria most of the time restaurants are closed on Monday, but if it falls on a public holiday they are open. So an extra field will take care of this. If the field will be left blank business is closed on a public holiday.

Best regards

That sounds like a great idea. I will think about a way to enter dates that override opening hours.

  • Like 1

Share this post


Link to post
Share on other sites
5 hours ago, Juergen said:

Most of the time I use this library for business hours. You can take a look at it: https://github.com/spatie/opening-hours

This will take care of exceptions (like public holidays)

 

 

I've never seen that library. That is looking very good. Maybe I will just use this library and create a fieldtype that creates the right settings for this lib. Looks like the license makes this possible.

Edit: looks like it needs PHP 7. I think a lot of ProcessWire users are still on 5.6 or even lower, so maybe that's not an option.
But I can always take a look at the source ;)

Share this post


Link to post
Share on other sites
4 minutes ago, thuijzer said:

Looks like the license makes this possible.

Yeah. MIT license is pretty permissive.

Share this post


Link to post
Share on other sites

Here is another library that I use to get public holidays for each country, but dont make it too complicated.

https://github.com/azuyalabs/yasumi

Its only a possibility to get holidays of each country without entering them inside an textarea input.

The big problem of holidays is that they can change from year to year (fe. Eastern)

So my thought is to include only an additional input field for the opening times on a public holiday (like the other days of the week).

Everyone can include the libraries I have mentioned if there is a need (like I have done with your input field). The new inputfield can be used to output the opening times for holidays like the other days of the week. Include a hint that holiday times will be not included in your output functions  like this

On 18.1.2018 at 2:46 PM, thuijzer said:

echo $page->field_name->isNowOpen() ? 'Now open' : 'Now closed';

Keep it as simple as possible.:)

Here is a screenshot of how I did it. The values of the opening times come from your field. If it is open today or not, comes from the Spatie library, so it will be no problem for developers to include it .

In addition a hint will be shown, when the business is open the next time (comes also from Spatie library)

Screenshot(2).thumb.png.81f3b067d8801e1ce72b707ea2c6e83f.png

In my case I only use your input field for entering the business hours. Everything on the frontend side (output) comes from the Spatie library.

Share this post


Link to post
Share on other sites

Just to clearify:

I think the first aim of this inputfield should be a clean UI for entering business hours in an easy way (and in this case you made a great job).:)

The next step is to provide the API calls to get the opening times for each day (like you have also done).:) So every opening time of each day can be indivdually outputted, formatted, styled or used for further PHP operations.

Offering some nice additional API-calls for getting some additional information (whether it is open or not) is great, but can be achived with other libraries or PHP coding too and should only be an addon (not really necessary).;)

So an additional input field for opening times on natural holidays is enough. We can use the value to make further operations (fe to check if this day is a nat. holiday or not by using fe. the Yasumi library) -> thats up to us as site developers and should not be an issue you have to deal with. Not everyone needs this feature.

Best regards

 

  • Like 2

Share this post


Link to post
Share on other sites

On PW 3.0.92 on my production server with Maria DB 10.2.12 I get the following error when trying to save a page with the fieldtype, even though all the fields have been filled out.

 Error saving field "businessHours" - SQLSTATE[HY000]: General error: 1364 Field 'data' doesn't have a default value

On my WAMP setup with mySQL 5.7.14 it does work.

I managed to create a workaround by manually editing the table design in phpMyAdmin and setting a default value for the data field to 0.

 

Share this post


Link to post
Share on other sites
1 hour ago, Kiwi Chris said:

On PW 3.0.92 on my production server with Maria DB 10.2.12 I get the following error when trying to save a page with the fieldtype, even though all the fields have been filled out.

 Error saving field "businessHours" - SQLSTATE[HY000]: General error: 1364 Field 'data' doesn't have a default value

Just wondering. All Fieldtypes need to have a column 'data' in their database table. This is defined in their getDatabaseSchema(). If you look at this method in the parent field type class, wire/core/Fieldtype.php, it has this comment each Fieldtype should override this in particular (with respect to the data column). I notice that this module does not define data in its schema but I would have thought that shouldn't be a problem since it first calls  the parent's parent::getDatabaseSchema() (which has data defined) and builds on that.

Just thinking out loud.

Share this post


Link to post
Share on other sites

Hi,

I have PHP 5.4.45 and PW 3.0.106 and get this error:

Fehler: Class 'DateTimeImmutable' not found (Zeile 51 in /home/wwwapow/public_html/cms/site/modules/_FieldtypeBusinessHours/FieldtypeBusinessHours.module)

How can I solve this error?

Thanks for help!

Share this post


Link to post
Share on other sites
1 minute ago, netcarver said:

You need to upgrade your PHP installation - that class was only added in version 5.5.0 (ref: PHP page for the class)

Thanks for your quick reply!

Is there no way to rewrite the code for earlier PHP version?

Share this post


Link to post
Share on other sites

@guenter55

I've no idea, about rewriting to remove this, I'm not familiar with the code. However, if on a linux system (or mac) it's probably much easier to upgrade the installed version of PHP than it is to rewrite the code to remove its use of that class. You are also well behind the curve in terms of supported (and potentially more secure) versions of PHP

Edited to add: Or wait until @adrian finds a shim 🙂

@thuijzer sounds like you need to add a 'requires' =>'php>=5.5.0' line to your module config.

  • Like 1

Share this post


Link to post
Share on other sites
4 minutes ago, guenter55 said:

@adrian
Where should I implement this class? I tried it in FieldtypeBusinessHours.module without effect. 

I would think that including it in the __construct() method would work. Make sure the path is correct and it is actually being included.

Note that I haven't ever used this.

Share this post


Link to post
Share on other sites
12 minutes ago, adrian said:

I would think that including it in the __construct() method would work. Make sure the path is correct and it is actually being included.

Thanks for the help @adrian but that seems to exceed my php knowledge. I see the __construct() functions in the modul-files, but I don´t know what exactly to do.

Share this post


Link to post
Share on other sites

I would try this line:

include_once(__DIR__ . '/DateTimeImmutable_php5.4.php');

before:

include_once(__DIR__ . '/BusinessHours.php');

making sure that you have saved the contents of that new class into the BusinessHours module folder.

Share this post


Link to post
Share on other sites
7 minutes ago, adrian said:

I would try this line:


include_once(__DIR__ . '/DateTimeImmutable_php5.4.php');

You are Great adrian!!
No more error in admin, I´ll try it in template tomorrow - it´s time to catch some hours sleep 😴

Greetings from Austria!

  • 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 Robin S
      A community member raised a question and I thought a new sanitizer method for the purpose would be useful, hence...
      Sanitizer Transliterate
      Adds a transliterate method to $sanitizer that performs character replacements as defined in the module config. The default character replacements are based on the defaults from InputfieldPageName, but with uppercase characters included too.
      Usage
      Install the Sanitizer Transliterate module.
      Customise the character replacements in the module config as needed.
      Use the sanitizer on strings like so:
      $transliterated_string = $sanitizer->transliterate($string);
       
      https://github.com/Toutouwai/SanitizerTransliterate
      https://modules.processwire.com/modules/sanitizer-transliterate/
       
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version to 2.10, add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By thomasaull
      I created a little helper module to trigger a CI pipeline when your website has been changed. It's quite simple and works like this: As soon as you save a page the module sets a Boolean via a pages save after hook. Once a day via LazyCron the module checks if the Boolean is set and sends a POST Request to a configurable Webhook URL.
      Some ideas to extend this:
      make request type configurable (GET, POST) make the module trigger at a specified time (probably only possible with a server cronjob) trigger manually Anything else? If there's interest, I might put in some more functionality. Let me know what you're interested in. Until then, maybe it is useful for a couple of people 🙂
      Github Repo: https://github.com/thomasaull/CiTrigger
    • By Robin S
      I created this module a while ago and never got around to publicising it, but it has been outed in the latest PW Weekly so here goes the support thread...
      Unique Image Variations
      Ensures that all ImageSizer options and focus settings affect image variation filenames.

      Background
      When using methods that produce image variations such as Pageimage::size(), ProcessWire includes some of the ImageSizer settings (height, width, cropping location, etc) in the variation filename. This is useful so that if you change these settings in your size() call a new variation is generated and you see this variation on the front-end.
      However, ProcessWire does not include several of the other ImageSizer settings in the variation filename:
      upscaling cropping, when set to false or a blank string interlace sharpening quality hidpi quality focus (whether any saved focus area for an image should affect cropping) focus data (the top/left/zoom data for the focus area) This means that if you change any of these settings, either in $config->imageSizerOptions or in an $options array passed to a method like size(), and you already have variations at the requested size/crop, then ProcessWire will not create new variations and will continue to serve the old variations. In other words you won't see the effect of your changed ImageSizer options on the front-end until you delete the old variations.
      Features
      The Unique Image Variations module ensures that any changes to ImageSizer options and any changes to the focus area made in Page Edit are reflected in the variation filename, so new variations will always be generated and displayed on the front-end.
      Installation
      Install the Unique Image Variations module.
      In the module config, set the ImageSizer options that you want to include in image variation filenames.
      Warnings
      Installing the module (and keeping one or more of the options selected in the module config) will cause all existing image variations to be regenerated the next time they are requested. If you have an existing website with a large number of images you may not want the performance impact of that. The module is perhaps best suited to new sites where image variations have not yet been generated.
      Similarly, if you change the module config settings on an existing site then all image variations will be regenerated the next time they are requested.
      If you think you might want to change an ImageSizer option in the future (I'm thinking here primarily of options such as interlace that are typically set in $config->imageSizerOptions) and would not want that change to cause existing image variations to be regenerated then best to not include that option in the module config after you first install the module.
       
      https://github.com/Toutouwai/UniqueImageVariations
      https://modules.processwire.com/modules/unique-image-variations/
    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      ProcessWire-Module: http://modules.processwire.com/modules/page-access-releasetime/
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      Usage
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      Limitations
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
×
×
  • Create New...