UPDATE additional SS4 compatability

Author: muskie9

_config.php

@@ -3,4 +3,4 @@ Name: markdowninjector
 ---
 SilverStripe\Core\Injector\Injector:
   Markdown:
-    class: UndefinedOffset\Markdown\Model\FieldTypes\Markdown
+    class: UndefinedOffset\Markdown\Model\FieldTypes\DBMarkdown

_config/injector.yml

@@ -1,7 +1,7 @@
 {
   "name": "undefinedoffset/silverstripe-markdown",
   "description": "Adds a field and a data type that allows for Markdown editing, uses the github api to render the html",
-  "type": "silverstripe-module",
+  "type": "silverstripe-vendormodule",
   "keywords": ["silverstripe", "markdown"],
   "license": "BSD-3-Clause",
   "authors": [
@@ -13,17 +13,22 @@
   ],
 
   "require": {
-    "silverstripe/framework": "^4.0@dev",
-    "composer/installers": "*"
+    "silverstripe/framework": "^4.0",
+    "michelf/php-markdown": "^1.8",
+    "ext-json": "*",
+    "ext-curl": "*"
   },
   "support": {
     "issues": "https://github.com/undefinedoffset/silverstripe-markdown/issues"
   },
   "extra": {
-    "installer-name": "markdown",
     "branch-alias": {
       "dev-ss4-compat": "2.x-dev"
-    }
+    },
+    "expose": [
+      "css",
+      "javascript"
+    ]
   },
   "autoload": {
     "psr-4": {

composer.json

@@ -5,6 +5,10 @@
 use SilverStripe\Forms\TextareaField;
 use SilverStripe\View\Requirements;
 
+/**
+ * Class MarkdownEditor
+ * @package UndefinedOffset\Markdown\Forms
+ */
 class MarkdownEditor extends TextareaField
 {
     /**
@@ -19,31 +23,31 @@ class MarkdownEditor extends TextareaField
 
     /**
      * Sets the "Wrap Mode" on the ACE editor markdown field.
-     * @param  boolean $mode True if word wrap should be enabled, false if not
+     * @param boolean $mode True if word wrap should be enabled, false if not
      * @return $this
      */
     public function setWrapMode($mode = false)
     {
         $this->wrap_mode = $mode;
+
         return $this;
     }
 
     /**
      * Returns the field holder used by templates
      * @return string HTML to be used
      */
-    public function FieldHolder($properties = array())
+    public function FieldHolder($properties = [])
     {
         $this->extraClasses['stacked'] = 'stacked';
 
+        Requirements::css('undefinedoffset/silverstripe-markdown: css/MarkdownEditor.css');
 
-        Requirements::css(MARKDOWN_MODULE_BASE . '/css/MarkdownEditor.css');
-
-        Requirements::javascript(MARKDOWN_MODULE_BASE . '/javascript/external/ace/ace.js');
-        Requirements::javascript(MARKDOWN_MODULE_BASE . '/javascript/external/ace/mode-markdown.js');
-        Requirements::javascript(MARKDOWN_MODULE_BASE . '/javascript/external/ace/theme-textmate.js');
-        Requirements::javascript(MARKDOWN_MODULE_BASE . '/javascript/external/ace/theme-twilight.js');
-        Requirements::javascript(MARKDOWN_MODULE_BASE . '/javascript/MarkdownEditor.js');
+        Requirements::javascript('undefinedoffset/silverstripe-markdown: javascript/external/ace/ace.js');
+        Requirements::javascript('undefinedoffset/silverstripe-markdown: javascript/external/ace/mode-markdown.js');
+        Requirements::javascript('undefinedoffset/silverstripe-markdown: javascript/external/ace/theme-textmate.js');
+        Requirements::javascript('undefinedoffset/silverstripe-markdown: javascript/external/ace/theme-twilight.js');
+        Requirements::javascript('undefinedoffset/silverstripe-markdown: javascript/MarkdownEditor.js');
 
         return parent::FieldHolder($properties);
     }
@@ -56,11 +60,11 @@ public function getAttributes()
     {
         return array_merge(
             parent::getAttributes(),
-            array(
+            [
                 // prevents horizontal scrollbars
                 'style' => 'width: 97%; max-width: 100%; height: ' . ($this->rows * 16) . 'px; resize: none;',
-                'wrap-mode' => ($this->wrap_mode) ? 'true' : 'false'
-            )
+                'wrap-mode' => ($this->wrap_mode) ? 'true' : 'false',
+            ]
         );
     }
 }

src/Forms/MarkdownEditor.php

@@ -2,33 +2,39 @@
 
 namespace UndefinedOffset\Markdown\Model\FieldTypes;
 
-use SilverStripe\Core\Cache;
+use Psr\SimpleCache\CacheInterface;
 use SilverStripe\Core\ClassInfo;
+use SilverStripe\Core\Injector\Injector;
 use SilverStripe\ORM\FieldType\DBText;
 use UndefinedOffset\Markdown\Renderer\GithubMarkdownRenderer;
+use UndefinedOffset\Markdown\Renderer\IMarkdownRenderer;
 
-class Markdown extends DBText
+/**
+ * Class Markdown
+ * @package UndefinedOffset\Markdown\Model\FieldTypes
+ */
+class DBMarkdown extends DBText
 {
     /**
      * {@inheritDoc}
      */
-    public static $casting = array(
+    private static $casting = [
         'AsHTML' => 'HTMLText',
-        'Markdown' => 'DBText'
-    );
+        'Markdown' => 'DBText',
+    ];
 
     /**
      * @var string
      */
-    public static $escape_type = 'xml';
+    private static $escape_type = 'xml';
 
     /**
      * @var string
      */
-    private static $renderer = 'UndefinedOffset\\Markdown\\Renderer\\GithubMarkdownRenderer';
+    private static $renderer = GithubMarkdownRenderer::class;
 
     /**
-     * @var \UndefinedOffset\Markdown\Renderer\IMarkdownRenderer
+     * @var IMarkdownRenderer
      */
     private $renderInst;
 
@@ -41,7 +47,7 @@ class Markdown extends DBText
     /**
      * Checks cache to see if the contents of this field have already been loaded from github, if they haven't
      * then a request is made to the github api to render the markdown
-     * @param  bool $useGFM Use Github Flavored Markdown or render using plain markdown defaults to false just like
+     * @param bool $useGFM Use Github Flavored Markdown or render using plain markdown defaults to false just like
      *                      how readme files are rendered on github
      * @return string Markdown rendered as HTML
      */
@@ -66,13 +72,14 @@ public function AsHTML($useGFM = false)
         }
 
         //Init cache stuff
-        $cacheKey = $this->getCacheKey();
-        $cache = Cache::factory('Markdown');
-        $cachedHTML = $cache->load($cacheKey);
+        /*$cacheKey = $this->getCacheKey();
+        $cache = Injector::inst()->get(CacheInterface::class . '.markdown');
+        $cachedHTML = $cache->load($cacheKey);//*/
 
         //Check cache, if it's good use it instead
-        if ($cachedHTML !== false) {
+        if (isset($cachedHTML) && $cachedHTML !== false) {
             $this->parsedHTML = $cachedHTML;
+
             return $this->parsedHTML;
         }
 
@@ -88,10 +95,12 @@ public function AsHTML($useGFM = false)
         $this->parsedHTML = $response;
 
         //Cache response to file system
-        $cache->save($this->parsedHTML, $cacheKey);
+        if (isset($cache) && isset($cacheKey)) {
+            $cache->save($this->parsedHTML, $cacheKey);
+        }
 
         //Reset GFM
-        if ($renderer instanceof GithubMarkdownRenderer) {
+        if ($renderer instanceof GithubMarkdownRenderer && isset($beforeUseGFM)) {
             GithubMarkdownRenderer::setUseGFM($beforeUseGFM);
         }
 
@@ -116,15 +125,15 @@ public function forTemplate()
      */
     public static function setRenderer($renderer)
     {
-        if (ClassInfo::classImplements($renderer, 'SilverStripe\\Markdown\\Renderer\\IMarkdownRenderer')) {
+        if (ClassInfo::classImplements($renderer, IMarkdownRenderer::class)) {
             self::$renderer = $renderer;
         } else {
             user_error('The renderer ' . $renderer . ' does not implement IMarkdownRenderer', E_USER_ERROR);
         }
     }
 
     /**
-     * Gets the active mardown renderer
+     * Gets the active markdown renderer
      * @return IMarkdownRenderer An implementation of IMarkdownRenderer
      */
     private function getRenderer()

src/Model/FieldTypes/Markdown.php src/Model/FieldTypes/DBMarkdown.phpsrc/Model/FieldTypes/Markdown.php renamed to src/Model/FieldTypes/DBMarkdown.php

@@ -2,10 +2,17 @@
 
 namespace UndefinedOffset\Markdown\Renderer;
 
+use SilverStripe\Core\Config\Configurable;
 use stdClass;
 
+/**
+ * Class GithubMarkdownRenderer
+ * @package UndefinedOffset\Markdown\Renderer
+ */
 class GithubMarkdownRenderer implements IMarkdownRenderer
 {
+    use Configurable;
+
     /**
      * @var bool
      */
@@ -20,6 +27,10 @@ class GithubMarkdownRenderer implements IMarkdownRenderer
      * @var string
      */
     private static $username;
+
+    /**
+     * @var
+     */
     private static $password;
 
     /**
@@ -38,19 +49,19 @@ public function isSupported()
 
     /**
      * Returns the supplied Markdown as rendered HTML
-     * @param  string $markdown The markdown to render
+     * @param string $value The markdown to render
      * @return string The rendered HTML
      */
     public function getRenderedHTML($value)
     {
         //Build object to send
         $sendObj = new stdClass();
         $sendObj->text = $value;
-        $sendObj->mode = (self::$useGFM ? 'gmf' : 'markdown');
+        $sendObj->mode = (self::$useGFM ? 'gfm' : 'markdown');
         $content = json_encode($sendObj);
 
         //Build headers
-        $headers = array('Content-type: application/json', 'User-Agent: curl');
+        $headers = ['Content-type: application/json', 'User-Agent: curl'];
         if (self::$useBasicAuth) {
             $encoded = base64_encode(self::$username . ':' . self::$password);
             $headers[] = "Authorization: Basic $encoded";
@@ -65,14 +76,13 @@ public function getRenderedHTML($value)
         curl_setopt($curl, CURLOPT_POSTFIELDS, $content);
         curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
 
-
         //Send request and verify response
         $response = curl_exec($curl);
         $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
         if ($status != 200) {
             user_error(
                 "Error: Call to api.github.com failed with status $status, response $response, curl_error "
-                    . curl_error($curl) . ", curl_errno " . curl_errno($curl),
+                . curl_error($curl) . ", curl_errno " . curl_errno($curl),
                 E_USER_WARNING
             );
         }
@@ -85,7 +95,7 @@ public function getRenderedHTML($value)
 
     /**
      * Globally enable or disable github flavored markdown
-     * @param bool $val Boolean true to enable false otherwise
+     * @param bool $value Boolean true to enable false otherwise
      */
     public static function setUseGFM($value = true)
     {
@@ -104,8 +114,8 @@ public static function getUseGFM()
     /**
      * Sets whether or not to include the Authorization header in GitHub API requests, both parameters are
      * required to enable basic auth
-     * @param string $username Github Username
-     * @param string $password Github Password
+     * @param bool|string $username Github Username
+     * @param bool|string $password Github Password
      */
     public function useBasicAuth($username = false, $password = false)
     {

src/Renderer/GithubMarkdownRenderer.php

@@ -2,6 +2,10 @@
 
 namespace UndefinedOffset\Markdown\Renderer;
 
+/**
+ * Interface IMarkdownRenderer
+ * @package UndefinedOffset\Markdown\Renderer
+ */
 interface IMarkdownRenderer
 {
     /**
@@ -14,7 +18,7 @@ public function isSupported();
 
     /**
      * Returns the supplied Markdown as rendered HTML
-     * @param  string $markdown The markdown to render
+     * @param string $markdown The markdown to render
      * @return string The rendered HTML
      */
     public function getRenderedHTML($markdown);

src/Renderer/IMarkdownRenderer.php

@@ -2,29 +2,36 @@
 
 namespace UndefinedOffset\Markdown\Renderer;
 
+use Michelf\Markdown;
+
+/**
+ * Class PHPMarkdownMarkdownRenderer
+ * @package UndefinedOffset\Markdown\Renderer
+ */
 class PHPMarkdownMarkdownRenderer implements IMarkdownRenderer
 {
     /**
      * Returns the supplied Markdown as rendered HTML
-     * @param  string $markdown The markdown to render
+     * @param string $markdown The markdown to render
      * @return string The rendered HTML
      */
     public function isSupported()
     {
-        $exist s =class_exists("\Michelf\Markdown");
+        $exists = class_exists(Markdown::class);
         if (!$exists) {
             return "Unable to find the php-markdown class (\Michelf\Markdown) on the classpath.";
         }
+
         return $exists;
     }
 
     /**
      * Returns the supplied Markdown as rendered HTML
-     * @param  string $markdown The markdown to render
+     * @param string $markdown The markdown to render
      * @return string The rendered HTML
      */
     public function getRenderedHTML($markdown)
     {
-        return \Michelf\Markdown::defaultTransform($markdown);
+        return Markdown::defaultTransform($markdown);
     }
 }