Packagesystem.serializers.eden
Classpublic class EdenConfigurator
InheritanceEdenConfigurator Inheritance Configurator Inheritance Object

The configurator object of the eden parser.



Public Properties
 PropertyDefined By
  allowAliases : Boolean
Allows to use aliases in the eden parser.
EdenConfigurator
  allowFunctionCall : Boolean
Allows to execute function call.
EdenConfigurator
  arrayIndexAsBracket : Boolean
When set to false array index are evaluated without bracket eval( test.0 ) for Flash ActionScript When set to true array index are evaluated with bracket eval( test[0] ) for JavaScript, JScript, JSDB etc.
EdenConfigurator
  authorized : Array
List of authorized keywords, objects path and constructors that the parser is allowed to interpret.
EdenConfigurator
  autoAddScopePath : Boolean
Determinates if the add scope process is automatic or not.
EdenConfigurator
  compress : Boolean
Parameter to remove (true) or add (false) all unecessary spaces, tabs, carriages returns, lines feeds etc.
EdenConfigurator
  copyObjectByValue : Boolean
Parameter allowing to copy objects by value if true or by reference if false.
EdenConfigurator
  security : Boolean
Parameter setting on (true) or off (false) the security.
EdenConfigurator
  strictMode : Boolean
Allows to define the case-sensitivy of the parsers.
EdenConfigurator
  undefineable : *
Value assigned to a variable when this one is not found or not authorized.
EdenConfigurator
  verbose : Boolean
Parameter allowing to trace messages in the console if the environment permit it.
EdenConfigurator
Public Methods
 MethodDefined By
  
EdenConfigurator(config:Object)
Creates a new EdenConfigurator instance.
EdenConfigurator
 Inherited
load(config:Object):void
Copy all properties in the specified passed-in object in the internal config object of the Configurator.
Configurator
 Inherited
toSource(indent:int = 0):String
Returns the source code string representation of the object.
Configurator
 Inherited
toString():String
Returns the String representation of the object.
Configurator
Property Detail
allowAliasesproperty
allowAliases:Boolean

Allows to use aliases in the eden parser.


Implementation
    public function get allowAliases():Boolean
    public function set allowAliases(value:Boolean):void
allowFunctionCallproperty 
allowFunctionCall:Boolean

Allows to execute function call. if set to false it blocks any functrion call and return undefined.

Example:

         "titi = \"hello world\";
         toto = titi.toUpperCase();"
         
         // allowFunctionCall = true
         toto = "HELLO WORLD"
         
         // allowFunctionCall = false
         toto = undefined
         


Implementation
    public function get allowFunctionCall():Boolean
    public function set allowFunctionCall(value:Boolean):void
arrayIndexAsBracketproperty 
arrayIndexAsBracket:Boolean

When set to false array index are evaluated without bracket eval( test.0 ) for Flash ActionScript When set to true array index are evaluated with bracket eval( test[0] ) for JavaScript, JScript, JSDB etc.


Implementation
    public function get arrayIndexAsBracket():Boolean
    public function set arrayIndexAsBracket(value:Boolean):void
authorizedproperty 
authorized:Array

List of authorized keywords, objects path and constructors that the parser is allowed to interpret.

Note: you can add full path

ex: "blah.foobar"

and/or starting path

ex: "toto.titi.

The difference is with a full path you can only create/use/define/assign value to this exact path and with a starting path you can create/use/define/assign value to this path and its child paths.

Attention: special values as NaN, true, false, null, undefined are always authorized.


Implementation
    public function get authorized():Array
    public function set authorized(value:Array):void
autoAddScopePathproperty 
autoAddScopePath:Boolean

Determinates if the add scope process is automatic or not.


Implementation
    public function get autoAddScopePath():Boolean
    public function set autoAddScopePath(value:Boolean):void
compressproperty 
compress:Boolean

Parameter to remove (true) or add (false) all unecessary spaces, tabs, carriages returns, lines feeds etc. to optimize (more or less) packets of datas when they are transfered.

Note 1 : use "compress = false" when you want to have a better view or debug packets of datas.

Note 2 : this property is in sync with eden.prettyPrint


Implementation
    public function get compress():Boolean
    public function set compress(value:Boolean):void
copyObjectByValueproperty 
copyObjectByValue:Boolean

Parameter allowing to copy objects by value if true or by reference if false.

Example :

foo = {a:1, b:2, c:3}; bar = foo; In this case with copyObjectByValue = false bar will be a reference to the foo object but if copyObjectByValue = true bar will be an exact copy of foo object


Implementation
    public function get copyObjectByValue():Boolean
    public function set copyObjectByValue(value:Boolean):void
securityproperty 
security:Boolean

Parameter setting on (true) or off (false) the security. If true, all object path, function or constructor will be scanned at interpretation time against the authorized list.


Implementation
    public function get security():Boolean
    public function set security(value:Boolean):void

See also

system.serializers.eden.config.authorized.
strictModeproperty 
strictMode:Boolean

Allows to define the case-sensitivy of the parsers. If true, variable names that differ only in case are considered different.


Implementation
    public function get strictMode():Boolean
    public function set strictMode(value:Boolean):void
undefineableproperty 
undefineable:*

Value assigned to a variable when this one is not found or not authorized. Depending on your environment you can override it with a more suitable one for exemple on C# you could set it to null.


Implementation
    public function get undefineable():*
    public function set undefineable(value:any):void
verboseproperty 
verbose:Boolean

Parameter allowing to trace messages in the console if the environment permit it.


Implementation
    public function get verbose():Boolean
    public function set verbose(value:Boolean):void
Constructor Detail
EdenConfigurator()Constructor
public function EdenConfigurator(config:Object)

Creates a new EdenConfigurator instance.

Parameters
config:Object — This argument initialize the configurator with a generic object.