void Adds an error on a specific property. ]]> string 1 The name of the property you want to add an error for. 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 route to your application. ]]> string 1 Name for the route. string 1 The URL pattern for the route. 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 (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 (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 e-mail addresses into clickable links. 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`. numeric Calculates the average value for a given property. Uses the SQL function `AVG`. ]]> string 1 Name of the property to calculate the average for. string 0 An SQL fragment such as `lastName LIKE 'A%'` for example. string 0 Any associations that need to be included in the query. 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. 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. ]]> 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 class (usually not needed if you follow the Wheels conventions since the model name will be deduced from the `name` argument). string 0 Foreign key property name (usually not needed if you follow the 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 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 (can also be called with the `action` argument). numeric 0 60 Minutes to cache the action(s) for. 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`.

#checkBox(objectName="photo", property="isPublic", label="Display this photo publicly.")#

]]> 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 1 The value of the check box when it's on the `checked` state. string 0 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing a check box form control based on the supplied `name`.

#checkBoxTag(name="suscribe", value="true", label="Suscribe to our newsletter", checked=false)#

]]> 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 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around 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. string Returns a list of column names in the table mapped to this model. The list is ordered according to the columns ordinal position in the database table. ]]> string Used inside a layout file to output the HTML created in the view. My Site #contentForLayout()# ]]> numeric Returns the number of rows that match the arguments (or all rows if no arguments are passed in). Uses the SQL function `COUNT`. ]]> string 0 An SQL fragment such as `lastName LIKE 'A%'` for example. string 0 Any associations that need to be included in the query. 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). boolean 0 true Whether or not to set default values for properties. any 0 true See documentation for @findAll. 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 a date based on the supplied `objectName` and `property`.

#dateSelect(objectName="user", property="dateOfBirth")#

]]> 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 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 2004 First year in select list. numeric 0 2014 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. 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing three select form controls (month, day and year).

#dateSelectTags()#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] 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 2004 First year in select list. numeric 0 2014 Last year in select list. string 0 names Pass in `names`, `numbers` or `abbreviations` to control display. any 0 false See documentation for @select. 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. 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")#

]]> 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 month,day,year See documentation for @dateSelect. string 0 See documentation for @dateSelect. numeric 0 2004 First year in select list. numeric 0 2014 Last year in select list. string 0 names Pass in `names`, `numbers` or `abbreviations` to control display. string 0 hour,minute,second See documentation for @timeSelect. string 0 : See documentation for @timeSelect. 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. 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing six select form controls (three for date selection and the remaining three for time selection).

#dateTimeSelectTags()#

]]> string 0 month,day,year See documentation for @dateSelect. string 0 See documentation for @dateSelect. numeric 0 2004 See documentation for @dateSelect. numeric 0 2014 See documentation for @dateSelect. string 0 names See documentation for @dateSelect. string 0 hour,minute,second See documentation for @timeSelect. string 0 : See documentation for @timeSelect. numeric 0 1 See documentation for @timeSelect. 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. 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. 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")#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around 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 Accepts a boolean value or a string. Set to `true` to use `cfqueryparam` on all columns or pass in a list of property names to use `cfqueryparam` on those only. 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`, `AND`, and `OR` (note that the key words have to be written in upper case). You can also use parentheses to group statements. You do not have 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. any 0 true Accepts a boolean value or a string. 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 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 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`, `AND`, and `OR` (note that the key words have to be written in upper case). You can also use parentheses to group statements. You do not have to specify the table name(s), Wheels will do that for you. string 0 This argument maps to the `ORDER BY` clause of the query. You do not have to specify the table name(s), Wheels will do that for you. 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 exists, the first one is returned. #errorMessageFor(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 error-message 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 error-messages CSS class to set on the `ul` element. boolean 0 true Whether to show duplicate error messages. array Returns an array of all errors associated with the supplied property (and error name when 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 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`, `AND`, and `OR` (note that the key words have to be written in upper case). You can also use parentheses to group statements. You do not have 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 has been run in the same request (the default in Wheels is to get the second query from the cache). any 0 true Accepts a boolean value or a string. 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`.

#fileField(objectName="photo", property="imageFile")#

]]> 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 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing a file form control based on the supplied `name`.

