void Use this method to specify which properties can be set through mass assignment. ]]> string 0 Property name (or list of property names) that are allowed to be altered through mass assignment. void Adds the default Wheels routes (for example, `[controller]/[action]/[key]`, etc.) to your application. Only use this method if you have set `loadDefaultRoutes` to `false` and want to control exactly where in the route order you want to place the default routes. ]]> void Adds an error on a specific property. ]]> string 1 The name of the property you want to add an error on. string 1 The error message (such as "Please enter a correct name in the form field" for example). string 0 A name to identify the error by (useful when you need to distinguish one error from another one set on the same object and you don't want to use the error message itself for that). void Adds an error on the object as a whole (not related to any specific property). ]]> string 1 The error message (such as "Please enter a correct name in the form field" for example). string 0 A name to identify the error by (useful when you need to distinguish one error from another one set on the same object and you don't want to use the error message itself for that). void Adds a new MIME format to your Wheels application for use with responding to multiple formats. ]]> string 1 File extension to add. string 1 Matching MIME type to associate with the file extension. void Adds a new route to your application. ]]> string 0 Name for the route. This is referenced as the `name` argument in functions based on @URLFor like @linkTo, @startFormTag, etc. string 1 The URL pattern that the route will match. string 0 Controller to call when route matches (unless the controller name exists in the pattern). string 0 Action to call when route matches (unless the action name exists in the pattern). void Registers method(s) that should be called after a new object is created. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after an object is deleted. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after an existing object has been initialized (which is usually done with the @findByKey or @findOne method). ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after an object has been initialized. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after a new object has been initialized (which is usually done with the @new method). ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after an object is saved. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after an existing object is updated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after an object is validated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after a new object is validated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called after an existing object is validated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). struct Returns a struct detailing all changes that have been made on the object but not yet saved to the database. ]]> array Returns an array of all the errors on the object. ]]> string Turns all URLs and email addresses into hyperlinks. Download Wheels from http://cfwheels.org/download #autoLink("Email us at info@cfwheels.org")# -> Email us at info@cfwheels.org]]> string 1 The text to create links in. string 0 all Whether to link URLs, email addresses or both. Possible values are: `all` (default), `URLs` and `emailAddresses`. void Whether or not to enable default validations for this model. ]]> any Calculates the average value for a given property. Uses the SQL function `AVG`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned. ]]> string 1 Name of the property to calculate the average for. string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though. boolean 0 false When `true`, `AVG` will be performed only on each unique instance of a value, regardless of how many times the value occurs. any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. any 0 The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. void Registers method(s) that should be called before a new object is created. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called before an object is deleted. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called before an object is saved. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called before an existing object is updated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called before an object is validated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called before a new object is validated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Registers method(s) that should be called before an existing object is validated. ]]> string 0 Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument). void Sets up a `belongsTo` association between this model and the specified one. Use this association when this model contains a foreign key referencing another model. ]]> string 1 Gives the association a name that you refer to when working with the association (in the `include` argument to @findAll, to name one example). string 0 Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the `name` argument). string 0 Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the `name` argument). string 0 inner Use to set the join type when joining associated tables. Possible values are `inner` (for `INNER JOIN`) and `outer` (for `LEFT OUTER JOIN`). string Builds and returns a string containing a button `form` control. #startFormTag(action="something")# #buttonTag(content="Submit this form", value="save")# #endFormTag()# ]]> string 0 Save changes Content to display inside the button. string 0 submit The type for the button: `button`, `reset`, or `submit`. string 0 File name of the image file to use in the button form control. string 0 save The value of the button when submitted. any 0 Whether or not to disable the button upon clicking. (Prevents double-clicking.) string Creates a form containing a single button that submits to the URL. The URL is built the same way as the @linkTo function. string 0 The text content of the button. string 0 Pass a message here to cause a JavaScript confirmation dialog box to pop up containing the message. string 0 If you want to use an image for the button pass in the link to it here (relative from the `images` folder). any 0 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). string 0 Name of a route that you have configured in `config/routes.cfm`. string 0 Name of the controller to include in the URL. string 0 Name of the action to include in the URL. any 0 Key(s) to include in the URL. string 0 Any additional params to be set in the query string. string 0 Sets an anchor name to be appended to the path. boolean 0 true If `true`, returns only the relative URL (no protocol, host name or port). string 0 Set this to override the current host. string 0 Set this to override the current protocol. numeric 0 0 Set this to override the current port number. void Tells Wheels to cache one or more actions. ]]> string 0 Action(s) to cache. This argument is also aliased as `actions`. numeric 0 60 Minutes to cache the action(s) for. boolean 0 false Set to `true` to tell Wheels that this is a static page and that it can skip running the controller filters (before and after filters set on actions) and application events (onSessionStart, onRequestStart etc). string Returns the text with the first character converted to uppercase. #capitalize("wheels is a framework")#]]> string 1 Text to capitalize. string 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. ]]> string 1 Name of property to get the previous value for. string Returns a list of the object properties that have been changed but not yet saved to the database. ]]> string Builds and returns a string containing a check box form control based on the supplied `objectName` and `property`. In most cases, this function generates a form field that should represent a `boolean` style field in your data. Use @checkBoxTag or @hasManyCheckBox to generate check boxes for selecting multiple values. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #checkBox(objectName="photo", property="isPublic", label="Display this photo publicly.")#

#user.photos[i].title#:

#checkBox(objectName="user", association="photos", position=i, property="isPublic", label="Display this photo publicly.")#

Toppings #checkBoxTag(name="toppings", value="true", label=toppings.name, checked=YesNoFormat(ListFind(ValueList(selectedToppings.id), toppings.id))#

]]> string 1 Name to populate in tag's `name` attribute. boolean 0 false Whether or not the check box should be checked by default. string 0 1 Value of check box in its `checked` state. string 0 The value of the check box when it's on the `unchecked` state. string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. void Clears out all errors set on the object or only the ones set for a specific property or name. ]]> string 0 Specify a property name here if you want to clear all errors set on that property. string 0 Specify an error name here if you want to clear all errors set with that error name. any Returns a struct with data for the named property. ]]> string 1 Name of column to retrieve data for. any Returns the column name mapped for the named model property. ]]> string 1 Name of property to inspect. string Returns a list of column names in the table mapped to this model. The list is ordered according to the columns' ordinal positions in the database table. ]]> array Returns an array of columns names for the table associated with this class. Does not include calculated properties that will be generated by the Wheels ORM. ]]> boolean Pass in another Wheels model object to see if the two objects are the same. ]]> void Used to store a section's output for rendering within a layout. This content store acts as a stack, so you can store multiple pieces of content for a given section.

My Sidebar Text

