MockStubTrait
trait MockStubTrait (View source)
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
No description
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
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
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.
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.
No description
Add a response object, and an optional status, to the list of responses to be returned via _simpleRequest.
Set the status object to be used when creating streaming calls.
Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
No description
No description
No description
No description
Creates a sequence such that the responses are returned in order.
Details
__construct($deserialize = null)
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
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
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.
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.
static
stripStatusFromResponses($responses)
addResponse(Message $response, Status $status = null)
Add a response object, and an optional status, to the list of responses to be returned via _simpleRequest.
setStreamingStatus(Status $status)
Set the status object to be used when creating streaming calls.
ReceivedRequest[]
popReceivedCalls()
Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
int
getReceivedCallCount()
array
popCallObjects()
bool
isExhausted()
static MockStubTrait
create(mixed $responseObject, $status = null, callable $deserialize = null)
static MockStubTrait
createWithResponseSequence(array $sequence, callable $deserialize = null, Status $finalStatus = null)
Creates a sequence such that the responses are returned in order.