cfcomponent

Last updated on May 30, 2024 | Also applies to ColdFusion

ColdFusion

Open app

CFML Reference User Guide

ColdFusion functions

ColdFusion functions by category
Functions a-b
1. Abs
2. ACos
3. AddSOAPRequestHeader
4. AddSOAPResponseHeader
5. AjaxLink
6. AjaxOnLoad
7. ApplicationStop
8. ArrayAppend
9. ArrayAvg
10. ArrayClear
11. ArrayContains
12. ArrayContainsNoCase
13. ArrayDelete
14. ArrayDeleteAt
15. ArrayDeleteNoCase
16. ArrayEach
17. ArrayFilter
18. ArrayFind
19. ArrayFindAll
20. ArrayFindAllNoCase
21. ArrayFindNoCase
22. ArrayInsertAt
23. ArrayIsDefined
24. ArrayIsEmpty
25. ArrayLen
26. ArrayMap
27. ArrayMax
28. ArrayMin
29. ArrayNew
30. ArrayPrepend
31. ArrayReduce
32. ArrayResize
33. ArraySet
34. ArraySetMetadata
35. ArraySlice
36. ArraySort
37. ArraySum
38. ArraySwap
39. ArrayToList
40. Asc
41. ASin
42. Atn
43. AuthenticatedContext
44. AuthenticatedUser
45. BinaryDecode
46. BinaryEncode
47. BitAnd
48. BitMaskClear
49. BitMaskRead
50. BitMaskSet
51. BitNot
52. BitOr
53. BitSHLN
54. BitSHRN
55. BitXor
56. BooleanFormat
Functions-c-d
Functions-e-g
Functions-h-im
Functions-in-k
Functions-l
Functions-m-r
Functions-s
Functions-t-z
1. Tan
2. ThreadJoin
3. ThreadTerminate
4. Throw
5. TimeFormat
6. ToBase64
7. ToBinary
8. ToScript
9. ToString
10. Trace
11. Transactionandconcurrency
12. TransactionCommit
13. TransactionRollback
14. TransactionSetSavePoint
15. Trim
16. UCase
17. URLDecode
18. URLEncodedFormat
19. URLSessionFormat
20. Val
21. ValueList
22. VerifyClient
23. Week
24. Wrap
25. WriteDump
26. WriteLog
27. WriteOutput
28. WSGetAllChannels
29. WSGetSubscribers
30. WSPublish
31. WSSendMessage
32. XmlChildPos
33. XmlElemNew
34. XmlFormat
35. XmlGetNodeType
36. XmlNew
37. XmlParse
38. XmlSearch
39. XmlTransform
40. XmlValidate
41. Year
42. YesNoFormat

ColdFusion tags

ColdFusion tag summary
ColdFusion tags by category
1. Application framework tags
  1. cfapplication
  2. cfassociate
  3. cferror
  4. cfimport
  5. cfinterface
  6. cflock
  7. cfscript
  8. cfthread
2. Communications tags
3. Database manipulation tags
4. Data output tags
  1. cfchart
5. Debugging tags
  1. cfdump
  2. cftimer
  3. cftrace
6. Exception handling tags
  1. cfcatch
  2. cferror
  3. cffinally
  4. cfrethrow
  5. cfthrow
  6. cftry
7. Extensibility tags
  1. cfchart
  2. cfchartdata
  3. cfchartseries
  4. cfcollection
  5. cfcomponent
  6. cfexecute
  7. cfftp
  8. function
  9. cfindex
  10. cfinterface
  11. cfinvoke
  12. cfinvokeargument
  13. cfobject
  14. cfproperty
  15. cfreport
  16. cfreportparam
  17. cfreturn
  18. cfsearch
  19. cfsharepoint
  20. cfspreadsheet
  21. cfwddx
  22. cfxml
8. File management tags
  1. cfdirectory
  2. cffile
  3. cffileupload
  4. cfftp
  5. cfzip
  6. cfzipparam
9. Flow-control tags
  1. cfabort
  2. cfbreak
  3. cfcase
  4. cfcontinue
  5. cfdefaultcase
  6. cfelse
  7. cfelseif
  8. cfexecute
  9. cfexit
  10. cfif
  11. cfinclude
  12. cflocation
  13. cfloop
  14. cfrethrow
  15. cfswitch
  16. cfthrow
  17. cftry
