wheels/view/formsdate.cfm wheels/view/formsdateobject.cfm wheels/view/formsdateplain.cfm wheels/view/formsobject.cfm wheels/view/formsplain.cfm @@ -1,5 +1,5 @@ <cfcomponent output="false"> - <cfinclude template="global/functions.cfm"> <cfinclude template="dispatch/functions.cfm"> + <cfinclude template="global/functions.cfm"> <cfinclude template="plugins/injection.cfm"> </cfcomponent> \ No newline at end of file wheels/Dispatch.cfc @@ -1,5 +1,5 @@ -<cfinclude template="global/functions.cfm"> <cfinclude template="controller/functions.cfm"> +<cfinclude template="global/functions.cfm"> <cfinclude template="view/functions.cfm"> <cfinclude template="plugins/injection.cfm"> <cfinclude template="../#application.wheels.viewPath#/helpers.cfm"> \ No newline at end of file wheels/controller.cfm @@ -1,17 +1,17 @@ <cfif StructKeyExists(server, "railo")> - <cfinclude template="initialization.cfm"> + <cfinclude template="caching.cfm"> <cfinclude template="filters.cfm"> <cfinclude template="flash.cfm"> - <cfinclude template="caching.cfm"> - <cfinclude template="rendering.cfm"> - <cfinclude template="redirection.cfm"> + <cfinclude template="initialization.cfm"> <cfinclude template="miscellaneous.cfm"> + <cfinclude template="redirection.cfm"> + <cfinclude template="rendering.cfm"> <cfelse> - <cfinclude template="wheels/controller/initialization.cfm"> + <cfinclude template="wheels/controller/caching.cfm"> <cfinclude template="wheels/controller/filters.cfm"> <cfinclude template="wheels/controller/flash.cfm"> - <cfinclude template="wheels/controller/caching.cfm"> - <cfinclude template="wheels/controller/rendering.cfm"> - <cfinclude template="wheels/controller/redirection.cfm"> + <cfinclude template="wheels/controller/initialization.cfm"> <cfinclude template="wheels/controller/miscellaneous.cfm"> + <cfinclude template="wheels/controller/redirection.cfm"> + <cfinclude template="wheels/controller/rendering.cfm"> </cfif> \ No newline at end of file wheels/controller/appfunctions.cfm @@ -1,7 +1,7 @@ -<cfinclude template="initialization.cfm"> +<cfinclude template="caching.cfm"> <cfinclude template="filters.cfm"> <cfinclude template="flash.cfm"> -<cfinclude template="caching.cfm"> -<cfinclude template="rendering.cfm"> +<cfinclude template="initialization.cfm"> +<cfinclude template="miscellaneous.cfm"> <cfinclude template="redirection.cfm"> -<cfinclude template="miscellaneous.cfm"> \ No newline at end of file +<cfinclude template="rendering.cfm"> \ No newline at end of file wheels/controller/functions.cfm @@ -1,3 +1,336 @@ +<cffunction name="$callAction" returntype="void" access="public" output="false"> + <cfargument name="controller" type="any" required="true"> + <cfargument name="controllerName" type="string" required="true"> + <cfargument name="actionName" type="string" required="true"> + <cfscript> + var loc = {}; + + if (Left(arguments.actionName, 1) == "$" || ListFindNoCase(application.wheels.protectedControllerMethods, arguments.actionName)) + $throw(type="Wheels.ActionNotAllowed", message="You are not allowed to execute the `#arguments.actionName#` method as an action.", extendedInfo="Make sure your action does not have the same name as any of the built-in Wheels functions."); + + if (StructKeyExists(arguments.controller, arguments.actionName)) + $invoke(componentReference=arguments.controller, method=arguments.actionName); + if (!StructKeyExists(request.wheels, "response")) + { + // a render function has not been called yet so call it here + try + { + arguments.controller.renderPage(); + } + catch(Any e) + { + if (FileExists(ExpandPath("#application.wheels.viewPath#/#LCase(arguments.controllerName)#/#LCase(arguments.actionName)#.cfm"))) + { + $throw(object=e); + } + else + { + if (application.wheels.showErrorInformation) + { + $throw(type="Wheels.ViewNotFound", message="Could not find the view page for the `#arguments.actionName#` action in the `#arguments.controllerName#` controller.", extendedInfo="Create a file named `#LCase(arguments.actionName)#.cfm` in the `views/#LCase(arguments.controllerName)#` directory (create the directory as well if it doesn't already exist)."); + } + else + { + $header(statusCode="404", statusText="Not Found"); + $includeAndOutput(template="#application.wheels.eventPath#/onmissingtemplate.cfm"); + $abort(); + } + } + } + } + </cfscript> +</cffunction> + +<cffunction name="$callActionAndAddToCache" returntype="string" access="public" output="false"> + <cfscript> + $callAction(controller=arguments.controller, controllerName=arguments.controllerName, actionName=arguments.actionName); + $addToCache(key=arguments.key, value=request.wheels.response, time=arguments.time, category=arguments.category); + </cfscript> + <cfreturn request.wheels.response> +</cffunction> + +<cffunction name="$createParams" returntype="struct" access="public" output="false"> + <cfargument name="route" type="string" required="true"> + <cfargument name="foundRoute" type="struct" required="true"> + <cfargument name="formScope" type="struct" required="false" default="#form#"> + <cfargument name="urlScope" type="struct" required="false" default="#url#"> + <cfscript> + var loc = {}; + + // add all normal URL variables to struct (i.e. ?x=1&y=2 etc) + loc.returnValue = arguments.urlScope; + + // go through the matching route pattern and add URL variables from the route to the struct + loc.iEnd = ListLen(arguments.foundRoute.pattern, "/"); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + { + loc.item = ListGetAt(arguments.foundRoute.pattern, loc.i, "/"); + if (Left(loc.item, 1) == "[") + loc.returnValue[ReplaceList(loc.item, "[,]", ",")] = ListGetAt(arguments.route, loc.i, "/"); + } + + // add controller and action unless they already exist + if (!StructKeyExists(loc.returnValue, "controller")) + loc.returnValue.controller = arguments.foundRoute.controller; + if (!StructKeyExists(loc.returnValue, "action")) + loc.returnValue.action = arguments.foundRoute.action; + + // convert controller to upperCamelCase and action to normal camelCase + loc.returnValue.controller = REReplace(loc.returnValue.controller, "-([a-z])", "\u\1", "all"); + loc.returnValue.action = REReplace(loc.returnValue.action, "-([a-z])", "\u\1", "all"); + + // add name of route to params if a named route is running + if (StructKeyExists(arguments.foundRoute, "name") && Len(arguments.foundRoute.name) && !StructKeyExists(loc.returnValue, "route")) + loc.returnValue.route = arguments.foundRoute.name; + + // decrypt all values except controller and action + if (application.wheels.obfuscateUrls) + { + for (loc.key in loc.returnValue) + { + if (loc.key != "controller" && loc.key != "action") + { + try + { + loc.returnValue[loc.key] = deobfuscateParam(loc.returnValue[loc.key]); + } + catch(Any e) {} + } + } + } + + if (StructCount(arguments.formScope)) + { + // loop through form variables, merge any date variables into one, fix checkbox submissions + loc.dates = {}; + for (loc.key in arguments.formScope) + { + if (FindNoCase("($checkbox)", loc.key)) + { + // if no other form parameter exists with this name it means that the checkbox was left blank and therefore we force the value to the unchecked values for the checkbox (to get around the problem that unchecked checkboxes don't post at all) + loc.formParamName = ReplaceNoCase(loc.key, "($checkbox)", ""); + if (!StructKeyExists(arguments.formScope, loc.formParamName)) + arguments.formScope[loc.formParamName] = arguments.formScope[loc.key]; + StructDelete(arguments.formScope, loc.key); + } + else if (REFindNoCase(".*\((\$year|\$month|\$day|\$hour|\$minute|\$second)\)$", loc.key)) + { + loc.temp = ListToArray(loc.key, "("); + loc.firstKey = loc.temp[1]; + loc.secondKey = SpanExcluding(loc.temp[2], ")"); + if (!StructKeyExists(loc.dates, loc.firstKey)) + loc.dates[loc.firstKey] = {}; + loc.dates[loc.firstKey][ReplaceNoCase(loc.secondKey, "$", "")] = arguments.formScope[loc.key]; + } + } + for (loc.key in loc.dates) + { + if (!StructKeyExists(loc.dates[loc.key], "year")) + loc.dates[loc.key].year = 1899; + if (!StructKeyExists(loc.dates[loc.key], "month")) + loc.dates[loc.key].month = 12; + if (!StructKeyExists(loc.dates[loc.key], "day")) + loc.dates[loc.key].day = 30; + if (!StructKeyExists(loc.dates[loc.key], "hour")) + loc.dates[loc.key].hour = 0; + if (!StructKeyExists(loc.dates[loc.key], "minute")) + loc.dates[loc.key].minute = 0; + if (!StructKeyExists(loc.dates[loc.key], "second")) + loc.dates[loc.key].second = 0; + try + { + arguments.formScope[loc.key] = CreateDateTime(loc.dates[loc.key].year, loc.dates[loc.key].month, loc.dates[loc.key].day, loc.dates[loc.key].hour, loc.dates[loc.key].minute, loc.dates[loc.key].second); + } + catch(Any e) + { + arguments.formScope[loc.key] = ""; + } + if (StructKeyExists(arguments.formScope, "#loc.key#($year)")) + StructDelete(arguments.formScope, "#loc.key#($year)"); + if (StructKeyExists(arguments.formScope, "#loc.key#($month)")) + StructDelete(arguments.formScope, "#loc.key#($month)"); + if (StructKeyExists(arguments.formScope, "#loc.key#($day)")) + StructDelete(arguments.formScope, "#loc.key#($day)"); + if (StructKeyExists(arguments.formScope, "#loc.key#($hour)")) + StructDelete(arguments.formScope, "#loc.key#($hour)"); + if (StructKeyExists(arguments.formScope, "#loc.key#($minute)")) + StructDelete(arguments.formScope, "#loc.key#($minute)"); + if (StructKeyExists(arguments.formScope, "#loc.key#($second)")) + StructDelete(arguments.formScope, "#loc.key#($second)"); + } + + // add form variables to the params struct + for (loc.key in arguments.formScope) + { + if (loc.key != "fieldnames") + { + if (Find("[", loc.key) && Right(loc.key, 1) == "]") + { + // object form field + loc.name = SpanExcluding(loc.key, "["); + loc.property = SpanExcluding(Reverse(SpanExcluding(Reverse(loc.key), "[")), "]"); + if (!StructKeyExists(loc.returnValue, loc.name)) + loc.returnValue[loc.name] = {}; + if (Find("][", loc.key)) + { + // a collection of objects was passed in + loc.primaryKeyValue = Replace(SpanExcluding(loc.key, "]"), loc.name & "[", "", "one"); + if (!StructKeyExists(loc.returnValue[loc.name], loc.primaryKeyValue)) + loc.returnValue[loc.name][loc.primaryKeyValue] = {}; + loc.returnValue[loc.name][loc.primaryKeyValue][loc.property] = arguments.formScope[loc.key]; + } + else + { + // just one object was passed in + loc.returnValue[loc.name][loc.property] = arguments.formScope[loc.key]; + } + } + else + { + // normal form field + loc.returnValue[loc.key] = arguments.formScope[loc.key]; + } + } + } + } + </cfscript> + <cfreturn loc.returnValue> +</cffunction> + +<cffunction name="$findMatchingRoute" returntype="struct" access="public" output="false"> + <cfargument name="route" type="string" required="true"> + <cfargument name="routes" type="array" required="false" default="#application.wheels.routes#"> + <cfscript> + var loc = {}; + loc.iEnd = ArrayLen(arguments.routes); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + { + loc.currentRoute = arguments.routes[loc.i].pattern; + if (arguments.route == "" && loc.currentRoute == "") + { + loc.returnValue = arguments.routes[loc.i]; + break; + } + else + { + if (ListLen(arguments.route, "/") >= ListLen(loc.currentRoute, "/") && loc.currentRoute != "") + { + loc.match = true; + loc.jEnd = ListLen(loc.currentRoute, "/"); + for (loc.j=1; loc.j <= loc.jEnd; loc.j++) + { + loc.item = ListGetAt(loc.currentRoute, loc.j, "/"); + loc.thisRoute = ReplaceList(loc.item, "[,]", ","); + loc.thisURL = ListGetAt(arguments.route, loc.j, "/"); + if (Left(loc.item, 1) != "[" && loc.thisRoute != loc.thisURL) + loc.match = false; + } + if (loc.match) + { + loc.returnValue = arguments.routes[loc.i]; + break; + } + } + } + } + if (!StructKeyExists(loc, "returnValue")) + $throw(type="Wheels.RouteNotFound", message="Wheels couldn't find a route that matched this request.", extendedInfo="Make sure there is a route setup in your `config/routes.cfm` file that matches the `#arguments.route#` request."); + </cfscript> + <cfreturn loc.returnValue> +</cffunction> + +<cffunction name="$getRouteFromRequest" returntype="string" access="public" output="false"> + <cfargument name="pathInfo" type="string" required="false" default="#request.cgi.path_info#"> + <cfargument name="scriptName" type="string" required="false" default="#request.cgi.script_name#"> + <cfscript> + var returnValue = ""; + if (arguments.pathInfo == arguments.scriptName || arguments.pathInfo == "/" || arguments.pathInfo == "") + returnValue = ""; + else + returnValue = Right(arguments.pathInfo, Len(arguments.pathInfo)-1); + </cfscript> + <cfreturn returnValue> +</cffunction> + +<cffunction name="$request" returntype="string" access="public" output="false"> + <cfscript> + var loc = {}; + if (application.wheels.showDebugInformation) + $debugPoint("setup"); + + // set route from incoming url, find a matching one and create the params struct + loc.route = $getRouteFromRequest(); + loc.foundRoute = $findMatchingRoute(route=loc.route); + loc.params = $createParams(route=loc.route, foundRoute=loc.foundRoute); + + // set params in the request scope as well so we can display it in the debug info outside of the controller context + request.wheels.params = loc.params; + + // create an empty flash unless it already exists + if (!StructKeyExists(session, "flash")) + session.flash = {}; + + // create the requested controller + loc.controller = $controller(loc.params.controller).$createControllerObject(loc.params); + + if (application.wheels.showDebugInformation) + $debugPoint("setup,beforeFilters"); + + // run verifications and before filters if they exist on the controller + $runVerifications(controller=loc.controller, actionName=loc.params.action, params=loc.params); + $runFilters(controller=loc.controller, type="before", actionName=loc.params.action); + + if (application.wheels.showDebugInformation) + $debugPoint("beforeFilters,action"); + + // call action on controller if it exists + loc.actionIsCachable = false; + if (application.wheels.cacheActions && StructIsEmpty(session.flash) && StructIsEmpty(form)) + { + loc.cachableActions = loc.controller.$getCachableActions(); + loc.iEnd = ArrayLen(loc.cachableActions); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + { + if (loc.cachableActions[loc.i].action == loc.params.action) + { + loc.actionIsCachable = true; + loc.timeToCache = loc.cachableActions[loc.i].time; + } + } + } + if (loc.actionIsCachable) + { + loc.category = "action"; + loc.key = "#request.cgi.script_name##request.cgi.path_info##request.cgi.query_string#"; + loc.lockName = loc.category & loc.key; + loc.conditionArgs = {}; + loc.conditionArgs.key = loc.key; + loc.conditionArgs.category = loc.category; + loc.executeArgs = {}; + loc.executeArgs.controller = loc.controller; + loc.executeArgs.controllerName = loc.params.controller; + loc.executeArgs.actionName = loc.params.action; + loc.executeArgs.key = loc.key; + loc.executeArgs.time = loc.timeToCache; + loc.executeArgs.category = loc.category; + request.wheels.response = $doubleCheckedLock(name=loc.lockName, condition="$getFromCache", execute="$callActionAndAddToCache", conditionArgs=loc.conditionArgs, executeArgs=loc.executeArgs); + } + else + { + $callAction(controller=loc.controller, controllerName=loc.params.controller, actionName=loc.params.action); + } + if (application.wheels.showDebugInformation) + $debugPoint("action,afterFilters"); + $runFilters(controller=loc.controller, type="after", actionName=loc.params.action); + if (application.wheels.showDebugInformation) + $debugPoint("afterFilters"); + + // clear the flash (note that this is not done for redirectTo since the processing does not get here) + StructClear(session.flash); + </cfscript> + <cfreturn Trim(request.wheels.response)> +</cffunction> + <cffunction name="$returnDispatcher" returntype="any" access="public" output="false"> <cfreturn this> </cffunction> @@ -75,337 +408,4 @@ } } </cfscript> -</cffunction> - -<cffunction name="$getRouteFromRequest" returntype="string" access="public" output="false"> - <cfargument name="pathInfo" type="string" required="false" default="#request.cgi.path_info#"> - <cfargument name="scriptName" type="string" required="false" default="#request.cgi.script_name#"> - <cfscript> - var returnValue = ""; - if (arguments.pathInfo == arguments.scriptName || arguments.pathInfo == "/" || arguments.pathInfo == "") - returnValue = ""; - else - returnValue = Right(arguments.pathInfo, Len(arguments.pathInfo)-1); - </cfscript> - <cfreturn returnValue> -</cffunction> - -<cffunction name="$findMatchingRoute" returntype="struct" access="public" output="false"> - <cfargument name="route" type="string" required="true"> - <cfargument name="routes" type="array" required="false" default="#application.wheels.routes#"> - <cfscript> - var loc = {}; - loc.iEnd = ArrayLen(arguments.routes); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.currentRoute = arguments.routes[loc.i].pattern; - if (arguments.route == "" && loc.currentRoute == "") - { - loc.returnValue = arguments.routes[loc.i]; - break; - } - else - { - if (ListLen(arguments.route, "/") >= ListLen(loc.currentRoute, "/") && loc.currentRoute != "") - { - loc.match = true; - loc.jEnd = ListLen(loc.currentRoute, "/"); - for (loc.j=1; loc.j <= loc.jEnd; loc.j++) - { - loc.item = ListGetAt(loc.currentRoute, loc.j, "/"); - loc.thisRoute = ReplaceList(loc.item, "[,]", ","); - loc.thisURL = ListGetAt(arguments.route, loc.j, "/"); - if (Left(loc.item, 1) != "[" && loc.thisRoute != loc.thisURL) - loc.match = false; - } - if (loc.match) - { - loc.returnValue = arguments.routes[loc.i]; - break; - } - } - } - } - if (!StructKeyExists(loc, "returnValue")) - $throw(type="Wheels.RouteNotFound", message="Wheels couldn't find a route that matched this request.", extendedInfo="Make sure there is a route setup in your `config/routes.cfm` file that matches the `#arguments.route#` request."); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="$createParams" returntype="struct" access="public" output="false"> - <cfargument name="route" type="string" required="true"> - <cfargument name="foundRoute" type="struct" required="true"> - <cfargument name="formScope" type="struct" required="false" default="#form#"> - <cfargument name="urlScope" type="struct" required="false" default="#url#"> - <cfscript> - var loc = {}; - - // add all normal URL variables to struct (i.e. ?x=1&y=2 etc) - loc.returnValue = arguments.urlScope; - - // go through the matching route pattern and add URL variables from the route to the struct - loc.iEnd = ListLen(arguments.foundRoute.pattern, "/"); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.item = ListGetAt(arguments.foundRoute.pattern, loc.i, "/"); - if (Left(loc.item, 1) == "[") - loc.returnValue[ReplaceList(loc.item, "[,]", ",")] = ListGetAt(arguments.route, loc.i, "/"); - } - - // add controller and action unless they already exist - if (!StructKeyExists(loc.returnValue, "controller")) - loc.returnValue.controller = arguments.foundRoute.controller; - if (!StructKeyExists(loc.returnValue, "action")) - loc.returnValue.action = arguments.foundRoute.action; - - // convert controller to upperCamelCase and action to normal camelCase - loc.returnValue.controller = REReplace(loc.returnValue.controller, "-([a-z])", "\u\1", "all"); - loc.returnValue.action = REReplace(loc.returnValue.action, "-([a-z])", "\u\1", "all"); - - // add name of route to params if a named route is running - if (StructKeyExists(arguments.foundRoute, "name") && Len(arguments.foundRoute.name) && !StructKeyExists(loc.returnValue, "route")) - loc.returnValue.route = arguments.foundRoute.name; - - // decrypt all values except controller and action - if (application.wheels.obfuscateUrls) - { - for (loc.key in loc.returnValue) - { - if (loc.key != "controller" && loc.key != "action") - { - try - { - loc.returnValue[loc.key] = deobfuscateParam(loc.returnValue[loc.key]); - } - catch(Any e) {} - } - } - } - - if (StructCount(arguments.formScope)) - { - // loop through form variables, merge any date variables into one, fix checkbox submissions - loc.dates = {}; - for (loc.key in arguments.formScope) - { - if (FindNoCase("($checkbox)", loc.key)) - { - // if no other form parameter exists with this name it means that the checkbox was left blank and therefore we force the value to the unchecked values for the checkbox (to get around the problem that unchecked checkboxes don't post at all) - loc.formParamName = ReplaceNoCase(loc.key, "($checkbox)", ""); - if (!StructKeyExists(arguments.formScope, loc.formParamName)) - arguments.formScope[loc.formParamName] = arguments.formScope[loc.key]; - StructDelete(arguments.formScope, loc.key); - } - else if (REFindNoCase(".*\((\$year|\$month|\$day|\$hour|\$minute|\$second)\)$", loc.key)) - { - loc.temp = ListToArray(loc.key, "("); - loc.firstKey = loc.temp[1]; - loc.secondKey = SpanExcluding(loc.temp[2], ")"); - if (!StructKeyExists(loc.dates, loc.firstKey)) - loc.dates[loc.firstKey] = {}; - loc.dates[loc.firstKey][ReplaceNoCase(loc.secondKey, "$", "")] = arguments.formScope[loc.key]; - } - } - for (loc.key in loc.dates) - { - if (!StructKeyExists(loc.dates[loc.key], "year")) - loc.dates[loc.key].year = 1899; - if (!StructKeyExists(loc.dates[loc.key], "month")) - loc.dates[loc.key].month = 12; - if (!StructKeyExists(loc.dates[loc.key], "day")) - loc.dates[loc.key].day = 30; - if (!StructKeyExists(loc.dates[loc.key], "hour")) - loc.dates[loc.key].hour = 0; - if (!StructKeyExists(loc.dates[loc.key], "minute")) - loc.dates[loc.key].minute = 0; - if (!StructKeyExists(loc.dates[loc.key], "second")) - loc.dates[loc.key].second = 0; - try - { - arguments.formScope[loc.key] = CreateDateTime(loc.dates[loc.key].year, loc.dates[loc.key].month, loc.dates[loc.key].day, loc.dates[loc.key].hour, loc.dates[loc.key].minute, loc.dates[loc.key].second); - } - catch(Any e) - { - arguments.formScope[loc.key] = ""; - } - if (StructKeyExists(arguments.formScope, "#loc.key#($year)")) - StructDelete(arguments.formScope, "#loc.key#($year)"); - if (StructKeyExists(arguments.formScope, "#loc.key#($month)")) - StructDelete(arguments.formScope, "#loc.key#($month)"); - if (StructKeyExists(arguments.formScope, "#loc.key#($day)")) - StructDelete(arguments.formScope, "#loc.key#($day)"); - if (StructKeyExists(arguments.formScope, "#loc.key#($hour)")) - StructDelete(arguments.formScope, "#loc.key#($hour)"); - if (StructKeyExists(arguments.formScope, "#loc.key#($minute)")) - StructDelete(arguments.formScope, "#loc.key#($minute)"); - if (StructKeyExists(arguments.formScope, "#loc.key#($second)")) - StructDelete(arguments.formScope, "#loc.key#($second)"); - } - - // add form variables to the params struct - for (loc.key in arguments.formScope) - { - if (loc.key != "fieldnames") - { - if (Find("[", loc.key) && Right(loc.key, 1) == "]") - { - // object form field - loc.name = SpanExcluding(loc.key, "["); - loc.property = SpanExcluding(Reverse(SpanExcluding(Reverse(loc.key), "[")), "]"); - if (!StructKeyExists(loc.returnValue, loc.name)) - loc.returnValue[loc.name] = {}; - if (Find("][", loc.key)) - { - // a collection of objects was passed in - loc.primaryKeyValue = Replace(SpanExcluding(loc.key, "]"), loc.name & "[", "", "one"); - if (!StructKeyExists(loc.returnValue[loc.name], loc.primaryKeyValue)) - loc.returnValue[loc.name][loc.primaryKeyValue] = {}; - loc.returnValue[loc.name][loc.primaryKeyValue][loc.property] = arguments.formScope[loc.key]; - } - else - { - // just one object was passed in - loc.returnValue[loc.name][loc.property] = arguments.formScope[loc.key]; - } - } - else - { - // normal form field - loc.returnValue[loc.key] = arguments.formScope[loc.key]; - } - } - } - } - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="$request" returntype="string" access="public" output="false"> - <cfscript> - var loc = {}; - if (application.wheels.showDebugInformation) - $debugPoint("setup"); - - // set route from incoming url, find a matching one and create the params struct - loc.route = $getRouteFromRequest(); - loc.foundRoute = $findMatchingRoute(route=loc.route); - loc.params = $createParams(route=loc.route, foundRoute=loc.foundRoute); - - // set params in the request scope as well so we can display it in the debug info outside of the controller context - request.wheels.params = loc.params; - - // create an empty flash unless it already exists - if (!StructKeyExists(session, "flash")) - session.flash = {}; - - // create the requested controller - loc.controller = $controller(loc.params.controller).$createControllerObject(loc.params); - - if (application.wheels.showDebugInformation) - $debugPoint("setup,beforeFilters"); - - // run verifications and before filters if they exist on the controller - $runVerifications(controller=loc.controller, actionName=loc.params.action, params=loc.params); - $runFilters(controller=loc.controller, type="before", actionName=loc.params.action); - - if (application.wheels.showDebugInformation) - $debugPoint("beforeFilters,action"); - - // call action on controller if it exists - loc.actionIsCachable = false; - if (application.wheels.cacheActions && StructIsEmpty(session.flash) && StructIsEmpty(form)) - { - loc.cachableActions = loc.controller.$getCachableActions(); - loc.iEnd = ArrayLen(loc.cachableActions); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - if (loc.cachableActions[loc.i].action == loc.params.action) - { - loc.actionIsCachable = true; - loc.timeToCache = loc.cachableActions[loc.i].time; - } - } - } - if (loc.actionIsCachable) - { - loc.category = "action"; - loc.key = "#request.cgi.script_name##request.cgi.path_info##request.cgi.query_string#"; - loc.lockName = loc.category & loc.key; - loc.conditionArgs = {}; - loc.conditionArgs.key = loc.key; - loc.conditionArgs.category = loc.category; - loc.executeArgs = {}; - loc.executeArgs.controller = loc.controller; - loc.executeArgs.controllerName = loc.params.controller; - loc.executeArgs.actionName = loc.params.action; - loc.executeArgs.key = loc.key; - loc.executeArgs.time = loc.timeToCache; - loc.executeArgs.category = loc.category; - request.wheels.response = $doubleCheckedLock(name=loc.lockName, condition="$getFromCache", execute="$callActionAndAddToCache", conditionArgs=loc.conditionArgs, executeArgs=loc.executeArgs); - } - else - { - $callAction(controller=loc.controller, controllerName=loc.params.controller, actionName=loc.params.action); - } - if (application.wheels.showDebugInformation) - $debugPoint("action,afterFilters"); - $runFilters(controller=loc.controller, type="after", actionName=loc.params.action); - if (application.wheels.showDebugInformation) - $debugPoint("afterFilters"); - - // clear the flash (note that this is not done for redirectTo since the processing does not get here) - StructClear(session.flash); - </cfscript> - <cfreturn Trim(request.wheels.response)> -</cffunction> - -<cffunction name="$callActionAndAddToCache" returntype="string" access="public" output="false"> - <cfscript> - $callAction(controller=arguments.controller, controllerName=arguments.controllerName, actionName=arguments.actionName); - $addToCache(key=arguments.key, value=request.wheels.response, time=arguments.time, category=arguments.category); - </cfscript> - <cfreturn request.wheels.response> -</cffunction> - -<cffunction name="$callAction" returntype="void" access="public" output="false"> - <cfargument name="controller" type="any" required="true"> - <cfargument name="controllerName" type="string" required="true"> - <cfargument name="actionName" type="string" required="true"> - <cfscript> - var loc = {}; - - if (Left(arguments.actionName, 1) == "$" || ListFindNoCase(application.wheels.protectedControllerMethods, arguments.actionName)) - $throw(type="Wheels.ActionNotAllowed", message="You are not allowed to execute the `#arguments.actionName#` method as an action.", extendedInfo="Make sure your action does not have the same name as any of the built-in Wheels functions."); - - if (StructKeyExists(arguments.controller, arguments.actionName)) - $invoke(componentReference=arguments.controller, method=arguments.actionName); - if (!StructKeyExists(request.wheels, "response")) - { - // a render function has not been called yet so call it here - try - { - arguments.controller.renderPage(); - } - catch(Any e) - { - if (FileExists(ExpandPath("#application.wheels.viewPath#/#LCase(arguments.controllerName)#/#LCase(arguments.actionName)#.cfm"))) - { - $throw(object=e); - } - else - { - if (application.wheels.showErrorInformation) - { - $throw(type="Wheels.ViewNotFound", message="Could not find the view page for the `#arguments.actionName#` action in the `#arguments.controllerName#` controller.", extendedInfo="Create a file named `#LCase(arguments.actionName)#.cfm` in the `views/#LCase(arguments.controllerName)#` directory (create the directory as well if it doesn't already exist)."); - } - else - { - $header(statusCode="404", statusText="Not Found"); - $includeAndOutput(template="#application.wheels.eventPath#/onmissingtemplate.cfm"); - $abort(); - } - } - } - } - </cfscript> </cffunction> \ No newline at end of file wheels/dispatch/request.cfm @@ -3,27 +3,27 @@ <cfset this.mappings["/wheelsMapping"] = this.rootDir & "wheels"> <cfset this.sessionManagement = true> <cfif StructKeyExists(server, "railo")> - <cfinclude template="global/appfunctions.cfm"> <cfinclude template="controller/appfunctions.cfm"> + <cfinclude template="global/appfunctions.cfm"> + <cfinclude template="events/onapplicationend.cfm"> <cfinclude template="events/onapplicationstart.cfm"> + <cfinclude template="events/onerror.cfm"> + <cfinclude template="events/onmissingtemplate.cfm"> + <cfinclude template="events/onsessionend.cfm"> <cfinclude template="events/onsessionstart.cfm"> - <cfinclude template="events/onrequeststart.cfm"> <cfinclude template="events/onrequest.cfm"> <cfinclude template="events/onrequestend.cfm"> - <cfinclude template="events/onsessionend.cfm"> - <cfinclude template="events/onapplicationend.cfm"> - <cfinclude template="events/onmissingtemplate.cfm"> - <cfinclude template="events/onerror.cfm"> + <cfinclude template="events/onrequeststart.cfm"> <cfelse> - <cfinclude template="wheels/global/appfunctions.cfm"> <cfinclude template="wheels/controller/appfunctions.cfm"> + <cfinclude template="wheels/global/appfunctions.cfm"> + <cfinclude template="wheels/events/onapplicationend.cfm"> <cfinclude template="wheels/events/onapplicationstart.cfm"> + <cfinclude template="wheels/events/onerror.cfm"> + <cfinclude template="wheels/events/onmissingtemplate.cfm"> + <cfinclude template="wheels/events/onsessionend.cfm"> <cfinclude template="wheels/events/onsessionstart.cfm"> - <cfinclude template="wheels/events/onrequeststart.cfm"> <cfinclude template="wheels/events/onrequest.cfm"> <cfinclude template="wheels/events/onrequestend.cfm"> - <cfinclude template="wheels/events/onsessionend.cfm"> - <cfinclude template="wheels/events/onapplicationend.cfm"> - <cfinclude template="wheels/events/onmissingtemplate.cfm"> - <cfinclude template="wheels/events/onerror.cfm"> + <cfinclude template="wheels/events/onrequeststart.cfm"> </cfif> \ No newline at end of file wheels/functions.cfm @@ -1,11 +1,11 @@ <cfif StructKeyExists(server, "railo")> + <cfinclude template="cfml.cfm"> <cfinclude template="internal.cfm"> <cfinclude template="public.cfm"> - <cfinclude template="cfml.cfm"> <cfinclude template="../../events/functions.cfm"> <cfelse> + <cfinclude template="wheels/global/cfml.cfm"> <cfinclude template="wheels/global/internal.cfm"> <cfinclude template="wheels/global/public.cfm"> - <cfinclude template="wheels/global/cfml.cfm"> <cfinclude template="events/functions.cfm"> </cfif> \ No newline at end of file wheels/global/appfunctions.cfm @@ -1,4 +1,4 @@ +<cfinclude template="cfml.cfm"> <cfinclude template="internal.cfm"> <cfinclude template="public.cfm"> -<cfinclude template="cfml.cfm"> <cfinclude template="../../events/functions.cfm"> \ No newline at end of file wheels/global/functions.cfm @@ -1,13 +1,50 @@ -<cffunction name="set" returntype="void" access="public" output="false" - hint="Use to configure a global setting." +<!--- PUBLIC CONFIGURATION METHODS ---> + +<cffunction name="addRoute" returntype="void" access="public" output="false" hint="Adds a new route to your application." examples= ' - <cfset set(URLRewriting="Partial")> <!--- can be set to "On", "Off" or "Partial" ---> + <!--- Adds a route which will invoke the `profile` action on the `user` controller with `params.userName` set when the URL matches the `pattern` argument ---> + <cfset addRoute(name="userProfile", pattern="user/[username]", controller="user", action="profile")> + ' + categories="configuration" chapters="using-routes" functions=""> + <cfargument name="name" type="string" required="true" hint="Name for the route."> + <cfargument name="pattern" type="string" required="true" hint="The URL pattern for the route."> + <cfargument name="controller" type="string" required="false" default="" hint="Controller to call when route matches (unless the controller name exists in the pattern)."> + <cfargument name="action" type="string" required="false" default="" hint="Action to call when route matches (unless the action name exists in the pattern)."> + <cfscript> + var loc = {}; + + // throw errors when controller or action is not passed in as arguments and not included in the pattern + if (!Len(arguments.controller) && arguments.pattern Does Not Contain "[controller]") + $throw(type="Wheels.IncorrectArguments", message="The `controller` argument is not passed in or included in the pattern.", extendedInfo="Either pass in the `controller` argument to specifically tell Wheels which controller to call or include it in the pattern to tell Wheels to determine it dynamically on each request based on the incoming URL."); + if (!Len(arguments.action) && arguments.pattern Does Not Contain "[action]") + $throw(type="Wheels.IncorrectArguments", message="The `action` argument is not passed in or included in the pattern.", extendedInfo="Either pass in the `action` argument to specifically tell Wheels which action to call or include it in the pattern to tell Wheels to determine it dynamically on each request based on the incoming URL."); + + loc.thisRoute = Duplicate(arguments); + loc.thisRoute.variables = ""; + loc.iEnd = ListLen(arguments.pattern, "/"); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + { + loc.item = ListGetAt(arguments.pattern, loc.i, "/"); + if (loc.item Contains "[") + loc.thisRoute.variables = ListAppend(loc.thisRoute.variables, ReplaceList(loc.item, "[,]", ",")); + } + ArrayAppend(application.wheels.routes, loc.thisRoute); + </cfscript> +</cffunction> + +<cffunction name="set" returntype="void" access="public" output="false" hint="Use to configure a global setting or set a default for a function." + examples= + ' + <!--- URL rewriting setting (determined and set automatically by Wheels, override it by setting it to "On", "Off" or "Partial") ---> + <cfset set(URLRewriting="Partial")> + + <!--- Database settings (set automatically by Wheels to the same name as the folder the application resides, override it by setting `dataSourceName`) ---> <cfset set(dataSourceName="")> <cfset set(dataSourceUserName="")> <cfset set(dataSourcePassword ="")> - <!--- environment settings ---> + <!--- Caching settings ---> <cfset set(cacheDatabaseSchema = false)> <cfset set(cacheFileChecking = false)> <cfset set(cacheImages = false)> @@ -18,29 +55,29 @@ <cfset set(cachePages = false)> <cfset set(cachePartials = false)> <cfset set(cacheQueries = false)> + <cfset set(maximumItemsToCache = 5000)> + <cfset set(cacheCullPercentage = 10)> + <cfset set(cacheCullInterval = 5)> + <cfset set(defaultCacheTime = 60)> + + <!--- Error and debugging settings ---> <cfset set(showDebugInformation = true)> <cfset set(showErrorInformation = true)> <cfset set(sendEmailOnError = false)> <cfset set(errorEmailAddress = "")> - <cfset set(errorEmailServer = "")> <!--- only required if the mail server hasn''t been set in the ColdFusion Administrator ---> + <cfset set(errorEmailServer = "")> - <!--- miscellaneous settings ---> + <!--- Miscellaneous settings ---> <cfset set(tableNamePrefix = "")> <cfset set(obfuscateURLs = false)> <cfset set(reloadPassword = "")> + <cfset set(ipExceptions = "")> <cfset set(softDeleteProperty = "deletedAt")> <cfset set(timeStampOnCreateProperty = "createdAt")> <cfset set(timeStampOnUpdateProperty = "updatedAt")> - <cfset set(ipExceptions = "")> <cfset set(overwritePlugins = true)> - <!--- caching settings ---> - <cfset set(maximumItemsToCache = 5000)> - <cfset set(cacheCullPercentage = 10)> - <cfset set(cacheCullInterval = 5)> - <cfset set(defaultCacheTime = 60)> - - <!--- function settings ---> + <!--- Function defaults ---> <cfset set(functionName="average", distinct=false)> <cfset set(functionName="buttonTo", onlyPath=true, host="", protocol="", port=0, text="", confirm="", image="", disable="")> <cfset set(functionName="caches", time=60)> @@ -110,7 +147,7 @@ <cfset set(functionName="verifies", handler=false)> <cfset set(functionName="yearSelectTag", label="", wrapLabel=true, prepend="", append="", prependToLabel="", appendToLabel="", includeBlank=false, startYear=Year(Now())-5, endYear=Year(Now())+5)> ' - categories="configuration" chapters="configurationand-defaults" functions="get"> + categories="configuration" chapters="configuration-and-defaults" functions="get"> <cfscript> var loc = {}; if (ArrayLen(arguments) > 1) @@ -128,18 +165,63 @@ </cfscript> </cffunction> -<cffunction name="get" returntype="any" access="public" output="false" - hint="Returns the current setting for the supplied variable name." +<!--- PUBLIC GLOBAL METHODS ---> + +<!--- miscellaneous ---> + +<cffunction name="deobfuscateParam" returntype="string" access="public" output="false" hint="Deobfuscates a value." + examples= + ' + <!--- Get the original value from an obfuscated one ---> + <cfset originalValue = deobfuscateParam("b7ab9a50")> + ' + categories="global" chapters="obfuscating-urls" functions="obfuscateParam"> + <cfargument name="param" type="string" required="true" hint="Value to deobfuscate."> + <cfscript> + var loc = {}; + if (Val(arguments.param) != arguments.param) + { + try + { + loc.checksum = Left(arguments.param, 2); + loc.returnValue = Right(arguments.param, (Len(arguments.param)-2)); + loc.z = BitXor(InputBasen(loc.returnValue,16),461); + loc.returnValue = ""; + loc.iEnd = Len(loc.z)-1; + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + loc.returnValue = loc.returnValue & Left(Right(loc.z, loc.i),1); + loc.checksumtest = "0"; + loc.iEnd = Len(loc.returnValue); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + loc.checksumtest = (loc.checksumtest + Left(Right(loc.returnValue, loc.i),1)); + if (Left(ToString(FormatBaseN((loc.checksumtest+154),10)),2) != Left(InputBasen(loc.checksum, 16),2)) + loc.returnValue = arguments.param; + } + catch(Any e) + { + loc.returnValue = arguments.param; + } + } + else + { + loc.returnValue = arguments.param; + } + </cfscript> + <cfreturn loc.returnValue> +</cffunction> + +<cffunction name="get" returntype="any" access="public" output="false" hint="Returns the current setting for the supplied variable name." examples= ' - <!--- custom find method ---> - <cfquery name="yourQueryName" datasource="##get(''dataSourceName'')##"> - <!--- YOUR SQL CODE ---> - </cfquery> + <!--- Get the current setting for the `tableNamePrefix` variable ---> + <cfset setting = get("tableNamePrefix")> + + <!--- Get the default for the `message` argument on the `validatesConfirmationOf` method ---> + <cfset setting = get(functionName"validatesConfirmationOf", name="message")> ' - categories="configuration" chapters="configurationand-defaults" functions="set"> - <cfargument name="name" type="string" required="true" hint="Variable name to get setting for"> - <cfargument name="functionName" type="string" required="false" default="" hint="Function name to get setting for"> + categories="global" chapters="configuration-and-defaults" functions="set"> + <cfargument name="name" type="string" required="true" hint="Variable name to get setting for."> + <cfargument name="functionName" type="string" required="false" default="" hint="Function name to get setting for."> <cfscript> var loc = {}; if (Len(arguments.functionName)) @@ -150,25 +232,76 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="URLFor" returntype="string" access="public" output="false" - hint="Creates an internal URL based on supplied arguments." +<cffunction name="model" returntype="any" access="public" output="false" hint="Returns a reference to the requested model so that class level methods can be called on it." + examples= + ' + <!--- The `model("author")` part of the code below gets a reference to the class in the application scope and then `findByKey` is called on it ---> + <cfset authorObject = model("author").findByKey(1)> + ' + categories="global" chapters="object-relational-mapping" functions=""> + <cfargument name="name" type="string" required="true" hint="Name of the model (class name) to get a reference to."> + <cfreturn $doubleCheckedLock(name="modelLock", condition="$cachedModelClassExists", execute="$createModelClass", conditionArgs=arguments, executeArgs=arguments)> +</cffunction> + +<cffunction name="obfuscateParam" returntype="string" access="public" output="false" hint="Obfuscates a value, typically used for hiding primary key values when passed along in the URL." + examples= + ' + <!--- Obfuscate the primary key value `99` ---> + <cfset newValue = obfuscateParam(99)> + ' + categories="global" chapters="obfuscating-urls" functions="deobfuscateParam"> + <cfargument name="param" type="any" required="true" hint="Value to obfuscate."> + <cfscript> + var loc = {}; + if (IsValid("integer", arguments.param) && IsNumeric(arguments.param) && arguments.param > 0) + { + loc.iEnd = Len(arguments.param); + loc.a = (10^loc.iEnd) + Reverse(arguments.param); + loc.b = "0"; + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + loc.b = (loc.b + Left(Right(arguments.param, loc.i), 1)); + loc.returnValue = FormatBaseN((loc.b+154),16) & FormatBaseN(BitXor(loc.a,461),16); + } + else + { + loc.returnValue = arguments.param; + } + </cfscript> + <cfreturn loc.returnValue> +</cffunction> + +<cffunction name="pluginNames" returntype="string" access="public" output="false" hint="Returns a list of all installed plugins." + examples= + ' + <!--- Check if the Scaffold plugin is installed ---> + <cfif ListFindNoCase("scaffold", pluginNames())> + <!--- do something cool ---> + </cfif> + ' + categories="global" chapters="using-and-creating-plugins" functions=""> + <cfreturn StructKeyList(application.wheels.plugins)> +</cffunction> + +<cffunction name="URLFor" returntype="string" access="public" output="false" hint="Creates an internal URL based on supplied arguments." examples= ' + <!--- Create the URL for the `logOut` action on the `account` controller, typically resulting in `/account/logout` ---> ##URLFor(controller="account", action="logOut")## + <!--- Create a URL with an anchor set on it ---> ##URLFor(action="comments", anchor="comment10")## ' - categories="global-helper" chapters="request-handling,linking-pages" functions="redirectTo,linkTo,startFormTag"> - <cfargument name="route" type="string" required="false" default="" hint="Name of a route that you have configured in 'config/routes.cfm'"> - <cfargument name="controller" type="string" required="false" default="" hint="Name of the controller to include in the URL"> - <cfargument name="action" type="string" required="false" default="" hint="Name of the action to include in the URL"> - <cfargument name="key" type="any" required="false" default="" hint="Key(s) to include in the URL"> - <cfargument name="params" type="string" required="false" default="" hint="Any additional params to be set in the query string"> - <cfargument name="anchor" type="string" required="false" default="" hint="Sets an anchor name to be appended to the path"> - <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.URLFor.onlyPath#" hint="If true, returns only the relative URL (no protocol, host name or port)"> - <cfargument name="host" type="string" required="false" default="#application.wheels.functions.URLFor.host#" hint="Set this to override the current host"> - <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.URLFor.protocol#" hint="Set this to override the current protocol"> - <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.URLFor.port#" hint="Set this to override the current port number"> + categories="global" chapters="request-handling,linking-pages" functions="redirectTo,linkTo,startFormTag"> + <cfargument name="route" type="string" required="false" default="" hint="Name of a route that you have configured in `config/routes.cfm`."> + <cfargument name="controller" type="string" required="false" default="" hint="Name of the controller to include in the URL."> + <cfargument name="action" type="string" required="false" default="" hint="Name of the action to include in the URL."> + <cfargument name="key" type="any" required="false" default="" hint="Key(s) to include in the URL."> + <cfargument name="params" type="string" required="false" default="" hint="Any additional params to be set in the query string."> + <cfargument name="anchor" type="string" required="false" default="" hint="Sets an anchor name to be appended to the path."> + <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.URLFor.onlyPath#" hint="If `true`, returns only the relative URL (no protocol, host name or port)."> + <cfargument name="host" type="string" required="false" default="#application.wheels.functions.URLFor.host#" hint="Set this to override the current host."> + <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.URLFor.protocol#" hint="Set this to override the current protocol."> + <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.URLFor.port#" hint="Set this to override the current port number."> <cfscript> var loc = {}; loc.params = {}; @@ -279,155 +412,27 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="obfuscateParam" returntype="string" access="public" output="false" - hint="Obfuscates a value." - examples= - ' - <cfset obfuscateParam(99)> - ' - categories="global-helper" chapters="obfuscating-urls" functions="deobfuscateParam"> - <cfargument name="param" type="any" required="true" hint="Value to obfuscate"> - <cfscript> - var loc = {}; - if (IsValid("integer", arguments.param) && IsNumeric(arguments.param) && arguments.param > 0) - { - loc.iEnd = Len(arguments.param); - loc.a = (10^loc.iEnd) + Reverse(arguments.param); - loc.b = "0"; - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - loc.b = (loc.b + Left(Right(arguments.param, loc.i), 1)); - loc.returnValue = FormatBaseN((loc.b+154),16) & FormatBaseN(BitXor(loc.a,461),16); - } - else - { - loc.returnValue = arguments.param; - } - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="deobfuscateParam" returntype="string" access="public" output="false" - hint="Deobfuscates a value." - examples= - ' - <cfset deobfuscateParam("b7ab9a50")> - ' - categories="global-helper" chapters="obfuscating-urls" functions="obfuscateParam"> - <cfargument name="param" type="string" required="true" hint="Value to deobfuscate"> - <cfscript> - var loc = {}; - if (Val(arguments.param) != arguments.param) - { - try - { - loc.checksum = Left(arguments.param, 2); - loc.returnValue = Right(arguments.param, (Len(arguments.param)-2)); - loc.z = BitXor(InputBasen(loc.returnValue,16),461); - loc.returnValue = ""; - loc.iEnd = Len(loc.z)-1; - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - loc.returnValue = loc.returnValue & Left(Right(loc.z, loc.i),1); - loc.checksumtest = "0"; - loc.iEnd = Len(loc.returnValue); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - loc.checksumtest = (loc.checksumtest + Left(Right(loc.returnValue, loc.i),1)); - if (Left(ToString(FormatBaseN((loc.checksumtest+154),10)),2) != Left(InputBasen(loc.checksum, 16),2)) - loc.returnValue = arguments.param; - } - catch(Any e) - { - loc.returnValue = arguments.param; - } - } - else - { - loc.returnValue = arguments.param; - } - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="addRoute" returntype="void" access="public" output="false" - hint="Adds a new route to your application." - examples= - ' - <cfset addRoute(name="userProfile", pattern="user/[username]", controller="user", action="profile")> - ' - categories="global-helper" chapters="using-routes" functions=""> - <cfargument name="name" type="string" required="true" hint="Name for the route"> - <cfargument name="pattern" type="string" required="true" hint="The URL pattern for the route"> - <cfargument name="controller" type="string" required="false" default="" hint="Controller to call when route matches (unless the controller name exists in the pattern)"> - <cfargument name="action" type="string" required="false" default="" hint="Action to call when route matches (unless the action name exists in the pattern)"> - <cfscript> - var loc = {}; +<!--- string helpers ---> - // throw errors when controller or action is not passed in as arguments and not included in the pattern - if (!Len(arguments.controller) && arguments.pattern Does Not Contain "[controller]") - $throw(type="Wheels.IncorrectArguments", message="The `controller` argument is not passed in or included in the pattern.", extendedInfo="Either pass in the `controller` argument to specifically tell Wheels which controller to call or include it in the pattern to tell Wheels to determine it dynamically on each request based on the incoming URL."); - if (!Len(arguments.action) && arguments.pattern Does Not Contain "[action]") - $throw(type="Wheels.IncorrectArguments", message="The `action` argument is not passed in or included in the pattern.", extendedInfo="Either pass in the `action` argument to specifically tell Wheels which action to call or include it in the pattern to tell Wheels to determine it dynamically on each request based on the incoming URL."); - - loc.thisRoute = Duplicate(arguments); - loc.thisRoute.variables = ""; - loc.iEnd = ListLen(arguments.pattern, "/"); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.item = ListGetAt(arguments.pattern, loc.i, "/"); - if (loc.item Contains "[") - loc.thisRoute.variables = ListAppend(loc.thisRoute.variables, ReplaceList(loc.item, "[,]", ",")); - } - ArrayAppend(application.wheels.routes, loc.thisRoute); - </cfscript> -</cffunction> - -<cffunction name="model" returntype="any" access="public" output="false" - hint="Returns a reference to the requested model so that class level methods can be called on it." - examples= - ' - <cfset authorObject = model("author").findByKey(1)> - ' - categories="global-helper" chapters="object-relational-mapping" functions=""> - <cfargument name="name" type="string" required="true" hint="Name of the model (class name) to get a reference to"> - <cfscript> - var loc = {}; - loc.returnValue = $doubleCheckedLock(name="modelLock", condition="$cachedModelClassExists", execute="$createModelClass", conditionArgs=arguments, executeArgs=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="pluginNames" returntype="string" access="public" output="false" - hint="Returns a list of all installed plugins." - examples= - ' - <cfif ListFindNoCase("scaffold", pluginNames())> - <!--- do something cool ---> - </cfif> - ' - categories="global-helper" chapters="global-functions" functions=""> - <cfreturn StructKeyList(application.wheels.plugins)> -</cffunction> - -<cffunction name="capitalize" returntype="string" access="public" output="false" - hint="Returns the text with the first character converted to uppercase." +<cffunction name="capitalize" returntype="string" access="public" output="false" hint="Returns the text with the first character converted to uppercase." examples= ' + <!--- Capitalize a sentence, will result in "Wheels is a framework" ---> ##capitalize("wheels is a framework")## - -> Wheels is a framework ' - categories="global-helper" chapters="global-functions" functions="humanize,pluralize,singularize"> - <cfargument name="text" type="string" required="true" hint="Text to capitalize"> + categories="global" chapters="miscellaneous-helpers" functions="humanize,pluralize,singularize"> + <cfargument name="text" type="string" required="true" hint="Text to capitalize."> <cfreturn UCase(Left(arguments.text, 1)) & Mid(arguments.text, 2, Len(arguments.text)-1)> </cffunction> -<cffunction name="humanize" returntype="string" access="public" output="false" - hint="Returns readable text by capitalizing, converting camel casing to multiple words." +<cffunction name="humanize" returntype="string" access="public" output="false" hint="Returns readable text by capitalizing, converting camel casing to multiple words." examples= ' + <!--- Humanize a string, will result in "Wheels Is A Framework" ---> ##humanize("wheelsIsAFramework")## - -> Wheels Is A Framework ' - categories="global-helper" chapters="global-functions" functions="capitalize,pluralize,singularize"> - <cfargument name="text" type="string" required="true" hint="Text to humanize"> + categories="global" chapters="miscellaneous-helpers" functions="capitalize,pluralize,singularize"> + <cfargument name="text" type="string" required="true" hint="Text to humanize."> <cfscript> var loc = {}; loc.returnValue = REReplace(arguments.text, "([[:upper:]])", " \1", "all"); // adds a space before every capitalized word @@ -437,34 +442,35 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="singularize" returntype="string" access="public" output="false" - hint="Returns the singular form of the passed in word." +<cffunction name="pluralize" returntype="string" access="public" output="false" hint="Returns the plural form of the passed in word." examples= ' - ##singularize("languages")## - -> language + <!--- Pluralize a word, will result in "people" ---> + ##pluralize("person")## + + <!--- Pluralize based on the count passed in ---> + Your search returned ##pluralize(word="person", count=users.recordCount)## ' - categories="global-helper" chapters="global-functions" functions="capitalize,humanize,pluralize"> - <cfargument name="word" type="string" required="true" hint="String to singularize"> - <cfreturn $singularizeOrPluralize(text=arguments.word, which="singularize")> + categories="global" chapters="miscellaneous-helpers" functions="capitalize,humanize,singularize"> + <cfargument name="word" type="string" required="true" hint="The word to pluralize."> + <cfargument name="count" type="numeric" required="false" default="-1" hint="Pluralization will occur when this value is not `1`."> + <cfargument name="returnCount" type="boolean" required="false" default="true" hint="Will return `count` prepended to the pluralization when `true` and `count` is not `-1`."> + <cfreturn $singularizeOrPluralize(text=arguments.word, which="pluralize", count=arguments.count, returnCount=arguments.returnCount)> </cffunction> -<cffunction name="pluralize" returntype="string" access="public" output="false" - hint="Returns the plural form of the passed in word." +<cffunction name="singularize" returntype="string" access="public" output="false" hint="Returns the singular form of the passed in word." examples= ' - ##pluralize("person")## - -> people - - Your search returned ##pluralize(word="person", count=users.recordCount)##. + <!--- Singularize a word, will result in "language" ---> + ##singularize("languages")## ' - categories="global-helper" chapters="global-functions" functions="capitalize,humanize,singularize"> - <cfargument name="word" type="string" required="true" hint="The word to pluralize"> - <cfargument name="count" type="numeric" required="false" default="-1" hint="Pluralization will occur when this value is not 1"> - <cfargument name="returnCount" type="boolean" required="false" default="true" hint="Will return the count prepended to the pluralization when true and count is not -1"> - <cfreturn $singularizeOrPluralize(text=arguments.word, which="pluralize", count=arguments.count, returnCount=arguments.returnCount)> + categories="global" chapters="miscellaneous-helpers" functions="capitalize,humanize,pluralize"> + <cfargument name="word" type="string" required="true" hint="String to singularize."> + <cfreturn $singularizeOrPluralize(text=arguments.word, which="singularize")> </cffunction> +<!--- PRIVATE GLOBAL METHODS ---> + <cffunction name="$singularizeOrPluralize" returntype="string" access="public" output="false"> <cfargument name="text" type="string" required="true"> <cfargument name="which" type="string" required="true"> wheels/global/public.cfm @@ -1,5 +1,4 @@ -<cffunction name="contentForLayout" returntype="string" access="public" output="false" - hint="Used inside a layout file to output the HTML created in the view." +<cffunction name="contentForLayout" returntype="string" access="public" output="false" hint="Used inside a layout file to output the HTML created in the view." examples= ' <!--- views/layout.cfm ---> @@ -20,8 +19,7 @@ <cfreturn request.wheels.contentForLayout> </cffunction> -<cffunction name="includePartial" returntype="string" access="public" output="false" - hint="Includes a specified file. Similar to using `cfinclude` but with the ability to cache the result and using Wheels specific file look-up. By default, Wheels will look for the file in the current controller's view folder. To include a file relative from the `views` folder, you can start the path supplied to `name` with a forward slash." +<cffunction name="includePartial" returntype="string" access="public" output="false" hint="Includes the specified file in the view. Similar to using `cfinclude` but with the ability to cache the result and using Wheels specific file look-up. By default, Wheels will look for the file in the current controller's view folder. To include a file relative from the `views` folder, you can start the path supplied to `name` with a forward slash." examples= ' <cfoutput>##includePartial("login")##</cfoutput> @@ -34,10 +32,10 @@ -> Wheels will include the file "views/shared/_button.cfm". ' categories="view-helper" chapters="pages,partials" functions="renderPartial"> - <cfargument name="partial" type="any" required="true" hint="See documentation for `renderPartial`"> - <cfargument name="group" type="string" required="false" default="" hint="field to group the query by. A new query will be passed into the partial template for you to iterate over"> - <cfargument name="cache" type="any" required="false" default="" hint="See documentation for `renderPartial`"> - <cfargument name="layout" type="string" required="false" default="#application.wheels.functions.includePartial.layout#" hint="See documentation for `renderPartial`"> - <cfargument name="spacer" type="string" required="false" default="" hint="HTML or string to place between partials when called using a query"> + <cfargument name="partial" type="any" required="true" hint="See documentation for @renderPartial."> + <cfargument name="group" type="string" required="false" default="" hint="field to group the query by. A new query will be passed into the partial template for you to iterate over."> + <cfargument name="cache" type="any" required="false" default="" hint="See documentation for @renderPartial."> + <cfargument name="layout" type="string" required="false" default="#application.wheels.functions.includePartial.layout#" hint="See documentation for @renderPartial."> + <cfargument name="spacer" type="string" required="false" default="" hint="HTML or string to place between partials when called using a query."> <cfreturn $includeOrRenderPartial(argumentCollection=$dollarify(arguments, "partial,group,cache,layout,spacer"))> -</cffunction> +</cffunction> \ No newline at end of file wheels/view/content.cfm @@ -1,14 +1,13 @@ -<cffunction name="distanceOfTimeInWords" returntype="string" access="public" output="false" - hint="Pass in two dates to this method, and it will return a string describing the difference between them." +<cffunction name="distanceOfTimeInWords" returntype="string" access="public" output="false" hint="Pass in two dates to this method, and it will return a string describing the difference between them." examples=' <cfset aWhileAgo = Now() - 30> <cfset rightNow = Now()> <cfoutput>##distanceOfTimeInWords(aWhileAgo, rightNow)##</cfoutput> ' - categories="view-helper" functions="timeAgoInWords,timeUntilInWords"> - <cfargument name="fromTime" type="date" required="true" hint="Date to compare from"> - <cfargument name="toTime" type="date" required="true" hint="Date to compare to"> - <cfargument name="includeSeconds" type="boolean" required="false" default="#application.wheels.functions.distanceOfTimeInWords.includeSeconds#" hint="Whether or not to include the number of seconds in the returned string"> + categories="view-helper" chapters="miscellaneous-helpers" functions="timeAgoInWords,timeUntilInWords"> + <cfargument name="fromTime" type="date" required="true" hint="Date to compare from."> + <cfargument name="toTime" type="date" required="true" hint="Date to compare to."> + <cfargument name="includeSeconds" type="boolean" required="false" default="#application.wheels.functions.distanceOfTimeInWords.includeSeconds#" hint="Whether or not to include the number of seconds in the returned string."> <cfscript> var loc = {}; loc.minuteDiff = DateDiff("n", arguments.fromTime, arguments.toTime); @@ -81,28 +80,26 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="timeAgoInWords" returntype="string" access="public" output="false" - hint="Pass in a date to this method, and it will return a string describing the approximate time difference between that date and the current date. " +<cffunction name="timeAgoInWords" returntype="string" access="public" output="false" hint="Pass in a date to this method, and it will return a string describing the approximate time difference between that date and the current date." examples=' <cfset aWhileAgo = Now() - 30> <cfoutput>##timeAgoInWords(aWhileAgo)##</cfoutput> ' - categories="view-helper" functions="distanceOfTimeInWords,timeUntilInWords"> - <cfargument name="fromTime" type="date" required="true" hint="See documentation for @distanceOfTimeInWords"> - <cfargument name="includeSeconds" type="boolean" required="false" default="#application.wheels.functions.timeAgoInWords.includeSeconds#" hint="See documentation for @distanceOfTimeInWords"> - <cfargument name="toTime" type="date" required="false" default="#now()#" hint="See documentation for @distanceOfTimeInWords"> + categories="view-helper" chapters="miscellaneous-helpers" functions="distanceOfTimeInWords,timeUntilInWords"> + <cfargument name="fromTime" type="date" required="true" hint="See documentation for @distanceOfTimeInWords."> + <cfargument name="includeSeconds" type="boolean" required="false" default="#application.wheels.functions.timeAgoInWords.includeSeconds#" hint="See documentation for @distanceOfTimeInWords."> + <cfargument name="toTime" type="date" required="false" default="#now()#" hint="See documentation for @distanceOfTimeInWords."> <cfreturn distanceOfTimeInWords(argumentCollection=arguments)> </cffunction> -<cffunction name="timeUntilInWords" returntype="string" access="public" output="false" - hint="Pass in a date to this method, and it will return a string describing the approximate time difference between the current date and that date." +<cffunction name="timeUntilInWords" returntype="string" access="public" output="false" hint="Pass in a date to this method, and it will return a string describing the approximate time difference between the current date and that date." examples=' <cfset aLittleAhead = Now() + 30> <cfoutput>##timeUntilInWords(aLittleAhead)##</cfoutput> ' - categories="view-helper" functions="timeAgoInWords,distanceOfTimeInWords"> - <cfargument name="toTime" type="date" required="true" hint="See documentation for @distanceOfTimeInWords"> - <cfargument name="includeSeconds" type="boolean" required="false" default="#application.wheels.functions.timeUntilInWords.includeSeconds#" hint="See documentation for @distanceOfTimeInWords"> - <cfargument name="fromTime" type="date" required="false" default="#now()#" hint="See documentation for @distanceOfTimeInWords"> + categories="view-helper" chapters="miscellaneous-helpers" functions="timeAgoInWords,distanceOfTimeInWords."> + <cfargument name="toTime" type="date" required="true" hint="See documentation for @distanceOfTimeInWords."> + <cfargument name="includeSeconds" type="boolean" required="false" default="#application.wheels.functions.timeUntilInWords.includeSeconds#" hint="See documentation for @distanceOfTimeInWords."> + <cfargument name="fromTime" type="date" required="false" default="#now()#" hint="See documentation for @distanceOfTimeInWords."> <cfreturn distanceOfTimeInWords(argumentCollection=arguments)> </cffunction> \ No newline at end of file wheels/view/dates.cfm @@ -1,5 +1,4 @@ -<cffunction name="errorMessagesFor" returntype="string" access="public" output="false" - hint="Builds and returns a list (`ul` tag with a class of `error-messages`) containing all the error messages for all the properties of the object, if any. Returns an empty string otherwise." +<cffunction name="errorMessagesFor" returntype="string" access="public" output="false" hint="Builds and returns a list (`ul` tag with a class of `error-messages`) containing all the error messages for all the properties of the object, if any. Returns an empty string otherwise." examples= ' <!--- view code ---> @@ -8,9 +7,9 @@ </cfoutput> ' categories="view-helper" chapters="form-helpers-and-showing-errors" functions="errorMessagesOn"> - <cfargument name="objectName" type="string" required="true" hint="The variable name of the object to display error messages for"> - <cfargument name="class" type="string" required="false" default="#application.wheels.functions.errorMessagesFor.class#" hint="CSS class to set on the `ul` element"> - <cfargument name="showDuplicates" type="boolean" required="false" default="#application.wheels.functions.errorMessagesFor.showDuplicates#" hint="Whether to show duplicate error messages"> + <cfargument name="objectName" type="string" required="true" hint="The variable name of the object to display error messages for."> + <cfargument name="class" type="string" required="false" default="#application.wheels.functions.errorMessagesFor.class#" hint="CSS class to set on the `ul` element."> + <cfargument name="showDuplicates" type="boolean" required="false" default="#application.wheels.functions.errorMessagesFor.showDuplicates#" hint="Whether to show duplicate error messages."> <cfscript> var loc = {}; $insertDefaults(name="errorMessagesFor", input=arguments); @@ -44,8 +43,7 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="errorMessageOn" returntype="string" access="public" output="false" - hint="Returns the error message, if one exists, on the object's property. If multiple error messages exists, the first one is returned." +<cffunction name="errorMessageOn" returntype="string" access="public" output="false" hint="Returns the error message, if one exists, on the object's property. If multiple error messages exists, the first one is returned." examples= ' <!--- view code ---> @@ -54,12 +52,12 @@ </cfoutput> ' categories="view-helper" chapters="form-helpers-and-showing-errors" functions="errorMessagesOn"> - <cfargument name="objectName" type="string" required="true" hint="The variable name of the object to display the error message for"> - <cfargument name="property" type="string" required="true" hint="The name of the property (database column) to display the error message for"> - <cfargument name="prependText" type="string" required="false" default="#application.wheels.functions.errorMessageOn.prependText#" hint="String to prepend to the error message"> - <cfargument name="appendText" type="string" required="false" default="#application.wheels.functions.errorMessageOn.appendText#" hint="String to append to the error message"> - <cfargument name="wrapperElement" type="string" required="false" default="#application.wheels.functions.errorMessageOn.wrapperElement#" hint="HTML element to wrap the error message in"> - <cfargument name="class" type="string" required="false" default="#application.wheels.functions.errorMessageOn.class#" hint="CSS class to set on the wrapper element"> + <cfargument name="objectName" type="string" required="true" hint="The variable name of the object to display the error message for."> + <cfargument name="property" type="string" required="true" hint="The name of the property to display the error message for."> + <cfargument name="prependText" type="string" required="false" default="#application.wheels.functions.errorMessageOn.prependText#" hint="String to prepend to the error message."> + <cfargument name="appendText" type="string" required="false" default="#application.wheels.functions.errorMessageOn.appendText#" hint="String to append to the error message."> + <cfargument name="wrapperElement" type="string" required="false" default="#application.wheels.functions.errorMessageOn.wrapperElement#" hint="HTML element to wrap the error message in."> + <cfargument name="class" type="string" required="false" default="#application.wheels.functions.errorMessageOn.class#" hint="CSS class to set on the wrapper element."> <cfscript> var loc = {}; $insertDefaults(name="errorMessageOn", input=arguments); wheels/view/errors.cfm @@ -1,5 +1,22 @@ -<cffunction name="startFormTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing the opening form tag. The form's action will be built according to the same rules as `URLFor`." +<cffunction name="endFormTag" returntype="string" access="public" output="false" hint="Builds and returns a string containing the closing `form` tag." + examples= + ' + <!--- view code ---> + <cfoutput> + ##startFormTag(action="create")## + <!--- your form controls ---> + ##endFormTag()## + </cfoutput> + ' + categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> + <cfscript> + if (StructKeyExists(request.wheels, "currentFormMethod")) + StructDelete(request.wheels, "currentFormMethod"); + </cfscript> + <cfreturn "</form>"> +</cffunction> + +<cffunction name="startFormTag" returntype="string" access="public" output="false" hint="Builds and returns a string containing the opening form tag. The form's action will be built according to the same rules as `URLFor`." examples= ' <!--- view code ---> @@ -10,19 +27,19 @@ </cfoutput> ' categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,endFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="method" type="string" required="false" default="#application.wheels.functions.startFormTag.method#" hint="The type of method to use in the form tag, `get` and `post` are the options"> - <cfargument name="multipart" type="boolean" required="false" default="#application.wheels.functions.startFormTag.multipart#" hint="Set to `true` if the form should be able to upload files"> - <cfargument name="spamProtection" type="boolean" required="false" default="#application.wheels.functions.startFormTag.spamProtection#" hint="Set to `true` to protect the form against spammers (done with JavaScript)"> - <cfargument name="route" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="controller" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="action" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="key" type="any" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="params" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="anchor" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.startFormTag.onlyPath#" hint="See documentation for @URLFor"> - <cfargument name="host" type="string" required="false" default="#application.wheels.functions.startFormTag.host#" hint="See documentation for @URLFor"> - <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.startFormTag.protocol#" hint="See documentation for @URLFor"> - <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.startFormTag.port#" hint="See documentation for @URLFor"> + <cfargument name="method" type="string" required="false" default="#application.wheels.functions.startFormTag.method#" hint="The type of method to use in the form tag, `get` and `post` are the options."> + <cfargument name="multipart" type="boolean" required="false" default="#application.wheels.functions.startFormTag.multipart#" hint="Set to `true` if the form should be able to upload files."> + <cfargument name="spamProtection" type="boolean" required="false" default="#application.wheels.functions.startFormTag.spamProtection#" hint="Set to `true` to protect the form against spammers (done with JavaScript)."> + <cfargument name="route" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="controller" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="action" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="key" type="any" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="params" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="anchor" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.startFormTag.onlyPath#" hint="See documentation for @URLFor."> + <cfargument name="host" type="string" required="false" default="#application.wheels.functions.startFormTag.host#" hint="See documentation for @URLFor."> + <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.startFormTag.protocol#" hint="See documentation for @URLFor."> + <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.startFormTag.port#" hint="See documentation for @URLFor."> <cfscript> var loc = {}; $insertDefaults(name="startFormTag", input=arguments); @@ -59,27 +76,7 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="endFormTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing the closing `form` tag." - examples= - ' - <!--- view code ---> - <cfoutput> - ##startFormTag(action="create")## - <!--- your form controls ---> - ##endFormTag()## - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfscript> - if (StructKeyExists(request.wheels, "currentFormMethod")) - StructDelete(request.wheels, "currentFormMethod"); - </cfscript> - <cfreturn "</form>"> -</cffunction> - -<cffunction name="submitTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a submit button `form` control." +<cffunction name="submitTag" returntype="string" access="public" output="false" hint="Builds and returns a string containing a submit button `form` control." examples= ' !--- view code ---> @@ -91,9 +88,9 @@ </cfoutput> ' categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="value" type="string" required="false" default="#application.wheels.functions.submitTag.value#" hint="Message to display in the button form control"> - <cfargument name="image" type="string" required="false" default="#application.wheels.functions.submitTag.image#" hint="File name of the image file to use in the button form control"> - <cfargument name="disable" type="any" required="false" default="#application.wheels.functions.submitTag.disable#" hint="Whether to disable the button upon clicking (prevents double-clicking)"> + <cfargument name="value" type="string" required="false" default="#application.wheels.functions.submitTag.value#" hint="Message to display in the button form control."> + <cfargument name="image" type="string" required="false" default="#application.wheels.functions.submitTag.image#" hint="File name of the image file to use in the button form control."> + <cfargument name="disable" type="any" required="false" default="#application.wheels.functions.submitTag.disable#" hint="Whether to disable the button upon clicking (prevents double-clicking)."> <cfscript> var loc = {}; $insertDefaults(name="submitTag", reserved="type,src", input=arguments); @@ -125,1220 +122,6 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="textField" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a text field form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##textField(label="First Name", objectName="user", property="firstName")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="The variable name of the object to build the form control for"> - <cfargument name="property" type="string" required="true" hint="The name of the property (database column) to use in the form control"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.textField.label#" hint="The label text to use in the form control"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.textField.labelPlacement#" hint="Whether to place the label before, after, or wrapped around the form control"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.textField.prepend#" hint="String to prepend to the form control. Useful to wrap the form control around HTML tags"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.textField.append#" hint="String to append to the form control. Useful to wrap the form control around HTML tags"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.textField.prependToLabel#" hint="String to prepend to the form control's label. Useful to wrap the form control around HTML tags"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.textField.appendToLabel#" hint="String to append to the form control's label. Useful to wrap the form control around HTML tags"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.textField.errorElement#" hint="HTML tag to wrap the form control with when the object contains errors"> - <cfscript> - var loc = {}; - $insertDefaults(name="textField", reserved="type,name,value", input=arguments); - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - arguments.type = "text"; - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property); - arguments.value = $formValue(argumentCollection=arguments); - loc.returnValue = loc.before & $tag(name="input", close=true, skip="objectName,property,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement", skipStartingWith="label", attributes=arguments) & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="textFieldTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a text field form control based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##textFieldTag(name="someName")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="Name to populate in tag's `name` attribute"> - <cfargument name="value" type="string" required="false" default="" hint="Value to populate in tag's `value` attribute"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.textFieldTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.textFieldTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.textFieldTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.textFieldTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.textFieldTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.textFieldTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = arguments.value; - StructDelete(arguments, "name"); - StructDelete(arguments, "value"); - loc.returnValue = textField(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="passwordField" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a password field form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##passwordField(objectName="user", property="pass")##</p> - </cfoutput> - ' - categories="view-helper" chapter="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,checkBox,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.passwordField.label#" hint="See documentation for textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.passwordField.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.passwordField.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.passwordField.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.passwordField.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.passwordField.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.passwordField.errorElement#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - $insertDefaults(name="passwordField", reserved="type,name,value", input=arguments); - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - arguments.type = "password"; - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property); - arguments.value = $formValue(argumentCollection=arguments); - loc.returnValue = loc.before & $tag(name="input", close=true, skip="objectName,property,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement", skipStartingWith="label", attributes=arguments) & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="passwordFieldTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a password field form control based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##passwordFieldTag(name="password")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="value" type="string" required="false" default="" hint="See documentation for @textFieldTag"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.passwordFieldTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.passwordFieldTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.passwordFieldTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.passwordFieldTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.passwordFieldTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.passwordFieldTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = arguments.value; - StructDelete(arguments, "name"); - StructDelete(arguments, "value"); - loc.returnValue = passwordField(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="hiddenField" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a hidden field form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##hiddenField(objectName="user", property="id")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,checkBox,passwordField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - $insertDefaults(name="hiddenField", reserved="type,name,value", input=arguments); - arguments.type = "hidden"; - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property); - arguments.value = $formValue(argumentCollection=arguments); - if (application.wheels.obfuscateUrls && StructKeyExists(request.wheels, "currentFormMethod") && request.wheels.currentFormMethod == "get") - arguments.value = obfuscateParam(arguments.value); - loc.returnValue = $tag(name="input", close=true, skip="objectName,property", attributes=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="hiddenFieldTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a hidden field form control based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##hiddenFieldTag(name="userId", value=user.id)##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="value" type="string" required="false" default="" hint="See documentation for @textFieldTag"> - <cfscript> - var loc = {}; - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = arguments.value; - StructDelete(arguments, "name"); - StructDelete(arguments, "value"); - loc.returnValue = hiddenField(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="fileField" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a file field form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##fileField(objectName="photo", property="imageFile")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.fileField.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.fileField.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.fileField.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.fileField.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.fileField.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.fileField.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.fileField.errorElement#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - $insertDefaults(name="fileField", reserved="type,name", input=arguments); - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - arguments.type = "file"; - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property); - loc.returnValue = loc.before & $tag(name="input", close=true, skip="objectName,property,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement", skipStartingWith="label", attributes=arguments) & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="fileFieldTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a file form control based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##fileFieldTag(name="photo")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.fileFieldTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.fileFieldTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.fileFieldTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.fileFieldTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.fileFieldTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.fileFieldTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = ""; - StructDelete(arguments, "name"); - loc.returnValue = fileField(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="textArea" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a password field form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##textArea(objectName="article", property="overview")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.textArea.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.textArea.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.textArea.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.textArea.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.textArea.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.textArea.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.textArea.errorElement#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - $insertDefaults(name="textArea", reserved="name", input=arguments); - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property); - loc.content = $formValue(argumentCollection=arguments); - loc.returnValue = loc.before & $element(name="textarea", skip="objectName,property,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement", skipStartingWith="label", content=loc.content, attributes=arguments) & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="textAreaTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a text area form control based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##textAreaTag(name="description")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="content" type="string" required="false" default="" hint="Content to display in `textarea` by default"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.textAreaTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.textAreaTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.textAreaTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.textAreaTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.textAreaTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.textAreaTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = arguments.content; - StructDelete(arguments, "name"); - StructDelete(arguments, "content"); - loc.returnValue = textArea(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="radioButton" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a radio button form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p> - ##radioButton(objectName="user", property="gender", tagValue="m", label="Male")##<br /> - ##radioButton(objectName="user", property="gender", tagValue="f", label="Female")## - </p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,textField,submitTag,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="tagValue" type="string" required="true" hint="The value of the radio button when `selected`"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.radioButton.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.radioButton.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.radioButton.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.radioButton.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.radioButton.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.radioButton.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.radioButton.errorElement#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - $insertDefaults(name="radioButton", reserved="type,name,value,checked", input=arguments); - loc.valueToAppend = LCase(Replace(ReReplaceNoCase(arguments.tagValue, "[^a-z0-9- ]", "", "all"), " ", "-", "all")); - arguments.$appendToFor = loc.valueToAppend; - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - arguments.type = "radio"; - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property) & "-" & loc.valueToAppend; - arguments.value = arguments.tagValue; - if (arguments.tagValue == $formValue(argumentCollection=arguments)) - arguments.checked = "checked"; - loc.returnValue = loc.before & $tag(name="input", close=true, skip="objectName,property,tagValue,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement", skipStartingWith="label", attributes=arguments) & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="radioButtonTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a radio button form control based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p> - ##radioButtonTag(name="gender", value="m", label="Male", checked=true)##<br /> - ##radioButtonTag(name="gender", value="f", label="Female")## - </p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="value" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="checked" type="boolean" required="false" default="false" hint="Whether or not to check the radio button by default"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.radioButtonTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.radioButtonTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.radioButtonTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.radioButtonTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.radioButtonTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.radioButtonTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - arguments.property = arguments.name; - arguments.objectName = {}; - if (arguments.checked) - { - arguments.objectName[arguments.name] = arguments.value; - arguments.tagValue = arguments.value; - } - else - { - arguments.objectName[arguments.name] = ""; - arguments.tagValue = arguments.value; - } - StructDelete(arguments, "name"); - StructDelete(arguments, "value"); - StructDelete(arguments, "checked"); - loc.returnValue = radioButton(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="checkBox" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a check box form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##checkBox(objectName="photo", property="isPublic", label="Display this photo publicly.")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="checkedValue" type="string" required="false" default="#application.wheels.functions.checkBox.checkedValue#" hint="The value of the check box when it's on the `checked` state"> - <cfargument name="uncheckedValue" type="string" required="false" default="#application.wheels.functions.checkBox.uncheckedValue#" hint="The value of the check box when it's on the `unchecked` state"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.checkBox.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.checkBox.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.checkBox.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.checkBox.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.checkBox.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.checkBox.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.checkBox.errorElement#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - $insertDefaults(name="checkBox", reserved="type,name,value,checked", input=arguments); - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - arguments.type = "checkbox"; - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property); - arguments.value = arguments.checkedValue; - loc.value = $formValue(argumentCollection=arguments); - if (loc.value == arguments.value || IsNumeric(loc.value) && loc.value == 1 || !IsNumeric(loc.value) && IsBoolean(loc.value) && loc.value) - arguments.checked = "checked"; - loc.returnValue = loc.before & $tag(name="input", close=true, skip="objectName,property,checkedValue,uncheckedValue,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement", skipStartingWith="label", attributes=arguments); - if (!IsStruct(arguments.objectName)) - { - loc.hiddenAttributes = {}; - loc.hiddenAttributes.type = "hidden"; - loc.hiddenAttributes.name = arguments.name & "($checkbox)"; - loc.hiddenAttributes.value = arguments.uncheckedValue; - loc.returnValue = loc.returnValue & $tag(name="input", close=true, attributes=loc.hiddenAttributes); - } - loc.returnValue = loc.returnValue & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="checkBoxTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a check box form control based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##checkBoxTag(name="suscribe", value="true", label="Suscribe to our newsletter", checked=false)##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTag,dateSelectTag,timeSelectTag"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="checked" type="boolean" required="false" default="false" hint="Whether or not the check box should be checked by default"> - <cfargument name="value" type="string" required="false" default="#application.wheels.functions.checkBoxTag.value#" hint="Value of check box in its `checked` state"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.checkBoxTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.checkBoxTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.checkBoxTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.checkBoxTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.checkBoxTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.checkBoxTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - arguments.checkedValue = arguments.value; - arguments.property = arguments.name; - arguments.objectName = {}; - if (arguments.checked) - arguments.objectName[arguments.name] = arguments.value; - else - arguments.objectName[arguments.name] = ""; - StructDelete(arguments, "name"); - StructDelete(arguments, "value"); - StructDelete(arguments, "checked"); - loc.returnValue = checkBox(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="select" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a select form control based on the supplied `objectName` and `property`." - examples= - ' - <!--- controller code ---> - <cfset authors = model("author").findAll()> - - <!--- view code ---> - <cfoutput> - <p>##select(objectName="book", property="authorId", options=authors)##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,dateTimeSelect,dateSelect,timeSelect"> - <cfargument name="objectName" type="any" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="options" type="any" required="true" hint="A collection to populate the select form control with. Can be a query recordset or an array of objects"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.select.includeBlank#" hint="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 -')"> - <cfargument name="valueField" type="string" required="false" default="#application.wheels.functions.select.valueField#" hint="The column or property to use for the value of each list element. Used only when a query or array of objects has been supplied in the `options` argument"> - <cfargument name="textField" type="string" required="false" default="#application.wheels.functions.select.textField#" hint="The column or property to use for the value of each list element that the end user will see. Used only when a query or array of objects has been supplied in the `options` argument"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.select.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.select.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.select.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.select.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.select.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.select.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.select.errorElement#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - $insertDefaults(name="select", reserved="name", input=arguments); - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - arguments.name = $tagName(arguments.objectName, arguments.property); - if (!StructKeyExists(arguments, "id")) - arguments.id = $tagId(arguments.objectName, arguments.property); - if (StructKeyExists(arguments, "multiple")) - { - if (arguments.multiple) - arguments.multiple = "multiple"; - else - StructDelete(arguments, "multiple"); - } - loc.content = $optionsForSelect(argumentCollection=arguments); - if (!IsBoolean(arguments.includeBlank) || arguments.includeBlank) - { - if (!IsBoolean(arguments.includeBlank)) - loc.blankOptionText = arguments.includeBlank; - else - loc.blankOptionText = ""; - loc.blankOptionAttributes = {value=""}; - loc.content = $element(name="option", content=loc.blankOptionText, attributes=loc.blankOptionAttributes) & loc.content; - } - loc.returnValue = loc.before & $element(name="select", skip="objectName,property,options,includeBlank,valueField,textField,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement", skipStartingWith="label", content=loc.content, attributes=arguments) & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="selectTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a select form control based on the supplied `name` and `options`." - examples= - ' - <!--- controller code ---> - <cfset cities = model("city").findAll()> - - <!--- view code ---> - <cfoutput> - <p>##selectTag(name="cityId", options=cities)##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="options" type="any" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="string" required="false" default="" hint="Value of option that should be selected by default"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.selectTag.includeBlank#" hint="See documentation for @select"> - <cfargument name="multiple" type="boolean" required="false" default="#application.wheels.functions.selectTag.multiple#" hint="Whether to allow multiple selection of options in the select form control"> - <cfargument name="valueField" type="string" required="false" default="#application.wheels.functions.selectTag.valueField#" hint="See documentation for @select"> - <cfargument name="textField" type="string" required="false" default="#application.wheels.functions.selectTag.textField#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.selectTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.selectTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.selectTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.selectTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.selectTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.selectTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = arguments.selected; - StructDelete(arguments, "name"); - StructDelete(arguments, "selected"); - loc.returnValue = select(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="dateSelect" returntype="string" access="public" output="false" - hint="Builds and returns a string containing three select form controls for a date based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##dateSelect(objectName="user", property="dateOfBirth")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,textField,submitTag,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,timeSelect"> - <cfargument name="objectName" type="any" required="false" default="" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="false" default="" hint="See documentation for @textField"> - <cfargument name="order" type="string" required="false" default="#application.wheels.functions.dateSelect.order#" hint="Use to change the order of or exclude date select tags"> - <cfargument name="separator" type="string" required="false" default="#application.wheels.functions.dateSelect.separator#" hint="Use to change the character that is displayed between the date select tags"> - <cfargument name="startYear" type="numeric" required="false" default="#application.wheels.functions.dateSelect.startYear#" hint="First year in select list"> - <cfargument name="endYear" type="numeric" required="false" default="#application.wheels.functions.dateSelect.endYear#" hint="Last year in select list"> - <cfargument name="monthDisplay" type="string" required="false" default="#application.wheels.functions.dateSelect.monthDisplay#" hint="Pass in `names`, `numbers` or `abbreviations` to control display"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.dateSelect.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.dateSelect.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.dateSelect.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.dateSelect.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.dateSelect.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.dateSelect.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.dateSelect.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.dateSelect.errorElement#" hint="See documentation for @textField"> - <cfscript> - $insertDefaults(name="dateSelect", input=arguments); - arguments.$functionName = "dateSelect"; - </cfscript> - <cfreturn $dateOrTimeSelect(argumentCollection=arguments)> -</cffunction> - -<cffunction name="dateSelectTags" returntype="string" access="public" output="false" - hint="Builds and returns a string containing three select form controls (month, day and year)." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##dateSelectTags()##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,textFieldTag,submitTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Now()#" hint="See documentation for @selectTag"> - <cfargument name="order" type="string" required="false" default="#application.wheels.functions.dateSelectTags.order#" hint="See documentation for @dateSelect"> - <cfargument name="separator" type="string" required="false" default="#application.wheels.functions.dateSelectTags.separator#" hint="See documentation for @dateSelect"> - <cfargument name="startYear" type="numeric" required="false" default="#application.wheels.functions.dateSelectTags.startYear#" hint="See documentation for @dateSelect"> - <cfargument name="endYear" type="numeric" required="false" default="#application.wheels.functions.dateSelectTags.endYear#" hint="See documentation for @dateSelect"> - <cfargument name="monthDisplay" type="string" required="false" default="#application.wheels.functions.dateSelectTags.monthDisplay#" hint="See documentation for @dateSelect"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.dateSelectTags.includeBlank#" hint="See documentation for @dateSelect"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.dateSelectTags.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.dateSelectTags.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.dateSelectTags.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.dateSelectTags.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.dateSelectTags.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.dateSelectTags.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = arguments.selected; - StructDelete(arguments, "name"); - StructDelete(arguments, "selected"); - arguments.$functionName = "dateSelectTag"; - </cfscript> - <cfreturn $dateOrTimeSelect(argumentCollection=arguments)> -</cffunction> - -<cffunction name="timeSelect" returntype="string" access="public" output="false" - hint="Builds and returns a string containing three select form controls for a time based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##timeSelect(objectName="business", property="openUntil")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateTimeSelect,dateSelect"> - <cfargument name="objectName" type="any" required="false" default="" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="false" default="" hint="See documentation for @textField"> - <cfargument name="order" type="string" required="false" default="#application.wheels.functions.timeSelect.order#" hint="Use to change the order of or exclude time select tags"> - <cfargument name="separator" type="string" required="false" default="#application.wheels.functions.timeSelect.separator#" hint="Use to change the character that is displayed between the time select tags"> - <cfargument name="minuteStep" type="numeric" required="false" default="#application.wheels.functions.timeSelect.minuteStep#" hint="Pass in `10` to only show minute 10, 20,30 etc"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.timeSelect.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.timeSelect.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.timeSelect.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.timeSelect.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.timeSelect.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.timeSelect.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.timeSelect.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.timeSelect.errorElement#" hint="See documentation for @textField"> - <cfscript> - $insertDefaults(name="timeSelect", input=arguments); - arguments.$functionName = "timeSelect"; - </cfscript> - <cfreturn $dateOrTimeSelect(argumentCollection=arguments)> -</cffunction> - -<cffunction name="timeSelectTags" returntype="string" access="public" output="false" - hint="Builds and returns a string containing three select form controls for a time based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##timeSelectTags(name="timeOfMeeting")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Now()#" hint="See documentation for @selectTag"> - <cfargument name="order" type="string" required="false" default="#application.wheels.functions.timeSelectTags.order#" hint="See documentation for @timeSelect"> - <cfargument name="separator" type="string" required="false" default="#application.wheels.functions.timeSelectTags.separator#" hint="See documentation for @timeSelect"> - <cfargument name="minuteStep" type="numeric" required="false" default="#application.wheels.functions.timeSelectTags.minuteStep#" hint="See documentation for @timeSelect"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.timeSelectTags.includeBlank#" hint="See documentation for @timeSelect"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.timeSelectTags.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.timeSelectTags.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.timeSelectTags.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.timeSelectTags.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.timeSelectTags.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.timeSelectTags.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.property = arguments.name; - arguments.objectName = {}; - arguments.objectName[arguments.name] = arguments.selected; - StructDelete(arguments, "name"); - StructDelete(arguments, "selected"); - arguments.$functionName = "timeSelectTag"; - </cfscript> - <cfreturn $dateOrTimeSelect(argumentCollection=arguments)> -</cffunction> - -<cffunction name="dateTimeSelect" returntype="string" access="public" output="false" - hint="Builds and returns a string containing six select form controls (three for date selection and the remaining three for time selection) based on the supplied `objectName` and `property`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##dateTimeSelect(objectName="article", property="publishedAt")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textField,radioButton,checkBox,passwordField,hiddenField,textArea,fileField,select,dateSelect,timeSelect"> - <cfargument name="objectName" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="property" type="string" required="true" hint="See documentation for @textField"> - <cfargument name="dateOrder" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.dateOrder#" hint="See documentation for @dateSelect"> - <cfargument name="dateSeparator" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.dateSeparator#" hint="See documentation for @dateSelect"> - <cfargument name="startYear" type="numeric" required="false" default="#application.wheels.functions.dateTimeSelect.startYear#" hint="See documentation for @dateSelect"> - <cfargument name="endYear" type="numeric" required="false" default="#application.wheels.functions.dateTimeSelect.endYear#" hint="See documentation for @dateSelect"> - <cfargument name="monthDisplay" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.monthDisplay#" hint="See documentation for @dateSelect"> - <cfargument name="timeOrder" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.timeOrder#" hint="See documentation for @timeSelect"> - <cfargument name="timeSeparator" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.timeSeparator#" hint="See documentation for @timeSelect"> - <cfargument name="minuteStep" type="numeric" required="false" default="#application.wheels.functions.dateTimeSelect.minuteStep#" hint="See documentation for @timeSelect"> - <cfargument name="separator" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.separator#" hint="Use to change the character that is displayed between the first and second set of select tags"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.dateTimeSelect.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.appendToLabel#" hint="See documentation for @textField"> - <cfargument name="errorElement" type="string" required="false" default="#application.wheels.functions.dateTimeSelect.errorElement#" hint="See documentation for @textField"> - <cfscript> - $insertDefaults(name="dateTimeSelect", reserved="name", input=arguments); - arguments.$functionName = "dateTimeSelect"; - </cfscript> - <cfreturn dateTimeSelectTags(argumentCollection=arguments)> -</cffunction> - -<cffunction name="dateTimeSelectTags" returntype="string" access="public" output="false" - hint="Builds and returns a string containing six select form controls (three for date selection and the remaining three for time selection)." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##dateTimeSelectTags()##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateSelectTags,timeSelectTags"> - <cfargument name="dateOrder" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.dateOrder#" hint="See documentation for @dateTimeSelect"> - <cfargument name="dateSeparator" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.dateSeparator#" hint="See documentation for @dateTimeSelect"> - <cfargument name="startYear" type="numeric" required="false" default="#application.wheels.functions.dateTimeSelectTags.startYear#" hint="See documentation for @dateTimeSelect"> - <cfargument name="endYear" type="numeric" required="false" default="#application.wheels.functions.dateTimeSelectTags.endYear#" hint="See documentation for @dateTimeSelect"> - <cfargument name="monthDisplay" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.monthDisplay#" hint="See documentation for @dateTimeSelect"> - <cfargument name="timeOrder" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.timeOrder#" hint="See documentation for @dateTimeSelect"> - <cfargument name="timeSeparator" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.timeSeparator#" hint="See documentation for @dateTimeSelect"> - <cfargument name="minuteStep" type="numeric" required="false" default="#application.wheels.functions.dateTimeSelectTags.minuteStep#" hint="See documentation for @dateTimeSelect"> - <cfargument name="separator" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.separator#" hint="See documentation for @dateTimeSelect"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.dateTimeSelectTags.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.label#" hint="See documentation for @textField@"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.dateTimeSelectTags.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - var loc = {}; - loc.returnValue = ""; - loc.separator = arguments.separator; - arguments.order = arguments.dateOrder; - arguments.separator = arguments.dateSeparator; - if (StructKeyExists(arguments, "$functionName") && arguments.$functionName == "dateTimeSelect") - loc.returnValue = loc.returnValue & dateSelect(argumentCollection=arguments); - else - loc.returnValue = loc.returnValue & dateSelectTags(argumentCollection=arguments); - loc.returnValue = loc.returnValue & loc.separator; - arguments.order = arguments.timeOrder; - arguments.separator = arguments.timeSeparator; - if (StructKeyExists(arguments, "$functionName") && arguments.$functionName == "dateTimeSelect") - loc.returnValue = loc.returnValue & timeSelect(argumentCollection=arguments); - else - loc.returnValue = loc.returnValue & timeSelectTags(argumentCollection=arguments); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="yearSelectTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a select form control for a range of years based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##yearSelectTag(name="yearOfBirthday")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Year(Now())#" hint="The year that should be selected initially"> - <cfargument name="startYear" type="numeric" required="false" default="#application.wheels.functions.yearSelectTag.startYear#" hint="See documentation for @dateSelect"> - <cfargument name="endYear" type="numeric" required="false" default="#application.wheels.functions.yearSelectTag.endYear#" hint="See documentation for @dateSelect"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.yearSelectTag.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.yearSelectTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.yearSelectTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.yearSelectTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.yearSelectTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.yearSelectTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.yearSelectTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.selected = createDate(arguments.selected, Month(Now()), Day(Now())); - arguments.order = "year"; - </cfscript> - <cfreturn dateSelectTags(argumentCollection=arguments)> -</cffunction> - -<cffunction name="monthSelectTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a select form control for the months of the year based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##monthSelectTag(name="monthOfBirthday")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Month(Now())#" hint="The month that should be selected initially"> - <cfargument name="monthDisplay" type="string" required="false" default="#application.wheels.functions.monthSelectTag.monthDisplay#" hint="See documentation for @dateSelect"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.monthSelectTag.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.monthSelectTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.monthSelectTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.monthSelectTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.monthSelectTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.monthSelectTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.monthSelectTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.selected = createDate(Year(Now()), arguments.selected, Day(Now())); - arguments.order = "month"; - </cfscript> - <cfreturn dateSelectTags(argumentCollection=arguments)> -</cffunction> - -<cffunction name="daySelectTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing a select form control for the days of the week based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##daySelectTag(name="dayOfWeek")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Day(Now())#" hint="The day that should be selected initially"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.daySelectTag.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.daySelectTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.daySelectTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.daySelectTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.daySelectTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.daySelectTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.daySelectTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.selected = createDate(Year(Now()), Month(Now()), arguments.selected); - arguments.order = "day"; - </cfscript> - <cfreturn dateSelectTags(argumentCollection=arguments)> -</cffunction> - -<cffunction name="hourSelectTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing one select form control for the hours of the day based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##hourSelectTag(name="hourOfMeeting")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Hour(Now())#" hint="The hour that should be selected initially"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.hourSelectTag.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.hourSelectTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.hourSelectTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.hourSelectTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.hourSelectTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.hourSelectTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.hourSelectTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.selected = createTime(arguments.selected, Minute(Now()), Second(Now())); - arguments.order = "hour"; - </cfscript> - <cfreturn timeSelectTags(argumentCollection=arguments)> -</cffunction> - -<cffunction name="minuteSelectTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing one select form control for the minutes of an hour based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##minuteSelectTag(name="minuteOfMeeting")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Minute(Now())#" hint="The minute that should be selected initially"> - <cfargument name="minuteStep" type="numeric" required="false" default="#application.wheels.functions.minuteSelectTag.minuteStep#" hint="See documentation for @timeSelect"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.minuteSelectTag.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.minuteSelectTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.minuteSelectTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.minuteSelectTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.minuteSelectTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.minuteSelectTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.minuteSelectTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.selected = createTime(Hour(Now()), arguments.selected, Second(Now())); - arguments.order = "minute"; - </cfscript> - <cfreturn timeSelectTags(argumentCollection=arguments)> -</cffunction> - -<cffunction name="secondSelectTag" returntype="string" access="public" output="false" - hint="Builds and returns a string containing one select form control for the seconds of a minute based on the supplied `name`." - examples= - ' - <!--- view code ---> - <cfoutput> - <p>##secondSelectTag(name="secondsToLaunch")##</p> - </cfoutput> - ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="URLFor,startFormTag,endFormTag,submitTag,textFieldTag,radioButtonTag,checkBoxTag,passwordFieldTag,hiddenFieldTag,textAreaTag,fileFieldTag,selectTag,dateTimeSelectTags,dateSelectTags,timeSelectTags"> - <cfargument name="name" type="string" required="true" hint="See documentation for @textFieldTag"> - <cfargument name="selected" type="date" required="false" default="#Second(Now())#" hint="The second that should be selected initially"> - <cfargument name="includeBlank" type="any" required="false" default="#application.wheels.functions.secondSelectTag.includeBlank#" hint="See documentation for @select"> - <cfargument name="label" type="string" required="false" default="#application.wheels.functions.secondSelectTag.label#" hint="See documentation for @textField"> - <cfargument name="labelPlacement" type="string" required="false" default="#application.wheels.functions.secondSelectTag.labelPlacement#" hint="See documentation for @textField"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.secondSelectTag.prepend#" hint="See documentation for @textField"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.secondSelectTag.append#" hint="See documentation for @textField"> - <cfargument name="prependToLabel" type="string" required="false" default="#application.wheels.functions.secondSelectTag.prependToLabel#" hint="See documentation for @textField"> - <cfargument name="appendToLabel" type="string" required="false" default="#application.wheels.functions.secondSelectTag.appendToLabel#" hint="See documentation for @textField"> - <cfscript> - arguments.selected = createTime(Hour(Now()), Minute(Now()), arguments.selected); - arguments.order = "second"; - </cfscript> - <cfreturn timeSelectTags(argumentCollection=arguments)> -</cffunction> - -<cffunction name="$yearSelectTag" returntype="string" access="public" output="false"> - <cfargument name="startYear" type="numeric" required="true"> - <cfargument name="endYear" type="numeric" required="true"> - <cfscript> - if (structkeyexists(arguments, "value") && val(arguments.value) gt 0 && arguments.value lt arguments.startYear) - { - arguments.startYear = arguments.value; - } - arguments.$loopFrom = arguments.startYear; - arguments.$loopTo = arguments.endYear; - arguments.$type = "year"; - arguments.$step = 1; - StructDelete(arguments, "startYear"); - StructDelete(arguments, "endYear"); - </cfscript> - <cfreturn $yearMonthHourMinuteSecondSelectTag(argumentCollection=arguments)> -</cffunction> - -<cffunction name="$monthSelectTag" returntype="string" access="public" output="false"> - <cfargument name="monthDisplay" type="string" required="true"> - <cfscript> - arguments.$loopFrom = 1; - arguments.$loopTo = 12; - arguments.$type = "month"; - arguments.$step = 1; - if (arguments.monthDisplay == "abbreviations") - arguments.$optionNames = "Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec"; - else if (arguments.monthDisplay == "names") - arguments.$optionNames = "January,February,March,April,May,June,July,August,September,October,November,December"; - StructDelete(arguments, "monthDisplay"); - </cfscript> - <cfreturn $yearMonthHourMinuteSecondSelectTag(argumentCollection=arguments)> -</cffunction> - -<cffunction name="$daySelectTag" returntype="string" access="public" output="false"> - <cfscript> - arguments.$loopFrom = 1; - arguments.$loopTo = 31; - arguments.$type = "day"; - arguments.$step = 1; - </cfscript> - <cfreturn $yearMonthHourMinuteSecondSelectTag(argumentCollection=arguments)> -</cffunction> - -<cffunction name="$hourSelectTag" returntype="string" access="public" output="false"> - <cfscript> - arguments.$loopFrom = 0; - arguments.$loopTo = 23; - arguments.$type = "hour"; - arguments.$step = 1; - </cfscript> - <cfreturn $yearMonthHourMinuteSecondSelectTag(argumentCollection=arguments)> -</cffunction> - -<cffunction name="$minuteSelectTag" returntype="string" access="public" output="false"> - <cfargument name="minuteStep" type="numeric" required="true"> - <cfscript> - arguments.$loopFrom = 0; - arguments.$loopTo = 59; - arguments.$type = "minute"; - arguments.$step = arguments.minuteStep; - StructDelete(arguments, "minuteStep"); - </cfscript> - <cfreturn $yearMonthHourMinuteSecondSelectTag(argumentCollection=arguments)> -</cffunction> - -<cffunction name="$secondSelectTag" returntype="string" access="public" output="false"> - <cfscript> - arguments.$loopFrom = 0; - arguments.$loopTo = 59; - arguments.$type = "second"; - arguments.$step = 1; - </cfscript> - <cfreturn $yearMonthHourMinuteSecondSelectTag(argumentCollection=arguments)> -</cffunction> - -<cffunction name="$dateOrTimeSelect" returntype="string" access="public" output="false"> - <cfargument name="objectName" type="any" required="true"> - <cfargument name="property" type="string" required="true"> - <cfargument name="$functionName" type="string" required="true"> - <cfscript> - var loc = {}; - loc.name = $tagName(arguments.objectName, arguments.property); - arguments.$id = $tagId(arguments.objectName, arguments.property); - loc.value = $formValue(argumentCollection=arguments); - loc.returnValue = ""; - loc.firstDone = false; - loc.iEnd = ListLen(arguments.order); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.item = ListGetAt(arguments.order, loc.i); - arguments.name = loc.name & "($" & loc.item & ")"; - if (Len(loc.value)) - if (Isdate(loc.value)) - arguments.value = Evaluate("#loc.item#(loc.value)"); - else - arguments.value = loc.value; - else - arguments.value = ""; - if (loc.firstDone) - loc.returnValue = loc.returnValue & arguments.separator; - loc.returnValue = loc.returnValue & Evaluate("$#loc.item#SelectTag(argumentCollection=arguments)"); - loc.firstDone = true; - } - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="$yearMonthHourMinuteSecondSelectTag" returntype="string" access="public" output="false"> - <cfargument name="name" type="string" required="true"> - <cfargument name="value" type="string" required="true"> - <cfargument name="includeBlank" type="any" required="true"> - <cfargument name="label" type="string" required="true"> - <cfargument name="labelPlacement" type="string" required="true"> - <cfargument name="prepend" type="string" required="true"> - <cfargument name="append" type="string" required="true"> - <cfargument name="prependToLabel" type="string" required="true"> - <cfargument name="appendToLabel" type="string" required="true"> - <cfargument name="errorElement" type="string" required="false" default=""> - <cfargument name="$type" type="string" required="true"> - <cfargument name="$loopFrom" type="numeric" required="true"> - <cfargument name="$loopTo" type="numeric" required="true"> - <cfargument name="$id" type="string" required="true"> - <cfargument name="$step" type="numeric" required="true"> - <cfargument name="$optionNames" type="string" required="false" default=""> - <cfscript> - var loc = {}; - if (!Len(arguments.value) && (!IsBoolean(arguments.includeBlank) || !arguments.includeBlank)) - arguments.value = Evaluate("#arguments.$type#(Now())"); - arguments.$appendToFor = arguments.$type; - if (StructKeyExists(arguments, "order") && ListLen(arguments.order) > 1 && ListLen(arguments.label) > 1) - arguments.label = ListGetAt(arguments.label, ListFindNoCase(arguments.order, arguments.$type)); - loc.before = $formBeforeElement(argumentCollection=arguments); - loc.after = $formAfterElement(argumentCollection=arguments); - loc.content = ""; - if (!IsBoolean(arguments.includeBlank) || arguments.includeBlank) - { - loc.args = {}; - loc.args.value = ""; - if (!IsBoolean(arguments.includeBlank)) - loc.optionContent = arguments.includeBlank; - else - loc.optionContent = ""; - loc.content = loc.content & $element(name="option", content=loc.optionContent, attributes=loc.args); - } - for (loc.i=arguments.$loopFrom; loc.i <= arguments.$loopTo; loc.i=loc.i+arguments.$step) - { - loc.args = {}; - loc.args.value = loc.i; - if (arguments.value == loc.i) - loc.args.selected = "selected"; - if (Len(arguments.$optionNames)) - loc.optionContent = ListGetAt(arguments.$optionNames, loc.i); - else - loc.optionContent = loc.i; - if (arguments.$type == "minute" || arguments.$type == "second") - loc.optionContent = NumberFormat(loc.optionContent, "09"); - loc.content = loc.content & $element(name="option", content=loc.optionContent, attributes=loc.args); - } - if (!StructKeyExists(arguments, "id")) - arguments.id = arguments.$id & "-" & arguments.$type; - loc.returnValue = loc.before & $element(name="select", skip="objectName,property,label,labelPlacement,prepend,append,prependToLabel,appendToLabel,errorElement,value,includeBlank,order,separator,startYear,endYear,monthDisplay,dateSeparator,dateOrder,timeSeparator,timeOrder,minuteStep", skipStartingWith="label", content=loc.content, attributes=arguments) & loc.after; - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="$optionsForSelect" returntype="string" access="public" output="false"> - <cfargument name="options" type="any" required="true"> - <cfargument name="valueField" type="string" required="true"> - <cfargument name="textField" type="string" required="true"> - <cfscript> - var loc = {}; - loc.value = $formValue(argumentCollection=arguments); - loc.returnValue = ""; - if (IsQuery(arguments.options)) - { - if (!Len(arguments.valueField) || !Len(arguments.textField)) - { - // order the columns according to their ordinal position in the database table - loc.info = GetMetaData(arguments.options); - loc.iEnd = ArrayLen(loc.info); - loc.columns = ""; - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - loc.columns = ListAppend(loc.columns, loc.info[loc.i].name); - if (ListLen(loc.columns) == 1) - { - arguments.valueField = ListGetAt(loc.columns, 1); - arguments.textField = ListGetAt(loc.columns, 1); - } - else - { - // take the first numeric field in the query as the value field and the first non numeric as the text field - loc.iEnd = arguments.options.RecordCount; - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.jEnd = ListLen(loc.columns); - for (loc.j=1; loc.j <= loc.jEnd; loc.j++) - { - if (!Len(arguments.valueField) && IsNumeric(arguments.options[ListGetAt(loc.columns, loc.j)][loc.i])) - arguments.valueField = ListGetAt(loc.columns, loc.j); - if (!Len(arguments.textField) && !IsNumeric(arguments.options[ListGetAt(loc.columns, loc.j)][loc.i])) - arguments.textField = ListGetAt(loc.columns, loc.j); - } - } - if (!Len(arguments.valueField) || !Len(arguments.textField)) - { - // the query does not contain both a numeric and a text column so we'll just use the first and second column instead - arguments.valueField = ListGetAt(loc.columns, 1); - arguments.textField = ListGetAt(loc.columns, 2); - } - } - } - loc.iEnd = arguments.options.RecordCount; - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.returnValue = loc.returnValue & $option(objectValue=loc.value, optionValue=arguments.options[arguments.valueField][loc.i], optionText=arguments.options[arguments.textField][loc.i]); - } - } - else if (IsStruct(arguments.options)) - { - loc.sortedKeys = ListSort(StructKeyList(arguments.options), "textnocase"); // sort struct keys alphabetically - loc.iEnd = ListLen(loc.sortedKeys); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.key = ListGetAt(loc.sortedKeys, loc.i); - loc.returnValue = loc.returnValue & $option(objectValue=loc.value, optionValue=LCase(loc.key), optionText=arguments.options[loc.key]); - } - } - else - { - // convert the options to an array so we don't duplicate logic - if (IsSimpleValue(arguments.options)) - arguments.options = ListToArray(arguments.options); - - // loop through the array - loc.iEnd = ArrayLen(arguments.options); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.optionValue = ""; - loc.optionText = ""; - // see if the value in the array cell is an array, which means the programmer is using multidimensional arrays. if it is, use the first dimension for the key and the second for the value if it exists. - if (IsSimpleValue(arguments.options[loc.i])) - { - loc.optionValue = arguments.options[loc.i]; - loc.optionText = humanize(arguments.options[loc.i]); - } - else if (IsArray(arguments.options[loc.i]) && ArrayLen(arguments.options[loc.i]) >= 2) - { - loc.optionValue = arguments.options[loc.i][1]; - loc.optionText = arguments.options[loc.i][2]; - } - loc.returnValue = loc.returnValue & $option(objectValue=loc.value, optionValue=loc.optionValue, optionText=loc.optionText); - } - } - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - -<cffunction name="$option" returntype="string" access="public" output="false"> - <cfargument name="objectValue" type="string" required="true"> - <cfargument name="optionValue" type="string" required="true"> - <cfargument name="optionText" type="string" required="true"> - <cfscript> - var loc = {}; - loc.optionAttributes = {value=arguments.optionValue}; - if (arguments.optionValue == arguments.objectValue || ListFindNoCase(arguments.objectValue, arguments.optionValue)) - loc.optionAttributes.selected = "selected"; - if (application.wheels.obfuscateUrls && StructKeyExists(request.wheels, "currentFormMethod") && request.wheels.currentFormMethod == "get") - loc.optionAttributes.value = obfuscateParam(loc.optionAttributes.value); - loc.returnValue = $element(name="option", content=arguments.optionText, attributes=loc.optionAttributes); - </cfscript> - <cfreturn loc.returnValue> -</cffunction> - <cffunction name="$formValue" returntype="string" access="public" output="false"> <cfargument name="objectName" type="any" required="true"> <cfargument name="property" type="string" required="true"> wheels/view/forms.cfm @@ -2,6 +2,11 @@ <cfinclude template="dates.cfm"> <cfinclude template="errors.cfm"> <cfinclude template="forms.cfm"> +<cfinclude template="formsdate.cfm"> +<cfinclude template="formsdateobject.cfm"> +<cfinclude template="formsdateplain.cfm"> +<cfinclude template="formsobject.cfm"> +<cfinclude template="formsplain.cfm"> <cfinclude template="media.cfm"> <cfinclude template="miscellaneous.cfm"> <cfinclude template="text.cfm"> wheels/view/functions.cfm @@ -1,5 +1,4 @@ -<cffunction name="styleSheetLinkTag" returntype="string" access="public" output="false" - hint="Returns a `link` tag based on the supplied arguments." +<cffunction name="styleSheetLinkTag" returntype="string" access="public" output="false" hint="Returns a `link` tag for a stylesheet (or several) based on the supplied arguments." examples= ' <!--- view code ---> @@ -8,9 +7,9 @@ </head> ' categories="view-helper" chapters="miscellaneous-helpers" functions="javaScriptIncludeTag,imageTag"> - <cfargument name="sources" type="string" required="false" default="" hint="The name of one or many CSS files in the `stylesheets` folder, minus the `.css` extension. (Can also be called with the `source` argument)"> - <cfargument name="type" type="string" required="false" default="#application.wheels.functions.styleSheetLinkTag.type#" hint="The `type` attribute for the `link` tag"> - <cfargument name="media" type="string" required="false" default="#application.wheels.functions.styleSheetLinkTag.media#" hint="The `media` attribute for the `link` tag"> + <cfargument name="sources" type="string" required="false" default="" hint="The name of one or many CSS files in the `stylesheets` folder, minus the `.css` extension. (Can also be called with the `source` argument)."> + <cfargument name="type" type="string" required="false" default="#application.wheels.functions.styleSheetLinkTag.type#" hint="The `type` attribute for the `link` tag."> + <cfargument name="media" type="string" required="false" default="#application.wheels.functions.styleSheetLinkTag.media#" hint="The `media` attribute for the `link` tag."> <cfscript> var loc = {}; if (StructKeyExists(arguments, "source")) @@ -31,8 +30,7 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="javaScriptIncludeTag" returntype="string" access="public" output="false" - hint="Returns a `script` tag based on the supplied arguments." +<cffunction name="javaScriptIncludeTag" returntype="string" access="public" output="false" hint="Returns a `script` tag for a Javascript file (or several) tag based on the supplied arguments." examples= ' <!--- view code ---> @@ -41,8 +39,8 @@ </head> ' categories="view-helper" chapters="miscellaneous-helpers" functions="styleSheetLinkTag,imageTag"> - <cfargument name="sources" type="string" required="false" default="" hint="The name of one or many JavaScript files in the `javascripts` folder, minus the `.js` extension. (Can also be called with the `source` argument)"> - <cfargument name="type" type="string" required="false" default="#application.wheels.functions.javaScriptIncludeTag.type#" hint="The `type` attribute for the `script` tag"> + <cfargument name="sources" type="string" required="false" default="" hint="The name of one or many JavaScript files in the `javascripts` folder, minus the `.js` extension. (Can also be called with the `source` argument)."> + <cfargument name="type" type="string" required="false" default="#application.wheels.functions.javaScriptIncludeTag.type#" hint="The `type` attribute for the `script` tag."> <cfscript> var loc = {}; if (StructKeyExists(arguments, "source")) @@ -62,14 +60,13 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="imageTag" returntype="string" access="public" output="false" - hint="Returns an image tag and will (if the image is stored in the local `images` folder) set the `width`, `height`, and `alt` attributes automatically for you." +<cffunction name="imageTag" returntype="string" access="public" output="false" hint="Returns an `img` tag and will (if the image is stored in the local `images` folder) set the `width`, `height`, and `alt` attributes automatically for you." examples= ' ##imageTag("logo.png")## ' categories="view-helper" chapters="miscellaneous-helpers" functions="javaScriptIncludeTag,styleSheetLinkTag"> - <cfargument name="source" type="string" required="true" hint="Image file name if local or full URL if remote"> + <cfargument name="source" type="string" required="true" hint="Image file name if local or full URL if remote."> <cfscript> var loc = {}; $insertDefaults(name="imageTag", reserved="src", input=arguments); wheels/view/media.cfm @@ -1,5 +1,4 @@ -<cffunction name="cycle" returntype="string" access="public" output="false" - hint="Cycles through list values every time it is called." +<cffunction name="cycle" returntype="string" access="public" output="false" hint="Cycles through list values every time it is called." examples= ' <!--- alternating table row colors ---> @@ -30,8 +29,8 @@ </cfoutput> ' categories="view-helper" functions="resetCycle"> - <cfargument name="values" type="string" required="true" hint="List of values to cycle through"> - <cfargument name="name" type="string" required="false" default="default" hint="Name to give the cycle. Useful when you use multiple cycles on a page"> + <cfargument name="values" type="string" required="true" hint="List of values to cycle through."> + <cfargument name="name" type="string" required="false" default="default" hint="Name to give the cycle. Useful when you use multiple cycles on a page."> <cfscript> var loc = {}; if (!StructKeyExists(request.wheels, "cycle")) @@ -52,8 +51,7 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="resetCycle" returntype="void" access="public" output="false" - hint="Resets a cycle so that it starts from the first list value the next time it is called." +<cffunction name="resetCycle" returntype="void" access="public" output="false" hint="Resets a cycle so that it starts from the first list value the next time it is called." examples= ' <!--- alternating row colors and shrinking emphasis ---> @@ -71,7 +69,7 @@ ' categories="view-helper" functions="cycle" > - <cfargument name="name" type="string" required="false" default="default" hint="The name of the cycle to reset"> + <cfargument name="name" type="string" required="false" default="default" hint="The name of the cycle to reset."> <cfscript> if (StructKeyExists(request.wheels, "cycle") && StructKeyExists(request.wheels.cycle, arguments.name)) StructDelete(request.wheels.cycle, arguments.name); wheels/view/miscellaneous.cfm @@ -1,15 +1,14 @@ -<cffunction name="excerpt" returntype="string" access="public" output="false" - hint="Extracts an excerpt from text that matches the first instance of phrase." +<cffunction name="excerpt" returntype="string" access="public" output="false" hint="Extracts an excerpt from text that matches the first instance of phrase." examples= ' ##excerpt(text="ColdFusion Wheels is a Rails-like MVC framework for Adobe ColdFusion and Railo", phrase="framework", radius=5)## -> ... MVC framework for ... ' categories="view-helper" functions="highlight,simpleFormat,stripLinks,stripTags,titleize,truncate"> - <cfargument name="text" type="string" required="true" hint="The text to extract an excerpt from"> - <cfargument name="phrase" type="string" required="true" hint="The phrase to extract"> - <cfargument name="radius" type="numeric" required="false" default="100" hint="Number of characters to extract surrounding the phrase"> - <cfargument name="excerptString" type="string" required="false" default="..." hint="String to replace first and/or last characters with"> + <cfargument name="text" type="string" required="true" hint="The text to extract an excerpt from."> + <cfargument name="phrase" type="string" required="true" hint="The phrase to extract."> + <cfargument name="radius" type="numeric" required="false" default="100" hint="Number of characters to extract surrounding the phrase."> + <cfargument name="excerptString" type="string" required="false" default="..." hint="String to replace first and/or last characters with."> <cfscript> var loc = {}; loc.pos = FindNoCase(arguments.phrase, arguments.text, 1); @@ -45,17 +44,16 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="highlight" returntype="string" access="public" output="false" - hint="Highlights the phrase(s) everywhere in the text if found by wrapping it in a span tag." +<cffunction name="highlight" returntype="string" access="public" output="false" hint="Highlights the phrase(s) everywhere in the text if found by wrapping it in a `span` tag." examples= ' ##highlight(text="You searched for: Wheels", phrases="Wheels")## -> You searched for: <span class="highlight">Wheels</span> ' categories="view-helper" functions="excerpt,simpleFormat,stripLinks,stripTags,titleize,truncate"> - <cfargument name="text" type="string" required="true" hint="Text to search"> - <cfargument name="phrases" type="string" required="true" hint="List of phrases to highlight"> - <cfargument name="class" type="string" required="false" default="highlight" hint="Class to use in `span` tags surrounding highlighted phrase(s)"> + <cfargument name="text" type="string" required="true" hint="Text to search."> + <cfargument name="phrases" type="string" required="true" hint="List of phrases to highlight."> + <cfargument name="class" type="string" required="false" default="highlight" hint="Class to use in `span` tags surrounding highlighted phrase(s)."> <cfscript> var loc = {}; if (!Len(arguments.text) || !Len(arguments.phrases)) @@ -91,8 +89,7 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="simpleFormat" returntype="string" access="public" output="false" - hint="Replaces single newline characters with HTML break tags and double newline characters with HTML paragraph tags (properly closed to comply with XHTML standards)." +<cffunction name="simpleFormat" returntype="string" access="public" output="false" hint="Replaces single newline characters with HTML break tags and double newline characters with HTML paragraph tags (properly closed to comply with XHTML standards)." examples= ' <!--- how most of your calls will look ---> @@ -117,8 +114,8 @@ </p> ' categories="view-helper" functions="excerpt,highlight,stripLinks,stripTags,titleize,truncate"> - <cfargument name="text" type="string" required="true" hint="The text to format"> - <cfargument name="wrap" type="boolean" required="false" default="true" hint="Set to true to wrap the result in a paragraph"> + <cfargument name="text" type="string" required="true" hint="The text to format."> + <cfargument name="wrap" type="boolean" required="false" default="true" hint="Set to `true` to wrap the result in a paragraph."> <cfscript> var loc = {}; loc.returnValue = Trim(arguments.text); @@ -131,42 +128,39 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="stripLinks" returntype="string" access="public" output="false" - hint="Removes all links from an HTML string, leaving just the link text." +<cffunction name="stripLinks" returntype="string" access="public" output="false" hint="Removes all links from an HTML string, leaving just the link text." examples= ' ##stripLinks("<strong>Wheels</strong> is a framework for <a href="http://www.adobe.com/products/coldfusion/">ColdFusion</a>.")## -> <strong>Wheels</strong> is a framework for ColdFusion. ' categories="view-helper" functions="excerpt,highlight,simpleFormat,stripTags,titleize,truncate"> - <cfargument name="html" type="string" required="true" hint="The html to remove links from"> + <cfargument name="html" type="string" required="true" hint="The html to remove links from."> <cfreturn REReplaceNoCase(arguments.html, "<a.*?>(.*?)</a>", "\1" , "all")> </cffunction> -<cffunction name="stripTags" returntype="string" access="public" output="false" - hint="Removes all HTML tags from a string." +<cffunction name="stripTags" returntype="string" access="public" output="false" hint="Removes all HTML tags from a string." examples= ' ##stripTags("<strong>Wheels</strong> is a framework for <a href="http://www.adobe.com/products/coldfusion/">ColdFusion</a>.")## -> Wheels is a framework for ColdFusion. ' categories="view-helper" functions="excerpt,highlight,simpleFormat,stripLinks,titleize,truncate"> - <cfargument name="html" type="string" required="true" hint="The HTML to remove links from"> + <cfargument name="html" type="string" required="true" hint="The HTML to remove links from."> <cfset var returnValue = ""> <cfset returnValue = REReplaceNoCase(arguments.html, "<\ *[a-z].*?>", "", "all")> <cfset returnValue = REReplaceNoCase(returnValue, "<\ */\ *[a-z].*?>", "", "all")> <cfreturn returnValue> </cffunction> -<cffunction name="titleize" returntype="string" access="public" output="false" - hint="Capitalizes all words in the text to create a nicer looking title." +<cffunction name="titleize" returntype="string" access="public" output="false" hint="Capitalizes all words in the text to create a nicer looking title." examples= ' ##titleize("Wheels is a framework for ColdFusion")## -> Wheels Is A Framework For ColdFusion ' categories="view-helper" functions="excerpt,highlight,simpleFormat,stripLinks,stripTags,truncate"> - <cfargument name="word" type="string" required="true" hint="The text to turn into a title"> + <cfargument name="word" type="string" required="true" hint="The text to turn into a title."> <cfscript> var loc = {}; loc.returnValue = ""; @@ -179,8 +173,7 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="truncate" returntype="string" access="public" output="false" - hint="Truncates text to the specified length and replaces the last characters with the specified truncate string. (Defaults to '...')" +<cffunction name="truncate" returntype="string" access="public" output="false" hint="Truncates text to the specified length and replaces the last characters with the specified truncate string. (Defaults to ""..."")." examples= ' ##truncate(text="Wheels is a framework for ColdFusion", length=20)## @@ -190,9 +183,9 @@ -> Wheels is a framework f (more) ' categories="view-helper" functions="excerpt,highlight,simpleFormat,stripLinks,stripTags,titleize"> - <cfargument name="text" type="string" required="true" hint="The text to truncate"> - <cfargument name="length" type="numeric" required="false" default="30" hint="Length to truncate the text to"> - <cfargument name="truncateString" type="string" required="false" default="..." hint="String to replace the last characters with"> + <cfargument name="text" type="string" required="true" hint="The text to truncate."> + <cfargument name="length" type="numeric" required="false" default="30" hint="Length to truncate the text to."> + <cfargument name="truncateString" type="string" required="false" default="..." hint="String to replace the last characters with."> <cfscript> var loc = {}; if (Len(arguments.text) > arguments.length) wheels/view/text.cfm @@ -1,5 +1,4 @@ -<cffunction name="linkTo" returntype="string" access="public" output="false" - hint="Creates a link to another page in your application. Pass in a route name to use your configured routes or a controller/action/key combination." +<cffunction name="linkTo" returntype="string" access="public" output="false" hint="Creates a link to another page in your application. Pass in the name of a `route` to use your configured routes or a `controller`/`action`/`key` combination." examples= ' ##linkTo(text="Log Out", controller="account", action="logout")## @@ -20,18 +19,18 @@ -> <a href="/user/joe">Joe''s Profile</a> ' categories="view-helper" chapters="linking-pages" functions="URLFor,buttonTo,mailTo"> - <cfargument name="text" type="string" required="false" default="" hint="The text content of the link"> - <cfargument name="confirm" type="string" required="false" default="" hint="Pass a message here to cause a JavaScript confirmation dialog box to pop up containing the message"> - <cfargument name="route" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="controller" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="action" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="key" type="any" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="params" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="anchor" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.linkTo.onlyPath#" hint="See documentation for @URLFor"> - <cfargument name="host" type="string" required="false" default="#application.wheels.functions.linkTo.host#" hint="See documentation for @URLFor"> - <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.linkTo.protocol#" hint="See documentation for @URLFor"> - <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.linkTo.port#" hint="See documentation for @URLFor"> + <cfargument name="text" type="string" required="false" default="" hint="The text content of the link."> + <cfargument name="confirm" type="string" required="false" default="" hint="Pass a message here to cause a JavaScript confirmation dialog box to pop up containing the message."> + <cfargument name="route" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="controller" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="action" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="key" type="any" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="params" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="anchor" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.linkTo.onlyPath#" hint="See documentation for @URLFor."> + <cfargument name="host" type="string" required="false" default="#application.wheels.functions.linkTo.host#" hint="See documentation for @URLFor."> + <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.linkTo.protocol#" hint="See documentation for @URLFor."> + <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.linkTo.port#" hint="See documentation for @URLFor."> <cfscript> var loc = {}; $insertDefaults(name="linkTo", reserved="href", input=arguments); @@ -52,27 +51,26 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="buttonTo" returntype="string" access="public" output="false" - hint="Creates a form containing a single button that submits to the URL. The URL is built the same way as the `linkTo` function." +<cffunction name="buttonTo" returntype="string" access="public" output="false" hint="Creates a form containing a single button that submits to the URL. The URL is built the same way as the @linkTo function." examples= ' ##buttonTo(text="Delete Account", action="perFormDelete", disabled="Wait...")## ' categories="view-helper" functions="URLFor,linkTo,mailTo"> - <cfargument name="text" type="string" required="false" default="#application.wheels.functions.buttonTo.text#" hint="The text content of the button"> - <cfargument name="confirm" type="string" required="false" default="#application.wheels.functions.buttonTo.confirm#" hint="See documentation for @linkTo"> - <cfargument name="image" type="string" required="false" default="#application.wheels.functions.buttonTo.image#" hint="If you want to use an image for the button pass in the link to it here (relative from the `images` folder)"> - <cfargument name="disable" type="any" required="false" default="#application.wheels.functions.buttonTo.disable#" hint="Pass in `true` if you want the button to be disabled when clicked (can help prevent multiple clicks), or pass in a string if you want the button disabled and the text on the button updated (to 'please wait...', for example)"> - <cfargument name="route" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="controller" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="action" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="key" type="any" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="params" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="anchor" type="string" required="false" default="" hint="See documentation for @URLFor"> - <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.buttonTo.onlyPath#" hint="See documentation for @URLFor"> - <cfargument name="host" type="string" required="false" default="#application.wheels.functions.buttonTo.host#" hint="See documentation for @URLFor"> - <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.buttonTo.protocol#" hint="See documentation for @URLFor"> - <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.buttonTo.port#" hint="See documentation for @URLFor"> + <cfargument name="text" type="string" required="false" default="#application.wheels.functions.buttonTo.text#" hint="The text content of the button."> + <cfargument name="confirm" type="string" required="false" default="#application.wheels.functions.buttonTo.confirm#" hint="See documentation for @linkTo."> + <cfargument name="image" type="string" required="false" default="#application.wheels.functions.buttonTo.image#" hint="If you want to use an image for the button pass in the link to it here (relative from the `images` folder)."> + <cfargument name="disable" type="any" required="false" default="#application.wheels.functions.buttonTo.disable#" hint="Pass in `true` if you want the button to be disabled when clicked (can help prevent multiple clicks), or pass in a string if you want the button disabled and the text on the button updated (to ""please wait..."", for example)."> + <cfargument name="route" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="controller" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="action" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="key" type="any" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="params" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="anchor" type="string" required="false" default="" hint="See documentation for @URLFor."> + <cfargument name="onlyPath" type="boolean" required="false" default="#application.wheels.functions.buttonTo.onlyPath#" hint="See documentation for @URLFor."> + <cfargument name="host" type="string" required="false" default="#application.wheels.functions.buttonTo.host#" hint="See documentation for @URLFor."> + <cfargument name="protocol" type="string" required="false" default="#application.wheels.functions.buttonTo.protocol#" hint="See documentation for @URLFor."> + <cfargument name="port" type="numeric" required="false" default="#application.wheels.functions.buttonTo.port#" hint="See documentation for @URLFor."> <cfscript> var loc = {}; $insertDefaults(name="buttonTo", reserved="method", input=arguments); @@ -93,17 +91,16 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="mailTo" returntype="string" access="public" output="false" - hint="Creates a mailto link tag to the specified email address, which is also used as the name of the link unless name is specified." +<cffunction name="mailTo" returntype="string" access="public" output="false" hint="Creates a `mailto` link tag to the specified email address, which is also used as the name of the link unless name is specified." examples= ' ##mailTo(emailAddress="webmaster@yourdomain.com", name="Contact our Webmaster")## -> <a href="mailto:webmaster@yourdomain.com">Contact our Webmaster</a> ' categories="view-helper" functions="URLFor,linkTo,buttonTo"> - <cfargument name="emailAddress" type="string" required="true" hint="The email address to link to"> - <cfargument name="name" type="string" required="false" default="" hint="A string to use as the link text ('Joe' or 'Support Department', for example)"> - <cfargument name="encode" type="boolean" required="false" default="#application.wheels.functions.mailTo.encode#" hint="Pass `true` here to encode the email address, making it harder for bots to harvest it"> + <cfargument name="emailAddress" type="string" required="true" hint="The email address to link to."> + <cfargument name="name" type="string" required="false" default="" hint="A string to use as the link text (""Joe"" or ""Support Department"", for example)."> + <cfargument name="encode" type="boolean" required="false" default="#application.wheels.functions.mailTo.encode#" hint="Pass `true` here to encode the email address, making it harder for bots to harvest it for example."> <cfscript> var loc = {}; $insertDefaults(name="mailTo", reserved="href", input=arguments); @@ -129,8 +126,7 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="autoLink" returntype="string" access="public" output="false" - hint="Turns all URLs and e-mail addresses into clickable links." +<cffunction name="autoLink" returntype="string" access="public" output="false" hint="Turns all URLs and e-mail addresses into clickable links." examples= ' ##autoLink("Download Wheels from http://cfwheels.org/download")## @@ -140,8 +136,8 @@ -> Email us at <a href="mailto:info@cfwheels.org">info@cfwheels.org</a> ' categories="view-helper"> - <cfargument name="text" type="string" required="true" hint="The text to create links in"> - <cfargument name="link" type="string" required="false" default="all" hint="Whether to link URLs, email addresses or both. Possible values are: `all` (default), `URLs` and `emailAddresses`"> + <cfargument name="text" type="string" required="true" hint="The text to create links in."> + <cfargument name="link" type="string" required="false" default="all" hint="Whether to link URLs, email addresses or both. Possible values are: `all` (default), `URLs` and `emailAddresses`."> <cfscript> var loc = {}; loc.urlRegex = "(?ix)([^(url=)|(href=)'""])(((https?)://([^:]+\:[^@]*@)?)([\d\w\-]+\.)?[\w\d\-\.]+\.(com|net|org|info|biz|tv|co\.uk|de|ro|it)(( / [\w\d\.\-@%\\\/:]* )+)?(\?[\w\d\?%,\.\/\##!@:=\+~_\-&amp;]*(?<![\.]))?)"; @@ -155,16 +151,15 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="pagination" returntype="struct" access="public" output="false" - hint="Returns a struct with information about the specificed paginated query. The available variables are `currentPage`, `totalPages` and `totalRecords`." +<cffunction name="pagination" returntype="struct" access="public" output="false" hint="Returns a struct with information about the specificed paginated query. The available variables are `currentPage`, `totalPages` and `totalRecords`." examples= ' <cfparam name="params.page" default="1"> - <cfset allAuthors = model("author").findAll(page=params.page, perPage=25, order="lastName", handle="authors_data")> - <cfset pageination_data = pagination("authors_data")> + <cfset allAuthors = model("author").findAll(page=params.page, perPage=25, order="lastName", handle="authorsData")> + <cfset paginationData = pagination("authorsData")> ' categories="view-helper"> - <cfargument name="handle" type="string" required="false" default="query" hint="The handle given to the query to return pagination information for"> + <cfargument name="handle" type="string" required="false" default="query" hint="The handle given to the query to return pagination information for."> <cfscript> if (application.wheels.showErrorInformation) { @@ -177,8 +172,7 @@ <cfreturn request.wheels[arguments.handle]> </cffunction> -<cffunction name="paginationLinks" returntype="string" access="public" output="false" - hint="Builds and returns a string containing links to pages based on a paginated query. Uses `linkTo` internally to build the link, so you need to pass in a route name, controller/action/key combination. All other `linkTo` arguments can be supplied as well, in which case they are passed through directly to `linkTo`. If you have paginated more than one query in the controller, you can use the `handle` argument to reference them. (Don't forget to pass in a `handle` to the `findAll` function in your controller first)" +<cffunction name="paginationLinks" returntype="string" access="public" output="false" hint="Builds and returns a string containing links to pages based on a paginated query. Uses @linkTo internally to build the link, so you need to pass in a `route` name or a `controller`/`action`/`key` combination. All other @linkTo arguments can be supplied as well, in which case they are passed through directly to @linkTo. If you have paginated more than one query in the controller, you can use the `handle` argument to reference them. (Don't forget to pass in a `handle` to the @findAll function in your controller first)." examples= ' <!--- controller code ---> @@ -220,20 +214,20 @@ </ul> ' categories="view-helper" chapters="getting-paginated-data,displaying-links-for-pagination" functions="linkTo,findAll,URLFor"> - <cfargument name="windowSize" type="numeric" required="false" default="#application.wheels.functions.paginationLinks.windowSize#" hint="The number of page links to show around the current page"> - <cfargument name="alwaysShowAnchors" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.alwaysShowAnchors#" hint="Whether or not links to the first and last page should always be displayed"> - <cfargument name="anchorDivider" type="string" required="false" default="#application.wheels.functions.paginationLinks.anchorDivider#" hint="String to place next to the anchors on either side of the list"> - <cfargument name="linkToCurrentPage" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.linkToCurrentPage#" hint="Whether or not the current page should be linked to"> - <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.paginationLinks.prepend#" hint="String or HTML to be prepended before result"> - <cfargument name="append" type="string" required="false" default="#application.wheels.functions.paginationLinks.append#" hint="String or HTML to be appended after result"> - <cfargument name="prependToPage" type="string" required="false" default="#application.wheels.functions.paginationLinks.prependToPage#" hint="String or HTML to be prepended before each page number"> - <cfargument name="prependOnFirst" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.prependOnFirst#" hint="Whether or not to prepend the `prependToPage` string on the first page in the list"> - <cfargument name="appendToPage" type="string" required="false" default="#application.wheels.functions.paginationLinks.appendToPage#" hint="String or HTML to be appended after each page number"> - <cfargument name="appendOnLast" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.appendOnLast#" hint="Whether or not to append the `appendToPage` string on the last page in the list"> - <cfargument name="classForCurrent" type="string" required="false" default="#application.wheels.functions.paginationLinks.classForCurrent#" hint="Class name for the current page number (if `linkToCurrentPage` is `true`, the class name will go on the `a` element. If not, a `span` element will be used)"> - <cfargument name="handle" type="string" required="false" default="query" hint="The handle given to the query that the pagination links should be displayed for"> - <cfargument name="name" type="string" required="false" default="#application.wheels.functions.paginationLinks.name#" hint="The name of the param that holds the current page number"> - <cfargument name="showSinglePage" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.showSinglePage#" hint="Will show a single page when set to `true`. (The default behavior is to return an empty string when there is only one page in the pagination)"> + <cfargument name="windowSize" type="numeric" required="false" default="#application.wheels.functions.paginationLinks.windowSize#" hint="The number of page links to show around the current page."> + <cfargument name="alwaysShowAnchors" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.alwaysShowAnchors#" hint="Whether or not links to the first and last page should always be displayed."> + <cfargument name="anchorDivider" type="string" required="false" default="#application.wheels.functions.paginationLinks.anchorDivider#" hint="String to place next to the anchors on either side of the list."> + <cfargument name="linkToCurrentPage" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.linkToCurrentPage#" hint="Whether or not the current page should be linked to."> + <cfargument name="prepend" type="string" required="false" default="#application.wheels.functions.paginationLinks.prepend#" hint="String or HTML to be prepended before result."> + <cfargument name="append" type="string" required="false" default="#application.wheels.functions.paginationLinks.append#" hint="String or HTML to be appended after result."> + <cfargument name="prependToPage" type="string" required="false" default="#application.wheels.functions.paginationLinks.prependToPage#" hint="String or HTML to be prepended before each page number."> + <cfargument name="prependOnFirst" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.prependOnFirst#" hint="Whether or not to prepend the `prependToPage` string on the first page in the list."> + <cfargument name="appendToPage" type="string" required="false" default="#application.wheels.functions.paginationLinks.appendToPage#" hint="String or HTML to be appended after each page number."> + <cfargument name="appendOnLast" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.appendOnLast#" hint="Whether or not to append the `appendToPage` string on the last page in the list."> + <cfargument name="classForCurrent" type="string" required="false" default="#application.wheels.functions.paginationLinks.classForCurrent#" hint="Class name for the current page number (if `linkToCurrentPage` is `true`, the class name will go on the `a` element. If not, a `span` element will be used)."> + <cfargument name="handle" type="string" required="false" default="query" hint="The handle given to the query that the pagination links should be displayed for."> + <cfargument name="name" type="string" required="false" default="#application.wheels.functions.paginationLinks.name#" hint="The name of the param that holds the current page number."> + <cfargument name="showSinglePage" type="boolean" required="false" default="#application.wheels.functions.paginationLinks.showSinglePage#" hint="Will show a single page when set to `true`. (The default behavior is to return an empty string when there is only one page in the pagination)."> <cfscript> var loc = {}; wheels/view/urls.cfm 08c3db27279e98e7780b90da2cb31af89a657341 per.djurner per.djurner@d8ff095c-9719-0410-9cd3-1dd5d13d90f5 http://github.com/rip747/cfwheels/commit/179561f6f833a331ca86e341e178f9d7d9c52cc2 179561f6f833a331ca86e341e178f9d7d9c52cc2 2009-11-04T06:33:38-08:00 2009-11-04T06:33:38-08:00 Docs, syntax, file moves. git-svn-id: https://cfwheels.googlecode.com/svn/trunk@3648 d8ff095c-9719-0410-9cd3-1dd5d13d90f5 82db90424458d77578954ee717a5b07c76fdaa4f per.djurner per.djurner@d8ff095c-9719-0410-9cd3-1dd5d13d90f5