My Site #includeContent("sidebar")# #includeContent()# ]]> any 0 last The position in the section's stack where you want the content placed. Valid values are `first`, `last`, or the numeric position. any 0 false Whether or not to overwrite any of the content. Valid values are `false`, `true`, or `all`. string Includes content for the `body` section, which equates to the output generated by the view template run by the request. My Site #contentForLayout()# ]]> any Creates and returns a controller object with your own custom `name` and `params`. Used primarily for testing purposes. ]]> string 1 Name of the controller to create. struct 0 [runtime expression] The params struct (combination of `form` and `URL` variables). numeric Returns the number of rows that match the arguments (or all rows if no arguments are passed in). Uses the SQL function `COUNT`. If no records can be found to perform the calculation on, `0` is returned. ]]> string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though. any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. any Creates a new object, saves it to the database (if the validation permits it), and returns it. If the validation fails, the unsaved object (with errors added to it) is still returned. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument. ]]> struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. boolean 0 false Set to `true` to reload the object from the database once an insert/update has completed. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. string Cycles through list values every time it is called.

Name	Phone
#employees.name#	#employees.phone#

#categories.categoryName#

]]> string 1 List of values to cycle through. string 0 default Name to give the cycle. Useful when you use multiple cycles on a page. void Use this method to override the data source connection information for this model. ]]> string 1 The data source name to connect to. string 0 The username for the data source. string 0 The password for the data source. string Builds and returns a string containing three select form controls for month, day, and year based on the supplied `objectName` and `property`. #dateSelect(objectName="user", property="dateOfBirth")# #dateSelect(objectName="order", property="expirationDate", order="month,year")# ]]> any 0 The variable name of the object to build the form control for. string 0 The name of the property to use in the form control. string 0 The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. string 0 The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out. string 0 month,day,year Use to change the order of or exclude date select tags. string 0 Use to change the character that is displayed between the date select tags. numeric 0 2005 First year in select list. numeric 0 2015 Last year in select list. string 0 names Pass in `names`, `numbers`, or `abbreviations` to control display. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 false The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string 0 fieldWithErrors The class name of the HTML tag that wraps the form control when there are errors. boolean 0 Set to `false` to not combine the select parts into a single `DateTime` object. string Builds and returns a string containing three select form controls (month, day, and year) based on a `name` and `value`. #dateSelectTags(name="dateStart", selected=params.dateStart)# #dateSelectTags(name="expiration", selected=params.expiration, order="month,year")# ]]> string 1 Name to populate in tag's `name` attribute. string 0 Value of option that should be selected by default. string 0 month,day,year Use to change the order of or exclude date select tags. string 0 Use to change the character that is displayed between the date select tags. numeric 0 2005 First year in select list. numeric 0 2015 Last year in select list. string 0 names Pass in `names`, `numbers`, or `abbreviations` to control display. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. boolean 0 Set to `false` to not combine the select parts into a single `DateTime` object. string 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`. #dateTimeSelect(objectName="article", property="publishedAt")# #dateTimeSelect(objectName="appointment", property="dateTimeStart", dateOrder="month,day", timeOrder="hour,minute")# ]]> string 1 The variable name of the object to build the form control for. string 1 The name of the property to use in the form control. string 0 The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. string 0 The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out. string 0 month,day,year Use to change the order of or exclude date select tags. string 0 Use to change the character that is displayed between the date select tags. numeric 0 2005 First year in select list. numeric 0 2015 Last year in select list. string 0 names Pass in `names`, `numbers`, or `abbreviations` to control display. string 0 hour,minute,second Use to change the order of or exclude time select tags. string 0 : Use to change the character that is displayed between the time select tags. numeric 0 1 Pass in `10` to only show minute 10, 20, 30, etc. string 0 - Use to change the character that is displayed between the first and second set of select tags. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 false The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string 0 fieldWithErrors The class name of the HTML tag that wraps the form control when there are errors. boolean 0 Set to `false` to not combine the select parts into a single `DateTime` object. boolean 0 false whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs string Builds and returns a string containing six select form controls (three for date selection and the remaining three for time selection) based on a `name`. #dateTimeSelectTags(name="dateTimeStart", selected=params.dateTimeStart)# #dateTimeSelectTags(name="dateTimeStart", selected=params.dateTimeStart, dateOrder="month,day", timeOrder="hour,minute")# ]]> string 1 Name to populate in tag's `name` attribute. string 0 Value of option that should be selected by default. string 0 month,day,year Use to change the order of or exclude date select tags. string 0 Use to change the character that is displayed between the date select tags. numeric 0 2005 First year in select list. numeric 0 2015 Last year in select list. string 0 names Pass in `names`, `numbers`, or `abbreviations` to control display. string 0 hour,minute,second Use to change the order of or exclude time select tags. string 0 : Use to change the character that is displayed between the time select tags. numeric 0 1 Pass in `10` to only show minute 10, 20, 30, etc. string 0 - Use to change the character that is displayed between the first and second set of select tags. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. boolean 0 Set to `false` to not combine the select parts into a single `DateTime` object. boolean 0 false whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs string Builds and returns a string containing a select form control for the days of the week based on the supplied `name`. #daySelectTag(name="dayOfWeek", selected=params.dayOfWeek)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 The day that should be selected initially. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. boolean Deletes the object, which means the row is deleted from the database (unless prevented by a `beforeDelete` callback). Returns `true` on successful deletion of the row, `false` otherwise. ]]> any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. boolean 0 true Set to `false` to permanently delete a record, even if it has a soft delete column. numeric Deletes all records that match the `where` argument. By default, objects will not be instantiated and therefore callbacks and validations are not invoked. You can change this behavior by passing in `instantiate=true`. Returns the number of records that were deleted. ]]> string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though. boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. boolean 0 false Whether or not to instantiate the object(s) first. When objects are not instantiated, any callbacks and validations set on them will be skipped. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. boolean 0 true Set to `false` to permanently delete a record, even if it has a soft delete column. boolean Finds the record with the supplied key and deletes it. Returns `true` on successful deletion of the row, `false` otherwise. ]]> any 1 Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list, or a numeric value. boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. boolean 0 true Set to `false` to permanently delete a record, even if it has a soft delete column. boolean Gets an object based on conditions and deletes it. ]]> string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Maps to the `ORDER BY` clause of the query. You do not need to specify the table name(s); Wheels will do that for you. boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. boolean 0 true Set to `false` to permanently delete a record, even if it has a soft delete column. string Deobfuscates a value. ]]> string 1 Value to deobfuscate. string Pass in two dates to this method, and it will return a string describing the difference between them. #distanceOfTimeInWords(aWhileAgo, rightNow)#]]> date 1 Date to compare from. date 1 Date to compare to. boolean 0 false Whether or not to include the number of seconds in the returned string. string Builds and returns a string containing the closing `form` tag. #startFormTag(action="create")# #endFormTag()# ]]> numeric Returns the number of errors this object has associated with it. Specify `property` or `name` if you wish to count only specific errors. ]]> string 0 Specify a property name here if you want to count only errors set on a specific property. string 0 Specify an error name here if you want to count only errors set with a specific error name. string Returns the error message, if one exists, on the object's property. If multiple error messages exist, the first one is returned. #errorMessageOn(objectName="user", property="email")# ]]> string 1 The variable name of the object to display the error message for. string 1 The name of the property to display the error message for. string 0 String to prepend to the error message. string 0 String to append to the error message. string 0 span HTML element to wrap the error message in. string 0 errorMessage CSS class to set on the wrapper element. string 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. #errorMessagesFor(objectName="user")# ]]> string 1 The variable name of the object to display error messages for. string 0 errorMessages CSS class to set on the `ul` element. boolean 0 true Whether or not to show duplicate error messages. array Returns an array of all errors associated with the supplied property (and error name if passed in). ]]> string 1 Specify the property name to return errors for here. string 0 If you want to return only errors on the above property set with a specific error name you can specify it here. array Returns an array of all errors associated with the object as a whole (not related to any specific property). ]]> string 0 Specify an error name here to only return errors for that error name. string Extracts an excerpt from text that matches the first instance of a given phrase. ... MVC framework for ...]]> string 1 The text to extract an excerpt from. string 1 The phrase to extract. numeric 0 100 Number of characters to extract surrounding the phrase. string 0 ... String to replace first and/or last characters with. boolean Checks if a record exists in the table. You can pass in either a primary key value to the `key` argument or a string to the `where` argument. ]]> any 0 Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list, or a numeric value. string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. string Builds and returns a string containing a file field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #fileField(label="Photo", objectName="photo", property="imageFile")#

