Merge pull request #800 from WordPress/792-do-not-use-heredoc

Disallow usage of HEREDOC and NOWDOC

phpcs-rulesets/plugin-review.xml

@@ -56,6 +56,11 @@
 		<severity>7</severity>
 	</rule>
 
+	<!-- Prohibit the use of HEREDOC or NOWDOC. -->
+	<rule ref="Squiz.PHP.Heredoc">
+		<severity>7</severity>
+	</rule>
+
 	<!-- Prohibit the use of the `goto` PHP language construct. -->
 	<rule ref="Generic.PHP.DiscourageGoto.Found">
 		<type>error</type>

tests/phpunit/testdata/plugins/test-plugin-review-phpcs-errors/load.php

@@ -24,3 +24,9 @@
 
 query_posts( 'cat=3' );
 wp_reset_query();
+
+$str = <<<EOD
+Example of string
+spanning multiple lines
+using heredoc syntax.
+EOD;

tests/phpunit/tests/Checker/Checks/Plugin_Review_PHPCS_Check_Tests.php

@@ -32,6 +32,9 @@ public function test_run_with_errors() {
 		$this->assertArrayHasKey( 'code', $errors['load.php'][6][1][0] );
 		$this->assertEquals( 'Generic.PHP.DisallowShortOpenTag.Found', $errors['load.php'][6][1][0]['code'] );
 
+		// Check for Squiz.PHP.Heredoc.NotAllowed error on Line no 28 and column no at 8.
+		$this->assertEquals( 'Squiz.PHP.Heredoc.NotAllowed', $errors['load.php'][28][8][0]['code'] );
+
 		// Check for WordPress.WP.DeprecatedFunctions.the_author_emailFound error on Line no 12 and column no at 5.
 		$this->assertArrayHasKey( 12, $errors['load.php'] );
 		$this->assertArrayHasKey( 5, $errors['load.php'][12] );