Lucee Tag Reference

<cffunction>

Defines a function within a CFML component that can accept arguments and return a value.

Body

This tag must have a body.

Example

<cffunction
[abstract=boolean]
[access=string]
[bufferoutput=boolean]
[cachedwithin=object]
[consumes=string]
[description=string]
[displayname=string]
[hint=string]
[httpmethod=GET|PUT|POST|DELETE]
[localmode=string]
[modifier=string]
name=string
[output=boolean]
[produces=string]
[restpath=string]
[returnformat=string]
[returntype=string]
[roles=string]
[securejson=boolean]
[verifyclient=boolean] ... >
</cffunction>

Attributes

This tag has a fixed definition of attributes (see below). In addition it allows to use any additional attribute

Name	Type	Required	Description
abstract	boolean	No	Indicates whether the function is abstract. Abstract functions must be implemented in a subclass and cannot contain a function body.
access	string	No	Defines the access level for the function. Accepted values include `public`, `private`, and `package`. Defaults to `public` if not specified.
bufferoutput	boolean	No	Determines whether the function's output is buffered. This attribute is only relevant when the `output` attribute is set to `false`. If set to `true` (default), the output generated in the function body is buffered and returned even if an exception occurs. If set to `false`, output is ignored when an error occurs.
cachedwithin	any	No	Determines if the function's output should be cached. Possible values include: `"request"`: Cached content is used if it was created within the current request. A timespan created with the `CreateTimeSpan` function: Cached content is used if the original content falls within the timespan. The function must be called with the exact same arguments to use cached data.
consumes	string	No	A comma-separated list of acceptable MIME types that the function can accept or consume. If no value is specified, all MIME types are consumed by default. Use this attribute to control the types of content the function can handle. This attribute overrides the `consumes` attribute at the component level.
description	string	No	Supplies a short text description of the function.
displayname	string	No	A human-readable name for the function, used in documentation and introspection tools.
hint	string	No	A brief description of what the function does. This hint is used in documentation and introspection tools.
httpmethod	string	No	Specifies the HTTP method to use when calling the function as part of a RESTful service. Accepted values include: `GET`: Requests information from the server. `POST`: Sends information to the server for processing. `PUT`: Requests the server to store the message body at the specified URL. `DELETE`: Requests the server to delete the specified URL. `HEAD`: Similar to GET but without a response body. `OPTIONS`: Requests information about the communication options available for the server or the specified URL. If not specified, the `GET` method is used by default.
localmode	string	No	Defines how the local scope of this function is invoked when a variable without a scope definition is used. Accepted values include: `classic`: The local scope is only invoked when the key already exists in it. `modern`: The local scope is always invoked.
modifier	string	No	Specifies the modifier for the function, such as: `abstract`: The function must be implemented in an extending component. `final`: The function cannot be overridden in any subclass. `static`: The function does not access instance variables in the component.
name	string	Yes	The name of the function. This is a required attribute.
output	boolean	No	Determines how the function's output is handled: `true`: The function's output is processed normally, as if it were within a `cfoutput` tag. `false`: The function's output is suppressed, as if it were within a `cfsilent` tag.
produces	string	No	A comma-separated list of MIME types that the function can produce. The function will respond with the most acceptable media type as declared by the client. This attribute overrides the `produces` attribute at the component level.
restpath	string	No	Defines a sub-resource path for the function when used as part of a RESTful web service. The path is case-sensitive and should avoid special characters. Regular expressions can be included in the path.
returnformat	string	No	Specifies the format in which the function returns its value to a remote caller. Possible values are: `plain` (default) `json` `xml` `wddx` `java`
returntype	string	No	The data type of the function's return value. If not specified, the default is `any`.
roles	string	No	Defines the roles that are permitted to invoke this function. If omitted, all roles can invoke the function.
securejson	boolean	No	Specifies whether to add a security prefix in front of any value that the function returns in JSON format in response to a remote call.
verifyclient	boolean	No	Specifies whether to require remote function calls to include an encrypted security token. This is typically used with AJAX applications.