From ae708a712a5dd932c01e734f8450b899b1407a70 Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Tue, 20 Dec 2016 20:06:39 -0500
Subject: Offer the possibility to override internal formatter objects from
 plugins

---
 doc/plugin-overrides.markdown | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

(limited to 'doc/plugin-overrides.markdown')

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);
+        });
+    }
+}
+```
-- 
cgit v1.2.3