PayloadAwareInterface

Interface PayloadAwareInterface.

Defines functionality for objects that encapsulate and manage a payload. Implementations of this interface MUST provide immutable methods for accessing and replacing the payload. The payload MAY be of any type supported by the implementation, including arrays, objects, scalars, or null.

---

• Full name: \FastForward\Http\Message\PayloadAwareInterface

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

---