cfparam

Tests for a parameter's existence, tests its data type, and, if
a default value is not assigned, optionally provides one.

 <cfparam name="">

Attribute Reference for the cfparam tag

name

Required: Yes
Name of parameter to test (such as "client.email" or
"cookie.backgroundColor"). If omitted, and if the
parameter does not exist, an error is thrown.

type

Required: No
Default: Any
The valid format for the data; one of the following.
* any: any type of value.
* array: an array of values.
* binary: a binary value.
* boolean: a Boolean value: yes, no, true, false, or a number.
* creditcard: a 13-16 digit number conforming to the mod10 algorithm.
* date or time: a date-time value.
* email: a valid e-mail address.
* eurodate: a date-time value. Any date part must be in the format dd/mm/yy, The format can use /, -, or . characters as delimiters.
* float or numeric: a numeric value.
* guid: a Universally Unique Identifier of the form "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" where 'X' is a hexadecimal number.
* numeric: a numeric value
* integer: an integer.
* query: a query object.
* range: a numeric range, specified by the min and max attributes.
* regex or regular_expression: matches input against pattern attribute.
* ssn or social_security_number: a U.S. social security number.
* string: a string value or single character.
* struct: a structure.
* telephone: a standard U.S. telephone number.
* URL: an http, https, ftp, file, mailto, or news URL.
* UUID: a ColdFusion Universally Unique Identifier, formatted 'XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXX', where 'X' is a hexadecimal number. See CreateUUID.
* USdate: a U.S. date of the format mm/dd/yy, with 1-2 digit days and months, 1-4 digit years.
* variableName: a string formatted according to ColdFusion variable naming conventions.
* xml: XML objects and XML strings.
* zipcode: U.S., 5- or 9-digit format ZIP codes. Values:
  • any
  • array
  • binary
  • boolean
  • creditcard
  • date
  • time
  • email
  • eurodate
  • float
  • numeric
  • guid
  • integer
  • query
  • range
  • regex
  • regular_expression
  • ssn
  • social_security_number
  • string
  • struct
  • telephone
  • url
  • uuid
  • usdate
  • variablename
  • xml
  • zipcode

default

Required: No
Value to set parameter to if it does not exist. Any
expression used for the default attribute is evaluated,
even if the parameter exists.
The result is not assigned if the parameter exists,
but if the expression has side effects, they still occur.

max

Required: No
The maximum valid value; used only for range validation.

min

Required: No
The minimum valid value; used only for range validation.

pattern

Required: No
A regular experession that the parameter must match;
used only for regex or regular_expression validation.

Examples sample code using the cfparam tag


cfparam in CFML

A very basic CFML cfparam example

<cfparam name="userID" default="0"/>

cfparam in cfscript

A very basic cfscript cfparam example

cfparam(name="userID", default=0);
param userID=0;

Tag syntax using a regex

Throws an error if the value is not one of a list of possible values

<cfparam name="sortdir" default="ASC" type="regex" pattern="ASC|DESC"/>

Fork me on GitHub