PHP Класс Eloquent\Phony\Call\CallData

Наследование: implements Eloquent\Phony\Call\Call
Показать файл Открыть проект

Открытые методы

Метод Описание
__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.

Приватные методы

Метод Описание
normalizeIndex ( $size, $index, &$normalized = null )

Описание методов

__construct() публичный Метод

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() публичный Метод

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

allCalls() публичный Метод

Get all calls as an array.
public allCalls ( ) : array
Результат array

allEvents() публичный Метод

Get all events as an array.
public allEvents ( ) : array
Результат array

argument() публичный Метод

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.
Результат mixed The argument.

arguments() публичный Метод

Get the received arguments.
public arguments ( ) : Arguments
Результат Arguments The received arguments.

callAt() публичный Метод

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.
Результат Eloquent\Phony\Call\Call The call.

callCount() публичный Метод

Get the number of calls.
public callCount ( ) : integer
Результат integer The call count.

callback() публичный Метод

Get the callback.
public callback ( ) : callable
Результат callable The callback.

calledEvent() публичный Метод

Get the 'called' event.
public calledEvent ( ) : CalledEvent
Результат Eloquent\Phony\Call\Event\CalledEvent The 'called' event.

compareSequential() публичный статический Метод

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.
Результат integer The comparison value.

count() публичный Метод

Get the event count.
public count ( ) : integer
Результат integer The event count.

endEvent() публичный Метод

Get the end event.
public endEvent ( ) : Eloquent\Phony\Call\Event\EndEvent | null
Результат Eloquent\Phony\Call\Event\EndEvent | null The end event, or null if the call has not yet completed.

endTime() публичный Метод

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
Результат 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() публичный Метод

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.
Результат Eloquent\Phony\Event\Event The event.

eventCount() публичный Метод

Get the number of events.
public eventCount ( ) : integer
Результат integer The event count.

exception() публичный Метод

Get the thrown exception.
public exception ( ) : Exceptio\Exception | Erro\Error
Результат Exceptio\Exception | Erro\Error The thrown exception.

firstCall() публичный Метод

Get the first call.
public firstCall ( ) : Eloquent\Phony\Call\Call
Результат Eloquent\Phony\Call\Call The call.

firstEvent() публичный Метод

Get the first event.
public firstEvent ( ) : Eloquent\Phony\Event\Event
Результат Eloquent\Phony\Event\Event The event.

generatorException() публичный Метод

Get the exception thrown from the generator.
public generatorException ( ) : Exceptio\Exception | Erro\Error
Результат Exceptio\Exception | Erro\Error The thrown exception.

generatorResponse() публичный Метод

Get the response from the generator.
public generatorResponse ( ) : tuple\null
Результат tuple\null

generatorReturnValue() публичный Метод

Get the value returned from the generator.
public generatorReturnValue ( ) : mixed
Результат mixed The returned value.

getIterator() публичный Метод

Get an iterator for this collection.
public getIterator ( ) : Iterator
Результат Iterator The iterator.

hasCalls() публичный Метод

Returns true if this collection contains any calls.
public hasCalls ( ) : boolean
Результат boolean True if this collection contains any calls.

hasCompleted() публичный Метод

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
Результат boolean True if this call has completed.

hasEvents() публичный Метод

Returns true if this collection contains any events.
public hasEvents ( ) : boolean
Результат boolean True if this collection contains any events.

hasResponded() публичный Метод

A call that has responded has returned a value, or thrown an exception.
public hasResponded ( ) : boolean
Результат boolean True if this call has responded.

index() публичный Метод

This number tracks the order of this call with respect to other calls made against the same spy.
public index ( ) : integer
Результат integer The index.

isGenerator() публичный Метод

Returns true if this call has responded with a generator.
public isGenerator ( ) : boolean
Результат boolean True if this call has responded with a generator.

isIterable() публичный Метод

Returns true if this call has responded with an iterable.
public isIterable ( ) : boolean
Результат boolean True if this call has responded with an iterable.

iterableEvents() публичный Метод

Get the iterable events.
public iterableEvents ( ) : array
Результат array

lastCall() публичный Метод

Get the last call.
public lastCall ( ) : Eloquent\Phony\Call\Call
Результат Eloquent\Phony\Call\Call The call.

lastEvent() публичный Метод

Get the last event.
public lastEvent ( ) : Eloquent\Phony\Event\Event
Результат Eloquent\Phony\Event\Event The event.

response() публичный Метод

Get the response.
public response ( ) : tuple\null
Результат tuple\null

responseEvent() публичный Метод

Get the response event.
public responseEvent ( ) : Eloquent\Phony\Call\Event\ResponseEvent | null
Результат Eloquent\Phony\Call\Event\ResponseEvent | null The response event, or null if the call has not yet responded.

responseTime() публичный Метод

A call that has responded has returned a value, or thrown an exception.
public responseTime ( ) : float | null
Результат 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() публичный Метод

Get the returned value.
public returnValue ( ) : mixed
Результат mixed The returned value.

sequenceNumber() публичный Метод

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
Результат integer The sequence number.

setEndEvent() публичный Метод

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

setResponseEvent() публичный Метод

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

time() публичный Метод

Get the time at which the event occurred.
public time ( ) : float
Результат float The time at which the event occurred, in seconds since the Unix epoch.