Update documentation

This commit is contained in:
Frederic Guillot 2016-06-01 20:21:26 -04:00
parent b0a31b168f
commit ca87b1b60f
5 changed files with 19 additions and 12 deletions

View File

@ -160,6 +160,7 @@ List of template hooks:
| `template:config:integrations` | Integration page in global settings |
| `template:dashboard:sidebar` | Sidebar on dashboard page |
| `template:export:sidebar` | Sidebar on export pages |
| `template:import:sidebar` | Sidebar on import pages |
| `template:layout:head` | Page layout `<head/>` tag |
| `template:layout:top` | Page layout top header |
| `template:layout:bottom` | Page layout footer |

View File

@ -13,28 +13,28 @@ Attach metadata to tasks and remove them
```php
// Return a dictionary of metadata (keys/values) for the $task_id
$this->taskMetadata->getAll($task_id);
$this->taskMetadataModel->getAll($task_id);
// Get a value only for a task
$this->taskMetadata->get($task_id, 'my_plugin_variable', 'default_value');
$this->taskMetadataModel->get($task_id, 'my_plugin_variable', 'default_value');
// Return true if the metadata my_plugin_variable exists
$this->taskMetadata->exists($task_id, 'my_plugin_variable');
$this->taskMetadataModel->exists($task_id, 'my_plugin_variable');
// Create or update metadata for the task
$this->taskMetadata->save($task_id, ['my_plugin_variable' => 'something']);
$this->taskMetadataModel->save($task_id, ['my_plugin_variable' => 'something']);
// Remove a metadata from a project
$this->projectMetadata->remove($project_id, my_plugin_variable);
$this->projectMetadataModel->remove($project_id, my_plugin_variable);
```
Metadata types
--------------
- TaskMetadata: `$this->taskMetadata`
- ProjectMetadata: `$this->projectMetadata`
- UserMetadata: `$this->userMetadata`
- Settings/Config: `$this->config`
- TaskMetadata: `$this->taskMetadataModel`
- ProjectMetadata: `$this->projectMetadataModel`
- UserMetadata: `$this->userMetadataModel`
- Settings/Config: `$this->configModel`
Notes
-----

View File

@ -13,8 +13,8 @@ Register a new notification type
In your plugin registration file call the method `setType()`:
```php
$this->userNotificationType->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
$this->projectNotificationType->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
$this->userNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
$this->projectNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
```
Your handler can be registered for user or project notification. You don't necessarily need to support both.

View File

@ -88,7 +88,7 @@ Plugin can be translated in the same way as the rest of the application. You mus
```php
public function onStartup()
{
Translator::load($this->language->getCurrentLanguage(), __DIR__.'/Locale');
Translator::load($this->languageModel->getCurrentLanguage(), __DIR__.'/Locale');
}
```

View File

@ -74,6 +74,12 @@ Kanboard is pre-configured to work with Apache (URL rewriting).
| ldap | Only for LDAP authentication |
| Zend OPcache | Recommended |
### Optional PHP extensions
| PHP Extensions required | Note |
|----------------------------|--------------------------------------------|
| zip | Used to install plugins from Kanboard |
### Recommendations
- Modern Linux or Unix operating system.