10. Forms tags
  1. cfapplet
  2. cfcalendar
  3. cffileupload
  4. cfform
  5. cfformgroup
  6. cfformitem
  7. cfgrid
  8. cfgridcolumn
  9. cfgridrow
  10. cfgridupdate
  11. cfinput
  12. cfpdf
  13. cfpdfform
  14. cfpdfformparam
  15. cfpdfparam
  16. cfpdfsubform
  17. cfselect
  18. cfslider
  19. cftextarea
  20. cftree
  21. cftreeitem
11. Internet Protocol tags
  1. cfajaximport
  2. cfajaxproxy
  3. cfftp
  4. cffeed
  5. cfimap
  6. cfhttp
  7. cfhttpparam
  8. cfldap
  9. cfmail
  10. cfmailparam
  11. cfmailpart
  12. cfpop
  13. cfsprydataset
12. Page processing tags
  1. cfcache
  2. cfcontent
  3. cfflush
  4. cfheader
  5. cfhtmlhead
  6. cfinclude
  7. cfprocessingdirective
  8. cfsetting
  9. cfsilent
13. Security tags
14. Variable manipulation tags
  1. cfcookie
  2. cfdump
  3. cfparam
  4. cfregistry
  5. cfsavecontent
  6. cfschedule
  7. cfset
  8. cfsetting
15. Other tags
  1. cfimage
  2. cflog
  3. cfregistry
Tags a-b
Tags c
Tags f
Tags g-h
1. cfgraph
2. cfgraphdata
3. cfgrid
4. cfgridcolumn
5. cfgridrow
6. cfgridupdate
7. cfheader
8. cfhtmlhead
9. cfhtmltopdf
10. cfhtmltopdfitem
11. cfhttp
12. cfhttpparam
Tags i
1. cfif
2. cfimage
3. cfimap
4. cfimapfilter
5. cfimpersonate
6. cfimport
7. cfinclude
8. cfindex
9. cfinput
10. cfinsert
11. cfinterface
12. cfinvoke
13. cfinvokeargument
Tags j-l
Tags m-o
Tags p-q
1. cfparam
2. cfpdf
3. cfpdfform
4. cfpdfformparam
5. cfpdfparam
6. cfpdfsubform
7. cfpod
8. cfpop
9. cfpresentation
10. cfpresentationslide
11. cfpresenter
12. cfprint
13. cfprocessingdirective
14. cfprocparam
15. cfprocresult
16. cfprogressbar
17. cfproperty
18. cfquery
19. cfqueryparam
Tags r-s
1. cfregistry
2. cfreport
3. cfreportparam
4. cfrethrow
5. cfreturn
6. cfsavecontent
7. cfschedule
8. cfscript
9. cfsearch
10. cfselect
11. cfservlet
12. cfservletparam
13. cfset
14. cfsetting
15. cfsharepoint
16. cfsilent
17. cfslider
18. cfspreadsheet
19. cfsprydataset
20. cfstoredproc
21. cfswitch
Tags t
1. cftable
2. cftextarea
3. cftextinput
4. cfthread
5. cfthrow
6. cftimer
7. cftooltip
8. cftrace
9. cftransaction
10. cftree
11. cftreeitem
12. cftry
Tags u-z
1. cfupdate
2. cfwddx
3. cfwebsocket
4. cfwindow
5. cfxml
6. cfzip
7. cfzipparam

CFML Reference

Cloud services

CFML Reference User Guide
ColdFusion functions
ColdFusion tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

Creates and defines a component object; encloses functionality that you build in CFML and enclose in cffunction tags. This tag contains one or more cffunction tags that define methods. Code within the body of this tag, other than cffunction tags, is executed when the component is instantiated.A component file has the extension CFC and is stored in any directory of an application.
A component method is invoked in the following ways:

In the cfinvoke tag in a ColdFusion page
In a URL that calls a CFC file and passes a method name as a URL parameter
In the cfscript tag
As a web service
From Flash code

Syntax

<cfcomponent

accessors = "yes|no"

autoIndex = "yes|no"

alias = "ActionScript 3 type alias"

bindingname = "binding element name"

displayname = "string"

extends = "component name"

hint = "string"

implements = "ColdFusion interface"

indexable = "yes|no"

indexLanguage = "language"

initMethod = "method name"

mappedSuperClass = "yes|no"

namespace = "default service namespace"

ormInitMethod="orminitfunc"

