PHP Interface Eloquent\Phony\Call\Call

Inheritance: extends Eloquent\Phony\Event\Event, extends Eloquent\Phony\Event\EventCollection
Afficher le fichier Open project: eloquent/phony Interface Usage Examples

Méthodes publiques

Méthode 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 méthode

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

argument() public méthode

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.
Résultat mixed The argument.

arguments() public méthode

Get the arguments.
public arguments ( ) : Arguments | null
Résultat Arguments | null The arguments.

callback() public méthode

Get the callback.
public callback ( ) : callable
Résultat callable The callback.

calledEvent() public méthode

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

endEvent() public méthode

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

endTime() public méthode

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
Résultat 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 méthode

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

generatorException() public méthode

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

generatorResponse() public méthode

Get the response from the generator.
public generatorResponse ( ) : tuple\null
Résultat tuple\null

generatorReturnValue() public méthode

Get the value returned from the generator.
public generatorReturnValue ( ) : mixed
Résultat mixed The returned value.

hasCompleted() public méthode

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
Résultat boolean True if this call has completed.

hasResponded() public méthode

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

index() public méthode

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

isGenerator() public méthode

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

isIterable() public méthode

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

iterableEvents() public méthode

Get the iterable events.
public iterableEvents ( ) : array
Résultat array

response() public méthode

Get the response.
public response ( ) : tuple\null
Résultat tuple\null

responseEvent() public méthode

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

responseTime() public méthode

A call that has responded has returned a value, or thrown an exception.
public responseTime ( ) : float | null
Résultat 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 méthode

Get the returned value.
public returnValue ( ) : mixed
Résultat mixed The returned value.

setEndEvent() public méthode

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

setResponseEvent() public méthode

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