findByKey()

Description

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().

Function Syntax

findByKey(key [, select, include, cache, reload, parameterize, returnAs ])

Parameters

Parameter Type Required Default Description
key any Yes 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.
select string No 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.
include string No 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.
cache any No 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).
reload boolean No 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).
parameterize any No 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.
returnAs string No object Can be set to either object or query. See documentation for findAll() for more info.

Examples

<!--- Getting the author with the primary key vale 99 as an object --->
<cfset auth = model("author").findByKey(99)>

<!--- Getting an author based on a form/URL value and then checking if it was found --->
<cfset auth = model("author").findByKey(params.key)>
<cfif NOT IsObject(auth)>
    <cfset flashInsert(message="Author #params.key# was not found")>
    <cfset redirectTo(back=true)>
</cfif>

<!--- If you have a `belongsTo` association setup from `comment` to `post` you can do a scoped call (the `post` method below will call `model("post").findByKey(comment.postId)` internally) --->
<cfset aComment = model("comment").findByKey(params.commentId)>
<cfset aPost = aComment.post()>