Refactor and improve formatter extender (#2098)

- Deprecated all events involved with Formatter
- Refactor ->configure() method on extender not to use events
- Add extender methods for ->render() and ->parse()
- Add integration tests

src/Formatter/Event/Configuring.php

@@ -11,6 +11,9 @@ namespace Flarum\Formatter\Event;
 
 use s9e\TextFormatter\Configurator;
 
+/**
+ * @deprecated beta 15, removed beta 16. Use the Formatter extender instead.
+ */
 class Configuring
 {
     /**

src/Formatter/Event/Parsing.php

@@ -11,6 +11,9 @@ namespace Flarum\Formatter\Event;
 
 use s9e\TextFormatter\Parser;
 
+/**
+ * @deprecated beta 15, removed beta 16. Use the Formatter extender instead.
+ */
 class Parsing
 {
     /**

src/Formatter/Event/Rendering.php

@@ -12,6 +12,9 @@ namespace Flarum\Formatter\Event;
 use Psr\Http\Message\ServerRequestInterface;
 use s9e\TextFormatter\Renderer;
 
+/**
+ * @deprecated beta 15, removed beta 16. Use the Formatter extender instead.
+ */
 class Rendering
 {
     /**

src/Formatter/Formatter.php

@@ -20,6 +20,12 @@ use s9e\TextFormatter\Unparser;
 
 class Formatter
 {
+    protected $configurationCallbacks = [];
+
+    protected $parsingCallbacks = [];
+
+    protected $renderingCallbacks = [];
+
     /**
      * @var Repository
      */
@@ -47,6 +53,21 @@ class Formatter
         $this->cacheDir = $cacheDir;
     }
 
+    public function addConfigurationCallback($callback)
+    {
+        $this->configurationCallbacks[] = $callback;
+    }
+
+    public function addParsingCallback($callback)
+    {
+        $this->parsingCallbacks[] = $callback;
+    }
+
+    public function addRenderingCallback($callback)
+    {
+        $this->renderingCallbacks[] = $callback;
+    }
+
     /**
      * Parse text.
      *
@@ -58,8 +79,13 @@ class Formatter
     {
         $parser = $this->getParser($context);
 
+        // Deprecated in beta 15, remove in beta 16
         $this->events->dispatch(new Parsing($parser, $context, $text));
 
+        foreach ($this->parsingCallbacks as $callback) {
+            $text = $callback($parser, $context, $text);
+        }
+
         return $parser->parse($text);
     }
 
@@ -75,8 +101,13 @@ class Formatter
     {
         $renderer = $this->getRenderer();
 
+        // Deprecated in beta 15, remove in beta 16
         $this->events->dispatch(new Rendering($renderer, $context, $xml, $request));
 
+        foreach ($this->renderingCallbacks as $callback) {
+            $xml = $callback($renderer, $context, $xml, $request);
+        }
+
         return $renderer->render($xml);
     }
 
@@ -122,8 +153,13 @@ class Formatter
         $configurator->Autolink;
         $configurator->tags->onDuplicate('replace');
 
+        // Deprecated in beta 15, remove in beta 16
         $this->events->dispatch(new Configuring($configurator));
 
+        foreach ($this->configurationCallbacks as $callback) {
+            $callback($configurator);
+        }
+
         $this->configureExternalLinks($configurator);
 
         return $configurator;