View GitHub Repository application-utils

Schedule Inspection
Subscribe
Passed
Push — master ( 16baae...6b22f3 )
by Sebastian
02:40
created
Status
Category
Toggle Patches
src/XMLHelper/DOMErrors/Error.php 1 patch
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch 
@@ -24,9 +24,9 @@
 
 block discarded – undo
24 24 
     const ERROR_CANNOT_UNSERIALIZE_ERROR_DATA = 57201;
25 25 
     const ERROR_ERROR_DATA_KEY_MISSING = 57202;
26 26
27 
-   /**
28 
-    * @var \LibXMLError
29 
-    */
27 
+    /**
28 
+     * @var \LibXMLError
29 
+     */
30 30 
     private $error;
31 31
32 32 
     private static $requiredKeys = array(
Please login to merge, or discard this patch.
src/XMLHelper/HTMLLoader.php 1 patch
Indentation   +66 added lines, -66 removed lines patch added patch discarded remove patch 
@@ -36,19 +36,19 @@  discard block
 
 block discarded – undo
36 36 
 {
37 37 
     const ERROR_STRING_ALREADY_HAS_BODY_TAG = 57001;
38 38
39 
-   /**
40 
-    * @var \DOMElement
41 
-    */
39 
+    /**
40 
+     * @var \DOMElement
41 
+     */
42 42 
     private $bodyNode;
43 43
44 
-   /**
45 
-    * @var XMLHelper_DOMErrors
46 
-    */
44 
+    /**
45 
+     * @var XMLHelper_DOMErrors
46 
+     */
47 47 
     private $errors;
48 48
49 
-   /**
50 
-    * @var string
51 
-    */
49 
+    /**
50 
+     * @var string
51 
+     */
52 52 
     private static $htmlTemplate =
53 53 
     '<!DOCTYPE html>'.
54 54 
     '<html>'.
 
@@ -60,9 +60,9 @@  discard block
 
 block discarded – undo
60 60 
         '</body>'.
61 61 
     '</html>';
62 62
63 
-   /**
64 
-    * @var \DOMDocument
65 
-    */
63 
+    /**
64 
+     * @var \DOMDocument
65 
+     */
66 66 
     private $dom;
67 67
68 68 
     private function __construct(string $html)
 
@@ -70,13 +70,13 @@  discard block
 
 block discarded – undo
70 70 
         $this->load($html);
71 71 
     }
72 72
73 
-   /**
74 
-    * Creates an HTML loader from an HTML fragment (without
75 
-    * doctype, head and body elements).
76 
-    *
77 
-    * @param string $fragment
78 
-    * @return XMLHelper_HTMLLoader
79 
-    */
73 
+    /**
74 
+     * Creates an HTML loader from an HTML fragment (without
75 
+     * doctype, head and body elements).
76 
+     *
77 
+     * @param string $fragment
78 
+     * @return XMLHelper_HTMLLoader
79 
+     */
80 80 
     public static function loadFragment(string $fragment) : XMLHelper_HTMLLoader
81 81 
     {
82 82 
         self::checkFragment($fragment);
 
@@ -87,24 +87,24 @@  discard block
 
 block discarded – undo
87 87 
         return new XMLHelper_HTMLLoader($pseudoHTML);
88 88 
     }
89 89
90 
-   /**
91 
-    * Creates an HTML loader from a full HTML document (including
92 
-    * doctype, head and body elements).
93 
-    *
94 
-    * @param string $html
95 
-    * @return XMLHelper_HTMLLoader
96 
-    */
90 
+    /**
91 
+     * Creates an HTML loader from a full HTML document (including
92 
+     * doctype, head and body elements).
93 
+     *
94 
+     * @param string $html
95 
+     * @return XMLHelper_HTMLLoader
96 
+     */
97 97 
     public static function loadHTML(string $html) : XMLHelper_HTMLLoader
98 98 
     {
99 99 
         return  new XMLHelper_HTMLLoader($html);
100 100 
     }
101 101
102 
-   /**
103 
-    * Verifies that the fragment does not already contain a body element or doctype.
104 
-    *
105 
-    * @param string $fragment
106 
-    * @throws XMLHelper_Exception
107 
-    */
102 
+    /**
103 
+     * Verifies that the fragment does not already contain a body element or doctype.
104 
+     *
105 
+     * @param string $fragment
106 
+     * @throws XMLHelper_Exception
107 
+     */
108 108 
     private static function checkFragment(string $fragment) : void
109 109 
     {
110 110 
         if(!stristr($fragment, '<body') && !stristr($fragment, 'doctype'))
 
@@ -142,65 +142,65 @@  discard block
 
 block discarded – undo
142 142 
         return $this->bodyNode;
143 143 
     }
144 144
145 
-   /**
146 
-    * Retrieves the document's `<body>` tag node.
147 
-    *
148 
-    * @return \DOMDocument
149 
-    */
145 
+    /**
146 
+     * Retrieves the document's `<body>` tag node.
147 
+     *
148 
+     * @return \DOMDocument
149 
+     */
150 150 
     public function getDOM() : \DOMDocument
151 151 
     {
152 152 
         return $this->dom;
153 153 
     }
154 154
155 
-   /**
156 
-    * Retrieves all nodes from the HTML fragment (= child nodes
157 
-    * of the `<body>` element).
158 
-    *
159 
-    * @return \DOMNodeList
160 
-    */
155 
+    /**
156 
+     * Retrieves all nodes from the HTML fragment (= child nodes
157 
+     * of the `<body>` element).
158 
+     *
159 
+     * @return \DOMNodeList
160 
+     */
161 161 
     public function getFragmentNodes() : \DOMNodeList
162 162 
     {
163 163 
         return $this->bodyNode->childNodes;
164 164 
     }
165 165
166 
-   /**
167 
-    * Retrieves the LibXML HTML parsing errors collection, which
168 
-    * can be used to review any errors that occurred while loading
169 
-    * the HTML document.
170 
-    *
171 
-    * @return XMLHelper_DOMErrors
172 
-    */
166 
+    /**
167 
+     * Retrieves the LibXML HTML parsing errors collection, which
168 
+     * can be used to review any errors that occurred while loading
169 
+     * the HTML document.
170 
+     *
171 
+     * @return XMLHelper_DOMErrors
172 
+     */
173 173 
     public function getErrors() : XMLHelper_DOMErrors
174 174 
     {
175 175 
         return $this->errors;
176 176 
     }
177 177
178 
-   /**
179 
-    * Returns a valid HTML string.
180 
-    *
181 
-    * @return string
182 
-    */
178 
+    /**
179 
+     * Returns a valid HTML string.
180 
+     *
181 
+     * @return string
182 
+     */
183 183 
     public function toHTML() : string
184 184 
     {
185 185 
         return $this->dom->saveHTML();
186 186 
     }
187 187
188 
-   /**
189 
-    * Returns a valid XML string.
190 
-    *
191 
-    * @return string
192 
-    */
188 
+    /**
189 
+     * Returns a valid XML string.
190 
+     *
191 
+     * @return string
192 
+     */
193 193 
     public function toXML() : string
194 194 
     {
195 195 
         return $this->dom->saveXML();
196 196 
     }
197 197
198 
-   /**
199 
-    * Converts the HTML fragment to valid XML (= all
200 
-    * child nodes of the `<body>` element).
201 
-    *
202 
-    * @return string
203 
-    */
198 
+    /**
199 
+     * Converts the HTML fragment to valid XML (= all
200 
+     * child nodes of the `<body>` element).
201 
+     *
202 
+     * @return string
203 
+     */
204 204 
     public function fragmentToXML() : string
205 205 
     {
206 206 
         $nodes = $this->getFragmentNodes();
Please login to merge, or discard this patch.
src/XMLHelper/DOMErrors.php 1 patch
Indentation   +50 added lines, -50 removed lines patch added patch discarded remove patch 
@@ -23,14 +23,14 @@  discard block
 
 block discarded – undo
23 23 
 {
24 24 
     const SERIALIZE_SEPARATOR = '__SERSEP__';
25 25
26 
-   /**
27 
-    * @var XMLHelper_DOMErrors_Error[]
28 
-    */
26 
+    /**
27 
+     * @var XMLHelper_DOMErrors_Error[]
28 
+     */
29 29 
     private $errors;
30 30
31 
-   /**
32 
-    * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
33 
-    */
31 
+    /**
32 
+     * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
33 
+     */
34 34 
     public function __construct(array $libxmlErrors)
35 35 
     {
36 36 
         foreach($libxmlErrors as $error)
 
@@ -56,11 +56,11 @@  discard block
 
 block discarded – undo
56 56 
         return $this->errors;
57 57 
     }
58 58
59 
-   /**
60 
-    * Retrieves all warnings, if any.
61 
-    *
62 
-    * @return XMLHelper_DOMErrors_Error[]
63 
-    */
59 
+    /**
60 
+     * Retrieves all warnings, if any.
61 
+     *
62 
+     * @return XMLHelper_DOMErrors_Error[]
63 
+     */
64 64 
     public function getWarnings()
65 65 
     {
66 66 
         return $this->getByLevel(LIBXML_ERR_WARNING);
 
@@ -107,12 +107,12 @@  discard block
 
 block discarded – undo
107 107 
     }
108 108
109 109
110 
-   /**
111 
-    * Retrieves all errors by the specified libxml error level.
112 
-    *
113 
-    * @param int $level
114 
-    * @return \AppUtils\XMLHelper_DOMErrors_Error[]
115 
-    */
110 
+    /**
111 
+     * Retrieves all errors by the specified libxml error level.
112 
+     *
113 
+     * @param int $level
114 
+     * @return \AppUtils\XMLHelper_DOMErrors_Error[]
115 
+     */
116 116 
     public function getByLevel(int $level)
117 117 
     {
118 118 
         $result = array();
 
@@ -128,12 +128,12 @@  discard block
 
 block discarded – undo
128 128 
         return $result;
129 129 
     }
130 130
131 
-   /**
132 
-    * Retrieves all errors by the specified libxml error code.
133 
-    *
134 
-    * @param int $code
135 
-    * @return \AppUtils\XMLHelper_DOMErrors_Error[]
136 
-    */
131 
+    /**
132 
+     * Retrieves all errors by the specified libxml error code.
133 
+     *
134 
+     * @param int $code
135 
+     * @return \AppUtils\XMLHelper_DOMErrors_Error[]
136 
+     */
137 137 
     public function getByCode(int $code)
138 138 
     {
139 139 
         $result = array();
 
@@ -149,12 +149,12 @@  discard block
 
 block discarded – undo
149 149 
         return $result;
150 150 
     }
151 151
152 
-   /**
153 
-    * Checks whether there are errors matching the libxml error level.
154 
-    *
155 
-    * @param int $level
156 
-    * @return bool
157 
-    */
152 
+    /**
153 
+     * Checks whether there are errors matching the libxml error level.
154 
+     *
155 
+     * @param int $level
156 
+     * @return bool
157 
+     */
158 158 
     public function hasErrorsByLevel(int $level) : bool
159 159 
     {
160 160 
         foreach($this->errors as $error)
 
@@ -168,12 +168,12 @@  discard block
 
 block discarded – undo
168 168 
         return false;
169 169 
     }
170 170
171 
-   /**
172 
-    * Checks whether there are any errors matching the libxml error code.
173 
-    *
174 
-    * @param int $code
175 
-    * @return bool
176 
-    */
171 
+    /**
172 
+     * Checks whether there are any errors matching the libxml error code.
173 
+     *
174 
+     * @param int $code
175 
+     * @return bool
176 
+     */
177 177 
     public function hasErrorsByCode(int $code) : bool
178 178 
     {
179 179 
         foreach($this->errors as $error)
 
@@ -199,13 +199,13 @@  discard block
 
 block discarded – undo
199 199 
         return $result;
200 200 
     }
201 201
202 
-   /**
203 
-    * Serializes the errors collection, so it can be stored and
204 
-    * restored as needed, using the `fromSerialized()` method.
205 
-    *
206 
-    * @return string
207 
-    * @see XMLHelper_DOMErrors::fromSerialized()
208 
-    */
202 
+    /**
203 
+     * Serializes the errors collection, so it can be stored and
204 
+     * restored as needed, using the `fromSerialized()` method.
205 
+     *
206 
+     * @return string
207 
+     * @see XMLHelper_DOMErrors::fromSerialized()
208 
+     */
209 209 
     public function serialize() : string
210 210 
     {
211 211 
         $data = array();
 
@@ -218,14 +218,14 @@  discard block
 
 block discarded – undo
218 218 
         return implode(self::SERIALIZE_SEPARATOR, $data);
219 219 
     }
220 220
221 
-   /**
222 
-    * Restores the errors collection from a previously serialized
223 
-    * collection, using `serialize()`.
224 
-    *
225 
-    * @param string $serialized
226 
-    * @return XMLHelper_DOMErrors
227 
-    * @see XMLHelper_DOMErrors::serialize()
228 
-    */
221 
+    /**
222 
+     * Restores the errors collection from a previously serialized
223 
+     * collection, using `serialize()`.
224 
+     *
225 
+     * @param string $serialized
226 
+     * @return XMLHelper_DOMErrors
227 
+     * @see XMLHelper_DOMErrors::serialize()
228 
+     */
229 229 
     public static function fromSerialized(string $serialized) : XMLHelper_DOMErrors
230 230 
     {
231 231 
         $parts = explode(self::SERIALIZE_SEPARATOR, $serialized);
Please login to merge, or discard this patch.
src/XMLHelper.php 1 patch
Indentation   +40 added lines, -40 removed lines patch added patch discarded remove patch 
@@ -32,41 +32,41 @@  discard block
 
 block discarded – undo
32 32 
         return new XMLHelper($dom);
33 33 
     }
34 34
35 
-   /**
36 
-    * Creates a converter instance from an XML file.
37 
-    * @param string $xmlFile
38 
-    * @return \AppUtils\XMLHelper_Converter
39 
-    */
35 
+    /**
36 
+     * Creates a converter instance from an XML file.
37 
+     * @param string $xmlFile
38 
+     * @return \AppUtils\XMLHelper_Converter
39 
+     */
40 40 
     public static function convertFile(string $xmlFile)
41 41 
     {
42 42 
         return XMLHelper_Converter::fromFile($xmlFile);
43 43 
     }
44 44
45 
-   /**
46 
-    * Creates a converter from an XML string.
47 
-    * @param string $xmlString
48 
-    * @return \AppUtils\XMLHelper_Converter
49 
-    */
45 
+    /**
46 
+     * Creates a converter from an XML string.
47 
+     * @param string $xmlString
48 
+     * @return \AppUtils\XMLHelper_Converter
49 
+     */
50 50 
     public static function convertString(string $xmlString)
51 51 
     {
52 52 
         return XMLHelper_Converter::fromString($xmlString);
53 53 
     }
54 54
55 
-   /**
56 
-    * Creates a converter from a SimpleXMLElement instance.
57 
-    * @param \SimpleXMLElement $element
58 
-    * @return \AppUtils\XMLHelper_Converter
59 
-    */
55 
+    /**
56 
+     * Creates a converter from a SimpleXMLElement instance.
57 
+     * @param \SimpleXMLElement $element
58 
+     * @return \AppUtils\XMLHelper_Converter
59 
+     */
60 60 
     public static function convertElement(\SimpleXMLElement $element)
61 61 
     {
62 62 
         return XMLHelper_Converter::fromElement($element);
63 63 
     }
64 64
65 
-   /**
66 
-    * Creates a converter from a DOMElement instance.
67 
-    * @param \DOMElement $element
68 
-    * @return \AppUtils\XMLHelper_Converter
69 
-    */
65 
+    /**
66 
+     * Creates a converter from a DOMElement instance.
67 
+     * @param \DOMElement $element
68 
+     * @return \AppUtils\XMLHelper_Converter
69 
+     */
70 70 
     public static function convertDOMElement(\DOMElement $element)
71 71 
     {
72 72 
         return XMLHelper_Converter::fromDOMElement($element);
 
@@ -435,31 +435,31 @@  discard block
 
 block discarded – undo
435 435 
         return $this->dom->saveXML();
436 436 
     }
437 437
438 
-   /**
439 
-    * Creates a new SimpleXML helper instance: this
440 
-    * object is useful to work with loading XML strings
441 
-    * and files with easy access to any errors that
442 
-    * may occurr, since the simplexml functions can be
443 
-    * somewhat cryptic.
444 
-    *
445 
-    * @return XMLHelper_SimpleXML
446 
-    */
438 
+    /**
439 
+     * Creates a new SimpleXML helper instance: this
440 
+     * object is useful to work with loading XML strings
441 
+     * and files with easy access to any errors that
442 
+     * may occurr, since the simplexml functions can be
443 
+     * somewhat cryptic.
444 
+     *
445 
+     * @return XMLHelper_SimpleXML
446 
+     */
447 447 
     public static function createSimplexml()
448 448 
     {
449 449 
         return new XMLHelper_SimpleXML();
450 450 
     }
451 451
452 
-   /**
453 
-    * Converts a string to valid XML: can be a text only string
454 
-    * or an HTML string. Returns valid XML code.
455 
-    *
456 
-    * NOTE: The string may contain custom tags, which are
457 
-    * preserved.
458 
-    *
459 
-    * @param string $string
460 
-    * @throws XMLHelper_Exception
461 
-    * @return string
462 
-    */
452 
+    /**
453 
+     * Converts a string to valid XML: can be a text only string
454 
+     * or an HTML string. Returns valid XML code.
455 
+     *
456 
+     * NOTE: The string may contain custom tags, which are
457 
+     * preserved.
458 
+     *
459 
+     * @param string $string
460 
+     * @throws XMLHelper_Exception
461 
+     * @return string
462 
+     */
463 463 
     public static function string2xml(string $string) : string
464 464 
     {
465 465 
         return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML();
Please login to merge, or discard this patch.
docs/libxml/generate-errorcodes.php 1 patch
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch 
@@ -14,9 +14,9 @@
 
 block discarded – undo
14 14 
  * @see http://www.xmlsoft.org/html/libxml-xmlerror.html
15 15 
  */
16 16
17 
-   /**
18 
-    * @var string $list
19 
-    */
17 
+    /**
18 
+     * @var string $list
19 
+     */
20 20 
     $list = file_get_contents('libxmlerrors.txt');
21 21 
     $outputFile = 'LibXML.php';
22 22 
     $lines = explode("\n", $list);
Please login to merge, or discard this patch.