timeSelect()
Description
Builds and returns a string containing three select form controls for hour, minute, and second based on the supplied objectName and property.
Function Syntax
timeSelect([ objectName, property, association, position, order, separator, minuteStep, includeBlank, label, labelPlacement, prepend, append, prependToLabel, appendToLabel, errorElement, errorClass, combine, twelveHour ])
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objectName |
any |
No | |
The variable name of the object to build the form control for. |
property |
string |
No | |
The name of the property to use in the form control. |
association |
string |
No | |
The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. |
position |
string |
No | |
The position used when referencing a hasMany relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out. |
order |
string |
No | hour,minute,second |
Use to change the order of or exclude time select tags. |
separator |
string |
No | : |
Use to change the character that is displayed between the time select tags. |
minuteStep |
numeric |
No | 1 |
Pass in 10 to only show minute 10, 20, 30, etc. |
includeBlank |
any |
No | false |
Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). |
label |
string |
No | false |
The label text to use in the form control. The label will be applied to all select tags, but you can pass in a list to cutomize each one individually. |
labelPlacement |
string |
No | around |
Whether to place the label before, after, or wrapped around the form control. |
prepend |
string |
No | |
String to prepend to the form control. Useful to wrap the form control with HTML tags. |
append |
string |
No | |
String to append to the form control. Useful to wrap the form control with HTML tags. |
prependToLabel |
string |
No | |
String to prepend to the form control's label. Useful to wrap the form control with HTML tags. |
appendToLabel |
string |
No | |
String to append to the form control's label. Useful to wrap the form control with HTML tags. |
errorElement |
string |
No | span |
HTML tag to wrap the form control with when the object contains errors. |
errorClass |
string |
No | fieldWithErrors |
The class name of the HTML tag that wraps the form control when there are errors. |
combine |
boolean |
No | |
Set to false to not combine the select parts into a single DateTime object. |
twelveHour |
boolean |
No | false |
whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs |
Examples
<!--- View code --->
<cfoutput>
#timeSelect(objectName="business", property="openUntil")#
</cfoutput>
<!--- Show fields for hour and minute --->
<cfoutput>
#timeSelect(objectName="business", property="openUntil", order="hour,minute")#
</cfoutput>
<!--- Only show 15-minute intervals --->
<cfoutput>
#timeSelect(objectName="appointment", property="dateTimeStart", minuteStep=15)#
</cfoutput>
