REST

HTTP REST client for communicating with a Warlock server endpoint.

class REST

Properties

serverConfig

Merged server/client/admin configuration for REST interactions.

public Config $serverConfig

client

HTTP client used to send protocol payloads.

private Client $client

protocol

Packet protocol encoder for request bodies.

private Protocol $protocol

Methods

__construct

public __construct(array $serverConfig): void

Parameters

Parameter	Type	Description
$serverConfig	array	override configuration values

trigger

Triggers an event and sends the corresponding data.

public trigger(string $event, mixed $data, mixed $options, ?Response $response): bool

Parameters

Parameter	Type	Description
$event	string	the event identifier
$data	mixed	The data to be sent with the event. Default is null.
$options	mixed	Additional options for the event. Default is null.
$response	Response

send

Sends a request to the configured server.

private send(PacketType $type, mixed $data, mixed $options, ?Response $response): bool

This method constructs a URL based on the server configuration and sends a POST request with the specified type and data. It handles cases where the client server or port is not specified by defaulting to the server's listen address and port. Additionally, it sets up the authorization header if an admin key is provided.

Parameters

Parameter	Type	Description
$type	PacketType	the type of the request
$data	mixed	The data to be sent with the request. Default is null.
$options	mixed	Additional options for the request. Default is null.
$response	Response

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:25 +0000