output = "no value|no|yes"

persistent = "yes|no"

porttypename = "port type element name"

Serializable = "yes|no"

serviceaddress = "service URL"

serviceportname = "port element name"

style = "rpc|document|wrapped"

wsversion = "1|2"

wsdlfile = "path">

variable declarations

...

</cffunction>

...

</cffunction>

</cfcomponent>

<cfcomponent accessors = "yes|no" autoIndex = "yes|no" alias = "ActionScript 3 type alias" bindingname = "binding element name" displayname = "string" extends = "component name" hint = "string" implements = "ColdFusion interface" indexable = "yes|no" indexLanguage = "language" initMethod = "method name" mappedSuperClass = "yes|no" namespace = "default service namespace" ormInitMethod="orminitfunc" output = "no value|no|yes" persistent = "yes|no" porttypename = "port type element name" Serializable = "yes|no" serviceaddress = "service URL" serviceportname = "port element name" style = "rpc|document|wrapped" wsversion = "1|2" wsdlfile = "path"> variable declarations <cffunction ...> ... </cffunction> <cffunction ...> ... </cffunction> </cfcomponent>

<cfcomponent  
accessors = "yes|no"  
autoIndex = "yes|no"  
alias = "ActionScript 3 type alias"  
bindingname = "binding element name"  
displayname = "string"  
extends = "component name"  
hint = "string"  
implements = "ColdFusion interface"  
indexable = "yes|no"  
indexLanguage = "language" 
initMethod = "method name" 
mappedSuperClass = "yes|no"  
namespace = "default service namespace"  
ormInitMethod="orminitfunc" 
output = "no value|no|yes" 
persistent = "yes|no" 
porttypename = "port type element name"  
Serializable = "yes|no"  
serviceaddress = "service URL"  
serviceportname = "port element name"  
style = "rpc|document|wrapped"  
wsversion = "1|2"  
wsdlfile = "path">  
variable declarations  
<cffunction ...>  
...  
</cffunction>  
 
<cffunction ...>  
...  
</cffunction>  
</cfcomponent>

History

ColdFusion 10: Added the attributes rest, restPath, httpMethod, produces, consumes, indexable, indexLanguage, autoIndex, wsVersion

ColdFusion 9.0.1: Added the attribute mappedSuperClass

ColdFusion 9: Added the attributes initMethod, serializable and accessors.

ColdFusion 8:

Added the implements and serviceaddress attributes.
Added support for the onMissingMethod function.
ColdFusion MX 7:
Added support for publishing document-literal style web services.
Added the style, namespace, serviceportname, porttypename, wsdlfile, bindingname, and output attributes.
Extended functionality for the hint and displayname attributes when publishing document-literal style web services.

ColdFusion MX: Added this tag.

ATTRIBUTES

