trait MockStubTrait (View source)

internal  
 

The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) It provides functionality to add responses, get received calls, and overrides the _simpleRequest method so that the elements of $responses are returned instead of making a call to the API.

Methods

__construct(callable $deserialize = null)

No description

_simpleRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _simpleRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockUnaryCall object that will return the first item from $responses

_clientStreamRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _clientStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockClientStreamingCall object that will return the first item from $responses

_serverStreamRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _serverStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockServerStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.

_bidiRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _bidiRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockBidiStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.

static 
stripStatusFromResponses($responses)

No description

addResponse(Message $response, stdClass $status = null)

Add a response object, and an optional status, to the list of responses to be returned via _simpleRequest.

setStreamingStatus(stdClass $status)

Set the status object to be used when creating streaming calls.

popReceivedCalls()

Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.

int
getReceivedCallCount()

No description

array
popCallObjects()

No description

bool
isExhausted()

No description

static MockStubTrait
create(mixed $responseObject, stdClass $status = null, callable $deserialize = null)

No description

static MockStubTrait
createWithResponseSequence(array $sequence, callable $deserialize = null, stdClass $finalStatus = null)

Creates a sequence such that the responses are returned in order.

Details

__construct(callable $deserialize = null)

No description

Parameters

callable $deserialize

MockUnaryCall _simpleRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _simpleRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockUnaryCall object that will return the first item from $responses

Parameters

string $method

The API method name to be called

Message $argument

The request object to the API method

callable $deserialize

A function to deserialize the response object

array $metadata
array $options

Return Value

MockUnaryCall

MockClientStreamingCall _clientStreamRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _clientStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockClientStreamingCall object that will return the first item from $responses

Parameters

string $method

The name of the method to call

callable $deserialize

A function that deserializes the responses

array $metadata

A metadata map to send to the server (optional)

array $options

An array of options (optional)

Return Value

MockClientStreamingCall

The active call object

MockServerStreamingCall _serverStreamRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _serverStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockServerStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.

Parameters

string $method

The name of the method to call

Message $argument

The argument to the method

callable $deserialize

A function that deserializes the responses

array $metadata

A metadata map to send to the server (optional)

array $options

An array of options (optional)

Return Value

MockServerStreamingCall

The active call object

MockBidiStreamingCall _bidiRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])

Overrides the _bidiRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockBidiStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.

Parameters

string $method

The name of the method to call

callable $deserialize

A function that deserializes the responses

array $metadata

A metadata map to send to the server (optional)

array $options

An array of options (optional)

Return Value

MockBidiStreamingCall

The active call object

static stripStatusFromResponses($responses)

No description

Parameters

$responses

addResponse(Message $response, stdClass $status = null)

Add a response object, and an optional status, to the list of responses to be returned via _simpleRequest.

Parameters

Message $response
stdClass $status

setStreamingStatus(stdClass $status)

Set the status object to be used when creating streaming calls.

Parameters

stdClass $status

ReceivedRequest[] popReceivedCalls()

Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.

Return Value

ReceivedRequest[]

An array of received requests

int getReceivedCallCount()

No description

Return Value

int

The number of calls received.

array popCallObjects()

No description

Return Value

array

The call objects created by calls to the stub

bool isExhausted()

No description

Return Value

bool

True if $receivedFuncCalls and $response are empty.

static MockStubTrait create(mixed $responseObject, stdClass $status = null, callable $deserialize = null)

No description

Parameters

mixed $responseObject
stdClass $status
callable $deserialize

Return Value

MockStubTrait

An instance of the current class type.

static MockStubTrait createWithResponseSequence(array $sequence, callable $deserialize = null, stdClass $finalStatus = null)

Creates a sequence such that the responses are returned in order.

Parameters

array $sequence
callable $deserialize
stdClass $finalStatus

Return Value

MockStubTrait

An instance of the current class type.