PHP/SimpleRouter
PHP/SimpleRouter
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Corrected documentation of run() arguments

Browse Source
This commit is contained in:
SteamPixel 2020-01-11 22:56:41 +01:00
parent 2acc000d98
commit 3c7b6e2412
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -33,11 +33,11 @@ Route::run('/api/v1');
Do not forget to edit the basepath in .htaccess too if you are on Apache2. In order to run the test files correctly inside a basepath you should also adjust the navigation links inside the index.php.
## Enable case sensitive routes, trailing slashes and multi match mode
The second and third parameters of `Route::run('/', false, false, true);` are both set to false by default.
The fourth parameter is set to true by default. Using this parameters you can switch on and off several options:
* Second parameter ($case_matters): You can enable case sensitive mode by setting the second parameter to true.
* Third parameter ($trailing_slash_matters): By default the router will ignore trailing slashes. Set this parameter to true to avoid this.
* Fourth parameter ($multimatch): By default the router will only execute the first matching route. Set this parameter to true to enable multi match mode.
The second, third and fourth parameters of `Route::run('/', false, false, true);` are set to false by default.
Using this parameters you can switch on and off several options:
* Second parameter: You can enable case sensitive mode by setting the second parameter to true.
* Third parameter: By default the router will ignore trailing slashes. Set this parameter to true to avoid this.
* Fourth parameter: By default the router will only execute the first matching route. Set this parameter to true to enable multi match mode.
## Something does not work?
* Don't forget to set the correct basepath as the first argument in your `run()` method and in your .htaccess file.