#fileFieldTag(name="photo")#

]]> string 1 Name to populate in tag's `name` 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. void Tells Wheels to run a function before an action is run or after an action has been run. You can also specify multiple functions and actions. ]]> string 1 Function(s) to execute before or after the action(s). string 0 before Whether to run the function(s) before or after the action(s). string 0 Pass in a list of action names (or one action name) to tell Wheels that the filter function(s) should only be run on these actions. string 0 Pass in a list of action names (or one action name) to tell Wheels that the filter function(s) should be run on all actions except the specified ones. any Returns records from the database table mapped to this model according to the arguments passed in (use the `where` argument to decide which records to get, use the `order` argument to set in what order those records should be returned and so on). The records will be returned as either a `cfquery` result set or an array of objects (depending on what the `returnAs` argument is set to). Instead of using the `where` argument you can create cleaner code by making use of a concept called dynamic finders. ]]> string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `AND`, and `OR` (note that the key words have to be written in upper case). You can also use parentheses to group statements. You do not have to specify the table name(s), Wheels will do that for you. string 0 This argument maps to the `ORDER BY` clause of the query. You do not have to specify the table name(s), Wheels will do that for you. string 0 This argument determines how the `SELECT` clause for the query used to return data will look. You can pass in a list of the properties (which maps to columns) that you want returned from your table(s). If you don't set this argument at all, Wheels will select all properties from your table(s). If you specify a table name (e.g. `users.email`) or alias a column (e.g. `fn AS firstName`) in the list then the entire list will be passed through unchanged and used in the `SELECT` clause of the query. If not, Wheels will prepend the table name and resolve any naming collisions (which could happen when using the `include` argument) automatically for you. The naming collisions are resolved by prepending the model name to the property name so `users.firstName` could become `userFirstName` for example. boolean 0 false Boolean value to decide whether to add the `DISTINCT` keyword to your `SELECT` clause. Wheels will, when necessary, add this automatically (when using pagination and a `hasMany` association is used in the `include` argument to name one example). 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. numeric 0 -1 Maximum number of records to retrieve. Passed on to the `maxRows` `cfquery` attribute. The default `-1` means that all records will be retrieved. numeric 0 0 If you want to paginate records (i.e. get records 11-20 for example) you can do so by specifying a page number here. For example, getting records 11-20 would be page number 2 when `perPage` is kept at the default setting (10 records per page). The default, `0`, means that records won't be paginated and that the `perPage`, `count` and `handle` arguments will be ignored. numeric 0 10 When using pagination you can specify how many records you want to fetch per page here. This argument is only used when the `page` argument has been passed in. numeric 0 0 When using pagination and you know in advance how many records you want to paginate through you can pass in that value here. Doing so will prevent Wheels from running a `COUNT` query to get this value. This argument is only used when the `page` argument has been passed in. string 0 query Handle to use for the query in pagination. This is useful when you're paginating multiple queries and need to reference them in the @paginationLinks function for example. This argument is only used when the `page` argument has been passed in. any 0 Accepts a boolean or numeric value. If you want to cache the query you can do so by specifying the number of minutes you want to cache the query for here. If you set it to `true` the default cache time will be used (60 minutes). boolean 0 false Set to `true` to force Wheels to query the database even though an identical query has been run in the same request (the default in Wheels is to get the second query from the cache). any 0 true Accepts a boolean value or a string. 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 query Set this to `objects` to return an array of objects instead of a query result set which is the default return type. boolean 0 true When `returnAs` is set to `objects` you can set this argument to `false` to prevent returning objects fetched from associations specified in the `include` argument. This is useful when you only need to include associations for use in the `WHERE` clause only and want to avoid the performance hit that comes with object creation. any Fetches the requested record and returns it as an object. Returns `false` if no record is found. You can override this behavior to return a `cfquery` result set instead, similar to what's described in the documentation for @findOne. ]]> 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. string 0 This argument determines how the `SELECT` clause for the query used to return data will look. You can pass in a list of the properties (which maps to columns) that you want returned from your table(s). If you don't set this argument at all, Wheels will select all properties from your table(s). If you specify a table name (e.g. `users.email`) or alias a column (e.g. `fn AS firstName`) in the list then the entire list will be passed through unchanged and used in the `SELECT` clause of the query. If not, Wheels will prepend the table name and resolve any naming collisions (which could happen when using the `include` argument) automatically for you. The naming collisions are resolved by prepending the model name to the property name so `users.firstName` could become `userFirstName` for example. 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. any 0 Accepts a boolean or numeric value. If you want to cache the query you can do so by specifying the number of minutes you want to cache the query for here. If you set it to `true` the default cache time will be used (60 minutes). boolean 0 false Set to `true` to force Wheels to query the database even though an identical query has been run in the same request (the default in Wheels is to get the second query from the cache). any 0 true Accepts a boolean value or a string. 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 object Can be set to either `object` or `query`. See documentation for @findAll for more info. any Fetches the first record found based on the `WHERE` and `ORDER BY` clauses. With the default settings (i.e. the `returnAs` argument set to `object`) a model object will be returned if the record is found and the boolean value `false` if not. Instead of using the `where` argument you can create cleaner code by making use of a concept called dynamic finders. ]]> string 0 This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `AND`, and `OR` (note that the key words have to be written in upper case). You can also use parentheses to group statements. You do not have to specify the table name(s), Wheels will do that for you. string 0 This argument maps to the `ORDER BY` clause of the query. You do not have to specify the table name(s), Wheels will do that for you. string 0 This argument determines how the `SELECT` clause for the query used to return data will look. You can pass in a list of the properties (which maps to columns) that you want returned from your table(s). If you don't set this argument at all, Wheels will select all properties from your table(s). If you specify a table name (e.g. `users.email`) or alias a column (e.g. `fn AS firstName`) in the list then the entire list will be passed through unchanged and used in the `SELECT` clause of the query. If not, Wheels will prepend the table name and resolve any naming collisions (which could happen when using the `include` argument) automatically for you. The naming collisions are resolved by prepending the model name to the property name so `users.firstName` could become `userFirstName` for example. 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. any 0 Accepts a boolean or numeric value. If you want to cache the query you can do so by specifying the number of minutes you want to cache the query for here. If you set it to `true` the default cache time will be used (60 minutes). boolean 0 false Set to `true` to force Wheels to query the database even though an identical query has been run in the same request (the default in Wheels is to get the second query from the cache). any 0 true Accepts a boolean value or a string. 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 object Can be set to either `object` or `query`. See documentation for @findAll for more info. any Gets the value of a specific key in the Flash (or the entire flash as a struct if no key is passed in). #flash("message")#

]]> string 0 The key to get the value for. void Deletes everything from the Flash. ]]> numeric Checks 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 to the Flash. ]]> boolean Checks if the Flash is empty. ]]> boolean Checks if a specific key exists in the Flash. do something... ]]> string 1 The key to check if it exists. any Returns the current setting for the supplied variable name. ]]> string 1 Variable name to get setting for. string 0 Function name to get setting for. boolean Returns `true` if the specified object property (or any if none was passed in) have 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 and 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 class (usually not needed if you follow the Wheels conventions since the model name will be deduced from the `name` argument). string 0 Foreign key property name (usually not needed if you follow the 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 Set this argument to create an additional dynamic method that gets the objects for a many-to-many association. string 0 [runtime expression] Set this argument if you need to override the Wheels convention when using the `shortcut` argument. 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 class (usually not needed if you follow the Wheels conventions since the model name will be deduced from the `name` argument). string 0 Foreign key property name (usually not needed if you follow the 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 Builds and returns a string containing a hidden field form control based on the supplied `objectName` and `property`.

#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 Builds and returns a string containing a hidden field form control based on the supplied `name`.

#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")#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string Returns readable text by capitalizing, converting camel casing to multiple words. #humanize("wheelsIsAFramework")#]]> string 1 Text to humanize. string Returns an `img` tag and will (if the image is stored in the local `images` folder) set the `width`, `height`, and `alt` attributes automatically for you. string 1 Image file name if local or full URL if remote. string Includes the specified file in the view. Similar to using `cfinclude` but with the ability to cache the result and using Wheels specific file look-up. By default, Wheels will look for the file in the current controller's view folder. To include a file relative from the `views` folder, you can start the path supplied to `name` with a forward slash. #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 file to be used (starting with an optional path and with the underscore and file extension excluded). string 0 Field to group the query by. A new query will be passed into the partial template for you to iterate over. any 0 See documentation for @renderPage. string 0 See documentation for @renderPage. string 0 HTML or string to place between partials when called using a query. boolean Returns whether the page was called from JavaScript or not. ]]> boolean Returns whether the request was a normal (GET) request or not. ]]> boolean Returns `true` if this object hasn't been saved yet (in other words no record exists in the database yet). Returns `false` if a record exists. ]]> boolean Returns whether the request came from a form submission or not. ]]> string Returns a `script` tag for a Javascript file (or several) tag based on the supplied arguments. #javaScriptIncludeTag("main")# ]]> 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 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. 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]]> 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 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. numeric Calculates the maximum value for a given property. Uses the SQL function `MAX`. ]]> string 1 Name of the property to get the highest value for (has to be a property of a numeric data type). string 0 An SQL fragment such as `lastName LIKE 'A%'` for example. string 0 Any associations that need to be included in the query. numeric Calculates the minimum value for a given property. Uses the SQL function `MIN`. ]]> string 1 Name of the property to get the lowest value for (has to be a property of a numeric data type). string 0 An SQL fragment such as `lastName LIKE 'A%'` for example. string 0 Any associations that need to be included in the query. 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")#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around 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 (class name) 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")#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. 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 false Whether or not to set default values for properties. string Obfuscates a value, typically used for hiding primary key values when passed along in the URL. ]]> any 1 Value to obfuscate. struct Returns a struct with information about the specificed paginated query. The variables that will be returned 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. 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. 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). string Builds and returns a string containing a password field form control based on the supplied `objectName` and `property`.

#passwordField(objectName="user", property="pass")#

]]> 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 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing a password field form control based on the supplied `name`.