Screenshots #fileField(label="File ##i#", objectName="site", association="screenshots", position=i, property="file")# #textField(label="Caption ##i#", objectName="site", association="screenshots", position=i, property="caption")#

#flash("message")#

#flash(flashItem)#

]]> string 0 The key to get the value for. void Deletes everything from the Flash. ]]> numeric Returns how many keys exist in the Flash. do something... ]]> boolean Deletes a specific key from the Flash. ]]> string 1 The key to delete. void Inserts a new key/value into the Flash. ]]> boolean Returns whether or not the Flash is empty.

#flash(flashItem)#

]]> void Make the entire Flash or specific key in it stick around for one more request. ]]> string 0 A key or list of keys to flag for keeping. This argument is also aliased as `keys`. boolean Checks if a specific key exists in the Flash.

#flash("error")#

]]> string 1 The key to check if it exists. string Displays a marked-up listing of messages that exists in the Flash. #flashMessages()# #flashMessages(key="success")# #flashMessages(keys="success,alert")# ]]> string 0 The key (or list of keys) to show the value for. You can also use the `key` argument instead for better readability when accessing a single key. string 0 flashMessages HTML `class` to set on the `div` element that contains the messages. boolean 0 false Includes the DIV container even if the flash is empty. boolean 0 false Outputs all class attribute values in lower case (except the main one). any Returns the current setting for the supplied Wheels setting or the current default for the supplied Wheels function argument. ]]> string 1 Variable name to get setting for. string 0 Function name to get setting for. string Returns the table name prefix set for the table. SELECT * FROM #this.getTableNamePrefix()#users WHERE disabled = 1 ]]> boolean Returns `true` if the specified property (or any if none was passed in) has been changed but not yet saved to the database. Will also return `true` if the object is new and no record for it exists in the database. ]]> string 0 Name of property to check for change. boolean Returns `true` if the object has any errors. You can also limit to only check a specific property or name for errors. ]]> string 0 Name of the property to check if there are any errors set on. string 0 Error name to check if there are any errors set with. void Sets up a `hasMany` association between this model and the specified one. ]]> string 1 Gives the association a name that you refer to when working with the association (in the `include` argument to @findAll, to name one example). string 0 Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the `name` argument). string 0 Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the `name` argument). string 0 outer Use to set the join type when joining associated tables. Possible values are `inner` (for `INNER JOIN`) and `outer` (for `LEFT OUTER JOIN`). string 0 false Defines how to handle dependent models when you delete a record from this model. Set to `delete` to instantiate associated models and call their @delete method, `deleteAll` to delete without instantiating, `nullify` to remove the foreign key, or `false` to do nothing. string 0 Set this argument to create an additional dynamic method that gets the object(s) from the other side of a many-to-many association. string 0 [runtime expression] Set this argument if you need to override Wheels conventions when using the `shortcut` argument. Accepts a list of two association names representing the chain from the opposite side of the many-to-many relationship to this model. string Used as a shortcut to output the proper form elements for an association. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #hasManyCheckBox( label=authors.fullName, objectName="book", association="bookAuthors", keys="#book.key()#,#authors.id#" )# ]]> string 1 Name of the variable containing the parent object to represent with this form field. string 1 Name of the association set in the parent object to represent with this form field. string 1 Primary keys associated with this form field. string 0 The label text to use in the form control. string 0 Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 HTML tag to wrap the form control with when the object contains errors. string 0 The class name of the HTML tag that wraps the form control when there are errors. string Used as a shortcut to output the proper form elements for an association. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #hasManyRadioButton( label=addresses.title, objectName="author", association="authorsDefaultAddresses", keys="#author.key()#,#addresses.id#" )# ]]> string 1 Name of the variable containing the parent object to represent with this form field. string 1 Name of the association set in the parent object to represent with this form field. string 1 Name of the property in the child object to represent with this form field. string 1 Primary keys associated with this form field. string 1 The value of the radio button when `selected`. boolean 0 false Whether or not to check this form field as a default if there is a blank value set for the property. string 0 The label text to use in the form control. void Sets up a `hasOne` association between this model and the specified one. ]]> string 1 Gives the association a name that you refer to when working with the association (in the `include` argument to @findAll, to name one example). string 0 Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the `name` argument). string 0 Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the `name` argument). string 0 outer Use to set the join type when joining associated tables. Possible values are `inner` (for `INNER JOIN`) and `outer` (for `LEFT OUTER JOIN`). string 0 false Defines how to handle dependent models when you delete a record from this model. Set to `delete` to instantiate associated models and call their @delete method, `deleteAll` to delete without instantiating, `nullify` to remove the foreign key, or `false` to do nothing. boolean Returns `true` if the specified property name exists on the model. ]]> string 1 Name of property to inspect. string Builds and returns a string containing a hidden field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #hiddenField(objectName="user", property="id")# ]]> any 1 The variable name of the object to build the form control for. string 1 The name of the property to use in the form control. string 0 The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. string 0 The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out. string Builds and returns a string containing a hidden field form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #hiddenFieldTag(name="userId", value=user.id)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 Value to populate in tag's `value` attribute. string Highlights the phrase(s) everywhere in the text if found by wrapping it in a `span` tag. You searched for: Wheels]]> string 1 Text to search. string 1 List of phrases to highlight. string 0 highlight Class to use in `span` tags surrounding highlighted phrase(s). string Builds and returns a string containing one select form control for the hours of the day based on the supplied `name`. #hourSelectTag(name="hourOfMeeting", selected=params.hourOfMeeting)# #hourSelectTag(name="hourOfMeeting", selected=params.hourOfMeeting, twelveHour=true)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 The hour that should be selected initially. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. boolean 0 false whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs string Returns readable text by capitalizing and converting camel casing to multiple words. #humanize("wheelsIsAFramework")# #humanize("wheelsIsACFMLFramework", "CFML")#]]> string 1 Text to humanize. string 0 a list of strings (space separated) to replace within the output. string Converts camelCase strings to lowercase strings with hyphens as word delimiters instead. Example: `myVariable` becomes `my-variable`. #hyphenize("myBlogPost")# ]]> string 1 The string to hyphenize. string Returns an `img` tag. If the image is stored in the local `images` folder, the tag will also set the `width`, `height`, and `alt` attributes for you. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #imageTag("logo.png")# #imageTag("http://cfwheels.org/images/logo.png", alt="ColdFusion on Wheels")# #imageTag(source="logo.png", class="logo")#]]> string 1 The file name of the image if it's availabe in the local file system (i.e. ColdFusion will be able to access it). Provide the full URL if the image is on a remote server. string Used to output the content for a particular section in a layout. My Site #includeContent("head")# #includeContent()# ]]> string 0 body Name of layout section to return content for. string 0 What to display as a default if the section is not defined. boolean Used as a shortcut to check if the specified IDs are a part of the main form object. This method should only be used for `hasMany` associations. ]]> string 1 Name of the variable containing the parent object to represent with this form field. string 1 Name of the association set in the parent object to represent with this form field. string 1 Primary keys associated with this form field. string Includes the contents of another layout file. This is usually used to include a parent layout from within a child layout.

