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
<?php
namespace Codeception\Util;
/**
* That's a pretty simple yet powerful class to build XML structures in jQuery-like style.
* With no XML line actually written!
* Uses DOM extension to manipulate XML data.
*
*
* ```php
* <?php
* $xml = new \Codeception\Util\XmlBuilder();
* $xml->users
* ->user
* ->val(1)
* ->email
* ->val('davert@mail.ua')
* ->attr('valid','true')
* ->parent()
* ->cart
* ->attr('empty','false')
* ->items
* ->item
* ->val('useful item');
* ->parents('user')
* ->active
* ->val(1);
* echo $xml;
* ```
*
* This will produce this XML
*
* ```xml
* <?xml version="1.0"?>
* <users>
* <user>
* 1
* <email valid="true">davert@mail.ua</email>
* <cart empty="false">
* <items>
* <item>useful item</item>
* </items>
* </cart>
* <active>1</active>
* </user>
* </users>
* ```
*
* ### Usage
*
* Builder uses chained calls. So each call to builder returns a builder object.
* Except for `getDom` and `__toString` methods.
*
* * `$xml->node` - create new xml node and go inside of it.
* * `$xml->node->val('value')` - sets the inner value of node
* * `$xml->attr('name','value')` - set the attribute of node
* * `$xml->parent()` - go back to parent node.
* * `$xml->parents('user')` - go back through all parents to `user` node.
*
* Export:
*
* * `$xml->getDom` - get a DOMDocument object
* * `$xml->__toString` - get a string representation of XML.
*
* [Source code](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/XmlBuilder.php)
*/
class XmlBuilder
{
/**
* @var \DOMDocument
*/
protected $__dom__;
/**
* @var \DOMElement
*/
protected $__currentNode__;
public function __construct()
{
$this->__dom__ = new \DOMDocument();
$this->__currentNode__ = $this->__dom__;
}
/**
* Appends child node
*
* @param $tag
*
* @return XmlBuilder
*/
public function __get($tag)
{
$node = $this->__dom__->createElement($tag);
$this->__currentNode__->appendChild($node);
$this->__currentNode__ = $node;
return $this;
}
/**
* @param $val
*
* @return XmlBuilder
*/
public function val($val)
{
$this->__currentNode__->nodeValue = $val;
return $this;
}
/**
* Sets attribute for current node
*
* @param $attr
* @param $val
*
* @return XmlBuilder
*/
public function attr($attr, $val)
{
$this->__currentNode__->setAttribute($attr, $val);
return $this;
}
/**
* Traverses to parent
*
* @return XmlBuilder
*/
public function parent()
{
$this->__currentNode__ = $this->__currentNode__->parentNode;
return $this;
}
/**
* Traverses to parent with $name
*
* @param $tag
*
* @return XmlBuilder
* @throws \Exception
*/
public function parents($tag)
{
$traverseNode = $this->__currentNode__;
$elFound = false;
while ($traverseNode->parentNode) {
$traverseNode = $traverseNode->parentNode;
if ($traverseNode->tagName == $tag) {
$this->__currentNode__ = $traverseNode;
$elFound = true;
break;
}
}
if (!$elFound) {
throw new \Exception("Parent $tag not found in XML");
}
return $this;
}
public function __toString()
{
return $this->__dom__->saveXML();
}
/**
* @return \DOMDocument
*/
public function getDom()
{
return $this->__dom__;
}
}