#passwordFieldTag(name="password")#

]]> 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string Returns a list of all installed plugins. ]]> string Returns the plural form of the passed in word. #pluralize("person")# Your search returned #pluralize(word="person", count=users.recordCount)#]]> string 1 The word to pluralize. numeric 0 -1 Pluralization will occur when this value is not `1`. boolean 0 true Will return `count` prepended to the pluralization when `true` and `count` is not `-1`. string Returns the name of the primary key for this model's table. This is determined through database introspection. If composite primary keys have been used they will both be returned in a list. ]]> struct Returns a structure of all the properties with their names as keys and the values of the property as values. ]]> void Use this method to map an object property to either a table column with a different name than the property or to a specific SQL function. You only need to use this method when you want to override the default mapping that Wheels performs. ]]> string 1 The name that you want to use for the column or SQL function result in the CFML code. string 0 The name of the column in the database table to map the property to. string 0 An SQL function to use to calculate the property value. string Returns a list of property names ordered by their respective column's ordinal position in the database table and with eventual calculated properties at the end. ]]> string Builds and returns a string containing a radio button form control based on the supplied `objectName` and `property`.

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

]]> 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 1 The value of the radio button when `selected`. 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing a radio button form control based on the supplied `name`.

#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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. void Redirects the browser to the supplied `controller`/`action`/`key`, `route` or back to the referring page. Internally It 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 `cflocation`. numeric 0 302 See documentation for `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. void Reloads the property values of this object from the database. ]]> void Renders a blank string to the browser. 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 Renders content to the browser by including the view page for the specified `controller` and `action`. ]]> 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. any 0 true The layout to wrap the content in. any 0 Minutes to cache the content for. string 0 Set to `string` to return the result to the controller instead of sending it to the browser immediately. any Renders content to the browser by including a partial. ]]> string 1 The name of the file to be used (starting with an optional path and with the underscore and file extension excluded). any 0 Minutes to cache the content for. string 0 The layout to wrap the content in. string 0 Set to `string` to return the result to the controller instead of sending it to the browser immediately. void Renders the specified text to the browser. ]]> any 1 The text to be rendered. 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. 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 Accepts a boolean value or a string. 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 Whether or not to set default values for properties. boolean 0 true Whether or not to run validations when saving 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")#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string Builds and returns a string containing a select form control based on the supplied `objectName` and `property`.

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

]]> 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. 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 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing a select form control based on the supplied `name` and `options`.