#includePartial(categories)# #includeLayout("/layout.cfm")# ]]> string 0 layout Name of the layout file to include. string Includes the specified partial file in the view. Similar to using `cfinclude` but with the ability to cache the result and use 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 base `views` folder, you can start the path supplied to `name` with a forward slash. #includePartial("login")# -> If we're in the "admin" controller, Wheels will include the file "views/admin/_login.cfm". #includePartial(partial="misc/doc", cache=30)# -> If we're in the "admin" controller, Wheels will include the file "views/admin/misc/_doc.cfm" and cache it for 30 minutes. #includePartial(partial="/shared/button")# -> Wheels will include the file "views/shared/_button.cfm".]]> any 1 The name of the partial file to be used. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension. string 0 If passing a query result set for the `partial` argument, use this to specify the field to group the query by. A new query will be passed into the partial template for you to iterate over. any 0 Number of minutes to cache the content for. string 0 The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all. string 0 HTML or string to place between partials when called using a query. any 0 true Name of controller function to load data from. any Runs the specified method within a single database transaction. ]]> string 1 Model method to run. string 0 commit Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. string 0 read_committed Isolation level to be passed through to the `cftransaction` tag. See your CFML engine's documentation for more details about `cftransaction`'s `isolation` attribute. boolean Returns whether the page was called from JavaScript or not. ]]> boolean Use this method within a model's method to check whether you are currently in a class-level object. ]]> boolean Returns whether the request was a normal `GET` request or not. ]]> boolean Use this method to check whether you are currently in an instance object. ]]> boolean Returns `true` if this object hasn't been saved yet. (In other words, no matching record exists in the database yet.) Returns `false` if a record exists. ]]> boolean Returns whether the request came from a form `POST` submission or not. ]]> boolean Returns whether Wheels is communicating over a secure port. ]]> string Returns a `script` tag for a JavaScript file (or several) based on the supplied arguments. #javaScriptIncludeTag("main")# #javaScriptIncludeTag("blog,accordion")# #javaScriptIncludeTag(source="tabs", head=true)# ]]> string 0 The name of one or many JavaScript files in the `javascripts` folder, minus the `.js` extension. (Can also be called with the `source` argument.) string 0 text/javascript The `type` attribute for the `script` tag. string 0 false Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior, which is to place the output where the function is called from. string 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). ]]> string 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. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. Log Out #linkTo(text="Log Out", action="logout")# -> Log Out #linkTo(text="View Post", controller="blog", action="post", key=99)# -> View Post #linkTo(text="View Settings", action="settings", params="show=all&sort=asc")# -> View Settings #linkTo(text="Joe's Profile", route="userProfile", userName="joe")# -> Joe's Profile #linkTo(text="ColdFusion Framework", href="http://cfwheels.org/")# -> ColdFusion Framework #linkTo(text="Delete Post", action="delete", key=99, class="delete", id="delete-99")# -> Delete Post]]> string 0 The text content of the link. string 0 Pass a message here to cause a JavaScript confirmation dialog box to pop up containing the message. string 0 Name of a route that you have configured in `config/routes.cfm`. string 0 Name of the controller to include in the URL. string 0 Name of the action to include in the URL. any 0 Key(s) to include in the URL. string 0 Any additional params to be set in the query string. string 0 Sets an anchor name to be appended to the path. boolean 0 true If `true`, returns only the relative URL (no protocol, host name or port). string 0 Set this to override the current host. string 0 Set this to override the current protocol. numeric 0 0 Set this to override the current port number. string 0 Pass a link to an external site here if you want to bypass the Wheels routing system altogether and link to an external URL. string Creates a `mailto` link tag to the specified email address, which is also used as the name of the link unless name is specified. Contact our Webmaster]]> string 1 The email address to link to. string 0 A string to use as the link text ("Joe" or "Support Department", for example). boolean 0 false Pass `true` here to encode the email address, making it harder for bots to harvest it for example. any Calculates the maximum value for a given property. Uses the SQL function `MAX`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned. ]]> string 1 Name of the property to get the highest value for (must be a property of a numeric data type). string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though. any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. any 0 The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. string Returns an associated MIME type based on a file extension. ]]> string 1 The extension to get the MIME type for. string 0 application/octet-stream the fallback MIME type to return. any Calculates the minimum value for a given property. Uses the SQL function `MIN`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned. ]]> string 1 Name of the property to get the lowest value for (must be a property of a numeric data type). string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though. any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. any 0 The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. string Builds and returns a string containing one select form control for the minutes of an hour based on the supplied `name`. #minuteSelectTag(name="minuteOfMeeting", value=params.minuteOfMeeting)# #minuteSelectTag(name="minuteOfMeeting", value=params.minuteOfMeeting, minuteStep=15)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 The minute that should be selected initially. numeric 0 1 Pass in `10` to only show minute 10, 20, 30, etc. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. any Returns a reference to the requested model so that class level methods can be called on it. ]]> string 1 Name of the model to get a reference to. string Builds and returns a string containing a select form control for the months of the year based on the supplied `name`. #monthSelectTag(name="monthOfBirthday", selected=params.monthOfBirthday)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 The month that should be selected initially. string 0 names Pass in `names`, `numbers`, or `abbreviations` to control display. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. void Allows for nested objects, structs, and arrays to be set from params and other generated data. ]]> string 0 The association (or list of associations) you want to allow to be set through the params. This argument is also aliased as `associations`. boolean 0 true Whether to save the association(s) when the parent object is saved. boolean 0 false Set `allowDelete` to `true` to tell Wheels to look for the property `_delete` in your model. If present and set to a value that evaluates to `true`, the model will be deleted when saving the parent. string 0 Set `sortProperty` to a property on the object that you would like to sort by. The property should be numeric, should start with 1, and should be consecutive. Only valid with `hasMany` associations. string 0 A list of properties that should not be blank. If any of the properties are blank, any CRUD operations will be rejected. any Creates a new object based on supplied properties and returns it. The object is not saved to the database; it only exists in memory. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument. ]]> struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). boolean 0 true Set to `false` to disable callbacks for this operation. string Obfuscates a value. Typically used for hiding primary key values when passed along in the URL. ]]> any 1 Value to obfuscate. void Use this in an individual controller action to define which formats the action will respond with. This can be used to define provides behavior in individual actions or to override a global setting set with @provides in the controller's `init()`. ]]> struct Returns a struct with information about the specificed paginated query. The keys that will be included in the struct are `currentPage`, `totalPages` and `totalRecords`. ]]> string 0 query The handle given to the query to return pagination information for. string 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.)

