About DatetimeAdvanced

Replacement for FieldtypeDatetime with support for subfield selectors like year, month, hour or day of year

Category Field Types
Fieldtype modules that represent a data type used by fields.
Release StateStable
Should be safe for use in production environments. *
Authorbitpoet
Module Version1.0.1
Class NameFieldtypeDatetimeAdvanced
Compatibility3.0
Date AddedOctober 25, 2018
Last UpdatedNovember 2, 2018
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/FieldtypeDatetimeAdvanced/
How to install or uninstall modules

README

DatetimeAdvanced

Replacement for FieldtypeDatetime with support for subfield selectors like year, month, hour or day of year.

Allows searching for individual components of datetime fields instandard subfield syntax.

Status

Beta. Please provide feedback.

Possible subfields

  • day

  • month

  • year (4-digit)

  • hour (0..23)

  • minutes

  • seconds

  • day_of_week (0..6, 0 = Sunday)

  • day_of_year (0..365)

  • week_of_year (1..53)

  • date (date formatted as yyyy-mm-dd)

  • time (time formatted as HH:MM:SS)

Also installs

WireDT: wrapper class for datetime fields, necessary to supportsubfield syntax when filtering PageArrays. FieldtypeDatetimeAdvanced won't work without it.

Requirements

Requires timezone support to be enabled in MySQL.

Usage

  • Unzip the module files (downloadable here through the green button) into site/modules
  • Install FieldtypeDatetimeAdvanced
  • Create a field with type DatetimeAdvanced and add it to your template
  • Populate the field with values in some pages
  • Start searching/filtering

Examples

Simple selector by year:

$pagelist = $pages->find("mydatefield.year=2016");

Simple selector by month:

$maypages = $pagelist->filter("mydatefield.month=5");

Searching for a birthday:

$birthday = date('Y-m-d');
$tocelebrate = $pages->find("birthday.date=$birthday");
foreach($tocelebrate as $person) {
	echo "Happy birthday {$person->name}!";
}

All pages with a date in the next 7 days:

$start = date('z');
$end = $start + 7;
$sevendays = $pages->find("mydatefield.day_of_year>=$start, mydatefield.day_of_year<$end");

Directly accessing a date subfield:

$blogentry = $pages->get('blog-entry-1');
echo $blogentry->title . "(" . $blogentry->publishdate->year . ")";

strftime() and date() shorthand:

echo $blogentry->publishdate->strftime("%Y-%m-%d %H:%M:%S") . PHP_EOL;
echo $blogentry->publishdate->date("Y-m-d H:i:s") . PHP_EOL;

A little bit of prose

This module came to be due to the repeated need to filter pages by a date span, like pagesfrom a certain year or in the last seven days. All the calculating back and forth to get the correct timestamps felt a bit of an overhead when there are perfectly easy functions to get individual date components in both PHP and MySQL.

If you are dealing with high numbers of pages (I'm talking five digits up), doing the calculationin PHP and running queries with plain timestamps will still be the way to go performance-wise. Filling additional fields with just the information you filter on (like month and year) when you save a page might then also be a good approach.

Timezone support

A prerequisite for installing this module is timezone support in MySQL. In most installations,MySQL is installed without timezone data, thus not adjusting for possible timezone differences between the server and clients. So, if the configured timezone in the server OS and PHP differ, the return values of MySQL's date and time functions differ from what PHP expects, rendering searches for date or time components unreliable at best and likely plain wrong.

This is not a problem with regular Datetime fields in ProcessWire, since all its values arestored in timestamp format and all conversions are done by PHP, conforming to the timezone configured there.

To use advanced selectors, though, MySQL needs to be aware of the timezone PHP is using toreturn the correct components, since it stores timestamp values in UTC (GMT).

To enable timezone support, the necessary timezone data nees to be installed and MySQLneeds to be restarted. On Unix'ish systems, MySQL comes with a tool to generate the correct timezone data from data already present in the OS, while other systems may require you to download database files or an SQL script. See the MySQL documentation for details.

Note

These subfield selectors can unfortunately not be used for the builtin "created" and "modified" fields.

License

Licensed under Mozilla Public License v2.0. See file LICENSE for details.

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.