class ReadResource implements Method

Traits

Methods

toJsonRpcResponse(JsonRpcRequest $request, Response|ResponseFactory|array|string $response, callable $serializable)

Serialize a response as a protocol result.

toJsonRpcStreamedResponse(JsonRpcRequest $request, iterable $responses, callable $serializable)

Stream notifications followed by the completed protocol result.

mixed
callHandler(callable $handler, JsonRpcRequest $request)

Call a handler and convert ordinary failures to protocol errors.

toJsonRpcException(Throwable $e, mixed $requestId)

Convert a handler failure to a protocol exception.

toErrorResponse(Throwable $e)

Convert a tool failure to an error response.

string
toErrorMessage(Throwable $e)

Report an internal error and choose its public message.

bool
isBinary(string $content)

Determine whether a response string contains binary data.

resolveResource(string|null $uri, ServerContext $context)

Resolve a resource by URI or URI template.

iterable|JsonRpcResponse
handle(JsonRpcRequest $request, ServerContext $context)

Read the requested resource.

mixed
invokeResource(Resource $resource, string $uri)

Invoke a resource under the installed request and template arguments.

callable
serializable(Resource $resource, string $uri)

Create the serializer for a resource response.

Details

protected JsonRpcResponse toJsonRpcResponse(JsonRpcRequest $request, Response|ResponseFactory|array|string $response, callable $serializable)

Serialize a response as a protocol result.

Parameters

JsonRpcRequest $request
Response|ResponseFactory|array|string $response
callable $serializable

Return Value

JsonRpcResponse

Exceptions

JsonRpcException

protected Generator toJsonRpcStreamedResponse(JsonRpcRequest $request, iterable $responses, callable $serializable)

Stream notifications followed by the completed protocol result.

Parameters

JsonRpcRequest $request
iterable $responses
callable $serializable

Return Value

Generator

protected mixed callHandler(callable $handler, JsonRpcRequest $request)

Call a handler and convert ordinary failures to protocol errors.

Parameters

callable $handler
JsonRpcRequest $request

Return Value

mixed

protected JsonRpcException toJsonRpcException(Throwable $e, mixed $requestId)

Convert a handler failure to a protocol exception.

Parameters

Throwable $e
mixed $requestId

Return Value

JsonRpcException

protected Response toErrorResponse(Throwable $e)

Convert a tool failure to an error response.

Parameters

Throwable $e

Return Value

Response

protected string toErrorMessage(Throwable $e)

Report an internal error and choose its public message.

Parameters

Throwable $e

Return Value

string

protected bool isBinary(string $content)

Determine whether a response string contains binary data.

Parameters

string $content

Return Value

bool

in ResolvesResources at line 17
protected Resource resolveResource(string|null $uri, ServerContext $context)

Resolve a resource by URI or URI template.

Parameters

string|null $uri
ServerContext $context

Return Value

Resource

at line 40
iterable|JsonRpcResponse handle(JsonRpcRequest $request, ServerContext $context)

Read the requested resource.

Parameters

JsonRpcRequest $request
ServerContext $context

Return Value

iterable|JsonRpcResponse

Exceptions

BindingResolutionException

at line 86
protected mixed invokeResource(Resource $resource, string $uri)

Invoke a resource under the installed request and template arguments.

Parameters

Resource $resource
string $uri

Return Value

mixed

Exceptions

BindingResolutionException

at line 100
protected callable serializable(Resource $resource, string $uri)

Create the serializer for a resource response.

Parameters

Resource $resource
string $uri

Return Value

callable