PHP Class MockGenerator, simpletest

@package SimpleTest
Mostrar archivo Open project: simpletest/simpletest Class Usage Examples

Public Methods

Method Description
__construct ( string $class, string $mock_class ) Builds initial reflection object.
generate ( array $methods ) Clones a class' interface and creates a mock version that can have return values and expectations set.
generatePartial ( array $methods ) Generates a version of a class with selected methods mocked only.
generateSubclass ( array $methods ) Subclasses a class and overrides every method with a mock one that can have return values and expectations set.

Protected Methods

Method Description
addMethodList ( array $methods ) : string Creates a list of mocked methods for error checking.
bailOutIfNotMocked ( string $alias ) : string Creates code to abandon the expectation if not mocked.
chainMockExpectations ( ) : string Creates source code for chaining to an aggregated mock object.
chainMockReturns ( ) : string Creates source code for chaining to the composited mock object.
chainThrowMethods ( ) : string Adds code for chaining the throw methods.
createClassCode ( array $methods ) : string The new mock class code as a string.
createConstructorCode ( ) : string Creates source code for late calling the constructor of the composited mock object.
createHandlerCode ( array $methods ) Creates code within a class to generate replaced methods.
createNewMethodCode ( array $methods ) Creates code within a class to generate a newmethods.
createSubclassCode ( array $methods ) : string The new mock class code as a string.
extendClassCode ( array $methods ) : string The extension class code as a string.
isConstructorOrDeconstructor ( string $method ) : boolean Tests to see if a special PHP method is about to be stubbed by mistake.
overrideMethods ( array $methods ) : string Creates source code to override a list of methods with mock versions.

Method Details

__construct() public method

Builds initial reflection object.
public __construct ( string $class, string $mock_class )
$class string Class to be mocked.
$mock_class string New class with identical interface, but no behaviour.

addMethodList() protected method

Creates a list of mocked methods for error checking.
protected addMethodList ( array $methods ) : string
$methods array Mocked methods.
return string Code for a method list.

bailOutIfNotMocked() protected method

Creates code to abandon the expectation if not mocked.
protected bailOutIfNotMocked ( string $alias ) : string
$alias string Parameter name of method name.
return string Code for bail out.

chainMockExpectations() protected method

Creates source code for chaining to an aggregated mock object.
protected chainMockExpectations ( ) : string
return string Code for expectations.

chainMockReturns() protected method

Creates source code for chaining to the composited mock object.
protected chainMockReturns ( ) : string
return string Code for mock set up.

chainThrowMethods() protected method

Adds code for chaining the throw methods.
protected chainThrowMethods ( ) : string
return string Code for chains.

createClassCode() protected method

The new mock class code as a string.
protected createClassCode ( array $methods ) : string
$methods array Additional methods.
return string Code for new mock class.

createConstructorCode() protected method

Creates source code for late calling the constructor of the composited mock object.
protected createConstructorCode ( ) : string
return string Code for late calls.

createHandlerCode() protected method

All methods call the invoke() handler with the method name and the arguments in an array.
protected createHandlerCode ( array $methods )
$methods array Additional methods.

createNewMethodCode() protected method

All methods call the invoke() handler on the internal mock with the method name and the arguments in an array.
protected createNewMethodCode ( array $methods )
$methods array Additional methods.

createSubclassCode() protected method

The mock will be a subclass of the original mocked class.
protected createSubclassCode ( array $methods ) : string
$methods array Additional methods.
return string Code for new mock class.

extendClassCode() protected method

The class composites a mock object and chains mocked methods to it.
protected extendClassCode ( array $methods ) : string
$methods array Mocked methods.
return string Code for a new class.

generate() public method

Clones a class' interface and creates a mock version that can have return values and expectations set.
public generate ( array $methods )
$methods array Additional methods to add beyond those in th cloned class. Use this to emulate the dynamic addition of methods in the cloned class or when the class hasn't been written yet.

generatePartial() public method

Inherits the old class and chains the mock methods of an aggregated mock object.
public generatePartial ( array $methods )
$methods array Methods to be overridden with mock versions.

generateSubclass() public method

Chains to an aggregated SimpleMock.
public generateSubclass ( array $methods )
$methods array Additional methods to add beyond those in the cloned class. Use this to emulate the dynamic addition of methods in the cloned class or when the class hasn't been written yet.

isConstructorOrDeconstructor() protected method

Tests to see if a special PHP method is about to be stubbed by mistake.
protected isConstructorOrDeconstructor ( string $method ) : boolean
$method string Method name.
return boolean True if special.

overrideMethods() protected method

Creates source code to override a list of methods with mock versions.
protected overrideMethods ( array $methods ) : string
$methods array Methods to be overridden with mock versions.
return string Code for overridden chains.