[11.x] Fix docblock of \Illuminate\Http\Response

[seriquynh]

\Illuminate\Http\Response::morphToJson() sometimes returns json_encode() result that could be either string or false (a boolean value). So, it's return docblock must contain string|false.

    /**
     * Morph the given content into JSON.
     *
     * @param  mixed  $content
     * @return string|false
     */
    protected function morphToJson($content)
    {
        if ($content instanceof Jsonable) {
            return $content->toJson();
        } elseif ($content instanceof Arrayable) {
            return json_encode($content->toArray());
        }

        return json_encode($content);
    }

[crynobone]

If the possible value is just false, shouldn't it be @return string|false?

[bulletproof-coding]

If you put the return type in line not in dock block will it be a breaking change?

[seriquynh]

I saw other places also used "string|false", so I changed to "@return string|false".

[seriquynh]

@marius-mcp It is not a breaking change, it a bug. This method absolutely return either string or false, I do not change it's behavior.

[bulletproof-coding]

@seriquynh ok, bug, but dock blocks are not restrictive. If you declare the function as

: string|false

it will throw exception if the return type will differ.