AS2: SharedObjectManager

Posted on
11/16/2007 in AS2 • My Classes

View Documentation
Download Class

A simple utility to manage shared objects and their properties.

PLAIN TEXT
Actionscript:
  1. import mx.events.EventDispatcher;
  2. import mx.utils.Delegate;
  3.  
  4. /**
  5. * A simple utility to manage shared objects and their properties.
  6. *
  7. * @usage
  8. * <code>
  9. * <pre>
  10. import com.reintroducing.utils.SharedObjectManager;
  12. var som:SharedObjectManager = new SharedObjectManager("userData");
  14. som.setProperty("hasVisited", "yes");
  16. trace(som.getProperty("hasVisited"));
  17. * </pre>
  18. * </code>
  19. *
  20. * @author Matt Przybylski [http://www.reintroducing.com]
  21. * @version 1.0
  22. */
  23.  
  24. class com.reintroducing.utils.SharedObjectManager
  25. {
  26. //- PRIVATE VARIABLES -------------------------------------------------------------------------------------
  27.     
  28.     private var dispatchEvent:Function;
  29.    
  30.     private var _so:SharedObject;
  31.    
  32. //- PUBLIC VARIABLES --------------------------------------------------------------------------------------
  33.    
  34.     public static var DEFAULT_NAME:String = "com.reintroducing.utils.SharedObjectManager";
  35.    
  36.     public var addEventListener:Function;
  37.     public var removeEventListener:Function;
  38.    
  39. //- CONSTRUCTOR -------------------------------------------------------------------------------------------
  40.    
  41.     /**
  42.      * Creates a new instance of the SharedObjectManager class.
  43.      *
  44.      * @usage <pre><code>var som:SharedObjectManager = new SharedObjectManager($name);</code></pre>
  45.      *
  46.      * @param $name A string value representing the shared object to create/retrieve from the user's hard drive
  47.      */
  48.    
  49.     public function SharedObjectManager($name:String)
  50.     {
  51.         EventDispatcher.initialize(this);
  52.        
  53.         this._so = SharedObject.getLocal($name);
  54.         this._so.onStatus = Delegate.create(this, onStatus);
  55.     }
  56.    
  57. //- PRIVATE METHODS ---------------------------------------------------------------------------------------
  58.    
  59.     private function onStatus($evt:Object):Void
  60.     {
  61.         switch ($evt.code)
  62.         {
  63.             case "SharedObject.Flush.Success":
  64.                 this.dispatchEvent({type: "onSOManagerSuccess", target: this});
  65.                 break;
  66.            
  67.             case "SharedObject.Flush.Failed":
  68.                 this.dispatchEvent({type: "onSOManagerFailed", target: this});
  69.                 break;
  70.         }
  71.     }
  72.    
  73. //- PUBLIC METHODS ----------------------------------------------------------------------------------------
  74.    
  75.     /**
  76.      * Sets a "cookie" (property/value pair) object in the current shared object and saves it to the user's hard drive.
  77.      *
  78.      * @usage <pre><code>som.setProperty("hasVisited", "yes");</code></pre>
  79.      *
  80.      * @param $name A string that represents the name of the property to be stored in the shared object
  81.      * @param $value A string that represents the value of the property to be stored in the shared object
  82.      *
  83.      * @return Nothing
  84.      */
  85.    
  86.     public function setProperty($name:String, $value:Object):Void
  87.     {
  88.         this._so.data[$name] = $value;
  89.         this._so.flush();
  90.     }
  91.    
  92.     /**
  93.      * Returns the value for the requested property.
  94.      *
  95.      * @usage <pre><code>som.getProperty("hasVisited");</code></pre>
  96.      *
  97.      * @param $name A string that represents the name of the property you want to retrieve
  98.      *
  99.      * @return String
  100.      */
  101.    
  102.     public function getProperty($name:String):String
  103.     {
  104.         return this._so.data[$name];
  105.     }
  106.    
  107.     /**
  108.      * Clears the current shared object.
  109.      *
  110.      * @usage <pre><code>som.clear();</code></pre>
  111.      *
  112.      * @return Nothing
  113.      */
  114.    
  115.     public function clear():Void
  116.     {
  117.         this._so.clear();
  118.     }
  119.    
  120. //- EVENT HANDLERS ----------------------------------------------------------------------------------------
  121.    
  122.    
  123.    
  124. //- GETTERS & SETTERS -------------------------------------------------------------------------------------
  125.    
  126.    
  127.    
  128. //- HELPERS -----------------------------------------------------------------------------------------------
  129.    
  130.     public function toString():String
  131.     {
  132.         return "com.reintroducing.utils.SharedObjectManager";
  133.     }
  134.    
  135. //- END CLASS ---------------------------------------------------------------------------------------------
  136. }

,

If you found this post useful, please consider leaving a comment, subscribing to the feed, or making a small donation.

1 Comment
Pingback by SharedObjectManager v1.1 Updates | EVOLVE on April 12, 2008 @ 9:14 pm

[...] I went ahead and threw in the secure parameter as well in case anyone needs it. I've updated the AS2 and AS3 versions to version 1.1 and you can grab the updated files at the respective links. I've [...]

Leave a comment

(required)

(required)