#firstName# #lastName#

#paginationLinks(action="listAuthors")# #paginationLinks(action="listAuthors", windowSize=5)#

#paginationLinks(action="listAuthors", handle="authQuery", prependToLink="

", appendToLink="

")#

#paginationLinks(route="paginatedCommentListing", year=2009, month="feb", day=10)#

]]> numeric 0 2 The number of page links to show around the current page. boolean 0 true Whether or not links to the first and last page should always be displayed. string 0 ... String to place next to the anchors on either side of the list. boolean 0 false Whether or not the current page should be linked to. string 0 String or HTML to be prepended before result. string 0 String or HTML to be appended after result. string 0 String or HTML to be prepended before each page number. boolean 0 true Whether or not to prepend the `prependToPage` string on the first page in the list. boolean 0 true Whether or not to prepend the `prependToPage` string on the anchors. string 0 String or HTML to be appended after each page number. boolean 0 true Whether or not to append the `appendToPage` string on the last page in the list. boolean 0 true Whether or not to append the `appendToPage` string on the anchors. string 0 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). string 0 query The handle given to the query that the pagination links should be displayed for. string 0 page The name of the param that holds the current page number. boolean 0 false 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). boolean 0 true Decides whether to link the page number as a param or as part of a route. (The default behavior is `true`). string Builds and returns a string containing a password field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #passwordField(label="Password", objectName="user", property="password")#

Passwords #passwordField(label="Password ##i#", objectName="user", association="passwords", position=i, property="password")#

Gender #radioButton(objectName="user", property="gender", tagValue="m", label="Male")#
#radioButton(objectName="user", property="gender", tagValue="f", label="Female")#

#committee.members[i].fullName#:

#radioButton(objectName="committee", association="members", position=i, property="gender", tagValue="m", label="Male")#
#radioButton(objectName="committee", association="members", position=i, property="gender", tagValue="f", label="Female")#

Gender #radioButtonTag(name="gender", value="m", label="Male", checked=true)#
#radioButtonTag(name="gender", value="f", label="Female")#

]]> string 1 Name to populate in tag's `name` attribute. string 1 Value to populate in tag's `value` attribute. boolean 0 false Whether or not to check the radio button by default. string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. void Redirects the browser to the supplied `controller`/`action`/`key`, `route` or back to the referring page. Internally, this function uses the @URLFor function to build the link and the `cflocation` tag to perform the redirect. ]]> boolean 0 false Set to `true` to redirect back to the referring page. boolean 0 false See documentation for your CFML engine's implementation of `cflocation`. numeric 0 302 See documentation for your CFML engine's implementation of `cflocation`. string 0 Name of a route that you have configured in `config/routes.cfm`. string 0 Name of the controller to include in the URL. string 0 Name of the action to include in the URL. any 0 Key(s) to include in the URL. string 0 Any additional params to be set in the query string. string 0 Sets an anchor name to be appended to the path. boolean 0 true If `true`, returns only the relative URL (no protocol, host name or port). string 0 Set this to override the current host. string 0 Set this to override the current protocol. numeric 0 0 Set this to override the current port number. boolean 0 false Set to `true` to delay the redirection until after the rest of your action code has executed. void Reloads the property values of this object from the database. ]]> void Instructs the controller to render an empty string when it's finished processing the action. This is very similar to calling `cfabort` with the advantage that any after filters you have set on the action will still be run. ]]> any Instructs the controller which view template and layout to render when it's finished processing the action. Note that when passing values for `controller` and/or `action`, this function does not load the actual action but rather just loads the corresponding view template. ]]> string 0 [runtime expression] Controller to include the view page for. string 0 [runtime expression] Action to include the view page for. string 0 A specific template to render. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. any 0 The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all. any 0 Number of minutes to cache the content for. string 0 Set to `string` to return the result instead of automatically sending it to the client. boolean 0 false Set to `true` to hide the debug information at the end of the output. This is useful when you're testing XML output in an environment where the global setting for `showDebugInformation` is `true`. any Instructs the controller to render a partial when it's finished processing the action. ]]> string 1 The name of the partial file to be used. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension. any 0 Number of minutes to cache the content for. string 0 The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all. string 0 Set to `string` to return the result instead of automatically sending it to the client. any 0 true Name of a controller function to load data from. void Instructs the controller to render specified text when it's finished processing the action. ]]> any 1 The text to be rendered. any Instructs the controller to render the data passed in to the format that is requested. If the format requested is `json` or `xml`, Wheels will transform the data into that format automatically. For other formats (or to override the automatic formatting), you can also create a view template in this format: `nameofaction.xml.cfm`, `nameofaction.json.cfm`, `nameofaction.pdf.cfm`, etc. ]]> any 1 Data to format and render. string 0 [runtime expression] Controller to include the view page for. string 0 [runtime expression] Action to include the view page for. string 0 A specific template to render. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. any 0 The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all. any 0 Number of minutes to cache the content for. string 0 Set to `string` to return the result instead of automatically sending it to the client. boolean 0 false Set to `true` to hide the debug information at the end of the output. This is useful when you're testing XML output in an environment where the global setting for `showDebugInformation` is `true`. void Resets a cycle so that it starts from the first list value the next time it is called.

