Javascript XML - Revision history

Marian: /* Methods */

2026-01-27T14:55:52Z

‎Methods

Marian at 10:08, 12 September 2024

2024-09-12T10:08:31Z

Marian at 10:40, 9 September 2024

2024-09-09T10:40:14Z

Marian at 11:11, 8 March 2022

2022-03-08T11:11:40Z

Marian at 13:13, 12 April 2018

2018-04-12T13:13:18Z

Marian: /* Methods */

2018-04-12T13:07:55Z

‎Methods

Marian: /* Methods */

2018-04-10T11:10:58Z

‎Methods

Marian: /* Methods */

2016-03-07T09:30:24Z

‎Methods

Marian: /* Methods */

2016-03-07T09:10:56Z

‎Methods

Marian: /* Methods */

2016-03-07T09:03:23Z

‎Methods

← Older revision		Revision as of 14:55, 27 January 2026
Line 261:		Line 261:
	'''declaration''': XML declaration to write. May be boolean ''true'' to write a default declaration (version=1.0 encoding=utf-8) or object with declaration attributes. If an object is set the ''version'' attribute will be always written even when missing in object properties.		'''declaration''': XML declaration to write. May be boolean ''true'' to write a default declaration (version=1.0 encoding=utf-8) or object with declaration attributes. If an object is set the ''version'' attribute will be always written even when missing in object properties.

		+	* '''compactText([recursive])'''
		+	Compact XML text (trim spaces, remove empty text).<br/>
		+	Parameters:<br>
		+	'''recursive''': Boolean. Set it to true to compact text of all XML children also.<br>

	== Static Properties ==		== Static Properties ==

@@ Line 44: / Line 44: @@
   x = new XML(msg,"xml",false); // Obtain a copy of the xml element
-==Static methods==
 * '''XML.loadFile(path)'''
@@ Line 55: / Line 57: @@
 The following object properties will be set:<br>
 '''declaration''': Object with declaration attributes if one is found in the file<br>
 == Methods ==
-* '''put(list, field_name [, addText])'''
+* '''put(list, field_name [, what])'''
-Put the XML (a copy of it) in a list (usually a [[Javascript Message|Message()]] object).<br>
+Put the XML (a copy of it) in a list (usually a [[Javascript Message|Message]] object).<br>
 Parameters:<br>
 '''list''': Destination object<br>
 '''field_name''': Field name to use<br>
-'''addText''': Optional. Add xml string also<br>
+'''what''': Optional. Set xml string and/or internal object. Default: XML.PutObject<br>
   x = new XML("a");
@@ Line 134: / Line 140: @@
 Return:<br>
 XML element, '''null''' if not found.<br>
 * '''getChildren([name] [, namespace])'''
@@ Line 142: / Line 155: @@
 Return:<br>
 Array of XML elements, '''null''' if no child found.<br>
 * '''addText(text)'''
@@ Line 165: / Line 208: @@
 Return:<br>
 XML child text (may be empty), '''null''' if child is not found.<br>
 * '''xmlText([spaces[,allLinesSpaces]])'''
@@ Line 170: / Line 220: @@
 Parameters:<br>
 '''spaces''': Optional spaces to use (verbose string build, print xml children on separate lines). Ignored if 0<br>
-'''allLinesSpaces''': Optional fixed number of spaces to add to each line. Ignored if 0 or ''spaces'' is 0<br>
+'''allLinesSpaces''': Optional fixed number of spaces to add to each line (except the first one). Ignored if 0 or ''spaces'' is 0<br>
 Return:<br>
 XML string.<br>
@@ Line 188: / Line 238: @@
   </a>
 sss:
-   <a attr="a">
+ <a attr="a">
       TEXT
       <ch>
@@ Line 196: / Line 246: @@
 * '''replaceParams(list)'''
-Recursively replace ${paramname} in children (elements and text) from parameters list.<br>
+Recursively replace ${paramname} in children (element attribute values and text) from parameters list.<br>
 Parameters:<br>
 '''list''': List of parameters. Ignored if not an object (no replace is made)<br>
@@ Line 210: / Line 260: @@
 The following object properties will be used to build the string to write:<br>
 '''declaration''': XML declaration to write. May be boolean ''true'' to write a default declaration (version=1.0 encoding=utf-8) or object with declaration attributes. If an object is set the ''version'' attribute will be always written even when missing in object properties.
 [[Category:Javascript]]

