Skip to content
Snippets Groups Projects
Commit 36fa709e authored by Jan-Hendrik Willms's avatar Jan-Hendrik Willms
Browse files

fix parameter for registering routes in JsonApiPlugin interface, fixes #1567

Closes #1567

Merge request studip/studip!989
parent 16749916
No related branches found
No related tags found
No related merge requests found
...@@ -12,51 +12,53 @@ interface JsonApiPlugin ...@@ -12,51 +12,53 @@ interface JsonApiPlugin
* In dieser Methode können Plugins eigene autorisierte Routen * In dieser Methode können Plugins eigene autorisierte Routen
* eintragen lassen. * eintragen lassen.
* *
* Dazu müssen am übergebenen \Slim\App-Objekt die Methoden * Dazu müssen am übergebenen \Slim\Routing\RouteCollectorProxy-Objekt die Methoden
* \Slim\App::get, \Slim\App::post, \Slim\App::put, * \Slim\Routing\RouteCollectorProxy::get, \Slim\Routing\RouteCollectorProxy::post,
* \Slim\App::delete oder \Slim\App::patch aufgerufen werden. * \Slim\Routing\RouteCollectorProxy::put, \Slim\Routing\RouteCollectorProxy::delete
* oder \Slim\Routing\RouteCollectorProxy::patch aufgerufen werden.
* *
* Beispiel: * Beispiel:
* class Blubber ... implements JsonApiPlugin * class Blubber ... implements JsonApiPlugin
* { * {
* public function registerAuthenticatedRoutes(\Slim\App $app) * public function registerAuthenticatedRoutes(\Slim\Routing\RouteCollectorProxy $group)
* { * {
* $app->get('/blubbers', BlubbersIndex::class); * $group->get('/blubbers', BlubbersIndex::class);
* } * }
* [...] * [...]
* } * }
* *
* @param \Slim\App $app die Slim-Applikation, in der das Plugin * @param \Slim\Routing\RouteCollectorProxy $group die Slim-Applikation, in der das Plugin
* Routen eintragen möchte * Routen eintragen möchte
* *
* @return void * @return void
*/ */
public function registerAuthenticatedRoutes(\Slim\App $app); public function registerAuthenticatedRoutes(\Slim\Routing\RouteCollectorProxy $group);
/** /**
* In dieser Methode können Plugins eigene Routen ohne Autorisierung * In dieser Methode können Plugins eigene Routen ohne Autorisierung
* eintragen lassen. * eintragen lassen.
* *
* Dazu müssen am übergebenen \Slim\App-Objekt die Methoden * Dazu müssen am übergebenen \Slim\Routing\RouteCollectorProxy-Objekt die Methoden
* \Slim\App::get, \Slim\App::post, \Slim\App::put, * \Slim\Routing\RouteCollectorProxy::get, \Slim\Routing\RouteCollectorProxy::post,
* \Slim\App::delete oder \Slim\App::patch aufgerufen werden. * \Slim\Routing\RouteCollectorProxy::put, \Slim\Routing\RouteCollectorProxy::delete
* oder \Slim\Routing\RouteCollectorProxy::patch aufgerufen werden.
* *
* Beispiel: * Beispiel:
* class Blubber ... implements JsonApiPlugin * class Blubber ... implements JsonApiPlugin
* { * {
* public function registerUnauthenticatedRoutes(\Slim\App $app) * public function registerUnauthenticatedRoutes(\Slim\Routing\RouteCollectorProxy $group)
* { * {
* $app->get('/blubbers', BlubbersIndex::class); * $group->get('/blubbers', BlubbersIndex::class);
* } * }
* [...] * [...]
* } * }
* *
* @param \Slim\App $app die Slim-Applikation, in der das Plugin * @param \Slim\Routing\RouteCollectorProxy $group die Slim-Applikation, in der das Plugin
* Routen eintragen möchte * Routen eintragen möchte
* *
* @return void * @return void
*/ */
public function registerUnauthenticatedRoutes(\Slim\App $app); public function registerUnauthenticatedRoutes(\Slim\Routing\RouteCollectorProxy $group);
/** /**
* In dieser Methode können Plugins Schemata den verwendeten * In dieser Methode können Plugins Schemata den verwendeten
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment