src/Capabilities/ICanHandleRequests.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Capabilities;
  23
  24 use Friendica\Network\HTTPException;
  25 use Psr\Http\Message\ResponseInterface;
  26
  27 /**
  28  * This interface provides the capability to handle requests from clients and returns the desired outcome
  29  */
  30 interface ICanHandleRequests
  31 {
  32         /**
  33          * @param array $request The $_REQUEST content (including content from the PHP input stream)
  34          *
  35          * @return ResponseInterface responding to the request handling
  36          *
  37          * @throws HTTPException\InternalServerErrorException
  38          */
  39         public function run(array $request = []): ResponseInterface;
  40 }