[thephpleague#19] Indented list not correctly converted

Add an openElement/closeElement to the converters so that they may track additional information once they're about to be converted/have been converted. This allows us to track the number of ul/ol opened, such that when we render the li element, we know the current indent level.
TomzxForks · Jul 25, 2015 · e1812e9 · e1812e9
1 parent 16f0fe2
commit e1812e9
Show file tree

Hide file tree

Showing 18 changed files with 94 additions and 18 deletions.
diff --git a/src/Converter/BaseConverter.php b/src/Converter/BaseConverter.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace League\HTMLToMarkdown\Converter;
+
+use League\HTMLToMarkdown\ElementInterface;
+
+abstract class BaseConverter implements ConverterInterface
+{
+    /**
+     * @param \League\HTMLToMarkdown\ElementInterface $element
+     * @return void
+     */
+    public function openElement(ElementInterface $element)
+    {
+        // Do nothing
+    }
+
+    /**
+     * @param \League\HTMLToMarkdown\ElementInterface $element
+     * @return void
+     */
+    public function closeElement(ElementInterface $element)
+    {
+        // Do nothing
+    }
+}
diff --git a/src/Converter/BlockquoteConverter.php b/src/Converter/BlockquoteConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class BlockquoteConverter implements ConverterInterface
+class BlockquoteConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/CommentConverter.php b/src/Converter/CommentConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class CommentConverter implements ConverterInterface
+class CommentConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/ConverterInterface.php b/src/Converter/ConverterInterface.php
@@ -17,4 +17,16 @@ public function convert(ElementInterface $element);
      * @return string[]
      */
     public function getSupportedTags();
+
+    /**
+     * @param \League\HTMLToMarkdown\ElementInterface $element
+     * @return void
+     */
+    public function openElement(ElementInterface $element);
+
+    /**
+     * @param \League\HTMLToMarkdown\ElementInterface $element
+     * @return void
+     */
+    public function closeElement(ElementInterface $element);
 }
diff --git a/src/Converter/DefaultConverter.php b/src/Converter/DefaultConverter.php
@@ -6,7 +6,7 @@
 use League\HTMLToMarkdown\ConfigurationAwareInterface;
 use League\HTMLToMarkdown\ElementInterface;
 
