Lucee Tag Reference

<cfcomponent>

The `component` tag is used to define a CFML component (CFC), which is a reusable encapsulation of logic and data in Lucee. Components allow for structured, object-oriented development by encapsulating related properties and functions within a single object. Inside the `component` tag, functions are defined using `cffunction` tags. Code placed outside `cffunction` tags within a component is executed when the component is instantiated. This tag is fundamental for building modular and maintainable code in CFML applications.

Body

This tag must have a body.

Example

<cfcomponent
[accessors=boolean]
[alias=string]
[bindingname=string]
[displayname=string]
[extends=string]
[hint=string]
[implements=string]
[mappedsuperclass=boolean]
[modifier=none|final|abstract]
[namespace=string]
[output=boolean]
[persistent=boolean]
[porttypename=string]
[serviceaddress=string]
[serviceportname=string]
[style=string]
[synchronized=boolean]
[wsdlfile=string] ... >
</cfcomponent>
This tag is also supported within cfscript
<cfscript>
component
[accessors=boolean]
[alias=string]
[bindingname=string]
[displayname=string]
[extends=string]
[hint=string]
[implements=string]
[mappedsuperclass=boolean]
[modifier=none|final|abstract]
[namespace=string]
[output=boolean]
[persistent=boolean]
[porttypename=string]
[serviceaddress=string]
[serviceportname=string]
[style=string]
[synchronized=boolean]
[wsdlfile=string]... {
[...]
}
</cfscript>

Attributes

This tag has a fixed definition of attributes (see below). In addition it allows to use any additional attribute
Name Type Required Description
accessors boolean No If set to true, enables implicit getters and setters for the component's properties. For persistent CFCs, accessors are always enabled. 
alias string No Defines an alternative name or alias for the component, providing flexibility in referencing the component in different contexts. 
bindingname string No Defines the name of the `binding` element in the WSDL. This attribute applies only when `style="document"`. 
displayname string No A user-friendly name for the component, used when displaying information about the CFC during introspection. This value appears alongside the component name and is used in the WSDL service element if the style is set to document. 
extends string No Specifies the name of the parent component from which to inherit properties and functions, facilitating code reuse and modularity. 
hint string No Provides a description of the component's purpose, displayed during introspection. This hint helps document the functionality and usage of the component. 
implements string No Lists the interfaces that the component implements, specifying the set of functions that the component must provide. 
mappedsuperclass boolean No Indicates whether the component acts as a mapped superclass. A mapped superclass serves as a base class for other components to extend but does not itself represent a database entity. 
modifier string No Defines the type of component: `none` for a regular component, `abstract` for a component that cannot be instantiated directly and must be extended, or `final` for a component that cannot be extended by other components. 
namespace string No Specifies the namespace for the WSDL when the CFC is used as a document-literal style web service. If not specified, Lucee derives the namespace from the CFC class name. This attribute applies only when `style="document"`. 
output boolean No - `true`: Allows the output generated by component functions to be displayed.
  • `false`: Suppresses the output generated by component functions, preventing it from being displayed. 
    		•
    persistent boolean No Specifies whether the component is persistent, meaning it can be saved to and loaded from a storage medium such as a database. 
    porttypename string No Specifies the name of the `portType` element in the WSDL, applicable only when `style="document"` is used. 
    serviceaddress string No Defines the SOAP URL of the web service. If not specified, Lucee uses the URL of the CFC in the WSDL service description. This attribute is particularly useful for specifying the protocol, such as using a URL starting with `https://`. It applies only to web services. 
    serviceportname string No Specifies the name of the port element in the WSDL. This attribute is relevant only when `style="document"` is used for web services. 
    style string No Determines whether the CFC, when used for web services, uses RPC-encoded style or document-literal style. This attribute controls the format of the generated WSDL. 
    synchronized boolean No If set to true, synchronizes all calls to an instance of the component, ensuring that each function can only be executed by one thread at a time, thereby providing thread safety. 
    wsdlfile string No Specifies a custom WSDL file to be used instead of the automatically generated WSDL by Lucee. This is applicable only when `style="document"`.