#categories.categoryName#

]]> string 0 default The name of the cycle to reset. string Returns content that Wheels will send to the client in response to the request. ]]> boolean Saves the object if it passes validation and callbacks. Returns `true` if the object was saved successfully to the database, `false` if not. ]]> any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. boolean 0 false Set to `true` to reload the object from the database once an insert/update has completed. boolean 0 true Set to `false` to skip validations for this operation. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. string Builds and returns a string containing one select form control for the seconds of a minute based on the supplied `name`. #secondSelectTag(name="secondsToLaunch", selected=params.secondsToLaunch)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 The second that should be selected initially. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string Builds and returns a string containing a `select` form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.

#select(objectName="book", property="authorId", options=authors)#

#select(label="Order ##shipments.orders[i].orderNum#", objectName="shipment", association="orders", position=i, property="statusId", options=statuses)# ]]> any 1 The variable name of the object to build the form control for. string 1 The name of the property to use in the form control. string 0 The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. string 0 The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out. any 1 A collection to populate the select form control with. Can be a query recordset or an array of objects. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 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. string 0 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. string 0 useDefaultLabel The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string 0 fieldWithErrors The class name of the HTML tag that wraps the form control when there are errors. string Builds and returns a string containing a select form control based on the supplied `name` and `options`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #selectTag(name="cityId", options=cities)# #selectTag(name="cityId", options=cities, valueField="id", textField="name")# ]]> string 1 Name to populate in tag's `name` attribute. any 1 A collection to populate the select form control with. Can be a query recordset or an array of objects. string 0 Value of option that should be selected by default. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). boolean 0 false Whether to allow multiple selection of options in the select form control. string 0 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. string 0 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. string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. any Sends an email using a template and an optional layout to wrap it in. Besides the Wheels-specific arguments documented here, you can also pass in any argument that is accepted by the `cfmail` tag as well as your own arguments to be used by the view. ]]> string 0 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. This argument is also aliased as `templates`. string 1 Email address to send from. string 1 List of email addresses to send the email to. string 1 The subject line of the email. any 0 false Layout(s) to wrap the email template in. This argument is also aliased as `layouts`. string 0 A list of the names of the files to attach to the email. This will reference files stored in the `files` folder (or a path relative to it). This argument is also aliased as `files`. boolean 0 true When set to `true` and multiple values are provided for the `template` argument, Wheels will detect which of the templates is text and which one is HTML (by counting the `<` characters). any Sends a file to the user (from the `files` folder or a path relative to it by default). ]]> string 1 The file to send to the user. string 0 The file name to show in the browser download dialog box. string 0 The HTTP content type to deliver the file as. string 0 attachment Set to `inline` to have the browser handle the opening of the file (possibly inline in the browser) or set to `attachment` to force a download dialog box. string 0 Directory outside of the webroot where the file exists. Must be a full path. boolean 0 false Pass in `true` to delete the file on the server after sending it. void Use to configure a global setting or set a default for a function. ]]> void Use this function if you need a more low level way of setting the entire filter chain for a controller. ]]> array 1 An array of structs, each of which represent an `argumentCollection` that get passed to the `filters` function. This should represent the entire filter chain that you want to use for this controller. void Allows you to set a pagination handle for a custom query so you can perform pagination on it in your view with `paginationLinks()`. SELECT * FROM users

#allUsers.firstName# #allUsers.lastName#

#paginationLinks(handle="myCustomQueryHandle")#

#allUsers.firstName# #allUsers.lastName#

#paginationLinks(handle="myCustomQueryHandle")# SELECT COUNT(*) AS theCount FROM users SELECT * FROM users LIMIT #arguments.page# OFFSET #arguments.perPage#

#allUsers.firstName# #allUsers.lastName#

#paginationLinks(handle="myCustomQueryHandle")#

#allUsers.firstName# #allUsers.lastName#

#paginationLinks(handle="myCustomQueryHandle")#]]> numeric 1 Total count of records that should be represented by the paginated links. numeric 0 1 Page number that should be represented by the data being fetched and the paginated links. numeric 0 25 Number of records that should be represented on each page of data. string 0 query Name of handle to reference in @paginationLinks. void Allows you to pass in the name(s) of the property(s) that should be used as the primary key(s). Pass as a list if defining a composite primary key. Also aliased as `setPrimaryKeys()`. ]]> string 1 Property (or list of properties) to set as the primary key. void Alias for @setPrimaryKey. Use this for better readability when you're setting multiple properties as the primary key. ]]> string 1 Property (or list of properties) to set as the primary key. void Allows you to set all the properties of an object at once by passing in a structure with keys matching the property names. ]]> struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). void Sets content that Wheels will send to the client in response to the request. ]]> string 1 The content to set as the response. void Sets a prefix to prepend to the table name when this model runs SQL queries. ]]> string 1 A prefix to prepend to the table name. void Use this function if you need a more low level way of setting the entire verification chain for a controller. ]]> array 1 An array of structs, each of which represent an `argumentCollection` that get passed to the `verifies` function. This should represent the entire verification chain that you want to use for this controller. string Replaces single newline characters with HTML break tags and double newline characters with HTML paragraph tags (properly closed to comply with XHTML standards). #simpleFormat(post.comments)# I love this post! Here's why: * Short * Succinct * Awesome #simpleFormat(comment)# ->

I love this post!

Here's why:
* Short
* Succinct
* Awesome

]]> string 1 The text to format. boolean 0 true Set to `true` to wrap the result in a paragraph. string Returns the singular form of the passed in word. #singularize("languages")#]]> string 1 String to singularize. string Builds and returns a string containing the opening form tag. The form's action will be built according to the same rules as `URLFor`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #startFormTag(action="create", spamProtection=true)# #endFormTag()# ]]> string 0 post The type of method to use in the form tag. `get` and `post` are the options. boolean 0 false Set to `true` if the form should be able to upload files. boolean 0 false Set to `true` to protect the form against spammers (done with JavaScript). string 0 Name of a route that you have configured in `config/routes.cfm`. string 0 Name of the controller to include in the URL. string 0 Name of the action to include in the URL. any 0 Key(s) to include in the URL. string 0 Any additional params to be set in the query string. string 0 Sets an anchor name to be appended to the path. boolean 0 true If `true`, returns only the relative URL (no protocol, host name or port). string 0 Set this to override the current host. string 0 Set this to override the current protocol. numeric 0 0 Set this to override the current port number. string Removes all links from an HTML string, leaving just the link text. Wheels is a framework for ColdFusion.")# -> Wheels is a framework for ColdFusion.]]> string 1 The HTML to remove links from. string Removes all HTML tags from a string. Wheels is a framework for ColdFusion.")# -> Wheels is a framework for ColdFusion.]]> string 1 The HTML to remove tag markup from. string Returns a `link` tag for a stylesheet (or several) based on the supplied arguments. #styleSheetLinkTag("styles")# #styleSheetLinkTag("blog,comments")# #styleSheetLinkTag(source="print", media="print")# #styleSheetLinkTag(source="tabs", head=true)# ]]> string 0 The name of one or many CSS files in the `stylesheets` folder, minus the `.css` extension. (Can also be called with the `source` argument.) string 0 text/css The `type` attribute for the `link` tag. string 0 all The `media` attribute for the `link` tag. string 0 false Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior, which is to place the output where the function is called from. string Builds and returns a string containing a submit button `form` control. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #startFormTag(action="something")# #submitTag()# #endFormTag()# ]]> string 0 Save changes Message to display in the button form control. string 0 File name of the image file to use in the button form control. any 0 Whether or not to disable the button upon clicking. (prevents double-clicking.) any Calculates the sum of values for a given property. Uses the SQL function `SUM`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned. ]]> string 1 Name of the property to get the sum for (must be a property of a numeric data type). string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though. boolean 0 false When `true`, `SUM` returns the sum of unique values only. any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. any 0 The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. void Use this method to tell Wheels what database table to connect to for this model. You only need to use this method when your table naming does not follow the standard Wheels convention of a singular object name mapping to a plural table name. ]]> string 1 Name of the table to map this model to. string Returns the name of the database table that this model is mapped to. ]]> string Builds and returns a string containing a text area field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #textArea(label="Overview", objectName="article", property="overview")#

