CFLib.org – DateTimeFormat

DateTimeFormat(time [, dateFormat] [, timeFormat] [, joinStr])

Last updated November 26, 2001

author

Raymond Camden
Send Email

Version: 1 | Requires: ColdFusion 5 | Library: DateLib

Rated 1 time(s). Average Rating: 5.0

Description:
This function serves as a simple shorthand for calling both DateFormat and TimeFormat on one data object.

Return Values:
This function returns a string.

Example:

<CFOUTPUT>
Default: #DateTimeFormat(Now())#<BR>
Euro Date: #DateTimeFormat(Now(),"dd/mm/yy")#<BR>
With JoinStr = at: #DateTimeFormat(Now(),"mmmm d, yyyy","h:mm tt"," at ")#<BR>
With JoinStr = /: #DateTimeFormat(Now(),"mmmm d, yyyy","h:mm tt"," / ")#
</CFOUTPUT>

Parameters:

Name	Description	Required
time	A data object.	Yes
dateFormat	The string to use to format dates. Defaults to	No
timeFormat	The string to use to format time. Defaults to	No
joinStr	This string is placed between the date and time. Defaults to one space character.	No

Full UDF Source:

	
	<cfscript>
/**
 * Calls both DateFormat and TimeFormat on a data object.
 * 
 * @param time      A data object. 
 * @param dateFormat      The string to use to format dates. Defaults to  
 * @param timeFormat      The string to use to format time. Defaults to  
 * @param joinStr      This string is placed between the date and time. Defaults to one space character. 
 * @return This function returns a string. 
 * @author Raymond Camden (ray@camdenfamily.com) 
 * @version 1, November 26, 2001 
 */
function DateTimeFormat(time) {
    var str = "";
    var dateFormat = "mmmm d, yyyy";
    var timeFormat = "h:mm tt";
    var joinStr = " ";
    
    if(ArrayLen(Arguments) gte 2) dateFormat = Arguments[2];
    if(ArrayLen(Arguments) gte 3) timeFormat = Arguments[3];
    if(ArrayLen(Arguments) gte 4) joinStr = Arguments[4];

    return DateFormat(time, dateFormat) & joinStr & TimeFormat(time, timeFormat);
}
</cfscript>