Added support for heredoc.

Author: prwater

composer.json

@@ -10,7 +10,7 @@
   "license": "MIT",
   "require": {
     "php": ">=7.1.0",
-    "setbased/helper-code-store": "^2.1.0"
+    "setbased/helper-code-store": "^2.2.0"
   },
   "require-dev": {
     "phpunit/phpunit": "^7.0.0 || ^8.0.0",

src/PhpCodeStore.php

@@ -16,6 +16,13 @@ class PhpCodeStore extends CodeStore
    */
   private $defaultLevel = [];
 
+  /**
+   * The heredoc identifier.
+   *
+   * @var string|null
+   */
+  private $heredocIdentifier;
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Object constructor.
@@ -42,6 +49,8 @@ protected function indentationMode(string $line): int
     $line = trim($line);
 
     $mode = 0;
+
+    $mode |= $this->indentationModeHeredoc($line);
     $mode |= $this->indentationModeSwitch($line);
     $mode |= $this->indentationModeBLock($line);
 
@@ -93,6 +102,8 @@ private function indentationModeBlock(string $line): int
   {
     $mode = 0;
 
+    if ($this->heredocIdentifier!==null) return $mode;
+
     if (substr($line, -1, 1)=='{')
     {
       $mode |= self::C_INDENT_INCREMENT_AFTER;
@@ -119,6 +130,38 @@ private function indentationModeBlock(string $line): int
     return $mode;
   }
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   *
+   * @param string $line The line of code.
+   *
+   * @return int
+   */
+  private function indentationModeHeredoc(string $line): int
+  {
+    $mode = 0;
+
+    if ($this->heredocIdentifier!==null)
+    {
+      $mode |= self::C_INDENT_HEREDOC;
+
+      if ($line==$this->heredocIdentifier.';')
+      {
+        $this->heredocIdentifier = null;
+      }
+    }
+    else
+    {
+      $n = preg_match('/=\s*<<<\s*([A-Z]+)$/', $line, $parts);
+      if ($n==1)
+      {
+        $this->heredocIdentifier = $parts[1];
+      }
+    }
+
+    return $mode;
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * Returns the indentation mode based on a line of code for switch statements.
@@ -131,6 +174,8 @@ private function indentationModeSwitch(string $line): int
   {
     $mode = 0;
 
+    if ($this->heredocIdentifier!==null) return $mode;
+
     if (substr($line, 0, 5)=='case ')
     {
       $mode |= self::C_INDENT_INCREMENT_AFTER;

test/CodeStoreTest.php

@@ -170,6 +170,67 @@ public function testSwitch2(\$i)
   }
 
   //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Test indentation levels for heredoc.
+   */
+  public function testHeredoc(): void
+  {
+    $store = new PhpCodeStore(2, 80);
+
+    $store->append('<?php');
+    $store->appendSeparator();
+    $store->append('namespace SetBased\Helper\CodeStore\Test;');
+    $store->append('');
+    $store->append('use SetBased\Helper\CodeStore\PhpCodeStore;');
+    $store->append('');
+    $store->appendSeparator();
+    $store->append('class PhpCodeStoreTest extends \PHPUnit_Framework_TestCase');
+    $store->append('{');
+    $store->appendSeparator();
+    $store->append('public function testHeredoc()');
+    $store->append('{');
+    $store->append('$text = <<< EOT');
+    $store->append('Hello, World!');
+    $store->append('Hello, World!');
+    $store->append('EOT;');
+    $store->append('}');
+    $store->append('');
+    $store->appendSeparator();
+    $store->append('}');
+    $store->append('');
+    $store->appendSeparator();
+
+    $expected = <<< EOL
+<?php
+//------------------------------------------------------------------------------
+namespace SetBased\Helper\CodeStore\Test;
+
+use SetBased\Helper\CodeStore\PhpCodeStore;
+
+//------------------------------------------------------------------------------
+class PhpCodeStoreTest extends \PHPUnit_Framework_TestCase
+{
+  //----------------------------------------------------------------------------
+  public function testHeredoc()
+  {
+    \$text = <<< EOT
+Hello, World!
+Hello, World!
+EOT;
+  }
+
+  //----------------------------------------------------------------------------
+}
+
+//------------------------------------------------------------------------------
+
+EOL;
+
+    $code = $store->getCode();
+
+    self::assertEquals($expected, $code);
+  }
+  //--------------------------------------------------------------------------------------------------------------------
 }
 
 //----------------------------------------------------------------------------------------------------------------------