#selectTag(name="cityId", options=cities)#

]]> 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. void Sends an email using a template and an optional layout to wrap it in. ]]> 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 (can also be called with the `template` argument). string 1 Email address to send from. string 1 Email address to send to. string 1 The subject line of the email. any 0 false Layout(s) to wrap body in. boolean 0 true When set to `true` Wheels will detect which of the templates is text and which one is html (by counting the `<` characters). void Sends a file to the user (from the `files` folder 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 or set to 'attachment' to force a download dialog box void Use to configure a global setting or set a default for a function. ]]> 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). 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`. #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 links from. string Returns a `link` tag for a stylesheet (or several) based on the supplied arguments. #styleSheetLinkTag("styles")# ]]> 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 Builds and returns a string containing a submit button `form` control. #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 to disable the button upon clicking (prevents double-clicking). numeric Calculates the sum of values for a given property. Uses the SQL function `SUM`. ]]> string 1 Name of the property to get the sum for (has to be a property of a numeric data type). string 0 An SQL fragment such as `lastName LIKE 'A%'` for example. string 0 Any associations that need to be included in the query. boolean 0 false When `true`, `SUM` returns the sum of unique values only. 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`.

#textArea(objectName="article", property="overview")#

]]> 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 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing a text area form control based on the supplied `name`.

