dafo v1.0.1

dafo

General Date Format

Description

To format date in PHP or MySQL style.

Table of Contents

• DISCLAIMER
• Get Started
• API
  • dafo/mysql
  • dafo/php
  • dafo.parse
  • dafo.toSeconds
  • Others
• Why dafo
• About
• References
• CHANGE LOG
• Homepage

DISCLAIMER

I understand that date and datetime is really important and sensitive. However, there are too many details to be dealt with in this package. So, there is NO guarantee that the outputs of dafo will conform to what described in this document.

If anything unexpected found, please create an issue to let me and others know.

Get Started

dafo offers different ways to format a date. And you may choose the style which you are familiar with.

MySQL Style

const DATE_FORMAT = require('dafo/mysql');

// Use customised format mask.
DATE_FORMAT(new Date, '%Y-%M-%d');
// e.g. RETURN 2018-1-1

// Use predefined format mask.
DATE_FORMAT(new Date, DATE_FORMAT.USA);

See MySQL Reference Manual Date and Time Functions, DATE_FORMAT for details, and GET_FORMAT for available predefined formats.

PHP Style

const date_format = require('dafo/php');

date_format(new Date, 'Y-n-j');
// e.g. RETURN 2018-1-1

See PHP Manual > Date/Time Functions for details.

API

dafo/mysql

const date_format = require('dafo/mysql');

• string date_format(Date date, string format)
• const string date_format.DATE.*
• const string date_format.DATETIME.*
• const string date_format.TIME.*

Special characters prefixed with % will be recognized and transformed into corresponding date text. Characters prefixed with % but unrecognizable will be preserved wite the leading % trimmed.

Follow the next table for frequently used format characters which supported by dafo/mysql:

ATTENTION: Most, but NOT ALL format characters used in MySQL function DATE_FORMAT() are supported by dafo/mysql.

dafo/php

const date_format = require('dafo/php');

• string date_format(Date date, string format)

As what date() in PHP does, dafo/php will recognize special single characters in format string and transform them into corresponding date text. Unlike dafo/mysql, there are no leading escapers before these special characters and those not recognized will be preserved.

Escape Character
If you want to keep the format character from being replaced, prefix it with an escape character anti-slash \, e.g.

date_format(new Date(2000, 0, 1), '\\Y Y');
// RETURN 'Y 2000'

// Because '\' is also the default escaper in JavaScript string, 
// you should input double anti-slash characters '\\' in string literal 
// to create a real '\' in the format.

Follow the next table for frequently used format characters which supported by dafo/php:

ATTENTION: Most, but NOT ALL format characters used in PHP function date() are supported by dafo/php.

dafo.parse

const dafo = require('dafo');

// Get a Date object.
let date = dafo.parse('2019.04.01', 'Y.m.d');

• Date dafo.parse(string date, string format)

Argument format describes what and how makes up date string. Acceptable placeholders include:
( Other characters are regarded as normal text. )

dafo.toSeconds

const dafo = require('dafo');
let secondCount = dafo.toSeconds('1d2h');

• Date dafo.toSeconds(string age)

Argument age is an expression used to describe age, generally that of HTTP cache.

Others

• number dafo.getDayOfYear(Date date)
  Get the day of the current year.
  Jan 1st is always 1, and Dec 31st may be 365 (not leap year) or 366 (leap year).

• number dafo.getMonthDays(Date date)
  Get days of the current month.

• number dafo.getWeekOfYear(Date date, number mode)
  Get the week number of year.
  Read section Week Mode for details about the mode argument.

• { Date first, Date last } dafo.getWeekRange({ number year, number week, number mode })
  Get the week range.
  Read section Week Mode for details about the mode argument.

• { year, week } dafo.getYearWeek(Date date, number mode)
  Get the week number of year, and the corresponding year.
  In some mode, the first few days in a year may be belonging to the last week of last year.
  Read section Week Mode for details about the mode argument.

• boolean dafo.isLeapYear(Date date)
  Return true if the year of date is leap. Otherwise return false.

• Date dafo.parse(string date, string format)

Week Mode

The definition of mode argument in functions dafo.getWeekOfYear() and dafo.getYearWeek() is borrowed from MySQL function WEEK(). The next table is cited from MySQL Manual and explains the difference between modes:

Why dafo

There have been lots of packages helping to format date or datetime. Generally, a format string is required to indicate what kind of date string you want, e.g. YY in moment means 2 digit year. The formats used in those packages are similiar, but more or less different from each other. It is really confusing! For those who are familiar with syntax used in date() in PHP or DATE_FORMAT() in MySQL, it is wasting time to learn another one.

I am tired of inventing something new but useless. What uou will not meet with in dafo is NOT a new general format, but something you have been familiar with.

About

References

• MySQL 5.7 Reference Manual > Date and Time Functions
• PHP Manual > Date/Time Functions
• Date and time format - ISO 8601 or WIKIPEDIA: ISO 8601