Bower Package Manager

Installation via bower package manager is as simple as running:

$ bower install php-date-formatter

Node Package Manager

Installation via NPM is as simple as running:

$ npm install php-date-formatter

Composer Package Manager

You can install php-date-formatter via composer package manager. Either run:

$ php composer.phar require kartik-v/php-date-formatter "dev-master"

or add:

"kartik-v/php-date-formatter": "dev-master"

to your composer.json file

Manual Install

You can also manually install the plugin easily to your project. Just download the source ZIP or TAR ball and extract the plugin asset files and folders into your project.

dateSettings

array, This property allows you to configure the terms used for short/long days and months, the meridiem, and the ordinal suffix (for day of the month - works best with j). This is defaulted to:

{
    longDays: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
    shortDays: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'],
    shortMonths: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
    longMonths: ['January', 'February', 'March', 'April', 'May', 'June',
        'July', 'August', 'September', 'October', 'November', 'December'],
    meridiem: ['AM', 'PM'],
    ordinal: function (number) {
        var n = number % 10, suffixes = {1: 'st', 2: 'nd', 3: 'rd'};
        return Math.floor(number % 100 / 10) === 1 || !suffixes[n] ? 'th' : suffixes[n];
    }
}

You can override these settings for your language, as shown in the example below:

var fmt = new DateFormatter({
    dateSettings: {
        longMonths: ['janvier', 'février', 'mars', 'avril', 'mai', 'juin', 
            'juillet', 'août', 'septembre', 'octobre', 'novembre', 'décembre']
    }
});

separators

Regex, the separators that are possible in the date string. This defaults to /[ \-+\/\.T:@]/g.

validParts

Regex, the valid format patterns that are possible in the date string. This defaults to /[dDjlNSwzWFmMntLoYyaABgGhHisueTIOPZcrU]/g.

intParts

Regex, the integer format patterns for which the ordinal suffix will automatically be calculated. This defaults to /[djwNzmnyYhHgGis]/g.

tzParts

Regex, the timezone patterns to scan for in the date string. This defaults to /\b(?:[PMCEA][SDP]T|(?:Pacific|Mountain|Central|Eastern|Atlantic) (?:Standard|Daylight|Prevailing) Time|(?:GMT|UTC)(?:[-+]\d{4})?)\b/g.

tzClip

Regex, the separator patterns for clipping the timezone string. This defaults to /[^-+\dA-Z]/g.

parseDate

This method allows you to convert any date string or date object to a javascript Date object for a specific PHP date format. This method takes in the following properties:

• vDate: Input date. Must be string or a javascript Date object.

• vFormat: The PHP DateTime format, used for parsing the date.

Example:

var fmt = new DateFormatter();
var d1 = fmt.parseDate('23-Sep-2013 09:24:12', 'd-M-Y H:i:s');
// d1 will return Javascript date object for your timezone
alert(d1); // will return: Mon Sep 23 2013 09:24:12 GMT+0530 (India Standard Time)

guessDate

This method allows you to intelligently guess the date by closely matching the specific format. You can guess a date for any date string or date object to return a javascript Date object. This method takes in the following properties:

• vDate: Input date. Must be string or a javascript Date object.

• vFormat: The PHP DateTime format, used for parsing the date.

Example:

// note the passed string and the PHP date-time format differ
var fmt = new DateFormatter();
var d1 = fmt.guessDate('23-09-13 09:24:12', 'd-M-Y H:i:s'); 
// d1 will again return Javascript date object for your timezone
alert(d1); // will return: Mon Sep 23 2013 09:24:12 GMT+0530 (India Standard Time)

formatDate

This method allows you to return a formatted date string using a specific PHP datetime format. You can format a date for any date string or date object to return a javascript Date object. This method takes in the following properties:

• vDate: Input date. Must be string or a javascript Date object.

• vFormat: The PHP DateTime format, used for parsing the date.

var d1 = new Date();
var fmt = new DateFormatter();
var d2 = fmt.formatDate(d1, 'd-M-Y H:i:s');
alert(d2); // will return: 23-Sep-2013 09:24:12