Attribute	Req/Opt	Default	Description
accessors	Optional	yes (for persistent CFC)no for others	If set to yes, lets you invoke implicit getters and setters. For persistent CFC, accessors is always enabled.
alias	Optional		Specifies the type label to give the object when it is converted from CFML to ActionScript 3. It matches the alias attribute of AS3 types. This is attribute applies only to Flash Remoting and LiveCycle Data Services value objects, and lets you work with typed objects in both ColdFusion and Flash.
autoIndex	Optional	yes	If no, auto-indexing of CFC does not occur. That is, indexing occurs only in offline mode.
bindingname	Optional		Specifies the binding attribute of the port element in the WSDL. If you don't specify this attribute, ColdFusion derives the value from the CFC class name.
consumes	optional	/	Comma-separated list of acceptable MIME types, for example consumes="text/plain,text/html".Searches for the Content-Type header in the HTTP request; if the value is, for example HTML or XML, ColdFusion finds the appropriate method which can handle the request and invoke the method.Used to specify which MIME media types of representation a resource can accept or consume, from the client. If this attribute is used at the component level (and not at the function level), all the response methods accept the specified MIME types by default. If no function in a CFC can consume the MIME type in a client request, the following error occurs: 415 Unsupported Media Type. If no value is specified, / is taken by default, which means, all MIME types are consumed.
displayname	Optional		A string that displays when you use introspection to show information about the CFC. The information appears on the heading, following the component name.
extends	Optional	WEB-INF.cftags.component	Name of parent component from which to inherit methods and properties. You can use the keyword component to specify the default value.
hint	Optional		Text that displays when you use introspection to show information about the CFC. The hint attribute value appears below the component name heading. Use this attribute to describe the purpose of the parameter.
httpMethod	optional		The HTTP method to use, must be one of the following: GET: Requests information from the server. Any data that the server requires to identify the requested information must be in the URL or in cfhttpparam type="URL" tag. POST: Sends information to the server for processing. Requires one or more cfhttpparam tags. Often used for submitting form-like data. PUT: Requests the server to store the message body at the specified URL. Use this method to send files to the server. DELETE: Requests the server to delete the specified URL. HEAD: Identical to the GET method, but the server does not send a message body in the response. Use this method for testing hypertext links for validity and accessibility, determining the type or modification time of a document, or determining the type of server. If you have not specified HEAD, by default, GET method is called. However, message body is not sent in the response. OPTIONS: A request for information about the communication options available for the server or the specified URL. This method enables the ColdFusion application to determine the options and requirements associated with a URL, or the capabilities of a server, without requesting any additional activity by the server. If you have not specified OPTIONS, then ColdFusion sends a response. Based on the request method, the corresponding function is invoked. For example, if a GET request is sent to the server, then a function with httpMethod as GET is invoked. If this value is not specified at the function level, then the value you define here is used. So all functions for which httpMethod is not specified are assigned this value.
implements	Optional		Name of the ColdFusion interface or interfaces that this component implements. If the component implements an interface, it must define all the functions in the interface, and the function definitions must conform to the definitions specified in the interface. For more information, see cfinterface.A component can implement any number of interfaces. To specify multiple interfaces, use a comma-delimited list with the format interface1,interface2.
indexable	Optional	no	If yes, enables indexing for the component.
indexLanguage	Optional	english	Specify the language that is used to index and search. The value you set overrides the value defined in the Application.cfc.
initMethod	Optional	init	Allows the specification of a different method to use for the component's constructor.
mappedSuperClass	Optional	no	If set to yes on a non-persistent CFC, child CFCs can inherit its properties. For example, you can define a base CFC with common properties such as ID, version, or createdOn which all other persistent CFCs would extend and thus get one common behavior.mappedSuperClass cannot be set to yes on a persistent CFC.
namespace	Optional	class name	Specifies the namespace used in the WSDL for a CFC that is invoked as a web service. If you don't specify this attribute, ColdFusion derives the value from the CFC class name.
output	Optional	Component body displayable text that is processed as standard CFML	Specifies whether constructor code in the component can generate HTML output; does not affect output in the body of cffunction tags in the component. yes: Constructor code is processed as if it were within a cfoutput tag. Variable names surrounded by number signs (#) are automatically replaced with their values. no: Constructor code is processed as if it were within a cfsilent tag. If you do not specify this attribute, constructor code is processed as standard CFML. Any variables must be in cfoutput tags.
orminitmethod	Optional		ORMInitMethod support for CFComponent. See example below.
persistent	Optional		Specifies if the CFC is persistent or not.
porttypename	Optional		Specifies the name attribute of the porttype element in the WSDL. If you don't specify this attribute, ColdFusion derives the value from the CFC class name.
produces	optional	/	Comma-separated list of acceptable MIME types, for example produces="text/plain,text/html". Searches for the Accept header in the HTTP request or extension in the URL (valid extensions are .xml and .json); if the value is, for example HTML, JSON, or XML, ColdFusion finds the appropriate method that can handle the request and invoke the method.Used to specify the MIME media types or representations a CFC can produce and send back to the client. If specified at the component level (and not at the function level) , all the functions in a CFC can produce the specified MIME types by default. If no methods in a CFC can produce the MIME type in a client request, the following error occurs: 406 Not Acceptable. If no value is specified, / is taken by default, which means, all MIME types are produced.
rest	Optional	true if RestPath is specified	If true, the CFC is REST-enabled.
restPath	Optional		You can access the REST resource either by providing a REST path or CFC path. So specify if you want to use a path other than the CFC path. If rest="true" and you do not specify this attribute, path to the CFC is used.Path to the CFC should be from the directory registered as a REST service. Also, you should include the CFC name in the path. For example, if you have a folder college that is registered as RestTest, and you want to publish student.cfc which is in a sub-folder department (in the folder college), then the URL used to access student.cfc is as follows: http://localhost:8500/rest/RestTest/department/student . The restPath in this case is department/student. The path is case-sensitive. Also, it is preferable to avoid special character in the path.At CFC level, specify the path as follows:restPath="restService" or {{restPath="test/restService"}}You can specify templates as value of restPath. For example, restPath="{name}". This means, all URLs in the format <Base URL>/rest/<service_mapping>/<any string without slash> matches the restPath. For example, http://localhost:8500/rest/service1/abc . The value in place of template can be accessed using the restargsource value path. For details, see the attribute details of cfargument. The attribute can have complex expressions as values. For example, restpath="customers/{firstname}-{lastname}". This matches URLs such as "/customers/paul-bensen" but not "/customers/paulbensen".Also restPath can include regular expressions such as restpath="/customers/{id : d+}". Here, id is an integer that can match "/customers/123111" but not "/customers/asd" or "/customers/123/122". If you have two methods with different path attribute values and if the paths are ambiguous, then there are precedence rules for finding the match. For example, restpath="/customers/{id : .+}". This expression matches any stream of characters after /customer. It matches "/customers/123", "/customers/asd", and "/customers/123/12/asdfa", but not "/customers". You can also have expressions such as restPath="/customers/{id : .+}/address", the URL "/customers/123/asd/address" is matched with both URLs. In such scenarios, the precedence rules are used to find the match.
serializable	Optional	true	Specifies whether this component can be serialized. If you set this value to false, the component and the data in the component's This and Variables scopes cannot be serialized, so they are not retained on session replication, and the component is in its default state.
serviceaddress	Optional	URL of the CFC	Specifies the SOAP URL of the web service. If you don't specify this attribute, ColdFusion uses the URL of the CFC in the WSDL service description. Use this attribute to specify the protocol, for example, by specifying a URL that starts with https:// . This attribute applies only for web services.
serviceportname	Optional		Specifies the name attribute of the port element in the WSDL. If you don't specify this attribute, ColdFusion derives the value from the CFC class name.
style	Optional	rpc	Specifies whether a CFC used for web services uses RPC-encoded style or document-literal style: rpc: RPC-encoded style document: Document-literal style wrapped: If you are setting wsVersion as 2, the default value is wrapped and if it is 1, then the default value is rpc.
wsdlfile	Optional		A properly formatted WSDL file to be used instead of WSDL generated by ColdFusion.
wsVersion	Optional		If you specify 2, CFC is deployed using Axis 2 engine. The value you specify overrides the value you specify at application or server level.

Usage

If you specify the extends attribute, the data and methods of the parent component are available to CFC methods as if they were parts of the current component. If the managerCFC component extends the employeeCFC component, and the employeeCFC component has a getEmployeeName method, you can call this method by using the managerCFC, as follows:

This tag requires an end tag.

If you specify style="document", ColdFusion publishes the CFC as a document-literal style web service. For more information, see Publishing document-literal style web services in the Developing ColdFusion Applications.

CFCs support an onMissingMethod function. By defining an onMissingMethod function in the cfcomponent tag body in the CFC, you can handle calls to methods that are not implemented in the CFC. If an application calls a function that is not defined in the CFC, ColdFusion calls the onMissingMethod function and passes it the requested method's name and arguments. If you do not define an onMissingMethod function, a call to a method that is not defined in the CFC causes ColdFusion to throw an error that must be handled in the calling code.
The onMissingMethod function is useful for several purposes:

To handle errors directly in the component, instead of requiring that each instance of code that calls the component handles them.
To create a dynamic proxy, an object that can take arbitrary calls and dynamically determines the correct action.
The onMissingMethodfunction must have the following format:

code to handle call to nonexistent method

</cffunction>

<cffunction name="onMissingMethod"> <cfargument name="missingMethodName" type="string"> <cfargument name="missingMethodArguments" type="struct"> code to handle call to nonexistent method </cffunction>

<cffunction name="onMissingMethod"> 
<cfargument name="missingMethodName" type="string"> 
<cfargument name="missingMethodArguments" type="struct"> 
code to handle call to nonexistent method 
</cffunction>

Note: The argument name for onMissingMethod must not change.

Example 1

SELECT FIRSTNAME, LASTNAME, EMAIL

FROM tblEmployees

</cfquery>

</cffunction>

SELECT *

FROM tblDepartments

</cfquery>

</cffunction>

</cfcomponent>

<cfcomponent> <cffunction name="getEmp"> <cfquery name="empQuery" datasource="cfdocexamples" > SELECT FIRSTNAME, LASTNAME, EMAIL FROM tblEmployees </cfquery> <cfreturn empQuery> </cffunction> <cffunction name="getDept"> <cfquery name="deptQuery" datasource="cfdocexamples" > SELECT * FROM tblDepartments </cfquery> <cfreturn deptQuery> </cffunction> </cfcomponent>

<cfcomponent> 
<cffunction name="getEmp"> 
<cfquery name="empQuery" datasource="cfdocexamples" > 
SELECT FIRSTNAME, LASTNAME, EMAIL 
FROM tblEmployees 
</cfquery> 
<cfreturn empQuery> 
</cffunction> 

<cffunction name="getDept"> 
<cfquery name="deptQuery" datasource="cfdocexamples" > 
SELECT * 
FROM tblDepartments 
</cfquery> 
<cfreturn deptQuery> 
</cffunction> 
</cfcomponent>

EXAMPLE- ORMINITMETHOD ATTRIBUTE

Application.cfc

component

{

this.name = "OrmInitMethod";

this.datasource = "sqlserver2012_merant";

this.ormEnabled = true;

this.ormSettings.dbcreate="dropcreate";

}

component { this.name = "OrmInitMethod"; this.datasource = "sqlserver2012_merant"; this.ormEnabled = true; this.ormSettings.dbcreate="dropcreate"; }

component 
{ 
 this.name = "OrmInitMethod"; 
 this.datasource = "sqlserver2012_merant"; 
 this.ormEnabled = true; 
 this.ormSettings.dbcreate="dropcreate"; 
}

HistoryEntry.cfc

component persistent="true" table="tbl_case_history" ormInitMethod="ormInit"

{

property name="id" type="numeric" fieldtype="id" generator="native";

property name="caseNumber" type="numeric" column="case_number";

property name="Description" type="string" column="Description";

public HistoryEntry function ormInit()

{

WriteOutput("Called from ormInit method!!!");

return this;

}

public HistoryEntry function init(required caseNumber numeric)

{

variables.caseNumber = arguments.caseNumber

WriteDump("Called from Init method!!!","console");

return this;

}

component persistent="true" table="tbl_case_history" ormInitMethod="ormInit" { property name="id" type="numeric" fieldtype="id" generator="native"; property name="caseNumber" type="numeric" column="case_number"; property name="Description" type="string" column="Description"; public HistoryEntry function ormInit() { WriteOutput("Called from ormInit method!!!"); return this; } public HistoryEntry function init(required caseNumber numeric) { variables.caseNumber = arguments.caseNumber WriteDump("Called from Init method!!!","console"); return this; } }

component persistent="true" table="tbl_case_history" ormInitMethod="ormInit" 
{ 
 
 property name="id" type="numeric" fieldtype="id" generator="native"; 
 property name="caseNumber" type="numeric" column="case_number"; 
 property name="Description" type="string" column="Description"; 
 
 public HistoryEntry function ormInit() 
 { 
  WriteOutput("Called from ormInit method!!!"); 
  return this; 
 } 
 
 public HistoryEntry function init(required caseNumber numeric) 
 { 
  variables.caseNumber = arguments.caseNumber 
  WriteDump("Called from Init method!!!","console"); 
  return this; 
 } 
 
}

index.cfm

historyObj = entityNew("HistoryEntry");

historyObj.setCaseNumber(1);

historyObj.setDescription("This is a sample case.");

entitysave(historyObj);

obj = entityLoad('HistoryEntry');

writedump(obj);

ApplicationStop();

</cfscript>

<cfscript> historyObj = entityNew("HistoryEntry"); historyObj.setCaseNumber(1); historyObj.setDescription("This is a sample case."); entitysave(historyObj); obj = entityLoad('HistoryEntry'); writedump(obj); ApplicationStop(); </cfscript>

<cfscript> 
 historyObj = entityNew("HistoryEntry"); 
 historyObj.setCaseNumber(1); 
 historyObj.setDescription("This is a sample case."); 
 entitysave(historyObj); 
 
 obj = entityLoad('HistoryEntry'); 
 writedump(obj); 
 
 ApplicationStop(); 
 
</cfscript>

Get help faster and easier

New user?

cfcomponent

Description

Category

Syntax

See also

History

Usage

Example 1

Get help faster and easier

Share this page

Ask the Community

Contact Us