From 36fa709e13a81eb135f152cff482dbaa50fe8d01 Mon Sep 17 00:00:00 2001
From: Jan-Hendrik Willms <tleilax+studip@gmail.com>
Date: Thu, 8 Sep 2022 12:58:38 +0000
Subject: [PATCH] fix parameter for registering routes in JsonApiPlugin
 interface, fixes #1567

Closes #1567

Merge request studip/studip!989
---
 .../JsonApi/Contracts/JsonApiPlugin.php       | 30 ++++++++++---------
 1 file changed, 16 insertions(+), 14 deletions(-)

diff --git a/lib/classes/JsonApi/Contracts/JsonApiPlugin.php b/lib/classes/JsonApi/Contracts/JsonApiPlugin.php
index 15f1a654975..8821682083a 100644
--- a/lib/classes/JsonApi/Contracts/JsonApiPlugin.php
+++ b/lib/classes/JsonApi/Contracts/JsonApiPlugin.php
@@ -12,51 +12,53 @@ interface JsonApiPlugin
      * In dieser Methode können Plugins eigene autorisierte Routen
      * eintragen lassen.
      *
-     * Dazu müssen am übergebenen \Slim\App-Objekt die Methoden
-     * \Slim\App::get, \Slim\App::post, \Slim\App::put,
-     * \Slim\App::delete oder \Slim\App::patch aufgerufen werden.
+     * Dazu müssen am übergebenen \Slim\Routing\RouteCollectorProxy-Objekt die Methoden
+     * \Slim\Routing\RouteCollectorProxy::get, \Slim\Routing\RouteCollectorProxy::post,
+     * \Slim\Routing\RouteCollectorProxy::put, \Slim\Routing\RouteCollectorProxy::delete
+     * oder \Slim\Routing\RouteCollectorProxy::patch aufgerufen werden.
      *
      * Beispiel:
      *     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
      *
      * @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
      * eintragen lassen.
      *
-     * Dazu müssen am übergebenen \Slim\App-Objekt die Methoden
-     * \Slim\App::get, \Slim\App::post, \Slim\App::put,
-     * \Slim\App::delete oder \Slim\App::patch aufgerufen werden.
+     * Dazu müssen am übergebenen \Slim\Routing\RouteCollectorProxy-Objekt die Methoden
+     * \Slim\Routing\RouteCollectorProxy::get, \Slim\Routing\RouteCollectorProxy::post,
+     * \Slim\Routing\RouteCollectorProxy::put, \Slim\Routing\RouteCollectorProxy::delete
+     * oder \Slim\Routing\RouteCollectorProxy::patch aufgerufen werden.
      *
      * Beispiel:
      *     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
      *
      * @return void
      */
-    public function registerUnauthenticatedRoutes(\Slim\App $app);
+    public function registerUnauthenticatedRoutes(\Slim\Routing\RouteCollectorProxy $group);
 
     /**
      * In dieser Methode können Plugins Schemata den verwendeten
-- 
GitLab