PHP Class IsAExpectation, simpletest

Inheritance: extends SimpleExpectation
Show file Open project: simpletest/simpletest Class Usage Examples

Public Methods

Method Description
__construct ( string $type, string $message = '%s' ) Sets the type to compare with.
test ( string $compare ) : boolean Tests the expectation. True if the type or class matches the string value.
testMessage ( mixed $compare ) : string Returns a human readable test message.

Protected Methods

Method Description
canonicalType ( string $type ) : string Coerces type name into a is_*() match.
getType ( ) : string Accessor for type to check against.

Method Details

__construct() public method

Sets the type to compare with.
public __construct ( string $type, string $message = '%s' )
$type string Type or class name.
$message string Customised message on failure.

canonicalType() protected method

Coerces type name into a is_*() match.
protected canonicalType ( string $type ) : string
$type string User type.
return string Simpler type.

getType() protected method

Accessor for type to check against.
protected getType ( ) : string
return string Type or class name.

test() public method

Tests the expectation. True if the type or class matches the string value.
public test ( string $compare ) : boolean
$compare string Comparison value.
return boolean True if correct.

testMessage() public method

Returns a human readable test message.
public testMessage ( mixed $compare ) : string
$compare mixed Comparison value.
return string Description of success or failure.