Use underscore_names instead of camelCasing for option keys

thephpleague · Jan 8, 2015 · 0b6f011 · 0b6f011 · melyux · Jan 11, 2015
1 parent d937a6d
commit 0b6f011
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 9 deletions.
diff --git a/src/Block/Renderer/BlockQuoteRenderer.php b/src/Block/Renderer/BlockQuoteRenderer.php
@@ -36,13 +36,13 @@ public function render(AbstractBlock $block, HtmlRenderer $htmlRenderer, $inTigh
 
         $filling = $htmlRenderer->renderBlocks($block->getChildren());
         if ($filling === '') {
-            return new HtmlElement('blockquote', array(), $htmlRenderer->getOption('innerSeparator', "\n"));
+            return new HtmlElement('blockquote', array(), $htmlRenderer->getOption('inner_separator', "\n"));
         }
 
         return new HtmlElement(
             'blockquote',
             array(),
-            $htmlRenderer->getOption('innerSeparator', "\n") . $filling . $htmlRenderer->getOption('innerSeparator', "\n")
+            $htmlRenderer->getOption('inner_separator', "\n") . $filling . $htmlRenderer->getOption('inner_separator', "\n")
         );
     }
 }
diff --git a/src/Block/Renderer/ListBlockRenderer.php b/src/Block/Renderer/ListBlockRenderer.php
@@ -44,10 +44,10 @@ public function render(AbstractBlock $block, HtmlRenderer $htmlRenderer, $inTigh
         return new HtmlElement(
             $tag,
             $attr,
-            $htmlRenderer->getOption('innerSeparator', "\n") . $htmlRenderer->renderBlocks(
+            $htmlRenderer->getOption('inner_separator', "\n") . $htmlRenderer->renderBlocks(
                 $block->getChildren(),
                 $block->isTight()
-            ) . $htmlRenderer->getOption('innerSeparator', "\n")
+            ) . $htmlRenderer->getOption('inner_separator', "\n")
         );
     }
 }
diff --git a/src/Environment.php b/src/Environment.php
@@ -463,9 +463,9 @@ public static function createCommonMarkEnvironment()
         $environment->addExtension(new CommonMarkCoreExtension());
         $environment->mergeConfig(array(
             'renderer' => array(
-                'blockSeparator' => "\n",
-                'innerSeparator' => "\n",
-                'softBreak' => "\n",
+                'block_separator' => "\n",
+                'inner_separator' => "\n",
+                'soft_break' => "\n",
             )
         ));
 

diff --git a/src/HtmlRenderer.php b/src/HtmlRenderer.php
@@ -61,6 +61,19 @@ public function __construct(Environment $environment)
      */
     public function getOption($option, $default = null)
     {
+        // Handle deprecated config names
+        $configNames = array(
+            'blockSeparator' => 'block_separator',
+            'innerSeparator' => 'inner_separator',
+            'softBreak' => 'soft_break',
+        );
+        if (isset($configNames[$option])) {
+            $msg = sprintf('The "%s" option name has been deprecated - use "%s" instead.', $option, $configNames[$option]);
+            trigger_error($msg, E_USER_DEPRECATED);
+
+            $option = $configNames[$option];
+        }
+
         // Deprecated retrieval method
         if (isset($this->options[$option])) {
             return $this->options[$option];
@@ -149,7 +162,7 @@ public function renderBlocks($blocks, $inTightList = false)
             $result[] = $this->renderBlock($block, $inTightList);
         }
 
-        $separator = $this->getOption('blockSeparator', "\n");
+        $separator = $this->getOption('block_separator', "\n");
 
         return implode($separator, $result);
     }

diff --git a/src/Inline/Renderer/NewlineRenderer.php b/src/Inline/Renderer/NewlineRenderer.php
@@ -36,7 +36,7 @@ public function render(AbstractInline $inline, HtmlRenderer $htmlRenderer)
         if ($inline->getType() === Newline::HARDBREAK) {
             return new HtmlElement('br', array(), '', true) . "\n";
         } else {
-            return $htmlRenderer->getOption('softBreak', "\n");
+            return $htmlRenderer->getOption('soft_break', "\n");
         }
     }
 }