continued.......
FormHandler.as
/**
* This class is basically a command-fascade pattern for handling forms. This class uses classes with the IFormCollection
* to collect data and validate contents. It then sends the data to a server side script.
*
* <p>The events dispatched from this class include:
* Event.INIT - whenever the vars sends it to the server
* Event.COMPLETE - whenever the server returns a response and it is in valid syntax
* ErrorEvent.ERROR - whenever something goes wrong from getting a response from the sever such as invalid syntax
* IOErrorEvent.IO_ERROR - whenever the url is not found.</p>
*
*/
package
{
import flash.text.TextFormat;
import flash.utils.Dictionary;
import flash.net.URLRequest;
import flash.net.URLVariables;
import flash.net.URLRequestMethod;
import flash.net.URLLoader;
import flash.net.URLLoaderDataFormat;
import flash.events.Event;
import flash.events.ErrorEvent;
import flash.events.IOErrorEvent;
import flash.events.EventDispatcher;
import flash.net.navigateToURL;
import com.*.v1.forms.IFormCollection;
public class FormHandler extends EventDispatcher
{
protected var collections:Array = new Array();
protected var allObjects:Array = new Array();
protected var errorObjects:Array = new Array();
protected var allData:Dictionary = new Dictionary();
protected var allRequest:Dictionary = new Dictionary();
protected var urlVars:URLVariables = new URLVariables();
protected var response:String;
public function FormHandler()
{
//
}
/**
* This method adds a collection
*
* @param collect A class that implements IFormCollection to be registered
*/
public function addCollection(collect:IFormCollection):void
{
allObjects = new Array();
collections.push(collect);
for (var i:int=0; i<collections.length; i++)
allObjects = allObjects.concat(collections[i].allObjs);
}
/**
* This method check all collections to see if they all have valid enteries
*
* @param return Returns true if everything is valid. False if there are errors.
*/
public function validate():Boolean
{
var valid:Boolean = true;
for (var i:int=0; i<collections.length; i++)
{
var temp:Boolean = collections[i].validate();
valid &&= temp; // must write this out the long was and it won't loop through if short hand
}
for (var j:int=0; j<collections.length; j++) errorObjects.concat(collections[j].errorObjs);
return valid;
}
/**
* This method loops through all the collections and add the data to a dictionary instance.
*/
public function collect():void
{
var i:int;
for (i=0; i<collections.length; i++)
{
collections[i].collect();
}
for (i=0; i<collections.length; i++)
{
var objs:Array = collections[i].allObjs;
for (var j:int=0; j<objs.length; j++)
{
allData[ objs[j] ] = collections[i].data[ objs[j] ];
allRequest[ objs[j] ] = collections[i].requests[ objs[j] ];
urlVars[ allRequest[objs[j]] ] = allData[ objs[j] ];
}
}
}
/**
* This method loops through all the collections and sets the objs to perform task upon an initial click
* such as clearing the text.
*
* @param tf is the TextFormat to apply to the obj after it has been clicked....MAYBE
*/
public function focusActions(tf:TextFormat=null):void
{
for (var i:int=0; i<collections.length; i++)
{
collections[i].focusActions();
}
}
/**
* This method loops through all the collections and sets the errorObjs to the error status.
*
* @param tf is the TextFormat to apply to the error message....MAYBE
*/
public function setErrors(tf:TextFormat=null):void
{
for (var i:int=0; i<collections.length; i++)
{
collections[i].errorState();
}
}
/**
* This method loops through all the collections and sets the objects back to the orignal states
*/
public function reset():void
{
for (var i:int=0; i<collections.length; i++)
{
collections[i].reset();
}
}
/**
* This method allows additional variables to be sent in addition to the ones collected
* by the collections
*
* @param vars The URLVariables to send in addition to the collections
*/
public function addVars(vars:URLVariables):void
{
for (var prop:* in vars)
{
urlVars[prop] = vars[prop];
}
}
/**
* This method sends the collected var to a url
*
* @param url Where to send the data
* @param method How to send the data
*/
public function sendVars(url:String, method:String=URLRequestMethod.POST):void
{
var loader:URLLoader = new URLLoader();
loader.addEventListener(Event.COMPLETE, onComplete);
loader.addEventListener(ErrorEvent.ERROR, onError);
loader.addEventListener(IOErrorEvent.IO_ERROR, onError);
var request:URLRequest = new URLRequest(url);
request.method = method;
loader.dataFormat = URLLoaderDataFormat.VARIABLES;
request.data = urlVars;
loader.load( request );
//navigateToURL(request, "_blank"); // for debugging
dispatchEvent( new Event(Event.INIT) );
}
protected function onComplete(e:Event):void
{
try
{
var loader:URLLoader = URLLoader(e.target);
var variables:URLVariables = new URLVariables(loader.data);
response = variables.echo;
dispatchEvent( new Event(Event.COMPLETE) );
}
catch(e:Error)
{
dispatchEvent( new ErrorEvent(ErrorEvent.ERROR) );
}
}
protected function onError(e:ErrorEvent):void
{
dispatchEvent(e); // this will dispatch an IO_ERROR or plain ERROR
//dispatchEvent( new ErrorEvent(ErrorEvent.ERROR) );
}
}
}
Ok so there are many many problems with this. The first of which I've addressed above. The way it currently validates the input make it very difficult to extend it.
Maybe the class is trying to do too much and the client should be more responsible for handling errors in the validation.
What you think Michael? How's that mess for a start?