PHP Class Eloquent\Phony\Call\CallData

Inheritance: implements Eloquent\Phony\Call\Call
Datei anzeigen Open project: eloquent/phony

Public Methods

Method Description
__construct ( integer $index, CalledEvent $calledEvent ) Construct a new call data instance.
addIterableEvent ( Eloquent\Phony\Call\Event\IterableEvent $iterableEvent ) Add an iterable event.
allCalls ( ) : array Get all calls as an array.
allEvents ( ) : array Get all events as an array.
argument ( integer $index ) : mixed Get an argument by index.
arguments ( ) : Arguments Get the received arguments.
callAt ( integer $index ) : Eloquent\Phony\Call\Call Get a call by index.
callCount ( ) : integer Get the number of calls.
callback ( ) : callable Get the callback.
calledEvent ( ) : CalledEvent Get the 'called' event.
compareSequential ( Eloquent\Phony\Call\Call $a, Eloquent\Phony\Call\Call $b ) : integer A comparator for ordering calls by sequence number.
count ( ) : integer Get the event count.
endEvent ( ) : Eloquent\Phony\Call\Event\EndEvent | null Get the end event.
endTime ( ) : float | null Get the time at which the call completed.
eventAt ( integer $index ) : Eloquent\Phony\Event\Event Get an event by index.
eventCount ( ) : integer Get the number of events.
exception ( ) : Exceptio\Exception | Erro\Error Get the thrown exception.
firstCall ( ) : Eloquent\Phony\Call\Call Get the first call.
firstEvent ( ) : Eloquent\Phony\Event\Event Get the first event.
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.
getIterator ( ) : Iterator Get an iterator for this collection.
hasCalls ( ) : boolean Returns true if this collection contains any calls.
hasCompleted ( ) : boolean Returns true if this call has completed.
hasEvents ( ) : boolean Returns true if this collection contains any events.
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.
lastCall ( ) : Eloquent\Phony\Call\Call Get the last call.
lastEvent ( ) : Eloquent\Phony\Event\Event Get the last event.
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.
sequenceNumber ( ) : integer Get the sequence number.
setEndEvent ( Eloquent\Phony\Call\Event\EndEvent $endEvent ) Set the end event.
setResponseEvent ( Eloquent\Phony\Call\Event\ResponseEvent $responseEvent ) Set the response event.
time ( ) : float Get the time at which the event occurred.

Private Methods

Method Description
normalizeIndex ( $size, $index, &$normalized = null )

Method Details

__construct() public method

Construct a new call data instance.
public __construct ( integer $index, CalledEvent $calledEvent )
$index integer The index of this call.
$calledEvent Eloquent\Phony\Call\Event\CalledEvent The 'called' event.

addIterableEvent() public method

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

allCalls() public method

Get all calls as an array.
public allCalls ( ) : array
return array

allEvents() public method

Get all events as an array.
public allEvents ( ) : array
return array

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 received arguments.
public arguments ( ) : Arguments
return Arguments The received arguments.

callAt() 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 callAt ( integer $index ) : Eloquent\Phony\Call\Call
$index integer The index.
return Eloquent\Phony\Call\Call The call.

callCount() public method

Get the number of calls.
public callCount ( ) : integer
return integer The call count.

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.

compareSequential() public static method

A comparator for ordering calls by sequence number.
public static compareSequential ( Eloquent\Phony\Call\Call $a, Eloquent\Phony\Call\Call $b ) : integer
$a Eloquent\Phony\Call\Call The first call.
$b Eloquent\Phony\Call\Call The second call.
return integer The comparison value.

count() public method

Get the event count.
public count ( ) : integer
return integer The event count.

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.

eventAt() 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 eventAt ( integer $index ) : Eloquent\Phony\Event\Event
$index integer The index.
return Eloquent\Phony\Event\Event The event.

eventCount() public method

Get the number of events.
public eventCount ( ) : integer
return integer The event count.

exception() public method

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

firstCall() public method

Get the first call.
public firstCall ( ) : Eloquent\Phony\Call\Call
return Eloquent\Phony\Call\Call The call.

firstEvent() public method

Get the first event.
public firstEvent ( ) : Eloquent\Phony\Event\Event
return Eloquent\Phony\Event\Event The event.

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.

getIterator() public method

Get an iterator for this collection.
public getIterator ( ) : Iterator
return Iterator The iterator.

hasCalls() public method

Returns true if this collection contains any calls.
public hasCalls ( ) : boolean
return boolean True if this collection contains any calls.

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.

hasEvents() public method

Returns true if this collection contains any events.
public hasEvents ( ) : boolean
return boolean True if this collection contains any events.

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

lastCall() public method

Get the last call.
public lastCall ( ) : Eloquent\Phony\Call\Call
return Eloquent\Phony\Call\Call The call.

lastEvent() public method

Get the last event.
public lastEvent ( ) : Eloquent\Phony\Event\Event
return Eloquent\Phony\Event\Event The event.

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.

sequenceNumber() public method

The sequence number is a unique number assigned to every event that Phony records. The numbers are assigned sequentially, meaning that sequence numbers can be used to determine event order.
public sequenceNumber ( ) : integer
return integer The sequence number.

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.

time() public method

Get the time at which the event occurred.
public time ( ) : float
return float The time at which the event occurred, in seconds since the Unix epoch.