@@ -29,7 +29,7 @@ </cfscript> </cffunction> - + <cffunction name="$getCachableActions" returntype="array" access="public" output="false"> <cfreturn variables.wheels.cachableActions> wheels/controller/caching.cfm @@ -53,7 +53,7 @@ </cfscript> </cffunction> - + <cffunction name="$getBeforeFilters" returntype="array" access="public" output="false"> <cfreturn variables.wheels.beforeFilters> wheels/controller/filters.cfm @@ -1,4 +1,4 @@ - + <cffunction name="$initControllerClass" returntype="any" access="public" output="false"> <cfargument name="name" type="string" required="false" default=""> wheels/controller/initialization.cfm @@ -1,11 +1,27 @@  +<cffunction name="isAjax" returntype="boolean" access="public" output="false" hint="Returns whether the page was called from JavaScript or not." + examples= + ' + <cfset requestIsAjax = isAjax()> + ' + categories="controller-request,miscellaneous" chapters="" functions="isGet,isPost"> + <cfscript> + var returnValue = ""; + if (request.cgi.http_x_requested_with == "XMLHTTPRequest") + returnValue = true; + else + returnValue = false; + </cfscript> + <cfreturn returnValue> +</cffunction> + <cffunction name="isGet" returntype="boolean" access="public" output="false" hint="Returns whether the request was a normal (GET) request or not." examples= ' <cfset requestIsGet = isGet()> ' - categories="controller-request" chapters="" functions="isAjax,isPost"> + categories="controller-request,miscellaneous" chapters="" functions="isAjax,isPost"> <cfscript> var returnValue = ""; if (request.cgi.request_method == "get") @@ -21,7 +37,7 @@ ' <cfset requestIsPost = isPost()> ' - categories="controller-request" chapters="" functions="isAjax,isGet"> + categories="controller-request,miscellaneous" chapters="" functions="isAjax,isGet"> <cfscript> var returnValue = ""; if (request.cgi.request_method == "post") @@ -32,20 +48,25 @@ <cfreturn returnValue> </cffunction> -<cffunction name="isAjax" returntype="boolean" access="public" output="false" hint="Returns whether the page was called from JavaScript or not." +<cffunction name="pagination" returntype="struct" access="public" output="false" hint="Returns a struct with information about the specificed paginated query. The variables that will be returned are `currentPage`, `totalPages` and `totalRecords`." examples= ' - <cfset requestIsAjax = isAjax()> + <cfparam name="params.page" default="1"> + <cfset allAuthors = model("author").findAll(page=params.page, perPage=25, order="lastName", handle="authorsData")> + <cfset paginationData = pagination("authorsData")> ' - categories="controller-request" chapters="" functions="isGet,isPost"> + categories="controller-request,miscellaneous" chapters="getting-paginated-data,displaying-links-for-pagination" functions="paginationLinks,findAll"> + <cfargument name="handle" type="string" required="false" default="query" hint="The handle given to the query to return pagination information for."> <cfscript> - var returnValue = ""; - if (request.cgi.http_x_requested_with == "XMLHTTPRequest") - returnValue = true; - else - returnValue = false; + if (application.wheels.showErrorInformation) + { + if (!StructKeyExists(request.wheels, arguments.handle)) + { + $throw(type="Wheels.QueryHandleNotFound", message="Wheels couldn't find a query with the handle of `#arguments.handle#`.", extendedInfo="Make sure your `findAll` call has the `page` argument specified and matching `handle` argument if specified."); + } + } </cfscript> - <cfreturn returnValue> + <cfreturn request.wheels[arguments.handle]> </cffunction> <cffunction name="sendEmail" returntype="void" access="public" output="false" hint="Sends an email using a template and an optional layout to wrap it in." @@ -55,7 +76,7 @@ <cfset member = model("member").findByKey(newMember.id)> <cfset sendEmail(to=member.email, template="myemailtemplate", subject="Thank You for Becoming a Member", recipientName=member.name, startDate=member.startDate)> ' - categories="controller-request" chapters="sending-email" functions=""> + categories="controller-request,miscellaneous" chapters="sending-email" functions=""> <cfargument name="templates" type="string" required="false" default="" hint="The path to the email template or two paths if you want to send a multipart email. if the `detectMultipart` argument is `false` the template for the text version should be the first one in the list (can also be called with the `template` argument)."> <cfargument name="from" type="string" required="true" hint="Email address to send from."> <cfargument name="to" type="string" required="true" hint="Email address to send to."> @@ -141,7 +162,7 @@  <cfset sendFile(file="../../tutorials/wheels_tutorial_20081028_J657D6HX.pdf")> ' - categories="controller-request" chapters="sending-files" functions=""> + categories="controller-request,miscellaneous" chapters="sending-files" functions=""> <cfargument name="file" type="string" required="true" hint="The file to send to the user"> <cfargument name="name" type="string" required="false" default="" hint="The file name to show in the browser download dialog box"> <cfargument name="type" type="string" required="false" default="" hint="The HTTP content type to deliver the file as"> wheels/controller/miscellaneous.cfm @@ -17,7 +17,7 @@  <cfset redirectTo(back=true)> ' - categories="controller-request" chapters="redirecting-users,using-routes" functions=""> + categories="controller-request,miscellaneous" chapters="redirecting-users,using-routes" functions=""> <cfargument name="back" type="boolean" required="false" default="false" hint="Set to `true` to redirect back to the referring page."> <cfargument name="addToken" type="boolean" required="false" default="#application.wheels.functions.redirectTo.addToken#" hint="See documentation for `cflocation`."> <cfargument name="statusCode" type="numeric" required="false" default="#application.wheels.functions.redirectTo.statusCode#" hint="See documentation for `cflocation`."> wheels/controller/redirection.cfm @@ -9,7 +9,7 @@  <cfset renderPage(layout=false, cache=60)> ' - categories="controller-request" chapters="rendering-pages" functions="renderPageToString,renderNothing,renderText,renderPartial"> + categories="controller-request,rendering" chapters="rendering-pages" functions="renderNothing,renderText,renderPartial"> <cfargument name="controller" type="string" required="false" default="#variables.params.controller#" hint="Controller to include the view page for."> <cfargument name="action" type="string" required="false" default="#variables.params.action#" hint="Action to include the view page for."> <cfargument name="template" type="string" required="false" default="" hint="A specific template to render."> @@ -60,7 +60,7 @@  <cfset renderNothing()> ' - categories="controller-request" chapters="rendering-pages" functions="renderPage,renderPageToString,renderText,renderPartial"> + categories="controller-request,rendering" chapters="rendering-pages" functions="renderPage,renderText,renderPartial"> <cfscript> request.wheels.response = ""; </cfscript> @@ -72,7 +72,7 @@  <cfset renderText("Done!")> ' - categories="controller-request" chapters="rendering-pages" functions="renderPage,renderPageToString,renderNothing,renderPartial"> + categories="controller-request,rendering" chapters="rendering-pages" functions="renderPage,renderNothing,renderPartial"> <cfargument name="text" type="any" required="true" hint="The text to be rendered."> <cfscript> request.wheels.response = arguments.text; @@ -85,7 +85,7 @@  <cfset renderPartial("comment")> ' - categories="controller-request" chapters="rendering-pages" functions="renderPage,renderPageToString,renderNothing,renderText"> + categories="controller-request,rendering" chapters="rendering-pages" functions="renderPage,renderNothing,renderText"> <cfargument name="partial" type="string" required="true" hint="The name of the file to be used (starting with an optional path and with the underscore and file extension excluded)."> <cfargument name="cache" type="any" required="false" default="" hint="See documentation for @renderPage."> <cfargument name="layout" type="string" required="false" default="#application.wheels.functions.renderPartial.layout#" hint="See documentation for @renderPage."> @@ -103,7 +103,7 @@ </cfif> </cffunction> - + <cffunction name="$renderPageAndAddToCache" returntype="string" access="public" output="false"> <cfscript> wheels/controller/rendering.cfm @@ -1,4 +1,4 @@ - + <cffunction name="addRoute" returntype="void" access="public" output="false" hint="Adds a new route to your application." examples= @@ -165,7 +165,7 @@ </cfscript> </cffunction> - +  @@ -175,7 +175,7 @@  <cfset originalValue = deobfuscateParam("b7ab9a50")> ' - categories="global" chapters="obfuscating-urls" functions="obfuscateParam"> + categories="global,miscellaneous" chapters="obfuscating-urls" functions="obfuscateParam"> <cfargument name="param" type="string" required="true" hint="Value to deobfuscate."> <cfscript> var loc = {}; @@ -219,7 +219,7 @@  <cfset setting = get(functionName"validatesConfirmationOf", name="message")> ' - categories="global" chapters="configuration-and-defaults" functions="set"> + categories="global,miscellaneous" 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> @@ -238,7 +238,7 @@  <cfset authorObject = model("author").findByKey(1)> ' - categories="global" chapters="object-relational-mapping" functions=""> + categories="global,miscellaneous" 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> @@ -249,7 +249,7 @@  <cfset newValue = obfuscateParam(99)> ' - categories="global" chapters="obfuscating-urls" functions="deobfuscateParam"> + categories="global,miscellaneous" chapters="obfuscating-urls" functions="deobfuscateParam"> <cfargument name="param" type="any" required="true" hint="Value to obfuscate."> <cfscript> var loc = {}; @@ -278,7 +278,7 @@  </cfif> ' - categories="global" chapters="using-and-creating-plugins" functions=""> + categories="global,miscellaneous" chapters="using-and-creating-plugins" functions=""> <cfreturn StructKeyList(application.wheels.plugins)> </cffunction> @@ -291,7 +291,7 @@  ##URLFor(action="comments", anchor="comment10")## ' - categories="global" chapters="request-handling,linking-pages" functions="redirectTo,linkTo,startFormTag"> + categories="global,miscellaneous" 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."> @@ -420,7 +420,7 @@  ##capitalize("wheels is a framework")## ' - categories="global" chapters="miscellaneous-helpers" functions="humanize,pluralize,singularize"> + categories="global,string" 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> @@ -431,7 +431,7 @@  ##humanize("wheelsIsAFramework")## ' - categories="global" chapters="miscellaneous-helpers" functions="capitalize,pluralize,singularize"> + categories="global,string" chapters="miscellaneous-helpers" functions="capitalize,pluralize,singularize"> <cfargument name="text" type="string" required="true" hint="Text to humanize."> <cfscript> var loc = {}; @@ -451,7 +451,7 @@  Your search returned ##pluralize(word="person", count=users.recordCount)## ' - categories="global" chapters="miscellaneous-helpers" functions="capitalize,humanize,singularize"> + categories="global,string" 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`."> @@ -464,14 +464,14 @@  ##singularize("languages")## ' - categories="global" chapters="miscellaneous-helpers" functions="capitalize,humanize,pluralize"> + categories="global,string" 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> - + -<cffunction name="$singularizeOrPluralize" returntype="string" access="public" output="false"> +<cffunction name="$singularizeOrPluralize" returntype="string" access="public" output="false" hint="Called by singularize and pluralize to perform the conversion."> <cfargument name="text" type="string" required="true"> <cfargument name="which" type="string" required="true"> <cfargument name="count" type="numeric" required="false" default="-1"> wheels/global/public.cfm @@ -49,7 +49,7 @@ <cfset anOrder = aCustomer.newOrder(shipping=params.shipping)> ' categories="model-class,create" chapters="creating-records,associations" functions="create,hasMany,hasOne"> - <cfargument name="properties" type="struct" required="false" default="#StructNew()#" hint="The properties you want to set on the object (can also be passed in as named arguments instead)."> + <cfargument name="properties" type="struct" required="false" default="#StructNew()#" hint="The properties you want to set on the object (can also be passed in as named arguments)."> <cfargument name="defaults" type="boolean" required="false" default="#application.wheels.functions.new.defaults#" hint="See documentation for @save."> <cfscript> var loc = {}; @@ -401,7 +401,7 @@ <cfset aPost = model("post").findByKey(params.postId)> <cfset removedSuccessfully = aPost.removeAllComments()> ' - categories="model-class,read" chapters="updating-records,associations" functions="hasMany,update,updateByKey,updateOne"> + categories="model-class,update" chapters="updating-records,associations" functions="hasMany,update,updateByKey,updateOne"> <cfargument name="where" type="string" required="false" default="" hint="See documentation for @findAll."> <cfargument name="include" type="string" required="false" default="" hint="See documentation for @findAll."> <cfargument name="properties" type="struct" required="false" default="#StructNew()#" hint="See documentation for @new."> @@ -808,34 +808,6 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="key" returntype="string" access="public" output="false" hint="Returns the value of the primary key for the object. If you have a single primary key named `id` then `someObject.key()` is functionally equivalent to `someObject.id`. This method is more useful when you do dynamic programming and don't know the name of the primary key or when you use composite keys (in which case it's convenient to use this method to get a list of both key values returned)." - examples= - ' -  - <cfset anEmployee = model("employee").findByKey(params.key)> - <cfset val = anEmployee.key()> - ' - categories="model-object,miscellaneous" chapters="object-relational-mapping" functions=""> - <cfargument name="$persisted" type="boolean" required="false" default="false"> - <cfscript> - var loc = {}; - loc.returnValue = ""; - loc.iEnd = ListLen(variables.wheels.class.keys); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.property = ListGetAt(variables.wheels.class.keys, loc.i); - if (StructKeyExists(this, loc.property)) - { - if ($persisted && hasChanged(loc.property)) - loc.returnValue = ListAppend(loc.returnValue, changedFrom(loc.property)); - else - loc.returnValue = ListAppend(loc.returnValue, this[loc.property]); - } - } - </cfscript> - <cfreturn loc.returnValue> -</cffunction> -   wheels/model/crud.cfm @@ -9,7 +9,7 @@ <cfset dataSource("users_source")> </cffunction> ' - categories="model-initialization,general" chapters="object-relational-mapping" functions="columnNames,property,propertyNames,table,tableName"> + categories="model-initialization,miscellaneous" chapters="using-multiple-data-sources" functions=""> <cfargument name="datasource" type="string" required="true" hint="The data source name to connect to."> <cfargument name="username" type="string" required="false" default="" hint="The username for the data source."> <cfargument name="password" type="string" required="false" default="" hint="The password for the data source."> @@ -27,7 +27,7 @@ <cfset table("tbl_USERS")> </cffunction> ' - categories="model-initialization,general" chapters="object-relational-mapping" functions="columnNames,dataSource,property,propertyNames,tableName"> + categories="model-initialization,miscellaneous" chapters="object-relational-mapping" functions="columnNames,dataSource,property,propertyNames,tableName"> <cfargument name="name" type="string" required="true" hint="Name of the table to map this model to."> <cfscript> variables.wheels.class.tableName = arguments.name; wheels/model/miscellaneous.cfm @@ -215,6 +215,18 @@ <cfreturn loc.returnValue> </cffunction> +<cffunction name="$propertyValue" returntype="string" access="public" output="false" hint="Returns the object's value of the passed in property name. If you pass in a list of property names you will get the values back in a list as well."> + <cfargument name="name" type="string" required="true" hint="Name of property to get value for."> + <cfscript> + var loc = {}; + loc.returnValue = ""; + loc.iEnd = ListLen(arguments.name); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + loc.returnValue = ListAppend(loc.returnValue, this[ListGetAt(arguments.name, loc.i)]); + </cfscript> + <cfreturn loc.returnValue> +</cffunction> + <cffunction name="$setForeignKeyValues" returntype="void" access="public" output="false"> <cfargument name="missingMethodArguments" type="struct" required="true"> <cfargument name="keys" type="string" required="true"> wheels/model/onmissingmethod.cfm @@ -1,42 +1,12 @@ -<cffunction name="properties" returntype="struct" access="public" output="false" - hint="Returns a structure of all the properties with their names as keys and the values of the property as values." - example= - ' -  - <cfset user = model("user").new()> - <cfset user.properties()> - - ' - categories="model-object" chapters="" functions="setProperties"> - <cfscript> - var loc = {}; - loc.returnvalue = {}; - loc.properties = ListToArray(variables.wheels.class.propertyList); - loc.iEnd = ArrayLen(loc.properties); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - loc.property = loc.properties[loc.i]; - loc.returnvalue[loc.property] = ""; - if(structkeyexists(this, loc.property)) - { - loc.returnvalue[loc.property] = this[loc.property]; - } - } - return loc.returnvalue; - </cfscript> -</cffunction> + -<cffunction name="property" returntype="void" access="public" output="false" - hint="Use this method to map an object property to either a table column with a different name than the property or to a specific SQL function. You only need to use this method when you want to override the default mapping that Wheels performs." +<cffunction name="property" returntype="void" access="public" output="false" hint="Use this method to map an object property to either a table column with a different name than the property or to a specific SQL function. You only need to use this method when you want to override the default mapping that Wheels performs." examples= ' -  - <cffunction name="init"> -  - <cfset property(name="firstName", column="STR_USERS_FNAME")> - </cffunction> +  + <cfset property(name="firstName", column="STR_USERS_FNAME")> ' - categories="model-initialization" chapters="object-relational-mapping" functions="columnNames,dataSource,propertyNames,table,tableName"> + categories="model-initialization,miscellaneous" chapters="object-relational-mapping" functions="columnNames,dataSource,propertyNames,table,tableName"> <cfargument name="name" type="string" required="true" hint="The name that you want to use for the column or SQL function result in the CFML code."> <cfargument name="column" type="string" required="false" default="" hint="The name of the column in the database table to map the property to."> <cfargument name="sql" type="string" required="false" default="" hint="An SQL function to use to calculate the property value."> @@ -55,79 +25,92 @@ </cfscript> </cffunction> -<cffunction name="setProperties" returntype="void" access="public" output="false" - hint="Allows you to set all the properties at once by passing in a structure with keys matching the property names." + + +<cffunction name="propertyNames" returntype="string" access="public" output="false" hint="Returns a list of property names ordered by their respective column's ordinal position in the database table." examples= ' -  - <cfset user = model("user").new(params)> - <cfset user.setProperties(params)> - ' - categories="model-object" chapters="" functions="properties"> - <cfargument name="properties" type="struct" required="false" default="#structnew()#"> - <cfscript> - var loc = {}; - loc.properties = duplicate(arguments.properties); - structdelete(arguments, "properties", false); - structappend(loc.properties, arguments, true); - for (loc.key in loc.properties) - { - if (ListFindNoCase(variables.wheels.class.propertyList, loc.key)) - { - this[loc.key] = loc.properties[loc.key]; - } - } - </cfscript> +  + <cfset propNames = model("user").propertyNames()> + ' + categories="model-class,miscellaneous" chapters="object-relational-mapping" functions="columnNames,dataSource,property,table,tableName"> + <cfreturn variables.wheels.class.propertyList> </cffunction> -<cffunction name="$propertyValue" returntype="string" access="public" output="false"> - <cfargument name="name" type="string" required="true"> + + + + +<cffunction name="key" returntype="string" access="public" output="false" hint="Returns the value of the primary key for the object. If you have a single primary key named `id` then `someObject.key()` is functionally equivalent to `someObject.id`. This method is more useful when you do dynamic programming and don't know the name of the primary key or when you use composite keys (in which case it's convenient to use this method to get a list of both key values returned)." + examples= + ' +  + <cfset anEmployee = model("employee").findByKey(params.key)> + <cfset val = anEmployee.key()> + ' + categories="model-object,miscellaneous" chapters="" functions=""> + <cfargument name="$persisted" type="boolean" required="false" default="false"> <cfscript> var loc = {}; loc.returnValue = ""; - loc.iEnd = ListLen(arguments.name); + loc.iEnd = ListLen(variables.wheels.class.keys); for (loc.i=1; loc.i <= loc.iEnd; loc.i++) { - loc.returnValue = ListAppend(loc.returnValue, this[ListGetAt(arguments.name, loc.i)]); + loc.property = ListGetAt(variables.wheels.class.keys, loc.i); + if (StructKeyExists(this, loc.property)) + { + if ($persisted && hasChanged(loc.property)) + loc.returnValue = ListAppend(loc.returnValue, changedFrom(loc.property)); + else + loc.returnValue = ListAppend(loc.returnValue, this[loc.property]); + } } - </cfscript> + </cfscript> <cfreturn loc.returnValue> </cffunction> -<cffunction name="propertyNames" returntype="string" access="public" output="false" - hint="Returns a list of property names (ordered by their respective column's ordinal position in the database table)." - examples= - ' -  - <cfset propNames = model("user").propertyNames()> +<cffunction name="properties" returntype="struct" access="public" output="false" hint="Returns a structure of all the properties with their names as keys and the values of the property as values." + example= ' - categories="model-class" chapters="object-relational-mapping" functions="columnNames,dataSource,property,table,tableName"> - <cfreturn variables.wheels.class.propertyList> -</cffunction> - - -<cffunction name="$updatePersistedProperties" returntype="void" access="public" output="false"> +  + <cfset user = model("user").findByKey(1)> + <cfset props = user.properties()> + ' + categories="model-object,miscellaneous" chapters="" functions="setProperties"> <cfscript> var loc = {}; - variables.$persistedProperties = {}; - for (loc.key in variables.wheels.class.properties) - if (StructKeyExists(this, loc.key)) - variables.$persistedProperties[loc.key] = this[loc.key]; + loc.returnValue = {}; + loc.properties = ListToArray(variables.wheels.class.propertyList); + loc.iEnd = ArrayLen(loc.properties); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + { + loc.property = loc.properties[loc.i]; + loc.returnValue[loc.property] = ""; + if (StructKeyExists(this, loc.property)) + loc.returnValue[loc.property] = this[loc.property]; + } </cfscript> + <cfreturn loc.returnValue> </cffunction> -<cffunction name="$setDefaultValues" returntype="any" access="public" output="false"> +<cffunction name="setProperties" returntype="void" access="public" output="false" hint="Allows you to set all the properties of an object at once by passing in a structure with keys matching the property names." + examples= + ' +  + <cfset user = model("user").findByKey(1)> + <cfset user.setProperties(params)> + ' + categories="model-object,miscellaneous" chapters="" functions="properties"> + <cfargument name="properties" type="struct" required="false" default="#StructNew()#" hint="See documentation for @new."> <cfscript> var loc = {}; - loc.iEnd = ListLen(variables.wheels.class.propertyList); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + loc.properties = Duplicate(arguments.properties); + StructDelete(arguments, "properties", false); + StructAppend(loc.properties, arguments, true); + for (loc.key in loc.properties) { - loc.iItem = ListGetAt(variables.wheels.class.propertyList, loc.i); - if (Len(variables.wheels.class.properties[loc.iItem].defaultValue) && (!StructKeyExists(this, loc.iItem) || !Len(this[loc.iItem]))) - { - // set the default value unless it is blank or a value already exists for that property on the object - this[loc.iItem] = variables.wheels.class.properties[loc.iItem].defaultValue; - } + if (ListFindNoCase(variables.wheels.class.propertyList, loc.key)) + this[loc.key] = loc.properties[loc.key]; } </cfscript> </cffunction> @@ -151,7 +134,7 @@  </cfif> ' - categories="model-object,changes" chapters="" functions="allChanges,changedFrom,changedProperties"> + categories="model-object,changes" chapters="dirty-records" functions="allChanges,changedFrom,changedProperties"> <cfargument name="property" type="string" required="false" default="" hint="Name of property to check for change."> <cfscript> var loc = {}; @@ -163,7 +146,6 @@ <cfreturn loc.returnValue> </cffunction> - <cffunction name="changedProperties" returntype="string" access="public" output="false" hint="Returns a list of the object properties that have been changed but not yet saved to the database." examples= ' @@ -173,7 +155,7 @@ <cfset member.email = params.newEmail> <cfset changes = member.changedProperties()> ' - categories="model-object,changes" chapters="" functions="allChanges,changedFrom,hasChanged"> + categories="model-object,changes" chapters="dirty-records" functions="allChanges,changedFrom,hasChanged"> <cfscript> var loc = {}; loc.returnValue = ""; @@ -184,7 +166,6 @@ <cfreturn loc.returnValue> </cffunction> - <cffunction name="changedFrom" returntype="string" access="public" output="false" hint="Returns the previous value of a property that has changed. Returns an empty string if no previous value exists. Wheels will keep a note of the previous property value until the object is saved to the database." examples= ' @@ -198,7 +179,7 @@  <cfset oldValue = member.emailChangedFrom()> ' - categories="model-object,changes" chapters="" functions="allChanges,changedProperties,hasChanged"> + categories="model-object,changes" chapters="dirty-records" functions="allChanges,changedProperties,hasChanged"> <cfargument name="property" type="string" required="true" hint="Name of property to get the previous value for."> <cfscript> var returnValue = ""; @@ -217,7 +198,7 @@ <cfset member.email = params.newEmail> <cfset allChangesAsStruct = member.allChanges()> ' - categories="model-object,changes" chapters="" functions="changedFrom,changedProperties,hasChanged"> + categories="model-object,changes" chapters="dirty-records" functions="changedFrom,changedProperties,hasChanged"> <cfscript> var loc = {}; loc.returnValue = {}; @@ -238,4 +219,32 @@ } </cfscript> <cfreturn loc.returnValue> +</cffunction> + + + +<cffunction name="$updatePersistedProperties" returntype="void" access="public" output="false"> + <cfscript> + var loc = {}; + variables.$persistedProperties = {}; + for (loc.key in variables.wheels.class.properties) + if (StructKeyExists(this, loc.key)) + variables.$persistedProperties[loc.key] = this[loc.key]; + </cfscript> +</cffunction> + +<cffunction name="$setDefaultValues" returntype="any" access="public" output="false"> + <cfscript> + var loc = {}; + loc.iEnd = ListLen(variables.wheels.class.propertyList); + for (loc.i=1; loc.i <= loc.iEnd; loc.i++) + { + loc.iItem = ListGetAt(variables.wheels.class.propertyList, loc.i); + if (Len(variables.wheels.class.properties[loc.iItem].defaultValue) && (!StructKeyExists(this, loc.iItem) || !Len(this[loc.iItem]))) + { + // set the default value unless it is blank or a value already exists for that property on the object + this[loc.iItem] = variables.wheels.class.properties[loc.iItem].defaultValue; + } + } + </cfscript> </cffunction> \ No newline at end of file wheels/model/properties.cfm @@ -233,7 +233,7 @@  </cfif> ' - categories="model-object" chapters="object-validation" functions=""> + categories="model-object,errors" chapters="object-validation" functions=""> <cfscript> var loc = {}; loc.returnValue = false; wheels/model/validations.cfm @@ -15,7 +15,7 @@ </body> </html> ' - categories="view-helper" chapters="using-layouts"> + categories="view-helper,content" chapters="using-layouts"> <cfreturn request.wheels.contentForLayout> </cffunction> @@ -31,9 +31,9 @@ <cfoutput>##includePartial(partial="/shared/button")##</cfoutput> -> Wheels will include the file "views/shared/_button.cfm". ' - categories="view-helper" chapters="pages,partials" functions="renderPartial"> + categories="view-helper,content" 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="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."> wheels/view/content.cfm @@ -4,7 +4,7 @@ <cfset rightNow = Now()> <cfoutput>##distanceOfTimeInWords(aWhileAgo, rightNow)##</cfoutput> ' - categories="view-helper" chapters="miscellaneous-helpers" functions="timeAgoInWords,timeUntilInWords"> + categories="view-helper,dates" 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."> @@ -85,7 +85,7 @@ <cfset aWhileAgo = Now() - 30> <cfoutput>##timeAgoInWords(aWhileAgo)##</cfoutput> ' - categories="view-helper" chapters="miscellaneous-helpers" functions="distanceOfTimeInWords,timeUntilInWords"> + categories="view-helper,dates" 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."> @@ -97,7 +97,7 @@ <cfset aLittleAhead = Now() + 30> <cfoutput>##timeUntilInWords(aLittleAhead)##</cfoutput> ' - categories="view-helper" chapters="miscellaneous-helpers" functions="timeAgoInWords,distanceOfTimeInWords."> + categories="view-helper,dates" 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."> wheels/view/dates.cfm @@ -6,7 +6,7 @@ ##errorMessageFor(objectName="user")## </cfoutput> ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="errorMessagesOn"> + categories="view-helper,errors" 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."> @@ -51,7 +51,7 @@ ##errorMessageFor(objectName="user", property="email")## </cfoutput> ' - categories="view-helper" chapters="form-helpers-and-showing-errors" functions="errorMessagesOn"> + categories="view-helper,errors" 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 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."> wheels/view/errors.cfm @@ -8,7 +8,7 @@ ##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"> + categories="view-helper,forms" 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"); @@ -26,7 +26,7 @@ ##endFormTag()## </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"> + categories="view-helper,forms" 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)."> @@ -87,7 +87,7 @@ ##endFormTag()## </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"> + categories="view-helper,forms" 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)."> wheels/view/forms.cfm @@ -6,7 +6,7 @@ ##dateSelect(objectName="user", property="dateOfBirth")## </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"> + categories="view-helper,forms-object" 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."> @@ -37,7 +37,7 @@ ##timeSelect(objectName="business", property="openUntil")## </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"> + categories="view-helper,forms-object" 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."> @@ -66,7 +66,7 @@ ##dateTimeSelect(objectName="article", property="publishedAt")## </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"> + categories="view-helper,forms-object" 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."> wheels/view/formsdateobject.cfm @@ -6,7 +6,7 @@ ##dateSelectTags()## </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"> + categories="view-helper,forms-plain" 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."> @@ -40,7 +40,7 @@ ##timeSelectTags(name="timeOfMeeting")## </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"> + categories="view-helper,forms-plain" 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."> @@ -72,7 +72,7 @@ ##dateTimeSelectTags()## </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"> + categories="view-helper,forms-plain" 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."> @@ -118,7 +118,7 @@ ##yearSelectTag(name="yearOfBirthday")## </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"> + categories="view-helper,forms-plain" 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."> @@ -145,7 +145,7 @@ ##monthSelectTag(name="monthOfBirthday")## </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"> + categories="view-helper,forms-plain" 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."> @@ -171,7 +171,7 @@ ##daySelectTag(name="dayOfWeek")## </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"> + categories="view-helper,forms-plain" 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."> @@ -196,7 +196,7 @@ ##hourSelectTag(name="hourOfMeeting")## </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"> + categories="view-helper,forms-plain" 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."> @@ -221,7 +221,7 @@ ##minuteSelectTag(name="minuteOfMeeting")## </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"> + categories="view-helper,forms-plain" 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."> @@ -247,7 +247,7 @@ ##secondSelectTag(name="secondsToLaunch")## </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"> + categories="view-helper,forms-plain" 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."> wheels/view/formsdateplain.cfm @@ -6,7 +6,7 @@ ##textField(label="First Name", objectName="user", property="firstName")## </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"> + categories="view-helper,forms-object" 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 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."> @@ -39,7 +39,7 @@ ##passwordField(objectName="user", property="pass")## </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"> + categories="view-helper,forms-object" 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"> @@ -72,7 +72,7 @@ ##hiddenField(objectName="user", property="id")## </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"> + categories="view-helper,forms-object" 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> @@ -98,7 +98,7 @@ ##fileField(objectName="photo", property="imageFile")## </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"> + categories="view-helper,forms-object" 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."> @@ -130,7 +130,7 @@ ##textArea(objectName="article", property="overview")## </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"> + categories="view-helper,forms-object" 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."> @@ -165,7 +165,7 @@ </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"> + categories="view-helper,forms-object" 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`."> @@ -203,7 +203,7 @@ ##checkBox(objectName="photo", property="isPublic", label="Display this photo publicly.")## </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"> + categories="view-helper,forms-object" 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."> @@ -253,7 +253,7 @@ ##select(objectName="book", property="authorId", options=authors)## </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"> + categories="view-helper,forms-object" 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."> wheels/view/formsobject.cfm @@ -6,7 +6,7 @@ ##textFieldTag(name="someName")## </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"> + categories="view-helper,forms-plain" 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."> @@ -35,7 +35,7 @@ ##passwordFieldTag(name="password")## </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"> + categories="view-helper,forms-plain" 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."> @@ -64,7 +64,7 @@ ##hiddenFieldTag(name="userId", value=user.id)## </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"> + categories="view-helper,forms-plain" 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> @@ -87,7 +87,7 @@ ##fileFieldTag(name="photo")## </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"> + categories="view-helper,forms-plain" 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."> @@ -114,7 +114,7 @@ ##textAreaTag(name="description")## </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"> + categories="view-helper,forms-plain" 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."> @@ -146,7 +146,7 @@ </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"> + categories="view-helper,forms-plain" 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."> @@ -186,7 +186,7 @@ ##checkBoxTag(name="suscribe", value="true", label="Suscribe to our newsletter", checked=false)## </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"> + categories="view-helper,forms-plain" 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."> @@ -224,7 +224,7 @@ ##selectTag(name="cityId", options=cities)## </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"> + categories="view-helper,forms-plain" 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."> wheels/view/formsplain.cfm @@ -6,7 +6,7 @@ ##styleSheetLinkTag("styles")## </head> ' - categories="view-helper" chapters="miscellaneous-helpers" functions="javaScriptIncludeTag,imageTag"> + categories="view-helper,media" 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."> @@ -38,7 +38,7 @@ ##javaScriptIncludeTag("main")## </head> ' - categories="view-helper" chapters="miscellaneous-helpers" functions="styleSheetLinkTag,imageTag"> + categories="view-helper,media" 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."> <cfscript> @@ -65,7 +65,7 @@ ' ##imageTag("logo.png")## ' - categories="view-helper" chapters="miscellaneous-helpers" functions="javaScriptIncludeTag,styleSheetLinkTag"> + categories="view-helper,media" chapters="miscellaneous-helpers" functions="javaScriptIncludeTag,styleSheetLinkTag"> <cfargument name="source" type="string" required="true" hint="Image file name if local or full URL if remote."> <cfscript> var loc = {}; wheels/view/media.cfm @@ -28,7 +28,7 @@ </div> </cfoutput> ' - categories="view-helper" functions="resetCycle"> + categories="view-helper,miscellaneous" 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."> <cfscript> @@ -67,7 +67,7 @@ </div> </cfoutput> ' - categories="view-helper" functions="cycle" + categories="view-helper,miscellaneous" functions="cycle" > <cfargument name="name" type="string" required="false" default="default" hint="The name of the cycle to reset."> <cfscript> wheels/view/miscellaneous.cfm @@ -4,7 +4,7 @@ ##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"> + categories="view-helper,text" 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."> @@ -50,7 +50,7 @@ ##highlight(text="You searched for: Wheels", phrases="Wheels")## -> You searched for: Wheels ' - categories="view-helper" functions="excerpt,simpleFormat,stripLinks,stripTags,titleize,truncate"> + categories="view-helper,text" 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)."> @@ -113,7 +113,7 @@ * Awesome ' - categories="view-helper" functions="excerpt,highlight,stripLinks,stripTags,titleize,truncate"> + categories="view-helper,text" 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."> <cfscript> @@ -134,7 +134,7 @@ ##stripLinks("Wheels 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,stripTags,titleize,truncate"> + categories="view-helper,text" functions="excerpt,highlight,simpleFormat,stripTags,titleize,truncate"> <cfargument name="html" type="string" required="true" hint="The html to remove links from."> <cfreturn REReplaceNoCase(arguments.html, "<a.*?>(.*?)</a>", "\1" , "all")> </cffunction> @@ -145,7 +145,7 @@ ##stripTags("Wheels 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"> + categories="view-helper,text" functions="excerpt,highlight,simpleFormat,stripLinks,titleize,truncate"> <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")> @@ -159,7 +159,7 @@ ##titleize("Wheels is a framework for ColdFusion")## -> Wheels Is A Framework For ColdFusion ' - categories="view-helper" functions="excerpt,highlight,simpleFormat,stripLinks,stripTags,truncate"> + categories="view-helper,text" functions="excerpt,highlight,simpleFormat,stripLinks,stripTags,truncate"> <cfargument name="word" type="string" required="true" hint="The text to turn into a title."> <cfscript> var loc = {}; @@ -182,7 +182,7 @@ ##truncate(text="Wheels is a framework for ColdFusion", truncateString=" (more)")## -> Wheels is a framework f (more) ' - categories="view-helper" functions="excerpt,highlight,simpleFormat,stripLinks,stripTags,titleize"> + categories="view-helper,text" 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."> wheels/view/text.cfm @@ -18,7 +18,7 @@ ##linkTo(text="Joe''s Profile", route="userProfile", userName="joe")## -> <a href="/user/joe">Joe''s Profile</a> ' - categories="view-helper" chapters="linking-pages" functions="URLFor,buttonTo,mailTo"> + categories="view-helper,links" 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."> @@ -56,7 +56,7 @@ ' ##buttonTo(text="Delete Account", action="perFormDelete", disabled="Wait...")## ' - categories="view-helper" functions="URLFor,linkTo,mailTo"> + categories="view-helper,links" 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)."> @@ -97,7 +97,7 @@ ##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"> + categories="view-helper,links" 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 for example."> @@ -135,7 +135,7 @@ ##autoLink("Email us at info@cfwheels.org")## -> Email us at <a href="mailto:info@cfwheels.org">info@cfwheels.org</a> ' - categories="view-helper"> + categories="view-helper,links"> <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> @@ -151,27 +151,6 @@ <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`." - examples= - ' - <cfparam name="params.page" default="1"> - <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."> - <cfscript> - if (application.wheels.showErrorInformation) - { - if (!StructKeyExists(request.wheels, arguments.handle)) - { - $throw(type="Wheels.QueryHandleNotFound", message="Wheels couldn't find a query with the handle of `#arguments.handle#`.", extendedInfo="Make sure your `findAll` call has the `page` argument specified and matching `handle` argument if specified."); - } - } - </cfscript> - <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 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= ' @@ -213,7 +192,7 @@ <cfoutput>##paginationLinks(route="paginatedCommentListing", year=2009, month="feb", day=10)##</cfoutput> </ul> ' - categories="view-helper" chapters="getting-paginated-data,displaying-links-for-pagination" functions="linkTo,findAll,URLFor"> + categories="view-helper,links" chapters="getting-paginated-data,displaying-links-for-pagination" functions="pagination,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."> wheels/view/urls.cfm 73d240b55b37da1c669a085424dd6bf01e5be180 per.djurner per.djurner@d8ff095c-9719-0410-9cd3-1dd5d13d90f5 http://github.com/rip747/cfwheels/commit/032cfe2788ba827956742e3b21d460804465f39a 032cfe2788ba827956742e3b21d460804465f39a

2009-11-05T02:38:32-08:00

Docs and syntax changes. git-svn-id: https://cfwheels.googlecode.com/svn/trunk@3666 d8ff095c-9719-0410-9cd3-1dd5d13d90f5 adbdd3c7c93265c78299e63b348c206dc2059abc per.djurner per.djurner@d8ff095c-9719-0410-9cd3-1dd5d13d90f5