Class ReferenceExpectation

Description

Test for reference.

Located in /expectation.php (line 448)


	
			
Method Summary
 ReferenceExpectation __construct ( &$value, [string $message = '%s'], mixed $value)
 string overlayMessage (mixed $compare, SimpleDumper $dumper)
 boolean test ( &$compare, mixed $compare)
 string testMessage (mixed $compare)
Methods
Constructor __construct (line 457)

Sets the reference value to compare against.

  • access: public
ReferenceExpectation __construct ( &$value, [string $message = '%s'], mixed $value)
  • mixed $value: Test reference to match.
  • string $message: Customised message on failure.
  • &$value
getDumper (line 508)

Accessor for the dumper.

  • return: Current value dumper.
  • access: protected
SimpleDumper getDumper ()
overlayMessage (line 498)

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

  • return: Description of success or failure.
  • access: public
string overlayMessage (mixed $compare, SimpleDumper $dumper)
  • mixed $compare: Comparison value.
  • SimpleDumper $dumper: For formatting the results.
test (line 469)

Tests the expectation. True if it exactly references the held value.

  • return: True if correct.
  • access: public
boolean test ( &$compare, mixed $compare)
  • mixed $compare: Comparison reference.
  • &$compare
testMessage (line 480)

Returns a human readable test message.

  • return: Description of success or failure.
  • access: public
string testMessage (mixed $compare)
  • mixed $compare: Comparison value.

Documentation generated on Sun, 31 Oct 2010 16:31:29 -0500 by phpDocumentor 1.4.3