Docs For Class EqualExpectation

Description

Test for equality.

SimpleExpectation
   |
   --EqualExpectation

Direct descendents

Class	Description
NotEqualExpectation	Test for inequality.
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:

NotEqualExpectation::__construct() : Sets the value to compare against.
IdenticalExpectation::__construct() : Sets the value to compare against.
NotIdenticalExpectation::__construct() : Sets the value to compare against.
MemberExpectation::__construct() : Sets the value to compare against.

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:

NotEqualExpectation::test() : Tests the expectation. True if it differs from the held value.
IdenticalExpectation::test() : Tests the expectation. True if it exactly matches the held value.
NotIdenticalExpectation::test() : Tests the expectation. True if it differs from the held value.
MemberExpectation::test() : Tests the expectation. True if the property value is identical.

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:

NotEqualExpectation::testMessage() : Returns a human readable test message.
IdenticalExpectation::testMessage() : Returns a human readable test message.
NotIdenticalExpectation::testMessage() : Returns a human readable test message.
MemberExpectation::testMessage() : Returns a human readable test message.

Inherited Methods

Inherited From SimpleExpectation

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