summaryrefslogtreecommitdiff
path: root/doc/plugin-avatar-provider.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2017-01-29 11:07:42 -0500
committerFrederic Guillot <fred@kanboard.net>2017-01-29 11:07:42 -0500
commit0371acff89b14b9bdcb03e72fd9637e26e6b517c (patch)
treef5878c9c07705379d137843cb8f92e3cdf7c20a8 /doc/plugin-avatar-provider.markdown
parent3bf4789be255650b64f42231f41383cb13b65572 (diff)
Move English documentation to folder en_US
Diffstat (limited to 'doc/plugin-avatar-provider.markdown')
-rw-r--r--doc/plugin-avatar-provider.markdown32
1 files changed, 0 insertions, 32 deletions
diff --git a/doc/plugin-avatar-provider.markdown b/doc/plugin-avatar-provider.markdown
deleted file mode 100644
index 62941e5c..00000000
--- a/doc/plugin-avatar-provider.markdown
+++ /dev/null
@@ -1,32 +0,0 @@
-Adding a new Avatar Provider
-=============================
-
-Registration
-------------
-
-```php
-$this->avatarManager->register(new CustomAvatarProvider());
-```
-
-Interface
----------
-
-The provider must implements the interface `Kanboard\Core\User\Avatar\AvatarProviderInterface`:
-
-
-| Method | Description |
-|-------------------------------|---------------------------------------------------------------|
-| `render(array $user, $size)` | Render HTML |
-| `isActive(array $user)` | Returns a boolean if the provider is able to render something |
-
-
-The `$user` argument is a dictionary that contains these keys:
-
-```php
-[
- 'id' => 123,
- 'username' => 'admin',
- 'name' => 'Administrator',
- 'email' => 'me@localhost',
-]
-```