CFLib.org – WDDXFileRead

WDDXFileRead(file)

Last updated October 15, 2002

author

Version: 2 | Requires: ColdFusion MX | Library: CFMLLib

Rated 1 time(s). Average Rating: 5.0

Description:
Ever get annoyed at the couple of lines you are always writing to store and retrieve WDDX in flat files? Then this is the UDF for you. Also see it's sister UDF WDDXFileWrite()

Return Values:
Returns deserialized data.

Example:

view plain print about

<cfscript>
	hello = structNew();
	hello.foo.bar = 2;
	hello.thing = "a string";
//	wddxfileWrite(expandPath("test.wddx"),hello);
//	stuff = WDDXFileRead(expandPath("test.wddx"));
</cfscript>
<!---
<cfdump var="#stuff#">
--->

<cfscript>
    hello = structNew();
    hello.foo.bar = 2;
    hello.thing = "a string";
//    wddxfileWrite(expandPath("test.wddx"),hello);
//    stuff = WDDXFileRead(expandPath("test.wddx"));
</cfscript>

Parameters:

Name	Description	Required
file	File to read and deserialize.	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
				
			<!---
 Reads a file containing WDDX and returns the CF variable.
 Updated for CFMX var scope syntax.
 
 @param file 	 File to read and deserialize. (Required)
 @return Returns deserialized data. 
 @author Nathan Dintenfass (&#110;&#97;&#116;&#104;&#97;&#110;&#64;&#99;&#104;&#97;&#110;&#103;&#101;&#109;&#101;&#100;&#105;&#97;&#46;&#99;&#111;&#109;) 
 @version 2, October 15, 2002 
--->
<cffunction name="WDDXFileRead" output="no">
	<cfargument name="file" required="yes">
	
	<cfset var tempPacket = "">
	<cfset var tempVar = "">
	
	<!--- make sure the file exists, otherwise, throw an error --->
	<cfif NOT fileExists(file)>
		<cfthrow message="WDDXFileRead() error: File Does Not Exist" detail="The file #file# called in WDDXFileRead() does not exist">
	</cfif>
	<!--- read the file --->
	<cffile action="read" file="#file#" variable="tempPacket">
	<!--- make sure it is a valid WDDX Packet --->
	<cfif NOT isWDDX(tempPacket)>
		<cfthrow message="WDDXFileRead() error: Bad Packet" detail="The file #file# called in WDDXFileRead() does not contain a valid WDDX packet">		
	</cfif>
	<!--- deserialize --->
	<cfwddx action="wddx2cfml" input="#tempPacket#" output="tempVar">
	<cfreturn tempVar>    
</cffunction>
		<!---
 Reads a file containing WDDX and returns the CF variable.
 Updated for CFMX var scope syntax.
 
 @param file      File to read and deserialize. (Required)
 @return Returns deserialized data. 
 @author Nathan Dintenfass (nathan@changemedia.com) 
 @version 2, October 15, 2002 
--->
<cffunction name="WDDXFileRead" output="no">
    <cfargument name="file" required="yes">
    
    <cfset var tempPacket = "">
    <cfset var tempVar = "">
    
    <!--- make sure the file exists, otherwise, throw an error --->
    <cfif NOT fileExists(file)>
        <cfthrow message="WDDXFileRead() error: File Does Not Exist" detail="The file #file# called in WDDXFileRead() does not exist">
    </cfif>
    <!--- read the file --->
    <cffile action="read" file="#file#" variable="tempPacket">
    <!--- make sure it is a valid WDDX Packet --->
    <cfif NOT isWDDX(tempPacket)>
        <cfthrow message="WDDXFileRead() error: Bad Packet" detail="The file #file# called in WDDXFileRead() does not contain a valid WDDX packet">        
    </cfif>
    <!--- deserialize --->
    <cfwddx action="wddx2cfml" input="#tempPacket#" output="tempVar">
    <cfreturn tempVar>    
</cffunction>