← Older revision		Revision as of 10:40, 9 September 2024
Line 210:		Line 210:
	The following object properties will be used to build the string to write:<br>		The following object properties will be used to build the string to write:<br>
	'''declaration''': XML declaration to write. May be boolean ''true'' to write a default declaration (version=1.0 encoding=utf-8) or object with declaration attributes. If an object is set the ''version'' attribute will be always written even when missing in object properties.		'''declaration''': XML declaration to write. May be boolean ''true'' to write a default declaration (version=1.0 encoding=utf-8) or object with declaration attributes. If an object is set the ''version'' attribute will be always written even when missing in object properties.
		+
		+
		+	[[Category:Javascript]]

@@ Line 166: / Line 166: @@
 XML child text (may be empty), '''null''' if child is not found.<br>
-* '''xmlText([spaces])'''
+* '''xmlText([spaces[,allLinesSpaces]])'''
 Convert the XML object to string representation.<br>
 Parameters:<br>
 '''spaces''': Optional spaces to use (verbose string build, print xml children on separate lines). Ignored if 0<br>
 Return:<br>
 XML string.<br>
@@ Line 176: / Line 177: @@
   s = x.xmlText();
   ss = x.xmlText(2);
 s:
   <a attr="a">TEXT<ch><c/></ch></a>
@@ Line 185: / Line 187: @@
     </ch>
   </a>
 * '''replaceParams(list)'''

@@ Line 43: / Line 43: @@
   x = new XML(msg,"xml",true);  // Take the xml from message
   x = new XML(msg,"xml",false); // Obtain a copy of the xml element
 == Methods ==

← Older revision		Revision as of 13:07, 12 April 2018
Line 178:		Line 178:
	Parameters:<br>		Parameters:<br>
	'''list''': List of parameters. Ignored if not an object (no replace is made)<br>		'''list''': List of parameters. Ignored if not an object (no replace is made)<br>
		+
		+	* '''saveFile(path [, spaces])'''
		+	Save xml to file.<br>
		+	Parameters:<br>
		+	'''path''': File path<br>
		+	'''spaces''': Optional number of spaces to use for indentation. Write a flat string if not given or less than 1<br>
		+	Return:<br>
		+	True on success, false on failure<br>
		+
		+	The following object properties will be used to build the string to write:<br>
		+	'''declaration''': XML declaration to write. May be boolean ''true'' to write a default declaration (version=1.0 encoding=utf-8) or object with declaration attributes. If an object is set the ''version'' attribute will be always written even when missing in object properties.

← Older revision		Revision as of 11:10, 10 April 2018
Line 173:		Line 173:
	</ch>		</ch>
	</a>		</a>
		+
		+	* '''replaceParams(list)'''
		+	Recursively replace ${paramname} in children (elements and text) from parameters list.<br>
		+	Parameters:<br>
		+	'''list''': List of parameters. Ignored if not an object (no replace is made)<br>

← Older revision		Revision as of 09:30, 7 March 2016
Line 154:		Line 154:
	XML child text (may be empty), '''null''' if child is not found.<br>		XML child text (may be empty), '''null''' if child is not found.<br>

−	* '''xmlText()'''	+	* '''xmlText([spaces])'''
		+	Convert the XML object to string representation.<br>
		+	Parameters:<br>
		+	'''spaces''': Optional spaces to use (verbose string build, print xml children on separate lines). Ignored if 0<br>
		+	Return:<br>
		+	XML string.<br>
		+
		+	x = new XML("<a attr='a'>TEXT<ch><c/></ch></a>");
		+	s = x.xmlText();
		+	ss = x.xmlText(2);
		+	s:
		+	<a attr="a">TEXT<ch><c/></ch></a>
		+	ss:
		+	<a attr="a">
		+	TEXT
		+	<ch>
		+	<c/>
		+	</ch>
		+	</a>

@@ Line 131: / Line 131: @@
 Array of XML elements, '''null''' if no child found.<br>
-* '''addText()'''
+* '''addText(text)'''
 * '''getText()'''
-* '''setText()'''
+* '''setText(text)'''
-* '''getChildText()'''
+* '''getChildText([name] [, namespace])'''
 * '''xmlText()'''

@@ Line 75: / Line 75: @@
   t = x.getTag(); // "some_ns:a"
-* '''getAttribute()'''
+* '''getAttribute(name)'''
-* '''setAttribute()'''
+* '''setAttribute(name [, value])'''
-* '''removeAttribute()'''
+ x = new XML("a");
 * '''attributes()'''
-* '''addChild()'''
+* '''addChild(name_xml_array [, text])'''
-* '''getChild()'''
+* '''getChild([name] [, namespace])'''
-* '''getChildren()'''
+* '''getChildren([name] [, namespace])'''
 * '''addText()'''