extracted markdown code highlighting to a trait

Author: cebe

CHANGELOG.md

@@ -6,6 +6,7 @@ Yii Framework 2 apidoc extension Change Log
 
 - Enh #38: Fixed display of default values given as octal or hex notation (hiqsol)
 - Enh: Display TOC only if there is more than one headline (cebe)
+- Enh: Extracted markdown code highlighting to a trait `MarkdownHighlightTrait` (cebe)
 
 
 2.1.0 November 22, 2016

helpers/ApiMarkdown.php

@@ -8,8 +8,6 @@
 namespace yii\apidoc\helpers;
 
 use cebe\markdown\GithubMarkdown;
-use DomainException;
-use Highlight\Highlighter;
 use yii\apidoc\models\TypeDoc;
 use yii\apidoc\renderers\BaseRenderer;
 use yii\helpers\Html;
@@ -25,6 +23,7 @@
 class ApiMarkdown extends GithubMarkdown
 {
     use ApiMarkdownTrait;
+    use MarkdownHighlightTrait;
 
     /**
      * @var BaseRenderer
@@ -85,69 +84,6 @@ protected function applyToc($content)
         return $content;
     }
 
-    /**
-     * @var Highlighter
-     */
-    private static $highlighter;
-
-    /**
-     * @inheritdoc
-     */
-    protected function renderCode($block)
-    {
-        if (self::$highlighter === null) {
-            self::$highlighter = new Highlighter();
-            self::$highlighter->setAutodetectLanguages([
-                'apache', 'nginx',
-                'bash', 'dockerfile', 'http',
-                'css', 'less', 'scss',
-                'javascript', 'json', 'markdown',
-                'php', 'sql', 'twig', 'xml',
-            ]);
-        }
-        try {
-            if (isset($block['language'])) {
-                $result = self::$highlighter->highlight($block['language'], $block['content'] . "\n");
-                return "<pre><code class=\"hljs {$result->language} language-{$block['language']}\">{$result->value}</code></pre>\n";
-            } else {
-                $result = self::$highlighter->highlightAuto($block['content'] . "\n");
-                return "<pre><code class=\"hljs {$result->language}\">{$result->value}</code></pre>\n";
-            }
-        } catch (DomainException $e) {
-            echo $e;
-            return parent::renderCode($block);
-        }
-    }
-
-    /**
-     * Highlights code
-     *
-     * @param string $code code to highlight
-     * @param string $language language of the code to highlight
-     * @return string HTML of highlighted code
-     * @deprecated since 2.0.5 this method is not used anymore, highlight.php is used for highlighting
-     */
-    public static function highlight($code, $language)
-    {
-        if ($language !== 'php') {
-            return htmlspecialchars($code, ENT_NOQUOTES | ENT_SUBSTITUTE, 'UTF-8');
-        }
-
-        if (strncmp($code, '<?php', 5) === 0) {
-            $text = @highlight_string(trim($code), true);
-        } else {
-            $text = highlight_string("<?php ".trim($code), true);
-            $text = str_replace('&lt;?php', '', $text);
-            if (($pos = strpos($text, '&nbsp;')) !== false) {
-                $text = substr($text, 0, $pos) . substr($text, $pos + 6);
-            }
-        }
-        // remove <code><span style="color: #000000">\n and </span>tags added by php
-        $text = substr(trim($text), 36, -16);
-
-        return $text;
-    }
-
     /**
      * @inheritDoc
      */

helpers/MarkdownHighlightTrait.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\helpers;
+
+use DomainException;
+use Highlight\Highlighter;
+
+/**
+ * MarkdownHighlightTrait provides code highlighting functionality for Markdown Parsers.
+ *
+ * @since 2.1.1
+ * @author Carsten Brandt <mail@cebe.cc>
+ */
+trait MarkdownHighlightTrait
+{
+    /**
+     * @var Highlighter
+     */
+    private static $highlighter;
+
+    /**
+     * @inheritdoc
+     */
+    protected function renderCode($block)
+    {
+        if (self::$highlighter === null) {
+            self::$highlighter = new Highlighter();
+            self::$highlighter->setAutodetectLanguages([
+                'apache', 'nginx',
+                'bash', 'dockerfile', 'http',
+                'css', 'less', 'scss',
+                'javascript', 'json', 'markdown',
+                'php', 'sql', 'twig', 'xml',
+            ]);
+        }
+        try {
+            if (isset($block['language'])) {
+                $result = self::$highlighter->highlight($block['language'], $block['content'] . "\n");
+                return "<pre><code class=\"hljs {$result->language} language-{$block['language']}\">{$result->value}</code></pre>\n";
+            } else {
+                $result = self::$highlighter->highlightAuto($block['content'] . "\n");
+                return "<pre><code class=\"hljs {$result->language}\">{$result->value}</code></pre>\n";
+            }
+        } catch (DomainException $e) {
+            echo $e;
+            return parent::renderCode($block);
+        }
+    }
+
+    /**
+     * Highlights code
+     *
+     * @param string $code code to highlight
+     * @param string $language language of the code to highlight
+     * @return string HTML of highlighted code
+     * @deprecated since 2.0.5 this method is not used anymore, highlight.php is used for highlighting
+     */
+    public static function highlight($code, $language)
+    {
+        if ($language !== 'php') {
+            return htmlspecialchars($code, ENT_NOQUOTES | ENT_SUBSTITUTE, 'UTF-8');
+        }
+
+        if (strncmp($code, '<?php', 5) === 0) {
+            $text = @highlight_string(trim($code), true);
+        } else {
+            $text = highlight_string("<?php ".trim($code), true);
+            $text = str_replace('&lt;?php', '', $text);
+            if (($pos = strpos($text, '&nbsp;')) !== false) {
+                $text = substr($text, 0, $pos) . substr($text, $pos + 6);
+            }
+        }
+        // remove <code><span style="color: #000000">\n and </span>tags added by php
+        $text = substr(trim($text), 36, -16);
+
+        return $text;
+    }
+}