1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
Custom Routes
=============
When URL rewriting is enabled, you can define custom routes from your plugins.
Define new routes
-----------------
Routes are handled by the class `Kanboard\Core\Http\Route`.
New routes can be added by using the method `addRoute($path, $controller, $action, $plugin)`, here an example:
```php
$this->route->addRoute('/my/custom/route', 'myController', 'myAction', 'myplugin');
```
When the end-user go to the URL `/my/custom/route`, the method `Kanboard\Plugin\Myplugin\Controller\MyController::myAction()` will be executed.
The first character of the controller and the plugin name will converted in uppercase with the function `ucfirst()`.
You can also define routes with variables:
```php
$this->route->addRoute('/my/route/:my_variable', 'myController', 'myAction', 'myplugin');
```
The colon prefix `:`, define a variable.
For example `:my_variable` declare a new variable named `my_variable`.
To fetch the value of the variable you can use the method `getStringParam()` or `getIntegerParam()` from the class `Kanboard\Core\Http\Request`:
If we have the URL `/my/route/foobar`, the value of `my_variable` is `foobar`:
```php
$this->request->getStringParam('my_variable'); // Return foobar
```
Generate links based on the routing table
-----------------------------------------
From templates, you have to use the helper `Kanboard\Helper\Url`.
### Generate a HTML link
```php
<?= $this->url->link('My link', 'mycontroller', 'myaction', array('plugin' => 'myplugin')) ?>
```
Will generate this HTML:
```html
<a href="/my/custom/route">My link</a>
```
### Generate only the attribute `href`:
```php
<?= $this->url->href('My link', 'mycontroller', 'myaction', array('plugin' => 'myplugin')) ?>
```
HTML output:
```html
/my/custom/route
```
HTML output when URL rewriting is not enabled:
```html
?controller=mycontroller&action=myaction&plugin=myplugin
```
### Generate redirect link:
From a controller, if you need to perform a redirection:
```php
$this->url->to('mycontroller', 'myaction', array('plugin' => 'myplugin'));
```
Generate:
```
?controller=mycontroller&action=myaction&plugin=myplugin
```
|
