friendica/src/Capabilities/ICanHandleRequests.php

<?php
/**
 * @copyright Copyright (C) 2010-2024, 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\Module\Special\HTTPException as ModuleHTTPException;
use Friendica\Network\HTTPException;
use Psr\Http\Message\ResponseInterface;

/**
 * This interface provides the capability to handle requests from clients and returns the desired outcome
 */
interface ICanHandleRequests
{
	/**
	 * @param ModuleHTTPException $httpException The special HTTPException Module in case of underlying errors
	 * @param array               $request       The $_REQUEST content (including content from the PHP input stream)
	 *
	 * @return ResponseInterface responding to the request handling
	 *
	 * @throws HTTPException\InternalServerErrorException
	 */
	public function run(ModuleHTTPException $httpException, array $request = []): ResponseInterface;
}