CFLib.org – isORM

isORM(item)

Last updated May 30, 2010

author

Version: 1 | Requires: ColdFusion 9 | Library: DatabaseLib

Rated 0 time(s). Average Rating: 0

Description:
There is no built in way to check this with a single function at this time. So I created a way to check if the element was either and ORM entity or collection of entities.

Return Values:
Returns a boolean.

Example:

view plain print about

<cfscript>
myStruct = structNew();
myQuery = queryNew();
selector = { id = 12 };
myEntity = EntityLoad('entityClass',selector,true);
</cfscript>

<cfoutput>
myStruct : #is_orm(myStruct)#<br>
myQuery : #is_orm(myQuery)#<br>
myEntity: #is_orm(myEntity)#<br>
</cfoutput>
- - - - - 
This will give the following result.
- - - - -
myStruct : false
myQuery : false
myEntity : true

- - - - -

We are using this logic inside our ReturnData.cfc inside COOP. It enables us to treat the entity as a generic data source and integrate lists, array of structures, queries and entities as data sources without having to manually set an attribute on custom tags and object methods. It's nice to have some intuition in our code.

<cfscript>
myStruct = structNew();
myQuery = queryNew();
selector = { id = 12 };
myEntity = EntityLoad('entityClass',selector,true);
</cfscript>

<cfoutput>
myStruct : #is_orm(myStruct)#<br>
myQuery : #is_orm(myQuery)#<br>
myEntity: #is_orm(myEntity)#<br>
</cfoutput>
- - - - -
This will give the following result.
- - - - -
myStruct : false
myQuery : false
myEntity : true

- - - - -

We are using this logic inside our ReturnData.cfc inside COOP. It enables us to treat the entity as a generic data source and integrate lists, array of structures, queries and entities as data sources without having to manually set an attribute on custom tags and object methods. It's nice to have some intuition in our code.

Parameters:

Name	Description	Required
item	Value to check.	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>
/**
 * Validates if item is orm entity or collection.
 * 
 * @param item 	 Value to check. (Required)
 * @return Returns a boolean. 
 * @author John Farrar (&#106;&#111;&#104;&#110;&#102;&#97;&#114;&#114;&#97;&#114;&#64;&#115;&#111;&#115;&#101;&#110;&#115;&#105;&#98;&#108;&#101;&#46;&#99;&#111;&#109;) 
 * @version 1, May 30, 2010 
 */
function isORM(item) {
	var metaItem = {};
	try {
		if(isArray(arguments.item) && arrayLen(arguments.item)){
			metaItem = getMetadata(arguments.item[1]);
		} else {
			metaItem = getMetadata(arguments.item);
		}
		if(structKeyExists(metaItem,'persistent') && metaItem.persistent){
			return true;
		} else {
			return false;
		}
	} catch(any e) {
		return false;
	}
}
</cfscript>
		<cfscript>
/**
 * Validates if item is orm entity or collection.
 * 
 * @param item      Value to check. (Required)
 * @return Returns a boolean. 
 * @author John Farrar (johnfarrar@sosensible.com) 
 * @version 1, May 30, 2010 
 */
function isORM(item) {
    var metaItem = {};
    try {
        if(isArray(arguments.item) && arrayLen(arguments.item)){
            metaItem = getMetadata(arguments.item[1]);
        } else {
            metaItem = getMetadata(arguments.item);
        }
        if(structKeyExists(metaItem,'persistent') && metaItem.persistent){
            return true;
        } else {
            return false;
        }
    } catch(any e) {
        return false;
    }
}
</cfscript>