(Suggestion) change Response::withJson() to be in line with PSR-7 methods

[npx]

public function withJson($data, $status = 200, $encodingOptions = 0)
{
    $body = $this->getBody();
    $body->rewind();
    $body->write(json_encode($data, $encodingOptions));

    return $this->withStatus($status)->withHeader('Content-Type', 'application/json;charset=utf-8');
}

Yes, withJson() is not part of PSR-7, but the naming suggests that it works like the other PSR-7 compliant methods.

I expected $response->withStatus(500)->withJson([ ... ]) to not override my status code.

Granted, I could use it as $response->withJson([...], 500) which to be honest I did not know about until I stumbled across this.

I feel like the naming strongly suggests the usual PSR-7 "cloning and keep your properties"-behaviour and suggest keeping the status code:

public function withJson($data, $status = null, $encodingOptions = 0)
{
    $body = $this->getBody();
    $body->rewind();
    $body->write(json_encode($data, $encodingOptions));

    $status = is_null($status) ? $this->getStatusCode() : null;

    return $this->withStatus($status)->withHeader('Content-Type', 'application/json;charset=utf-8');
}

What do you think?

TL;DR withJson is not part of PSR-7 but is named like a PSR-7 compliant method and therefore should not override a response's status code

[akrabat]

This has already been fixed in #1737 and will be available in version 3.2.