-class DefaultConverter implements ConverterInterface, ConfigurationAwareInterface
+class DefaultConverter extends BaseConverter implements ConfigurationAwareInterface
 {
     const DEFAULT_CONVERTER = '_default';
 

diff --git a/src/Converter/DivConverter.php b/src/Converter/DivConverter.php
@@ -6,7 +6,7 @@
 use League\HTMLToMarkdown\ConfigurationAwareInterface;
 use League\HTMLToMarkdown\ElementInterface;
 
-class DivConverter implements ConverterInterface, ConfigurationAwareInterface
+class DivConverter extends BaseConverter implements ConfigurationAwareInterface
 {
     /**
      * @var Configuration

diff --git a/src/Converter/EmphasisConverter.php b/src/Converter/EmphasisConverter.php
@@ -6,7 +6,7 @@
 use League\HTMLToMarkdown\ConfigurationAwareInterface;
 use League\HTMLToMarkdown\ElementInterface;
 
-class EmphasisConverter implements ConverterInterface, ConfigurationAwareInterface
+class EmphasisConverter extends BaseConverter implements ConfigurationAwareInterface
 {
     /**
      * @var Configuration

diff --git a/src/Converter/HardBreakConverter.php b/src/Converter/HardBreakConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class HardBreakConverter implements ConverterInterface
+class HardBreakConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/HeaderConverter.php b/src/Converter/HeaderConverter.php
@@ -6,7 +6,7 @@
 use League\HTMLToMarkdown\ConfigurationAwareInterface;
 use League\HTMLToMarkdown\ElementInterface;
 
-class HeaderConverter implements ConverterInterface, ConfigurationAwareInterface
+class HeaderConverter extends BaseConverter implements ConfigurationAwareInterface
 {
     const STYLE_ATX = 'atx';
     const STYLE_SETEXT = 'setext';

diff --git a/src/Converter/HorizontalRuleConverter.php b/src/Converter/HorizontalRuleConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class HorizontalRuleConverter implements ConverterInterface
+class HorizontalRuleConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/ImageConverter.php b/src/Converter/ImageConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class ImageConverter implements ConverterInterface
+class ImageConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/LinkConverter.php b/src/Converter/LinkConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class LinkConverter implements ConverterInterface
+class LinkConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/ListBlockConverter.php b/src/Converter/ListBlockConverter.php
@@ -4,17 +4,23 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class ListBlockConverter implements ConverterInterface
+class ListBlockConverter extends BaseConverter
 {
+	public static $level = -1;
+
     /**
      * @param ElementInterface $element
      *
      * @return string
      */
     public function convert(ElementInterface $element)
     {
-        return $element->getValue() . "\n";
-    }
+		if (self::$level >= 0) {
+			return "\n".$element->getValue() . "\n";
+		} else {
+      		return $element->getValue() . "\n";
+		}
+	}
 
     /**
      * @return string[]
@@ -23,4 +29,14 @@ public function getSupportedTags()
     {
         return array('ol', 'ul');
     }
+
+	public function openElement(ElementInterface $element)
+	{
+		self::$level++;
+	}
+
+	public function closeElement(ElementInterface $element)
+	{
+		self::$level--;
+	}
 }
diff --git a/src/Converter/ListItemConverter.php b/src/Converter/ListItemConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class ListItemConverter implements ConverterInterface
+class ListItemConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element
@@ -24,7 +24,7 @@ public function convert(ElementInterface $element)
             $markdown = $number . '. ' . trim($value) . "\n";
         }
 
-        return $markdown;
+        return str_repeat("\t", ListBlockConverter::$level).$markdown;
     }
 
     /**

diff --git a/src/Converter/ParagraphConverter.php b/src/Converter/ParagraphConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class ParagraphConverter implements ConverterInterface
+class ParagraphConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/PreformattedConverter.php b/src/Converter/PreformattedConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class PreformattedConverter implements ConverterInterface
+class PreformattedConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/Converter/TextConverter.php b/src/Converter/TextConverter.php
@@ -4,7 +4,7 @@
 
 use League\HTMLToMarkdown\ElementInterface;
 
-class TextConverter implements ConverterInterface
+class TextConverter extends BaseConverter
 {
     /**
      * @param ElementInterface $element

diff --git a/src/HtmlConverter.php b/src/HtmlConverter.php
@@ -133,13 +133,17 @@ private function convertChildren(ElementInterface $element)
             return;
         }
 
+        $this->preProcess($element);
+
         // If the node has children, convert those to Markdown first
         if ($element->hasChildren()) {
             foreach ($element->getChildren() as $child) {
                 $this->convertChildren($child);
             }
         }
 
+        $this->postProcess($element);
+
         // Now that child nodes have been converted, convert the original node
         $markdown = $this->convertToMarkdown($element);
 
@@ -149,6 +153,24 @@ private function convertChildren(ElementInterface $element)
         $element->setFinalMarkdown($markdown);
     }
 
+    /**
+     * @param \League\HTMLToMarkdown\ElementInterface $element
+     */
+    protected function preProcess(ElementInterface $element)
+    {
+        $converter = $this->environment->getConverterByTag($element->getTagName());
+        $converter->openElement($element);
+    }
+
+    /**
+     * @param \League\HTMLToMarkdown\ElementInterface $element
+     */
+    protected function postProcess(ElementInterface $element)
+    {
+        $converter = $this->environment->getConverterByTag($element->getTagName());
+        $converter->closeElement($element);
+    }
+
     /**
      * Convert to Markdown
      *