Config(configPath, xml)

Config class, loads and saves XML from the config folders

Creating a new Config instance will do one of 2 things:

1. If the associated XML file doesn't exist, the Config instance will be created, without yet creating an XML file
2. If the associated XML file does exist, the file will be loaded and the data saved in the file will be available to use straight away

Note that passing a relative file path will attempt to find the file in the cascading file structure, defaulting to user/config/

The following example creates a new empty config file in the user folder:

var config = new Config('test');
trace(config);

[object Config path="E:/Projects/xJSFL/user/config/test.xml" rootnodes=0 exists=false]

Note that you can save config data to subfolders by specifying a path:

var config = new Config('settings/test');

There is no need to specify an .xml extension as Config files are XML by default, but if you do so, it will be ignored.

set(path, value)

Sets data on the wrapped XML data

The following example sets various properties and attributes on a new Config instance:

var config = new Config('settings/test');
config
	.set('app', 'xJSFL')                // root-level node (string)
	.set('@id', 1)                      // root-level attribute (number)
	.set('long.path.to.value', 'Hello') // compound path

trace(config.toXMLString());

<settings id="1">
  <app>xJSFL</app>
  <long>
    <path>
      <to>
        <value>Hello</value>
      </to>
    </path>
  </long>
</settings>

The following example attempts to set various datatypes:

var config = new Config('settings/test');
config
    .clear()
    .set('string', '"Hello"')
    .set('illegalstring', '<Hello>')
    .set('number', 1)
    .set('boolean', true)
    .set('xml', <name>Dave</name>)
    .set('xmllist', new XMLList('<icon id="1" /><icon id="2" /><icon id="3" />'))
    .set('date', new Date())
    .set('class', new Config('settings/config'))
    .set('array', [1,2,3,4,5]);

trace(config.toString(true));

<settings>
    <string>"Hello"</string>
    <illegalstring>&lt;Hello&gt;</illegalstring>
    <number>1</number>
    <boolean>true</boolean>
    <xml>
        <name>Dave</name>
    </xml>
    <xmllist>
        <icon id="1"/>
        <icon id="2"/>
        <icon id="3"/>
    </xmllist>
    <date>Thu Jul 21 2011 17:43:05 GMT+0100 (GMT Daylight Time)</date>
    <class>[object Config path="xJSFL/user/config/settings/config.xml" nodes=0]</class>
    <array>1,2,3,4,5</array>
</settings>

get(path)

Gets the value of the specified node path

The following example gets a node attribute:

var config = new Config('settings/test');
config
	.clear()
	.set('some.setting.@id', 'Hello')

trace(config.toXMLString());
trace(config.get('some.setting.@id'));

<settings>
  <some>
    <setting id="Hello"/>
  </some>
</settings>

Hello

The following example enters some values into the Config instance, then extracts them into a table, so you can see how the data types are parsed for simple node types:

// create a new config, and clear it
	var config = new Config('test').clear();

// set some values
	config.set('@attr', 5);
	config.set('a.b', 'hello');
	config.set('c', value);

// trace the XML
	XML.prettyPrinting = true;
	trace(config.toXMLString());

// extract the values into a table
	var data = [];
	var nodes = ['a', 'a.b', 'c', '@attr', 'somenode'];
	XML.prettyPrinting = false;
	for each(var node in nodes)
	{
		var value	= config.get(node);
		data.push({node:node, value:value, type:typeof value});
	}
	XML.prettyPrinting = true;

// trace values
	Table.print(data);

<config attr="5">
	<a>
		<b>hello</b>
	</a>
	<c attr="1">value</c>
</config>

+----------+---------------------+-----------+
| node     | value               | type      |
+----------+---------------------+-----------+
| a        | <a><b>hello</b></a> | xml       |
| a.b      | hello               | string    |
| c        | value               | string    |
| @attr    | 5                   | number    |
| somenode | undefined           | undefined |
+----------+---------------------+-----------+

remove(path)

Removes the node from the Config instance's XML

The following example adds a new value, then removes one of its parent nodes:

var config = new Config('test').clear();
config.set('a.b.c', 5);
config.remove('a.b');
trace(config.toXMLString());	

<config>
	<a/>
</config>	

clear()

Clears all nodes inside the internal XML

The following example clears the current config instance:

var config = new Config('test').clear();
config.set('value', 5);
config.clear();
trace(config.toXMLString());

<config />

load()

Loads the XML config from disk

You normally won't need to call this method, as a Config instance's XML is loaded automatically from disk when first instantiated, however, the following example loads (or reloads) the related XML file:

var config = new Config('settings/test');
// perhaps something happened here, like an external modification to config
config.load();

[object Config path="E:/Projects/xJSFL/user/config/settings/test.xml" rootnodes=5 exists=true]

save()

Saves the internal XML to disk

The following example saves the current config instance:

var config = new Config('test');
config.save();
trace(config);

[object Config path="E:/Projects/xJSFL/user/config/test.xml" rootnodes=0 exists=true]

removeFile()

Removes the config file from disk

The following example removes the config item from disk:

var config = new Config('test');
config.set('value', 5);
trace(config);
config.removeFile();
trace(config);

[object Config path="E:/Projects/xJSFL/user/config/test.xml" rootnodes=1 exists=true]
[object Config path="E:/Projects/xJSFL/user/config/test.xml" rootnodes=1 exists=false]	

toString()

Returns a String representation of the Config instance

The following example traces a new, empty Config instance:

trace(new Config('test'));

[object Config path="E:/Projects/xJSFL/user/config/test.xml" rootnodes=0 exists=false]

toXMLString()

Returns the pretty-printed XML contents

The following example traces a new, empty Config instance as an XML String:

trace(new Config('test').toXMLString());

<config />