/
XmlFile.php
133 lines (104 loc) · 3.36 KB
/
XmlFile.php
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
<?php declare(strict_types=1);
/*
* This file is part of Phive.
*
* Copyright (c) Arne Blankerts <arne@blankerts.de>, Sebastian Heuer <sebastian@phpeople.de> and contributors
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
*/
namespace PharIo\Phive;
use DOMDocument;
use DOMElement;
use DOMNode;
use DOMNodeList;
use DOMXPath;
use PharIo\FileSystem\Directory;
use PharIo\FileSystem\File;
use PharIo\FileSystem\Filename;
class XmlFile {
/** @var null|DOMDocument */
private $dom;
/** @var DOMXPath */
private $xPath;
/** @var Filename */
private $filename;
/** @var string */
private $namespace;
/** @var string */
private $rootElementName;
/**
* @throws InvalidXmlException
*/
public static function fromFile(File $file): self {
$dom = self::createDomDocument();
$content = $file->getContent();
if ($content === '') {
throw new InvalidXmlException();
}
$dom->loadXML($content);
$xmlFile = new self(
$file->getFilename(),
$dom->documentElement->namespaceURI ?? '',
$dom->documentElement->localName
);
$xmlFile->dom = $dom;
return $xmlFile;
}
public function __construct(Filename $filename, string $namespace, string $root) {
$this->filename = $filename;
$this->namespace = $namespace;
$this->rootElementName = $root;
}
public function createElement(string $name, string $text = ''): DOMElement {
return $this->getDom()->createElementNS($this->namespace, $name, $text);
}
public function query(string $xpath, ?DOMNode $ctx = null): DOMNodeList {
if ($ctx === null) {
$ctx = $this->getDom()->documentElement;
}
return $this->getXPath()->query($xpath, $ctx);
}
public function addElement(DOMNode $node): void {
$this->getDom()->documentElement->appendChild($node);
}
public function save(): void {
$this->getDirectory()->ensureExists();
$this->getDom()->save($this->filename->asString());
}
public function getDirectory(): Directory {
return $this->filename->getDirectory();
}
public function getDom(): DOMDocument {
$this->initDom();
return $this->dom;
}
private function getXPath(): DOMXPath {
$this->initXPath();
return $this->xPath;
}
/** @psalm-assert \DomDocument $this->dom */
private function initDom(): void {
if ($this->dom instanceof DOMDocument) {
return;
}
$this->dom = self::createDomDocument();
if ($this->filename->exists()) {
$this->dom->load($this->filename->asString());
} else {
$this->dom->appendChild($this->dom->createElementNS($this->namespace, $this->rootElementName));
}
}
private function initXPath(): void {
$this->initDom();
$this->xPath = new DOMXPath($this->dom);
$this->xPath->registerNamespace('phive', $this->namespace);
}
private static function createDomDocument(): DOMDocument {
$dom = new DOMDocument('1.0', 'UTF-8');
$dom->preserveWhiteSpace = false;
$dom->formatOutput = true;
return $dom;
}
}