PHP Interface Eloquent\Phony\Call\Call

Inheritance: extends Eloquent\Phony\Event\Event, extends Eloquent\Phony\Event\EventCollection
Show file Open project: eloquent/phony Interface Usage Examples

Public Methods

Method Description
addIterableEvent ( Eloquent\Phony\Call\Event\IterableEvent $iterableEvent ) Add an iterable event.
argument ( integer $index ) : mixed Get an argument by index.
arguments ( ) : Arguments | null Get the arguments.
callback ( ) : callable Get the callback.
calledEvent ( ) : CalledEvent Get the 'called' event.
endEvent ( ) : Eloquent\Phony\Call\Event\EndEvent | null Get the end event.
endTime ( ) : float | null Get the time at which the call completed.
exception ( ) : Exceptio\Exception | Erro\Error Get the thrown exception.
generatorException ( ) : Exceptio\Exception | Erro\Error Get the exception thrown from the generator.
generatorResponse ( ) : tuple\null Get the response from the generator.
generatorReturnValue ( ) : mixed Get the value returned from the generator.
hasCompleted ( ) : boolean Returns true if this call has completed.
hasResponded ( ) : boolean Returns true if this call has responded.
index ( ) : integer Get the call index.
isGenerator ( ) : boolean Returns true if this call has responded with a generator.
isIterable ( ) : boolean Returns true if this call has responded with an iterable.
iterableEvents ( ) : array Get the iterable events.
response ( ) : tuple\null Get the response.
responseEvent ( ) : Eloquent\Phony\Call\Event\ResponseEvent | null Get the response event.
responseTime ( ) : float | null Get the time at which the call responded.
returnValue ( ) : mixed Get the returned value.
setEndEvent ( Eloquent\Phony\Call\Event\EndEvent $endEvent ) Set the end event.
setResponseEvent ( Eloquent\Phony\Call\Event\ResponseEvent $responseEvent ) Set the response event.

Method Details

addIterableEvent() public method

Add an iterable event.
public addIterableEvent ( Eloquent\Phony\Call\Event\IterableEvent $iterableEvent )
$iterableEvent Eloquent\Phony\Call\Event\IterableEvent The iterable event.

argument() public method

Negative indices are offset from the end of the list. That is, -1 indicates the last element, and -2 indicates the second last element.
public argument ( integer $index ) : mixed
$index integer The index.
return mixed The argument.

arguments() public method

Get the arguments.
public arguments ( ) : Arguments | null
return Arguments | null The arguments.

callback() public method

Get the callback.
public callback ( ) : callable
return callable The callback.

calledEvent() public method

Get the 'called' event.
public calledEvent ( ) : CalledEvent
return Eloquent\Phony\Call\Event\CalledEvent The 'called' event.

endEvent() public method

Get the end event.
public endEvent ( ) : Eloquent\Phony\Call\Event\EndEvent | null
return Eloquent\Phony\Call\Event\EndEvent | null The end event, or null if the call has not yet completed.

endTime() public method

When generator spies are in use, a call that returns a generator will not be considered complete until the generator has been completely consumed via iteration. Similarly, when iterable spies are in use, a call that returns an iterable will not be considered complete until the iterable has been completely consumed via iteration.
public endTime ( ) : float | null
return float | null The time at which the call completed, in seconds since the Unix epoch, or null if the call has not yet completed.

exception() public method

Get the thrown exception.
public exception ( ) : Exceptio\Exception | Erro\Error
return Exceptio\Exception | Erro\Error The thrown exception.

generatorException() public method

Get the exception thrown from the generator.
public generatorException ( ) : Exceptio\Exception | Erro\Error
return Exceptio\Exception | Erro\Error The thrown exception.

generatorResponse() public method

Get the response from the generator.
public generatorResponse ( ) : tuple\null
return tuple\null

generatorReturnValue() public method

Get the value returned from the generator.
public generatorReturnValue ( ) : mixed
return mixed The returned value.

hasCompleted() public method

When generator spies are in use, a call that returns a generator will not be considered complete until the generator has been completely consumed via iteration. Similarly, when iterable spies are in use, a call that returns an iterable will not be considered complete until the iterable has been completely consumed via iteration.
public hasCompleted ( ) : boolean
return boolean True if this call has completed.

hasResponded() public method

A call that has responded has returned a value, or thrown an exception.
public hasResponded ( ) : boolean
return boolean True if this call has responded.

index() public method

This number tracks the order of this call with respect to other calls made against the same spy.
public index ( ) : integer
return integer The index.

isGenerator() public method

Returns true if this call has responded with a generator.
public isGenerator ( ) : boolean
return boolean True if this call has responded with a generator.

isIterable() public method

Returns true if this call has responded with an iterable.
public isIterable ( ) : boolean
return boolean True if this call has responded with an iterable.

iterableEvents() public method

Get the iterable events.
public iterableEvents ( ) : array
return array

response() public method

Get the response.
public response ( ) : tuple\null
return tuple\null

responseEvent() public method

Get the response event.
public responseEvent ( ) : Eloquent\Phony\Call\Event\ResponseEvent | null
return Eloquent\Phony\Call\Event\ResponseEvent | null The response event, or null if the call has not yet responded.

responseTime() public method

A call that has responded has returned a value, or thrown an exception.
public responseTime ( ) : float | null
return float | null The time at which the call responded, in seconds since the Unix epoch, or null if the call has not yet responded.

returnValue() public method

Get the returned value.
public returnValue ( ) : mixed
return mixed The returned value.

setEndEvent() public method

Set the end event.
public setEndEvent ( Eloquent\Phony\Call\Event\EndEvent $endEvent )
$endEvent Eloquent\Phony\Call\Event\EndEvent The end event.

setResponseEvent() public method

Set the response event.
public setResponseEvent ( Eloquent\Phony\Call\Event\ResponseEvent $responseEvent )
$responseEvent Eloquent\Phony\Call\Event\ResponseEvent The response event.