PayloadResponseInterface

Interface PayloadResponseInterface.

Defines the contract for payload-specific HTTP response implementations. Implementations of this interface MUST provide access to a payload and comply with PSR-7 ResponseInterface.

This interface SHALL be used to identify responses intended to transmit payloads with proper headers.

---

• Full name: \FastForward\Http\Message\PayloadResponseInterface
• Parent interfaces: \FastForward\Http\Message\PayloadAwareInterface, PayloadImmutableInterface, ResponseInterface

Inherited methods

getPayload

Retrieves the payload contained within the object.

public getPayload(): mixed

This method MUST return the payload as originally provided or modified. The returned type MAY vary depending on the structure of the payload (e.g., array, object, scalar, or null).

Return Value:

the payload, which MAY be of any type including array, object, scalar, or null

---