SimpleExpectation Class Reference

Inheritance diagram for SimpleExpectation:

Public Member Functions
	SimpleExpectation ($message= '%s')
	test ($compare)
	testMessage ($compare)
	overlayMessage ($compare, $dumper)
&	_getDumper ()
Static Public Member Functions
	isExpectation ($expectation)
Data Fields
	$_dumper = false
	$_message

---

Detailed Description

Definition at line 23 of file expectation.php.

---

Member Function Documentation

& _getDumper

(

)

Accessor for the dumper.

Returns:

SimpleDumper Current value dumper. protected

Definition at line 76 of file expectation.php.

Here is the caller graph for this function:

isExpectation

(

$

expectation

)

[static]

Test to see if a value is an expectation object. A useful utility method.

Parameters:

mixed

$expectation

Hopefully an Epectation class.

Returns:

boolean True if descended from this class. public

Definition at line 94 of file expectation.php.

Here is the call graph for this function:

Here is the caller graph for this function:

overlayMessage	(	$	compare,
		$	dumper
	)

Overlays the generated message onto the stored user message. An additional message can be interjected.

Parameters:

mixed	$compare	Comparison value.
SimpleDumper	$dumper	For formatting the results.

Returns:

string Description of success or failure. public

Definition at line 66 of file expectation.php.

Here is the call graph for this function:

SimpleExpectation

(

$

message = '%s'

)

Creates a dumper for displaying values and sets the test message.

Parameters:

string

$message

Customised message on failure.

Definition at line 32 of file expectation.php.

Here is the caller graph for this function:

test

(

$

compare

)

Tests the expectation. True if correct.

Parameters:

mixed

$compare

Comparison value.

Returns:

boolean True if correct. public

Reimplemented in MethodExistsExpectation, NotAExpectation, IsAExpectation, NoPatternExpectation, PatternExpectation, NotIdenticalExpectation, ContainsEmptyTag, IdenticalExpectation, ContainsTagWithContents, DoesNotContainTagWithAttributes, OutsideMarginExpectation, NoTextExpectation, ContainsSelectExpectation, WithinMarginExpectation, TextExpectation, NotEqualExpectation, ContainsTagWithAttributes, NoHttpHeaderExpectation, EqualExpectation, ContainsTagWithAttribute, FalseExpectation, HttpHeaderExpectation, TrueExpectation, CheckSpecifiedFieldsExpectation, FailedExpectation, ArraysHaveSameValuesExpectation, AnythingExpectation, ExceptionExpectation, IgnoreWhitespaceExpectation, TimeModifiedExpectation, and FieldExpectation.

Definition at line 43 of file expectation.php.

testMessage

(

$

compare

)

Returns a human readable test message.

Parameters:

mixed

$compare

Comparison value.

Returns:

string Description of success or failure. public

Reimplemented in MethodExistsExpectation, NotAExpectation, IsAExpectation, NoPatternExpectation, PatternExpectation, NotIdenticalExpectation, ContainsEmptyTag, IdenticalExpectation, ContainsTagWithContents, ReferenceExpectation, OutsideMarginExpectation, NoTextExpectation, WithinMarginExpectation, TextExpectation, NotEqualExpectation, NoHttpHeaderExpectation, EqualExpectation, HttpHeaderExpectation, FalseExpectation, XMLStructureExpectation, TrueExpectation, CheckSpecifiedFieldsExpectation, FailedExpectation, ArraysHaveSameValuesExpectation, AnythingExpectation, FieldExpectation, ExceptionExpectation, IgnoreWhitespaceExpectation, and TimeModifiedExpectation.

Definition at line 54 of file expectation.php.

Here is the caller graph for this function:

---

Field Documentation

$_dumper = false

Definition at line 24 of file expectation.php.

$_message

Definition at line 25 of file expectation.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/simpletestlib/expectation.php