feat: add "html" and "markdown" arg option to contentsList() (fix #20) (PR #36)

* feat: add "html" option arg for `contentsList()` (issue #20)
* feat: add "markdown" option arg for `contentsList()`
* docs: update PHPDocs for `html` and `markdown` option args

closes #20

Author: KEINOS

Extension.php

@@ -294,34 +294,46 @@ public function body($text, $omit_toc_tag = false)
     }
 
     /**
-     * Returns the parsed ToC.
-     * If the arg is "string" then it returns the ToC in HTML string.
+     * Returns the parsed ToC in various formats.
      *
-     * @param string $type_return  Type of the return format. "string", "json", "flatarray" and "nestedarray".
+     * If the arg is empty or "html" then it returns the ToC in HTML string.
      *
-     * @return false|string|array ToC in HTML/JSON format string or array.
+     * @param string $type_return  Type of the return format. Available types: "markdown", "html", "json", "flatarray" and "nestedarray". Default: "html". Aliases: "string" = "html", "md" = "markdown".
+     *
+     * @return false|string|array ToC in HTML/JSON format string or PHP array.
      */
-    public function contentsList($type_return = 'string')
+    public function contentsList($type_return = 'html')
     {
-        if ('string' === strtolower($type_return)) {
+        $type_return = strtolower($type_return);
+
+        if ('markdown' === $type_return || 'md' === $type_return) {
             $result = '';
             if (! empty($this->contentsListString)) {
-                // Parses the ToC list in markdown to HTML
+                $result = $this->contentsListString;
+            }
+
+            return rtrim($result);
+        }
+
+        if ('html' === $type_return || 'string' === $type_return) {
+            $result = '';
+            if (! empty($this->contentsListString)) {
+                // Parses the markdown ToC list to HTML
                 $result = $this->body($this->contentsListString);
             }
 
             return $result;
         }
 
-        if ('json' === strtolower($type_return)) {
+        if ('json' === $type_return) {
             return json_encode($this->contentsListArray);
         }
 
-        if ('flatarray' === strtolower($type_return)) {
+        if ('flatarray' === $type_return) {
             return $this->contentsListArray;
         }
 
-        if ('nestedarray' === strtolower($type_return)) {
+        if ('nestedarray' === $type_return) {
             return $this->buildNestedToc($this->contentsListArray);
         }
 
@@ -332,7 +344,7 @@ public function contentsList($type_return = 'string')
             . ' in Line:' . __LINE__ . ' (Using default type)'
         );
 
-        return $this->contentsList('string');
+        return $this->contentsList('html');
     }
 
     /**
@@ -451,6 +463,8 @@ protected function getSalt()
     /**
      * Gets the markdown tag for ToC.
      *
+     * It returns the current tag to search for the ToC tag, '[toc]' for example, in the markdown text.
+     *
      * @return string
      */
     protected function getTagToC()
@@ -530,7 +544,7 @@ protected function setContentsListAsString(array $Content)
             $level = $level - $cutIndent;
         }
 
-        $indent = str_repeat('  ', $level);
+        $indent = str_repeat('  ', $level-1);
 
         // Stores in markdown list format as below:
         // - [Header1](#Header1)

README.md

@@ -37,13 +37,13 @@ $parser = new \ParsedownToc();
 // Get the parsed HTML
 $html = $parser->text($inputMarkdown);
 
-// Get the Table of Contents
-$ToC  = $parser->contentsList();
+// Get the Table of Contents in HTML
+$tocHTML = $parser->contentsList('html');
 
 // Print the parsed HTML and ToC
 echo $html . PHP_EOL;
 echo "---" . PHP_EOL;
-echo $ToC . PHP_EOL;
+echo $tocHTML . PHP_EOL;
 ```
 
 ```shellsession
@@ -121,10 +121,10 @@ require_once __DIR__ . '/vendor/autoload.php';
 // Sample Markdown with '[toc]' tag included
 $text_markdown = file_get_contents('SAMPLE.md');
 
-$Parsedown = new \ParsedownToC();
+$parser = new \ParsedownToC();
 
 // Parse Markdown and the '[toc]' tag to HTML
-$html = $Parsedown->text($text_markdown);
+$html = $parser->text($text_markdown);
 
 echo $html . PHP_EOL;
 

docs/classes/DynamicParent.html

@@ -107,7 +107,7 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="Extension.php"><a href="files/extension.html">Extension.php</a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">34</span>
+    <span class="phpdocumentor-element-found-in__line">32</span>
 
     </aside>
 
@@ -175,7 +175,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="Extension.php"><a href="files/extension.html">Extension.php</a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">36</span>
+    <span class="phpdocumentor-element-found-in__line">34</span>
 
     </aside>