Update getFormattedXML() to match its docblock

fredden · fredden · commit d2b2e67541c8 · 2023-07-03T14:14:13.000+01:00
diff --git a/Magento2/Sniffs/Legacy/ClassReferencesInConfigurationFilesSniff.php b/Magento2/Sniffs/Legacy/ClassReferencesInConfigurationFilesSniff.php
@@ -113,10 +113,14 @@ private function assertNonFactoryNameModule(File $phpcsFile, array $classes)
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 
     /**
diff --git a/Magento2/Sniffs/Legacy/LayoutSniff.php b/Magento2/Sniffs/Legacy/LayoutSniff.php
@@ -272,10 +272,14 @@ private function testObsoleteReferences(SimpleXMLElement $layout, File $phpcsFil
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 
     /**
diff --git a/Magento2/Sniffs/Legacy/ModuleXMLSniff.php b/Magento2/Sniffs/Legacy/ModuleXMLSniff.php
@@ -88,9 +88,13 @@ public function process(File $phpcsFile, $stackPtr)
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 }
diff --git a/Magento2/Sniffs/Legacy/ObsoleteAclSniff.php b/Magento2/Sniffs/Legacy/ObsoleteAclSniff.php
@@ -57,9 +57,13 @@ public function process(File $phpcsFile, $stackPtr)
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 }
diff --git a/Magento2/Sniffs/Legacy/ObsoleteConfigNodesSniff.php b/Magento2/Sniffs/Legacy/ObsoleteConfigNodesSniff.php
@@ -79,10 +79,14 @@ public function process(File $phpcsFile, $stackPtr)
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 
     /**
diff --git a/Magento2/Sniffs/Legacy/ObsoleteMenuSniff.php b/Magento2/Sniffs/Legacy/ObsoleteMenuSniff.php
@@ -62,9 +62,13 @@ public function process(File $phpcsFile, $stackPtr)
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 }
diff --git a/Magento2/Sniffs/Legacy/ObsoleteSystemConfigurationSniff.php b/Magento2/Sniffs/Legacy/ObsoleteSystemConfigurationSniff.php
@@ -84,9 +84,13 @@ private function invalidXML(File $phpcsFile, int $stackPtr): void
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 }
diff --git a/Magento2/Sniffs/Legacy/WidgetXMLSniff.php b/Magento2/Sniffs/Legacy/WidgetXMLSniff.php
@@ -110,9 +110,13 @@ protected function invalidXML(File $phpcsFile, int $stackPtr): void
      */
     private function getFormattedXML(File $phpcsFile)
     {
-        $doc = new DomDocument('1.0');
-        $doc->formatOutput = true;
-        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
-        return $doc->saveXML();
+        try {
+            $doc = new DomDocument('1.0');
+            $doc->formatOutput = true;
+            $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));
+            return $doc->saveXML();
+        } catch (\Exception $e) {
+            return false;
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -88,9 +88,13 @@ public function process(File $phpcsFile, $stackPtr)`
`88`	`88`	`*/`
`89`	`89`	`private function getFormattedXML(File $phpcsFile)`
`90`	`90`	`{`
`91`		`- $doc = new DomDocument('1.0');`
`92`		`- $doc->formatOutput = true;`
`93`		`- $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));`
`94`		`- return $doc->saveXML();`
	`91`	`+ try {`
	`92`	`+ $doc = new DomDocument('1.0');`
	`93`	`+ $doc->formatOutput = true;`
	`94`	`+ $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));`
	`95`	`+ return $doc->saveXML();`
	`96`	`+ } catch (\Exception $e) {`
	`97`	`+ return false;`
	`98`	`+ }`
`95`	`99`	`}`
`96`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,9 +57,13 @@ public function process(File $phpcsFile, $stackPtr)`
`57`	`57`	`*/`
`58`	`58`	`private function getFormattedXML(File $phpcsFile)`
`59`	`59`	`{`
`60`		`- $doc = new DomDocument('1.0');`
`61`		`- $doc->formatOutput = true;`
`62`		`- $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));`
`63`		`- return $doc->saveXML();`
	`60`	`+ try {`
	`61`	`+ $doc = new DomDocument('1.0');`
	`62`	`+ $doc->formatOutput = true;`
	`63`	`+ $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));`
	`64`	`+ return $doc->saveXML();`
	`65`	`+ } catch (\Exception $e) {`
	`66`	`+ return false;`
	`67`	`+ }`
`64`	`68`	`}`
`65`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,9 +62,13 @@ public function process(File $phpcsFile, $stackPtr)`
`62`	`62`	`*/`
`63`	`63`	`private function getFormattedXML(File $phpcsFile)`
`64`	`64`	`{`
`65`		`- $doc = new DomDocument('1.0');`
`66`		`- $doc->formatOutput = true;`
`67`		`- $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));`
`68`		`- return $doc->saveXML();`
	`65`	`+ try {`
	`66`	`+ $doc = new DomDocument('1.0');`
	`67`	`+ $doc->formatOutput = true;`
	`68`	`+ $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));`
	`69`	`+ return $doc->saveXML();`
	`70`	`+ } catch (\Exception $e) {`
	`71`	`+ return false;`
	`72`	`+ }`
`69`	`73`	`}`
`70`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,9 +84,13 @@ private function invalidXML(File $phpcsFile, int $stackPtr): void`
`84`	`84`	`*/`
`85`	`85`	`private function getFormattedXML(File $phpcsFile)`
`86`	`86`	`{`
`87`		`- $doc = new DomDocument('1.0');`
`88`		`- $doc->formatOutput = true;`
`89`		`- $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));`
`90`		`- return $doc->saveXML();`
	`87`	`+ try {`
	`88`	`+ $doc = new DomDocument('1.0');`
	`89`	`+ $doc->formatOutput = true;`
	`90`	`+ $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));`
	`91`	`+ return $doc->saveXML();`
	`92`	`+ } catch (\Exception $e) {`
	`93`	`+ return false;`
	`94`	`+ }`
`91`	`95`	`}`
`92`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,9 +110,13 @@ protected function invalidXML(File $phpcsFile, int $stackPtr): void`
`110`	`110`	`*/`
`111`	`111`	`private function getFormattedXML(File $phpcsFile)`
`112`	`112`	`{`
`113`		`- $doc = new DomDocument('1.0');`
`114`		`- $doc->formatOutput = true;`
`115`		`- $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));`
`116`		`- return $doc->saveXML();`
	`113`	`+ try {`
	`114`	`+ $doc = new DomDocument('1.0');`
	`115`	`+ $doc->formatOutput = true;`
	`116`	`+ $doc->loadXML($phpcsFile->getTokensAsString(0, count($phpcsFile->getTokens())));`
	`117`	`+ return $doc->saveXML();`
	`118`	`+ } catch (\Exception $e) {`
	`119`	`+ return false;`
	`120`	`+ }`
`117`	`121`	`}`
`118`	`122`	`}`