diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugin-hooks.markdown | 1 | ||||
| -rw-r--r-- | doc/plugin-metadata.markdown | 18 | ||||
| -rw-r--r-- | doc/plugin-notifications.markdown | 4 | ||||
| -rw-r--r-- | doc/plugin-registration.markdown | 2 | ||||
| -rw-r--r-- | doc/requirements.markdown | 6 |
5 files changed, 19 insertions, 12 deletions
diff --git a/doc/plugin-hooks.markdown b/doc/plugin-hooks.markdown index f6760f96..71ae90c3 100644 --- a/doc/plugin-hooks.markdown +++ b/doc/plugin-hooks.markdown @@ -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 | diff --git a/doc/plugin-metadata.markdown b/doc/plugin-metadata.markdown index f5ace73c..49da0ac1 100644 --- a/doc/plugin-metadata.markdown +++ b/doc/plugin-metadata.markdown @@ -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 ----- diff --git a/doc/plugin-notifications.markdown b/doc/plugin-notifications.markdown index 15cf4b9b..4900b34b 100644 --- a/doc/plugin-notifications.markdown +++ b/doc/plugin-notifications.markdown @@ -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. diff --git a/doc/plugin-registration.markdown b/doc/plugin-registration.markdown index 37540f29..74dc160a 100644 --- a/doc/plugin-registration.markdown +++ b/doc/plugin-registration.markdown @@ -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'); } ``` diff --git a/doc/requirements.markdown b/doc/requirements.markdown index 3e8a6420..9943465a 100644 --- a/doc/requirements.markdown +++ b/doc/requirements.markdown @@ -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. |