summaryrefslogtreecommitdiff
path: root/doc/plugin-registration.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-12-06 23:00:58 -0500
committerFrederic Guillot <fred@kanboard.net>2015-12-06 23:00:58 -0500
commit7f3bf38e8db9288d92f2864be4f66b14adf80971 (patch)
tree57c5d31876ba50c1674736493f58d9ab4e59474b /doc/plugin-registration.markdown
parent5c84996ee7140e2cff1d8e18fb9482e8a4c020a8 (diff)
Fix typo in documentation
Diffstat (limited to 'doc/plugin-registration.markdown')
-rw-r--r--doc/plugin-registration.markdown10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/plugin-registration.markdown b/doc/plugin-registration.markdown
index e6d33794..746fa200 100644
--- a/doc/plugin-registration.markdown
+++ b/doc/plugin-registration.markdown
@@ -25,7 +25,7 @@ plugins
└── Test <= Unit tests
```
-Only the registration file `Plugin.php` is required. Other folders are optionals.
+Only the registration file `Plugin.php` is required. Other folders are optional.
The first letter of the plugin name must be capitalized.
@@ -52,7 +52,7 @@ class Plugin extends Base
}
```
-This file should contains a class `Plugin` defined under the namespace `Kanboard\Plugin\Yourplugin` and extends `Kanboard\Core\Plugin\Base`.
+This file should contain a class `Plugin` defined under the namespace `Kanboard\Plugin\Yourplugin` and extends `Kanboard\Core\Plugin\Base`.
The only required method is `initialize()`. This method is called for each request when the plugin is loaded.
@@ -95,7 +95,7 @@ The translations must be stored in `plugins/Myplugin/Locale/xx_XX/translations.p
Dependency Injection Container
------------------------------
-Kanboard use Pimple, a simple PHP Dependency Injection Container. However, Kanboard can register any class in the container easily.
+Kanboard uses Pimple, a simple PHP Dependency Injection Container. However, Kanboard can register any class in the container easily.
Those classes are available everywhere in the application and only one instance is created.
@@ -123,7 +123,7 @@ $this->budget->getDailyBudgetBreakdown(456);
$this->container['hourlyRate']->getAll();
```
-Keys of the containers are unique across the application. If you override an existing class you will change the default behavior.
+Keys of the containers are unique across the application. If you override an existing class, you will change the default behavior.
Event Listening
---------------
@@ -166,7 +166,7 @@ class Plugin extends Base
- The first argument of the method `extendActions()` is the action class with the complete namespace path. **The namespace path must starts with a backslash** otherwise Kanboard will not be able to load your class.
- The second argument is the description of your automatic action.
-The automatic action class must inherits from the class `Kanboard\Action\Base` and implements all abstract methods:
+The automatic action class must inherit from the class `Kanboard\Action\Base` and implements all abstract methods:
- `getCompatibleEvents()`
- `getActionRequiredParameters()`