Screenshots #fileField(label="File ##i#", objectName="site", association="screenshots", position=i, property="file")# #textArea(label="Caption ##i#", objectName="site", association="screenshots", position=i, property="caption")#

Phone Numbers #textField(label="Phone ##i#", objectName="contact", association="phoneNumbers", position=i, property="phoneNumber")#

]]> any 1 The variable name of the object to build the form control for. string 1 The name of the property to use in the form control. string 0 The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. string 0 The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out. string 0 useDefaultLabel The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string 0 fieldWithErrors The class name of the HTML tag that wraps the form control when there are errors. string Builds and returns a string containing a text field form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes. #textFieldTag(label="Search", name="q", value=params.q)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 Value to populate in tag's `value` attribute. string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string 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. #timeAgoInWords(aWhileAgo)#]]> date 1 Date to compare from. boolean 0 false Whether or not to include the number of seconds in the returned string. date 0 [runtime expression] Date to compare to. string Builds and returns a string containing three select form controls for hour, minute, and second based on the supplied `objectName` and `property`. #timeSelect(objectName="business", property="openUntil")# #timeSelect(objectName="business", property="openUntil", order="hour,minute")# #timeSelect(objectName="appointment", property="dateTimeStart", minuteStep=15)# ]]> any 0 The variable name of the object to build the form control for. string 0 The name of the property to use in the form control. string 0 The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out. string 0 The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out. string 0 hour,minute,second Use to change the order of or exclude time select tags. string 0 : Use to change the character that is displayed between the time select tags. numeric 0 1 Pass in `10` to only show minute 10, 20, 30, etc. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 false The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string 0 fieldWithErrors The class name of the HTML tag that wraps the form control when there are errors. boolean 0 Set to `false` to not combine the select parts into a single `DateTime` object. boolean 0 false whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs string Builds and returns a string containing three select form controls for hour, minute, and second based on `name`. #timeSelectTags(name="timeOfMeeting" selected=params.timeOfMeeting)# #timeSelectTags(name="timeOfMeeting", selected=params.timeOfMeeting, order="hour,minute")# ]]> string 1 Name to populate in tag's `name` attribute. string 0 Value of option that should be selected by default. string 0 hour,minute,second Use to change the order of or exclude time select tags. string 0 : Use to change the character that is displayed between the time select tags. numeric 0 1 Pass in `10` to only show minute 10, 20, 30, etc. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags. boolean 0 Set to `false` to not combine the select parts into a single `DateTime` object. boolean 0 false whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs string 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. #timeUntilInWords(aLittleAhead)#]]> date 1 Date to compare to. boolean 0 false Whether or not to include the number of seconds in the returned string. date 0 [runtime expression] Date to compare from. string Capitalizes all words in the text to create a nicer looking title. Wheels Is A Framework For ColdFusion]]> string 1 The text to turn into a title. any Assigns to the property specified the opposite of the property's current boolean value. Throws an error if the property cannot be converted to a boolean value. Returns this object if save called internally is `false`. ]]> boolean 0 true Argument to decide whether save the property after it has been toggled. Defaults to true. string Returns an XHTML-compliant string. #toXHTML("productId=5&categoryId=12&returningCustomer=1")# ]]> string 1 String to make XHTML-compliant. string Truncates text to the specified length and replaces the last characters with the specified truncate string (which defaults to "..."). Wheels is a frame... #truncate(text="Wheels is a framework for ColdFusion", truncateString=" (more)")# -> Wheels is a framework f (more)]]> string 1 The text to truncate. numeric 0 30 Length to truncate the text to. string 0 ... String to replace the last characters with. boolean Updates the object with the supplied properties and saves it to the database. Returns `true` if the object was saved successfully to the database and `false` otherwise. ]]> struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) boolean 0 true Set to `false` to skip validations for this operation. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. numeric Updates all properties for the records that match the `where` argument. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument. By default, objects will not be instantiated and therefore callbacks and validations are not invoked. You can change this behavior by passing in `instantiate=true`. This method returns the number of records that were updated. ]]> string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though. struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. boolean 0 false Whether or not to instantiate the object(s) first. When objects are not instantiated, any callbacks and validations set on them will be skipped. boolean 0 true Set to `false` to skip validations for this operation. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. boolean Finds the object with the supplied key and saves it (if validation permits it) with the supplied properties and/or named arguments. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument. Returns `true` if the object was found and updated successfully, `false` otherwise. ]]> any 1 Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list, or a numeric value. struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) boolean 0 true Set to `false` to skip validations for this operation. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. boolean Gets an object based on the arguments used and updates it with the supplied properties. Returns `true` if an object was found and updated successfully, `false` otherwise. ]]> string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you. string 0 Maps to the `ORDER BY` clause of the query. You do not need to specify the table name(s); Wheels will do that for you. struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). boolean 0 false Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.) boolean 0 true Set to `false` to skip validations for this operation. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean 0 false You can set this argument to `true` to include soft-deleted records in the results. boolean Updates all the properties from the `properties` argument or other named arguments. If the object is invalid, the save will fail and `false` will be returned. ]]> struct 0 [runtime expression] Struct containing key/value pairs with properties and associated values that need to be updated globally. any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. boolean 0 true Set to `false` to skip validations for this operation. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. boolean Updates a single property and saves the record without going through the normal validation procedure. This is especially useful for boolean flags on existing records. ]]> string 1 Name of the property to update the value for globally. any 1 Value to set on the given property globally. any 0 true Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only. string 0 [runtime expression] Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether. boolean 0 true Set to `false` to disable callbacks for this operation. string Creates an internal URL based on supplied arguments. #URLFor(controller="account", action="logOut")# #URLFor(action="comments", anchor="comment10")# #URLFor(route="product", categorySlug="accessories", productSlug="battery-charger")#]]> string 0 Name of a route that you have configured in `config/routes.cfm`. string 0 Name of the controller to include in the URL. string 0 Name of the action to include in the URL. any 0 Key(s) to include in the URL. string 0 Any additional params to be set in the query string. string 0 Sets an anchor name to be appended to the path. boolean 0 true If `true`, returns only the relative URL (no protocol, host name or port). string 0 Set this to override the current host. string 0 Set this to override the current protocol. numeric 0 0 Set this to override the current port number. void Used within a controller's `init()` method to specify controller- or action-specific layouts. ]]> string 1 Name of the layout template or method name you want to use string 0 Name of the layout template you want to use for AJAX requests string 0 List of actions that SHOULD NOT get the layout string 0 List of action that SHOULD ONLY get the layout boolean 0 true When specifying conditions or a method, pass `true` to use the default `layout.cfm` if none of the conditions are met boolean Runs the validation on the object and returns `true` if it passes it. Wheels will run the validation process automatically whenever an object is saved to the database, but sometimes it's useful to be able to run this method to see if the object is valid without saving it to the database. ]]> boolean 0 true Set to `false` to disable callbacks for this operation. void Registers method(s) that should be called to validate objects before they are saved. ]]> string 0 Method name or list of method names to call. (Can also be called with the `method` argument.) string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Registers method(s) that should be called to validate new objects before they are inserted. ]]> string 0 Method name or list of method names to call. (Can also be called with the `method` argument.) string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Registers method(s) that should be called to validate existing objects before they are updated. ]]> string 0 Method name or list of method names to call. (Can also be called with the `method` argument.) string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Validates that the value of the specified property also has an identical confirmation value. (This is common when having a user type in their email address a second time to confirm, confirming a password by typing it a second time, etc.) The confirmation value only exists temporarily and never gets saved to the database. By convention, the confirmation property has to be named the same as the property with "Confirmation" appended at the end. Using the password example, to confirm our `password` property, we would create a property called `passwordConfirmation`. ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 0 [property] should match confirmation Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Validates that the value of the specified property does not exist in the supplied list. ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 1 Single value or list of values that should not be allowed. string 0 [property] is reserved Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). boolean 0 false If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't. string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Validates that the value of the specified property is formatted correctly by matching it against a regular expression using the `regEx` argument and/or against a built-in CFML validation type using the `type` argument (`creditcard`, `date`, `email`, etc.). ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 0 Regular expression to verify against. string 0 One of the following types to verify against: `creditcard`, `date`, `email`, `eurodate`, `guid`, `social_security_number`, `ssn`, `telephone`, `time`, `URL`, `USdate`, `UUID`, `variableName`, `zipcode` (will be passed through to your CFML engine's `IsValid()` function). string 0 [property] is invalid Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). boolean 0 false If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't. string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Validates that the value of the specified property exists in the supplied list. ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 1 List of allowed values. string 0 [property] is not included in the list Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). boolean 0 false If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't. string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Validates that the value of the specified property matches the length requirements supplied. Use the `exactly`, `maximum`, `minimum` and `within` arguments to specify the length requirements. ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 0 [property] is the wrong length Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). boolean 0 false If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't. numeric 0 0 The exact length that the property value must be. numeric 0 0 The maximum length that the property value can be. numeric 0 0 The minimum length that the property value can be. string 0 A list of two values (minimum and maximum) that the length of the property value must fall within. string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Validates that the value of the specified property is numeric. ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 0 [property] is not a number Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). boolean 0 false If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't. boolean 0 false Specifies whether the property value must be an integer. string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). boolean 0 Specifies whether or not the value must be an odd number. boolean 0 Specifies whether or not the value must be an even number. numeric 0 Specifies whether or not the value must be greater than the supplied value. numeric 0 Specifies whether or not the value must be greater than or equal the supplied value. numeric 0 Specifies whether or not the value must be equal to the supplied value. numeric 0 Specifies whether or not the value must be less than the supplied value. numeric 0 Specifies whether or not the value must be less than or equal the supplied value. void Validates that the specified property exists and that its value is not blank. ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 0 [property] can't be empty Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). void Validates that the value of the specified property is unique in the database table. Useful for ensuring that two users can't sign up to a website with identical screen names for example. When a new record is created, a check is made to make sure that no record already exists in the database with the given value for the specified property. When the record is updated, the same check is made but disregarding the record itself. ]]> string 0 Name of property or list of property names to validate against (can also be called with the `property` argument). string 0 [property] has already been taken Supply a custom error message here to override the built-in one. string 0 onSave Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`). boolean 0 false If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't. string 0 One or more properties by which to limit the scope of the uniqueness constraint. string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run). string 0 String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run). array Returns an array of all the verifications set on this controller in the order in which they will be executed. ]]> void Instructs Wheels to verify that some specific criterias are met before running an action. ]]> string 0 List of action names to limit this verification to. string 0 List of action names to exclude this verification from. any 0 Set to `true` to verify that this is a `POST` request. any 0 Set to `true` to verify that this is a `GET` request. any 0 Set to `true` to verify that this is an AJAX request. string 0 Verify that the passed in variable name exists in the `cookie` scope. string 0 Verify that the passed in variable name exists in the `session` scope. string 0 Verify that the passed in variable name exists in the `params` struct. string 0 Pass in the name of a function that should handle failed verifications. The default is to just abort the request when a verification fails. string 0 List of types to check each listed `cookie` value against (will be passed through to your CFML engine's `IsValid` function). string 0 List of types to check each list `session` value against (will be passed through to your CFML engine's `IsValid` function). string 0 List of types to check each `params` value against (will be passed through to your CFML engine's `IsValid` function). string Truncates text to the specified length of words and replaces the remaining characters with the specified truncate string (which defaults to "..."). Wheels is a framework... #truncate(text="Wheels is a framework for ColdFusion", truncateString=" (more)")# -> Wheels is a framework for (more)]]> string 1 The text to truncate. numeric 0 5 Number of words to truncate the text to. string 0 ... String to replace the last characters with. string Builds and returns a string containing a select form control for a range of years based on the supplied `name`. #yearSelectTag(name="yearOfBirthday", selected=params.yearOfBirthday)# #yearSelectTag(name="yearOfBirthday", selected=params.yearOfBirthday, startYear=fiftyYearsAgo, endYear=eighteenYearsAgo)# ]]> string 1 Name to populate in tag's `name` attribute. string 0 The year that should be selected initially. numeric 0 2005 First year in select list. numeric 0 2015 Last year in select list. any 0 false Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). string 0 The label text to use in the form control. string 0 around Whether to place the label `before`, `after`, or wrapped `around` the form control. string 0 String to prepend to the form control. Useful to wrap the form control with HTML tags. string 0 String to append to the form control. Useful to wrap the form control with HTML tags. string 0 String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags. string 0 String to append to the form control's `label`. Useful to wrap the form control with HTML tags.