#textAreaTag(name="description")#

]]> string 1 Name to populate in tag's `name` attribute. string 0 Content to display in `textarea` 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string Builds and returns a string containing a text field form control based on the supplied `objectName` and `property`.

#textField(label="First Name", objectName="user", property="firstName")#

]]> 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 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing a text field form control based on the supplied `name`.

#textFieldTag(name="someName")#

]]> 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around 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 a time based on the supplied `objectName` and `property`.

#timeSelect(objectName="business", property="openUntil")#

]]> 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 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. 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. string 0 span HTML tag to wrap the form control with when the object contains errors. string Builds and returns a string containing three select form controls for a time based on the supplied `objectName` and `property`.

#timeSelectTags(name="timeOfMeeting")#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] 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 See documentation for @select. 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags. 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. string Truncates text to the specified length and replaces the last characters with the specified truncate string. (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 Accepts a boolean value or a string. Set to `true` to use `cfqueryparam` on all columns or pass in a list of property names to use `cfqueryparam` on those only. 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`, `AND`, and `OR` (note that the key words have to be written in upper case). You can also use parentheses to group statements. You do not have 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. struct 0 [runtime expression] The properties you want to set on the object (can also be passed in as named arguments). any 0 true Accepts a boolean value or a string. 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 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 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`, `AND`, and `OR` (note that the key words have to be written in upper case). You can also use parentheses to group statements. You do not have to specify the table name(s), Wheels will do that for you. string 0 This argument maps to the `ORDER BY` clause of the query. You do not have 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). string Creates an internal URL based on supplied arguments. #URLFor(controller="account", action="logOut")# #URLFor(action="comments", anchor="comment10")#]]> 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 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. ]]> 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 (common when having a user type in their email address, choosing a password 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. 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 (`creditcard`, `date`, `email` etc) using the `type` argument. ]]> 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`, `zipcode` (will be passed through to CFML'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. 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. 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. numeric 0 0 The exact length that the property value has to be. numeric 0 0 The maximum length that the property value has to be. numeric 0 0 The minimum length that the property value has to be. string 0 A list of two values (minimum and maximum) that the length of the property value has to 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. boolean 0 false Specifies whether the property value has to 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). 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. 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). void Tells Wheels to verify that some specific criterias are met before running an action. ]]> string 0 Pass in a list of action names (or one action name) to tell Wheels that the verifications should only be run on these actions. string 0 Pass in a list of action names (or one action name) to tell Wheels that the filter function(s) should be run on all actions except the specified ones. 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. string 0 Verify that the passed in variable name exists in the session. string 0 Verify that the passed in variable name exists in the params. string 0 Pass in the name of a function that should handle failed verifications (default is to just abort the request when a verification fails). string Builds and returns a string containing a select form control for a range of years based on the supplied `name`.

#yearSelectTag(name="yearOfBirthday")#

]]> string 1 Name to populate in tag's `name` attribute. date 0 [runtime expression] The year that should be selected initially. numeric 0 2004 First year in select list. numeric 0 2014 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 around HTML tags. string 0 String to append to the form control. Useful to wrap the form control around HTML tags. string 0 String to prepend to the form control's label. Useful to wrap the form control around HTML tags. string 0 String to append to the form control's label. Useful to wrap the form control around HTML tags.