Offer the possibility to override internal formatter objects from plugins

1 files changed, 31 insertions, 0 deletions

diff --git a/doc/plugin-overrides.markdown b/doc/plugin-overrides.markdown
index 96a09e47..b9372bdf 100644
--- a/doc/plugin-overrides.markdown
+++ b/doc/plugin-overrides.markdown
@@ -40,3 +40,34 @@ You can still use the original template using the "kanboard:" prefix:
 ```php
 <?= $this->render('kanboard:header') ?>
 ```
+
+Formatter Overrides
+-------------------
+
+Here an example to override formatter objects in Kanboard:
+
+```php
+class MyFormatter extends UserAutoCompleteFormatter {
+
+    public function format()
+    {
+        $users = parent::format();
+
+        foreach ($users as &$user) {
+            $user['label'] = 'something'; // Do something useful here
+        }
+
+        return $users;
+    }
+}
+
+class Plugin extends Base
+{
+    public function initialize()
+    {
+        $this->container['userAutoCompleteFormatter'] = $this->container->factory(function ($c) {
+            return new MyFormatter($c);
+        });
+    }
+}
+```