PHP Interface Eloquent\Phony\Stub\Stub

Inheritance: extends Eloquent\Phony\Invocation\WrappedInvocable
Datei anzeigen Open project: eloquent/phony Interface Usage Examples

Public Methods

Method Description
calls ( callable $callback ) Add a callback to be called as part of an answer.
callsArgument ( integer $index ) Add an argument callback to be called as part of an answer.
callsArgumentWith ( integer $index, Arguments | array $arguments = [], boolean $prefixSelf = false, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true ) Add an argument callback to be called as part of an answer.
callsWith ( callable $callback, Arguments | array $arguments = [], boolean | null $prefixSelf = null, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true ) Add a callback to be called as part of an answer.
closeRule ( ) Close any existing rule.
defaultAnswerCallback ( ) : callable Get the default answer callback.
does ( callable $callback ) Add a callback as an answer.
doesWith ( callable $callback, Arguments | array $arguments = [], boolean | null $prefixSelf = null, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true ) Add a callback as an answer.
forwards ( Arguments | array $arguments = [], boolean | null $prefixSelf = null, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true ) Add an answer that calls the wrapped callback.
generates ( mixed>\mixed $values = [] ) : Eloquent\Phony\Stub\Answer\Builder\GeneratorAnswerBuilder Add an answer that returns a generator, and return a builder for customizing the generator's behavior.
returns ( mixed $value = null ) Add an answer that returns a value.
returnsArgument ( integer $index ) Add an answer that returns an argument.
returnsSelf ( ) Add an answer that returns the self value.
self ( ) : mixed Get the self value of this stub.
setDefaultAnswerCallback ( callable $defaultAnswerCallback ) Set the callback to use when creating a default answer.
setSelf ( mixed $self ) Set the self value of this stub.
setsArgument ( mixed $indexOrValue = null, mixed $value = null ) Set the value of an argument passed by reference as part of an answer.
throws ( Exceptio\Exception | Erro\Error | string | null $exception = null ) Add an answer that throws an exception.
with ( ) Modify the current criteria to match the supplied arguments.

Method Details

calls() public method

Note that all supplied callbacks will be called in the same invocation.
public calls ( callable $callback )
$callback callable The callback.

callsArgument() 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. Note that all supplied callbacks will be called in the same invocation.
public callsArgument ( integer $index )
$index integer The argument index.

callsArgumentWith() 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. Note that all supplied callbacks will be called in the same invocation.
public callsArgumentWith ( integer $index, Arguments | array $arguments = [], boolean $prefixSelf = false, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true )
$index integer The argument index.
$arguments Eloquent\Phony\Call\Arguments | array The arguments.
$prefixSelf boolean True if the self value should be prefixed.
$suffixArgumentsObject boolean True if the arguments object should be appended.
$suffixArguments boolean True if the arguments should be appended individually.

callsWith() public method

This method supports reference parameters. Note that all supplied callbacks will be called in the same invocation.
public callsWith ( callable $callback, Arguments | array $arguments = [], boolean | null $prefixSelf = null, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true )
$callback callable The callback.
$arguments Eloquent\Phony\Call\Arguments | array The arguments.
$prefixSelf boolean | null True if the self value should be prefixed.
$suffixArgumentsObject boolean True if the arguments object should be appended.
$suffixArguments boolean True if the arguments should be appended individually.

closeRule() public method

Close any existing rule.
public closeRule ( )

defaultAnswerCallback() public method

Get the default answer callback.
public defaultAnswerCallback ( ) : callable
return callable The default answer callback.

does() public method

Add a callback as an answer.
public does ( callable $callback )
$callback callable The callback.

doesWith() public method

Add a callback as an answer.
public doesWith ( callable $callback, Arguments | array $arguments = [], boolean | null $prefixSelf = null, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true )
$callback callable The callback.
$arguments Eloquent\Phony\Call\Arguments | array The arguments.
$prefixSelf boolean | null True if the self value should be prefixed.
$suffixArgumentsObject boolean True if the arguments object should be appended.
$suffixArguments boolean True if the arguments should be appended individually.

forwards() public method

Add an answer that calls the wrapped callback.
public forwards ( Arguments | array $arguments = [], boolean | null $prefixSelf = null, boolean $suffixArgumentsObject = false, boolean $suffixArguments = true )
$arguments Eloquent\Phony\Call\Arguments | array The arguments.
$prefixSelf boolean | null True if the self value should be prefixed.
$suffixArgumentsObject boolean True if the arguments object should be appended.
$suffixArguments boolean True if the arguments should be appended individually.

generates() public method

Add an answer that returns a generator, and return a builder for customizing the generator's behavior.
public generates ( mixed>\mixed $values = [] ) : Eloquent\Phony\Stub\Answer\Builder\GeneratorAnswerBuilder
$values mixed>\mixed
return Eloquent\Phony\Stub\Answer\Builder\GeneratorAnswerBuilder The answer builder.

returns() public method

Add an answer that returns a value.
public returns ( mixed $value = null )
$value mixed The return value.

returnsArgument() 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 returnsArgument ( integer $index )
$index integer The argument index.

returnsSelf() public method

Add an answer that returns the self value.
public returnsSelf ( )

self() public method

Get the self value of this stub.
public self ( ) : mixed
return mixed The self value.

setDefaultAnswerCallback() public method

Set the callback to use when creating a default answer.
public setDefaultAnswerCallback ( callable $defaultAnswerCallback )
$defaultAnswerCallback callable The default answer callback.

setSelf() public method

This value is used by returnsSelf().
public setSelf ( mixed $self )
$self mixed The self value.

setsArgument() public method

If called with no arguments, sets the first argument to null. If called with one argument, sets the first argument to $indexOrValue. If called with two arguments, sets the argument at $indexOrValue to $value.
public setsArgument ( mixed $indexOrValue = null, mixed $value = null )
$indexOrValue mixed The index, or value if no index is specified.
$value mixed The value.

throws() public method

Add an answer that throws an exception.
public throws ( Exceptio\Exception | Erro\Error | string | null $exception = null )
$exception Exceptio\Exception | Erro\Error | string | null The exception, or message, or null to throw a generic exception.

with() public method

Modify the current criteria to match the supplied arguments.
public with ( )