Class EqualExpectation

Description

Test for equality.

Located in /expectation.php (line 223)

SimpleExpectation
   |
   --EqualExpectation
Direct descendents
Class Description
 class NotEqualExpectation Test for inequality.
 class IdenticalExpectation Test for identity.
Method Summary
 EqualExpectation __construct (mixed $value, [string $message = '%s'])
 mixed getValue ()
 boolean test (mixed $compare)
 string testMessage (mixed $compare)
Variables

Inherited Variables

Inherited from SimpleExpectation

SimpleExpectation::$dumper
Methods
Constructor __construct (line 232)

Sets the value to compare against.

  • access: public
EqualExpectation __construct (mixed $value, [string $message = '%s'])
  • mixed $value: Test value to match.
  • string $message: Customised message on failure.

Redefinition of:
SimpleExpectation::__construct()
Creates a dumper for displaying values and sets the test message.

Redefined in descendants as:
getValue (line 269)

Accessor for comparison value.

  • return: Held value to compare with.
  • access: protected
mixed getValue ()
test (line 244)

Tests the expectation. True if it matches the held value.

  • return: True if correct.
  • access: public
boolean test (mixed $compare)
  • mixed $compare: Comparison value.

Redefinition of:
SimpleExpectation::test()
Tests the expectation. True if correct.

Redefined in descendants as:
testMessage (line 255)

Returns a human readable test message.

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

Redefinition of:
SimpleExpectation::testMessage()
Returns a human readable test message.

Redefined in descendants as:

Inherited Methods

Inherited From SimpleExpectation

 SimpleExpectation::__construct()
 SimpleExpectation::getDumper()
 SimpleExpectation::isExpectation()
 SimpleExpectation::overlayMessage()
 SimpleExpectation::test()
 SimpleExpectation::testMessage()

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