Ensure the script threats PHP open tags in a case insensitive way

Author: rodrigoprimo

Scripts/DocCodeExamples/XmlDocValidator.php

@@ -335,7 +335,7 @@ private function displayErrorMessage(string $message)
      */
     private function maybeAddPhpOpenTag(string $codeBlockContent): string
     {
-        if (\strpos(\trim($codeBlockContent), '<?php') === false) {
+        if (\strpos(\trim(\strtolower($codeBlockContent)), '<?php') === false) {
             $codeBlockContent = '<?php ' . \PHP_EOL . $codeBlockContent;
         }
 

Tests/DocCodeExamples/XmlDocValidatorTest.php

@@ -212,6 +212,11 @@ public static function dataValidate()
                 'expectedErrorMessage' => '',
                 'expectedReturnValue'  => true,
             ],
+            'Code examples testing adding or not the PHP open tag'   => [
+                'xmlPath'              => 'Tests/Fixtures/DocCodeExamples/CheckCodeExamplesStandard/Docs/Examples/PhpOpenTagStandard.xml',
+                'expectedErrorMessage' => '',
+                'expectedReturnValue'  => true,
+            ],
             'Code example with syntax error using colorized output'  => [
                 'xmlPath'              => 'Tests/Fixtures/DocCodeExamples/CheckCodeExamplesStandard/Docs/Examples/SyntaxErrorExampleStandard.xml',
                 'expectedErrorMessage' => "\033[31mErrors found while processing Tests/Fixtures/DocCodeExamples/CheckCodeExamplesStandard/Docs/Examples/SyntaxErrorExampleStandard.xml\033[0m" . PHP_EOL . PHP_EOL .

Tests/Fixtures/DocCodeExamples/CheckCodeExamplesStandard/Docs/Examples/PhpOpenTagStandard.xml

@@ -0,0 +1,35 @@
+<documentation title="PHP Open Tag">
+    <standard>
+    <![CDATA[
+    Documentation containing valid and invalid code examples that are correct. Uses a variation of
+    tests with and without the PHP open tag to test that the script correctly adds one when needed.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: valid code example without PHP open tag.">
+        <![CDATA[
+function sniffValidationWillPass() {}
+        ]]>
+        </code>
+        <code title="Invalid: invalid code example with PHP open tag.">
+        <![CDATA[
+<?php
+function sniffValidationWillFail() {}
+        ]]>
+        </code>
+    </code_comparison>
+    <code_comparison>
+        <code title="Valid: valid code example with uppercase PHP open tag.">
+            <![CDATA[
+<?PHP
+function sniffValidationWillPass() {}
+        ]]>
+        </code>
+        <code title="Invalid: invalid code example with varying case PHP open tag.">
+            <![CDATA[
+<?pHp
+function sniffValidationWillFail() {}
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>

Tests/Fixtures/DocCodeExamples/CheckCodeExamplesStandard/Sniffs/Examples/PhpOpenTagSniff.php

@@ -0,0 +1,11 @@
+<?php
+
+/**
+ * Test fixture.
+ *
+ * @see \PHPCSDevTools\Tests\DocCodeExamples\XmlDocValidatorTest
+ */
+
+namespace Fixtures\DocCodeExamples\CheckCodeExamplesStandard\Sniffs\Examples;
+
+class PhpOpenTagSniff extends BaseExamplesSniff {}