DefaultScope

The DefaultScope plugin seeks to add the functionality of Rails' ActiveRecord::Base#default_scope to Wheels. While you can use set() right now in Wheels to alter the global defaults of the findAll() method, you can't set a scope for individual models. With this plugin, you can specify default values for the findAll() method on a specific model.

This plugin overrides the findAll() method and adds a new method called defaultScope().

New Methods

• defaultScope([ where, order, select, distinct, include, maxRows, page, perPage, count, handle, cache, reload, parameterize, returnAs, returnIncluded ])

This method is mixed in to your Models and is meant to be invoked from the init() method. It takes all of the same optional arguments as the findAll() method, and will set them as defaults for future calls to that method.

Overridden Methods

• findAll()

While this method has been overridden in order to accommodate the new defaultScope settings, it still behaves the same as it did before. Use it the way you normally would. Just remember that you might have set some values in the defaultScope(). If you set new values for the same parameters here, those values will override the values set in defaultScope().

How to Use

Install it! Then the new method is automatically available to you.

Uninstallation

All you need to do is delete the /plugins/DefaultScope-x.x.zip file.

Thanks

To the rather active CFWheels Google group, and especially James Gibson who helped squirrel out an annoying bug during the initial development.

<!--- in any model --->
<cffunction name="init">
<!--- assume we have a model containing user information, and you want to sort by the last name then first for most of your findAll() requests. --->
<cfset defaultScope(order="lastName, firstName") />
</cffunction>