summaryrefslogtreecommitdiffstats
path: root/pts-core/objects/tandem_Xml/tandem_XmlWriter.php
blob: 78a8c5e6098a5df3572a1671a35ddade56dfa396 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<?php

/*
	Phoronix Test Suite
	URLs: http://www.phoronix.com, http://www.phoronix-test-suite.com/
	Copyright (C) 2008, Phoronix Media
	Copyright (C) 2004-2008, Michael Larabel
	tandem_XmlReader.php: The XML writing object for the Phoronix Test Suite.

	Additional Notes: A very simple XML writer with a few extras... Does not support attributes on tags, etc.
	A work in progress. This was originally designed for just some select needs in the past. It does support linking to an XSL as 
	well as whether to format the XML or not, etc. Also provides a MD5 checksum of the XML body.

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

class tandem_XmlWriter
{
	var $xml_objects = array();
	var $xml_string_paths = array();
	var $xml_statements = array();

	var $xml_checksum = false;
	var $format_xml = true;
	var $xsl_binding = null;

	function __construct($nice_formatting = true)
	{
		$this->format_xml = ($nice_formatting == true);
	}
	function setXslBinding($url)
	{
		$this->xsl_binding = $url;
	}
	function writeXmlCheckSum()
	{
		$this->xml_checksum = true;
	}
	function addXmlObject($xml_location, $unique_identifier = 0, $xml_value = "", $std_step = null, $step_id = null)
	{
		$xml_array = array();
		$alt_step = -1;
		$steps = 0;
		
		if($std_step == null)
		{
			$std_step = 2;
		}
		if($step_id == null)
		{
			$step_id = $unique_identifier;
		}

		if(array_search($unique_identifier . "," . $xml_location, $this->xml_string_paths) !== false)
		{
			$alt_step = 2;
		}
		else
		{
			array_push($this->xml_string_paths, $unique_identifier . "," . $xml_location);
		}

		$xml_steps = explode('/', $xml_location);
		foreach(array_reverse($xml_steps) as $current_tag)
		{
			$steps++;

			if(empty($xml_array))
			{
				$xml_array = $xml_value;
			}
			if(!empty($current_tag))
			{
				$xml_array = array("$current_tag" => $xml_array);
			}

			if($steps == $std_step)
			{
				$xml_array = array("id_" . $unique_identifier => $xml_array);
			}
			if($steps == $alt_step)
			{
				$xml_array = array("id_" . $step_id => $xml_array);
			}
		}

		$this->xml_objects = array_merge_recursive($this->xml_objects, $xml_array);
	}
	function addStatement($name, $value)
	{
		array_push($this->xml_statements, trim($name . ": " . $value));
	}
	function getXMLStatements()
	{
		$return_string = "";
		$statements_to_print = array_reverse($this->xml_statements);

		foreach($statements_to_print as $statement)
		{
			$return_string .= "<!-- " . $statement . " -->\n";
		}

		return $return_string;
	}
	function getXML()
	{
		$formatted_xml = $this->getXMLBelow($this->xml_objects, 0);

		$this->addStatement("Generated", date("Y-m-d H:i:s"));

		if($this->xml_checksum)
		{
			$this->addStatement("Checksum", md5($formatted_xml));
		}

		return "<?xml version=\"1.0\"?>\n" . $this->getXSL() . $this->getXMLStatements() . $formatted_xml;
	}
	function getXSL()
	{
		$str = "";

		if($this->xsl_binding != null)
		{
			$str = "<?xml-stylesheet type=\"text/xsl\" href=\"" . $this->xsl_binding . "\" ?>\n";
		}

		return $str;
	}
	function getJustXML()
	{
		return $this->getXMLBelow($this->xml_objects, 0);
	}
	function getXMLBelow($statement_name, $times_deep)
	{
		$formatted_xml = "";

		foreach($statement_name as $key => $value)
		{
			if(!is_array($value))
			{
				$formatted_xml .= $this->getXMLTabs($times_deep) . "<" . $key . ">" . $value . "</" . $key . ">" . $this->getXMLBreaks();
			}
			else
			{
				if(substr($key, 0, 3) === "id_")
				{
					$formatted_xml .= $this->getXMLBelow($value, $times_deep);
				}
				else
				{
					$formatted_xml .= $this->getXMLTabs($times_deep) . "<" . $key . ">" . $this->getXMLBreaks();
					$formatted_xml .= $this->getXMLBelow($value, $times_deep + 1);
					$formatted_xml .= $this->getXMLTabs($times_deep) . "</" . $key . ">" . $this->getXMLBreaks();
				}
			}
		}

		return $formatted_xml;
	}
	function getXMLTabs($times_deep)
	{
		$format = "";

		if($this->format_xml)
		{
			$format = str_repeat("\t", $times_deep);
		}

		return $format;
	}
	function getXMLBreaks()
	{
		$format = "";

		if($this->format_xml)
		{
			$format = "\n";
		}

		return $format;
	}
	function debugDumpArray()
	{
		return $this->xml_objects;
	}
}

?>