Documentation

InvocationMocker
in package
implements InvocationStubber, MethodNameMatch

FinalYes
Tags
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

Table of Contents

Interfaces

InvocationStubber
MethodNameMatch

Properties

$configurableMethodNames  : array<string|int, mixed>|null
$configurableMethods  : array<string|int, mixed>
$invocationHandler  : InvocationHandler
$matcher  : Matcher

Methods

__construct()  : mixed
after()  : $this
id()  : $this
method()  : $this
will()  : $this
willReturn()  : self
willReturnArgument()  : self
willReturnCallback()  : self
willReturnMap()  : self
willReturnOnConsecutiveCalls()  : self
willReturnReference()  : self
willReturnSelf()  : self
willThrowException()  : self
with()  : $this
withAnyParameters()  : $this
configuredMethod()  : ConfigurableMethod|null
ensureParametersCanBeConfigured()  : void
ensureTypeOfReturnValues()  : void

Properties

$configurableMethodNames

private array<string|int, mixed>|null $configurableMethodNames = null
Tags
psalm-var

?array<string, int>

$configurableMethods read-only

private array<string|int, mixed> $configurableMethods
Tags
psalm-var

list<ConfigurableMethod>

$invocationHandler read-only

private InvocationHandler $invocationHandler

Methods

__construct()

public __construct(InvocationHandler $handler, Matcher $matcher, ConfigurableMethod ...$configurableMethods) : mixed
Parameters
$handler : InvocationHandler
$matcher : Matcher
$configurableMethods : ConfigurableMethod

after()

public after(string $id) : $this
Parameters
$id : string
Return values
$this

id()

public id(string $id) : $this
Parameters
$id : string
Tags
throws
MatcherAlreadyRegisteredException
Return values
$this

method()

public method(Constraint|string $constraint) : $this
Parameters
$constraint : Constraint|string
Tags
throws
InvalidArgumentException
throws
MethodCannotBeConfiguredException
throws
MethodNameAlreadyConfiguredException
Return values
$this

will()

public will(Stub $stub) : $this
Parameters
$stub : Stub
Return values
$this

willReturn()

public willReturn(mixed $value, mixed ...$nextValues) : self
Parameters
$value : mixed
$nextValues : mixed
Tags
throws
IncompatibleReturnValueException
Return values
self

willReturnArgument()

public willReturnArgument(int $argumentIndex) : self
Parameters
$argumentIndex : int
Return values
self

willReturnCallback()

public willReturnCallback(callable $callback) : self
Parameters
$callback : callable
Return values
self

willReturnMap()

public willReturnMap(array<string|int, mixed> $valueMap) : self
Parameters
$valueMap : array<string|int, mixed>
Return values
self

willReturnOnConsecutiveCalls()

public willReturnOnConsecutiveCalls(mixed ...$values) : self
Parameters
$values : mixed
Return values
self

willReturnReference()

public willReturnReference(mixed &$reference) : self
Parameters
$reference : mixed
Return values
self

willThrowException()

public willThrowException(Throwable $exception) : self
Parameters
$exception : Throwable
Return values
self

with()

public with(mixed ...$arguments) : $this
Parameters
$arguments : mixed
Tags
throws
Exception
throws
MethodNameNotConfiguredException
throws
MethodParametersAlreadyConfiguredException
Return values
$this

withAnyParameters()

public withAnyParameters() : $this
Tags
throws
MethodNameNotConfiguredException
throws
MethodParametersAlreadyConfiguredException
Return values
$this

configuredMethod()

private configuredMethod() : ConfigurableMethod|null
Return values
ConfigurableMethod|null

ensureParametersCanBeConfigured()

private ensureParametersCanBeConfigured() : void
Tags
throws
MethodNameNotConfiguredException
throws
MethodParametersAlreadyConfiguredException

ensureTypeOfReturnValues()

private ensureTypeOfReturnValues(array<string|int, mixed> $values) : void
Parameters
$values : array<string|int, mixed>
Tags
throws
IncompatibleReturnValueException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results