Nexus API Reference

Response
in package

FinalYes
Tags
psalm-api

Sugar for common ResponseInterface shapes. Returns nyholm/psr7 Response instances so consumers can keep calling withStatus/withHeader/etc.

Table of Contents

Methods

badRequest()  : ResponseInterface
created()  : ResponseInterface
gatewayTimeout()  : ResponseInterface
internalServerError()  : ResponseInterface
noContent()  : ResponseInterface
notFound()  : ResponseInterface
ok()  : ResponseInterface
serviceUnavailable()  : ResponseInterface

Methods

badRequest()

public static badRequest([string $message = 'Bad Request' ]) : ResponseInterface
Parameters
$message : string = 'Bad Request'
Return values
ResponseInterface

created()

public static created([string|null $location = null ]) : ResponseInterface
Parameters
$location : string|null = null
Return values
ResponseInterface

gatewayTimeout()

public static gatewayTimeout() : ResponseInterface
Return values
ResponseInterface

internalServerError()

public static internalServerError() : ResponseInterface
Return values
ResponseInterface

noContent()

public static noContent() : ResponseInterface
Return values
ResponseInterface

notFound()

public static notFound([string $message = 'Not Found' ]) : ResponseInterface
Parameters
$message : string = 'Not Found'
Return values
ResponseInterface

ok()

public static ok() : ResponseInterface
Return values
ResponseInterface

serviceUnavailable()

public static serviceUnavailable([Duration|null $retryAfter = null ]) : ResponseInterface
Parameters
$retryAfter : Duration|null = null
Return values
ResponseInterface

        
On this page

Search results