CFLib.org – getComponentProps

getComponentProps(object)

Last updated September 21, 2010

author

Version: 3 | Requires: ColdFusion MX | Library: DataManipulationLib

Rated 1 time(s). Average Rating: 1.0

Description:
Pass in the result from getMetaData() and returns all properties within the cfc and those it extends. It is recursive. (I didn't find any true time difference and this seemed cleaner). This does not include the base 'component' tag in it's search. I couldn't see anyone putting properties there anyways. A special value will be added to each propery, foundIn, that represents which CFC a property was found in. This is useful in case both a child and parent CFC share the same property.

Return Values:
Returns an array of structs.

Example:

view plain print about

<cfset whatever = createobject('component', 'foo.bar')>
<cfset dummyArray = getComponentProps( getMetaData( whatever ))>
<cfdump var="#dummyArray#" />

Parameters:

Name	Description	Required
object	The metadata from a component.	Yes

Full UDF Source:

	
	
			
			
			
				
				view plain
				
				
				copy to clipboard
				
				
				
				
				print
				
				
				about
				ColdFISH is developed by Jason Delmore.  Source code and license information available at coldfish.riaforge.org.  Version 3.1.1
				
			<cfscript>
/**
 * Returns an array of all properties in cfc's metadata, inherited or not.
 * v2 was submitted by salvatore fusto
 * v3 ditto
 * 
 * @param object 	 The metadata from a component. (Required)
 * @return Returns an array of structs. 
 * @author Robby Lansaw (&#114;&#111;&#98;&#98;&#121;&#64;&#111;&#104;&#115;&#111;&#103;&#111;&#111;&#101;&#121;&#46;&#99;&#111;&#109;) 
 * @version 3, September 21, 2010 
 */
function getComponentProps(object) {
       var propArray = arrayNew(1);
       if (structKeyExists(object,'properties')) {
               propArray = object.properties
       }
       if (structKeyExists(object,'extends')) {
               propArray.addAll(getComponentProps(object.extends ))
       }
       return propArray;
}
</cfscript>
		<cfscript>
/**
 * Returns an array of all properties in cfc's metadata, inherited or not.
 * v2 was submitted by salvatore fusto
 * v3 ditto
 * 
 * @param object      The metadata from a component. (Required)
 * @return Returns an array of structs. 
 * @author Robby Lansaw (robby@ohsogooey.com) 
 * @version 3, September 21, 2010 
 */
function getComponentProps(object) {
       var propArray = arrayNew(1);
       if (structKeyExists(object,'properties')) {
               propArray = object.properties
       }
       if (structKeyExists(object,'extends')) {
               propArray.addAll(getComponentProps(object.extends ))
       }
       return propArray;
}
</cfscript>