[4.x] Decorated Request in case of third-party Server Request Creator

[adriansuter]

Hi there

Related to #2709, how is it possible to get a decorated request?

I mean, to get a response factory that would create a decorated response, we could use \Slim\Factory\Psr17\SlimHttpPsr17Factory. But I can't use \Slim\Factory\Psr17\SlimHttpServerRequestCreator to achieve that for decorated requests, could I?

declare(strict_types=1);

use Nyholm\Psr7\Factory\Psr17Factory;
use Nyholm\Psr7Server\ServerRequestCreator;
use Psr\Http\Message\RequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use Slim\Factory\AppFactory;
use Slim\Factory\Psr17\SlimHttpPsr17Factory;


require __DIR__.'/../vendor/autoload.php';

$responseFactory = new Psr17Factory();
$app = AppFactory::create(
    SlimHttpPsr17Factory::createDecoratedResponseFactory(
        $responseFactory, $responseFactory
    )
);

$app->get('/', function (Request $request, Response $response, array $args) {
    $response->getBody()->write(get_class($request).', '.get_class($response));

    return $response;
});

// Create the nyholm server request creator.
$creator = new ServerRequestCreator(
    $responseFactory, $responseFactory, $responseFactory, $responseFactory
);

// Create the request.
$request = $creator->fromGlobals();

$app->run($request);

Requesting the route would return

Nyholm\Psr7\ServerRequest, Slim\Http\Response

[adriansuter]

I just saw, that instead of using the server request creator, we could use \Slim\Http\Factory\DecoratedServerRequestFactory:

$decoratedServerRequestFactory = new DecoratedServerRequestFactory($responseFactory);
$request = $decoratedServerRequestFactory->createServerRequest(
    'GET', $responseFactory->createUri('/'), []
);

Unfortunately there is no createServerRequestFromGlobals() method, which would therefore be up to the user to implement. Apparently this is not part of PSR-17, and so this would not be possible to be implemented directly in Slim-Http.

[adriansuter]

Another workaround would be the following:

declare(strict_types=1);

use Nyholm\Psr7\Factory\Psr17Factory;
use Nyholm\Psr7Server\ServerRequestCreator;
use Psr\Http\Message\RequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use Slim\Factory\AppFactory;
use Slim\Factory\Psr17\ServerRequestCreator as SlimServerRequestCreator;
use Slim\Factory\Psr17\SlimHttpPsr17Factory;
use Slim\Factory\Psr17\SlimHttpServerRequestCreator;

require __DIR__.'/../vendor/autoload.php';

$psr17Factory = new Psr17Factory();
$app = AppFactory::create(
    SlimHttpPsr17Factory::createDecoratedResponseFactory(
        $psr17Factory, $psr17Factory
    )
);

$app->get('/', function (Request $request, Response $response, array $args) {
    $response->getBody()->write(get_class($request).', '.get_class($response));

    return $response;
});

// 1) Create the Server Request Creator.
$nyholmServerRequestCreator = new ServerRequestCreator(
    $psr17Factory, $psr17Factory, $psr17Factory, $psr17Factory
);

// 2) Use Slim to create a new `Slim\Factory\Psr17\ServerRequestCreator`.
$slimServerRequestCreator = new SlimServerRequestCreator(
    $nyholmServerRequestCreator, 'fromGlobals'
);

// 3) Use Slim-Http to create a decorated creator.
$slimHttpServerRequestCreator = new SlimHttpServerRequestCreator($slimServerRequestCreator);

$app->run($slimHttpServerRequestCreator->createServerRequestFromGlobals());

Step 1 assumes that the third-party PSR-7 implementation has a Server Request Creator (Nyholm has one).

Step 2 assumes that the Server Request Creator of the third-party PSR-7 implementation has a fromGlobals method, that can be used to create the server request (Nyholm has one).

If the third-party PSR-7 implementation has another method (like for example Slim-PSR7 createFromGlobals), then the second param should be changed accordingly.

Is this the way to go?

[l0gicgate]

You can simply instantiate a decorated server request like this:

<?php
declare(strict_types=1);

use Slim\Factory\ServerRequestCreatorFactory;
use Slim\Http\ServerRequest as DecoratedServerRequest;

require __DIR__.'/../vendor/autoload.php';

$serverRequestCreator = ServerRequestCreatorFactory::create();
$request = $serverRequestCreator->createServerRequestFromGlobals();
$decoratedRequest = new DecoratedServerRequest($request);

[adriansuter]

Ah I see. This would only work for the supported psr17 implementations. But we can always add a new implementation by calling \Slim\Factory\Psr17\Psr17FactoryProvider::addFactory(), can't we?