diff options
author | Frédéric Guillot <fred@kanboard.net> | 2018-04-06 10:54:58 -0700 |
---|---|---|
committer | Frédéric Guillot <fred@kanboard.net> | 2018-04-06 10:54:58 -0700 |
commit | 0b306fa60ad84ea077111e0ff7b59208ba7bc8a3 (patch) | |
tree | 5d8941b5950ede2db8ca3fba0213792db0f07a50 /doc/en_US/plugin-avatar-provider.markdown | |
parent | ac11220a1aa7ae30b8827d9bbf221888d3edd0a7 (diff) |
Move documentation to https://docs.kanboard.org/
Diffstat (limited to 'doc/en_US/plugin-avatar-provider.markdown')
-rw-r--r-- | doc/en_US/plugin-avatar-provider.markdown | 32 |
1 files changed, 0 insertions, 32 deletions
diff --git a/doc/en_US/plugin-avatar-provider.markdown b/doc/en_US/plugin-avatar-provider.markdown deleted file mode 100644 index 62941e5c..00000000 --- a/doc/en_US/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', -] -``` |