+Show TOC
×Hide TOC

SharedObjectUtils

Kind of class:	public class
Package:	com.bourre.utils
Inherits from:	none
Version:	1.0
Author:	Francis Bourre, Cédric Néhémie
Classpath:	com.bourre.utils.SharedObjectUtils
File last modified:	Monday, 24 November 2008, 11:36:51

► View source

▼ Hide source

package com.bourre.utils 
{
    import com.bourre.log.PixlibDebug;
    
    import flash.net.SharedObject;    

    /**
     * The original <code>SharedObjectUtils</code> class provide simple methods 
     * to save data on the local machine.
     * 
     * <p>The AS3 version don't handle remote SharedObject. It's not in its main goal.</p>
     * 
     * @author    Francis Bourre
     * @author    C√©dric N√©h√©mie
     * @version 1.0
     * @see        http://livedocs.macromedia.com/flex/2/langref/flash/net/SharedObject.html
     */
    public class SharedObjectUtils
    {
        public function SharedObjectUtils( access : PrivateConstructorAccess )
        {
            
        }
        
        /**
         * Get a value stored in a local SharedObject.
         * 
         * <p>If an error occurs the function return a null value.</p>
         * 
         * @param     sCookieName    Name of the cookie.
         * @param     sObjectName    Field to retreive.
         * @return     The value stored in the field or <code>null</code>.
         */
        public static function loadLocal( sCookieName : String, sObjectName : String ) : *
        {    
            try
            {
                var save:SharedObject = SharedObject.getLocal(sCookieName, "/");
                return save.data[sObjectName];
            }
            catch(e:Error)
            {
                PixlibDebug.ERROR ( e );
                return null;
            }
        }
        /**
         * Save a data in a local SharedObject.
         * 
         * <p>If an error occurs the function die silently and no value is saved.</p>
         * 
         * @param    sCookieName    Name of the cookie.
         * @param    sObjectName    Field to retreive.
         * @param    refValue    Value to save.
         * @return    <code>true</code> if the data have been saved.
         */
        public static function saveLocal(     sCookieName : String, sObjectName : String, refValue : * ) : Boolean
        {
            try
            {
                var save:SharedObject = SharedObject.getLocal( sCookieName );
                save.data[sObjectName] = refValue;
                save.flush();
                return true;
            }
            catch(e:Error)
            {
                PixlibDebug.ERROR ( e );
            }
            return false;
        }
        /**
         * Clear all values stored in a local SharedObject.
         * 
         * <p>If an error occurs the function die silently and return false.</p>
         * 
         * @param    sCookieName Name of the cookie.
         * @return    <code>true</code> if the data have been cleared.
         */
        public static function clearLocal( sCookieName : String ) : Boolean
        {
            try
            {
                var save:SharedObject = SharedObject.getLocal( sCookieName );
                save.clear();
                return true;
            }
            catch( e : Error )
            {
                PixlibDebug.ERROR ( e );
            }
            return false;
        }
    }
}

internal class PrivateConstructorAccess {}

The original SharedObjectUtils class provide simple methods
to save data on the local machine.

The AS3 version don't handle remote SharedObject. It's not in its main goal.

Summary

Constructor

SharedObjectUtils (access:PrivateConstructorAccess)

Class methods

loadLocal (sCookieName:String, sObjectName:String) : *
- Get a value stored in a local SharedObject.
saveLocal (sCookieName:String, sObjectName:String, refValue:*) : Boolean
- Save a data in a local SharedObject.
clearLocal (sCookieName:String) : Boolean
- Clear all values stored in a local SharedObject.

Constructor

SharedObjectUtils

public function SharedObjectUtils (

access:PrivateConstructorAccess)

Class methods

clearLocal

public static function clearLocal (

sCookieName:String) : Boolean

Clear all values stored in a local SharedObject.

If an error occurs the function die silently and return false.

Parameters:

sCookieName:

Name of the cookie.

Returns:

true if the data have been cleared.

loadLocal

public static function loadLocal (

sCookieName:String, sObjectName:String) : *

Get a value stored in a local SharedObject.

If an error occurs the function return a null value.

Parameters:

sCookieName:

Name of the cookie.

sObjectName:

Field to retreive.

Returns:

The value stored in the field or null.

saveLocal

public static function saveLocal (

sCookieName:String, sObjectName:String, refValue:*) : Boolean

Save a data in a local SharedObject.

If an error occurs the function die silently and no value is saved.

Parameters:

sCookieName:

Name of the cookie.

sObjectName:

Field to retreive.

refValue :

Value to save.

Returns:

true if the data have been saved.