php-auth/src/Controllers/ControllerInterface.php

<?php

declare(strict_types=1);

namespace Siteworxpro\App\Controllers;

use Nyholm\Psr7\ServerRequest;
use Psr\Http\Message\ResponseInterface;

/**
 * Interface ControllerInterface
 *
 * Defines the contract for handling HTTP requests in a controller.
 */
interface ControllerInterface
{
    /**
     * Handle the request and return a response.
     *
     * @param ServerRequest $request The request data.
     * @return ResponseInterface The response data.
     */
    public function get(ServerRequest $request): ResponseInterface;

    /**
     * Handle the request and return a response.
     *
     * @param ServerRequest $request The request data.
     * @return ResponseInterface The response data.
     */
    public function post(ServerRequest $request): ResponseInterface;

    /**
     * Handle the request and return a response.
     *
     * @param ServerRequest $request The request data.
     * @return ResponseInterface The response data.
     */
    public function put(ServerRequest $request): ResponseInterface;

    /**
     * Handle the request and return a response.
     *
     * @param ServerRequest $request The request data.
     * @return ResponseInterface The response data.
     */
    public function delete(ServerRequest $request): ResponseInterface;

    /**
     * Handle the request and return a response.
     *
     * @param ServerRequest $request The request data.
     * @return ResponseInterface The response data.
     */
    public function patch(ServerRequest $request): ResponseInterface;
}