Docs For Class EqualExpectation

Description

Test for equality.

SimpleExpectation
   |
   --EqualExpectation

Direct descendents

Class	Description
NotEqualExpectation	Test for inequality.
IdenticalExpectation	Test for identity.

Variable Summary

mixed $_value

Method Summary

EqualExpectation EqualExpectation (mixed $value, [string $message = '%s'])

boolean test (mixed $compare)

string testMessage (mixed $compare)

mixed _getValue ()

Variables

mixed $_value (line 225)

Inherited Variables

Inherited from SimpleExpectation

SimpleExpectation::$_dumper
SimpleExpectation::$_message

Methods

Constructor EqualExpectation (line 233)

Sets the value to compare against.

access: public

EqualExpectation EqualExpectation (mixed $value, [string $message = '%s'])

mixed $value: Test value to match.
string $message: Customised message on failure.

test (line 245)

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.

testMessage (line 256)

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.

_getValue (line 270)

Accessor for comparison value.

return: Held value to compare with.
access: protected

mixed _getValue ()

Inherited Methods

Inherited From SimpleExpectation

SimpleExpectation::SimpleExpectation()
SimpleExpectation::isExpectation()
SimpleExpectation::overlayMessage()
SimpleExpectation::test()
SimpleExpectation::testMessage()
SimpleExpectation::_getDumper()