Merge pull request #634 from PHPCSStandards/feature/148-squiz-heredoc…

…-add-docs Squiz/Heredoc: add XML doc
PHPCSStandards · Oct 24, 2024 · 6f96ad8 · 6f96ad8
2 parents b1d8ff7 + dfafcd5
commit 6f96ad8
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/src/Standards/Squiz/Docs/PHP/HeredocStandard.xml b/src/Standards/Squiz/Docs/PHP/HeredocStandard.xml
@@ -0,0 +1,32 @@
+<documentation title="Heredoc">
+    <standard>
+    <![CDATA[
+    Forbids the use of heredoc and nowdoc syntax.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Using standard strings or inline HTML.">
+        <![CDATA[
+$text = "some $text";
+
+
+
+?>
+some text
+<?php
+
+        ]]>
+        </code>
+        <code title="Invalid: Using heredoc or nowdoc syntax.">
+        <![CDATA[
+$text = <em><<<EOD
+some $text
+EOD</em>;
+
+echo <em><<<'EOD'
+some text
+EOD</em>;
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>