Apply suggestions from code review

[friendica.git] / src / Capabilities / ICanHandleRequests.php

diff --git a/src/Capabilities/ICanHandleRequests.php b/src/Capabilities/ICanHandleRequests.php
index 6c4ae51385410f49c73178ba493215f10385c4cd..154eae69e5b65ae534fa3057bdf09b4839a8efcf 100644 (file)
--- a/src/Capabilities/ICanHandleRequests.php
+++ b/src/Capabilities/ICanHandleRequests.php
@@ -1,8 +1,28 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Capabilities;
 
 use Friendica\Network\HTTPException;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * This interface provides the capability to handle requests from clients and returns the desired outcome
@@ -10,12 +30,11 @@ use Friendica\Network\HTTPException;
 interface ICanHandleRequests
 {
        /**
-        * @param array $post    The $_POST content (in case of POST)
-        * @param array $request The $_REQUEST content (in case of GET, POST)
+        * @param array $request The $_REQUEST content (including content from the PHP input stream)
         *
-        * @return string Returns the content of the module as string
+        * @return ResponseInterface responding to the request handling
         *
         * @throws HTTPException\InternalServerErrorException
         */
-       public function run(array $post = [], array $request = []): string;
+       public function run(array $request = []): ResponseInterface;
 }