• Basics
  • Introduction
  • Hello World
  • External Variables
  • Defaulting, Requiring, Redirecting
  • Data Types
  • Imitating Inheritance
  • Additional Methods
  • AJAX
• Special Functionality
  • Filtering from URL Variables
• Change Log
  • Change Log

Filtering from URL Variables

The Page Controller can automatically create structure keys for use in filtering and adjust the title accordingly based on incoming URL variables. The "addURLFilter" method is provided for this use:

Arguments:

• vars (struct, required): The variables scope of the page.
• structname (string, required): The name of the structure into which to insert data.
• urlvar (string, required): The name of the URL variable to use.
• key (string, required): The name of the key to add to the structure.
• Comp (component, required): The name of the component to use.
• Method (string, default:getLabelFieldValue): A method that will return a string to add to the title. A value will be added to the structure only if this returns a non-empty string.
• TitleJoin (string, default:for): The word to go between the title and the word returned by the method. Alternately, a string containing [Title] and [Label] that will be used for the title (taking [Title] as a placeholder for the original title and [Label] as the string returned from the method).

Example:

Here is a Page Controller for an order-list.cfm page:

<cfcomponent>

<cfset loadExternalVars("Orders,Customers")>

<cffunction name="loadData" access="public" returntype="struct" output="no">
	
	<cfset var local = StructNew()>
	<cfset var vars = getDefaultVars("Orders","list")>
	
	<cfset addURLFilter(vars,"sFilters","customer","CustomerID",variables.Customers)>
	
	<cfreturn vars>
</cffunction>

</cfcomponent>

For our example, assume that variables.Customers.getLabelFieldValue(2) returns "Bob Smith".

You could call this page as order-list.cfm?customer=2 and the "sFilters" structure would have a sFilters["CustomerID"] = 2 and the title of the page would be "Orders for Bob Smith".