MyCLabs\Enum\PHPUnit\Comparator Class Reference

Use this Comparator to get nice output when using PHPUnit assertEquals() with Enums. More...

Inheritance diagram for MyCLabs\Enum\PHPUnit\Comparator:

Collaboration diagram for MyCLabs\Enum\PHPUnit\Comparator:

Public Member Functions
	accepts ($expected, $actual)
	assertEquals ($expected, $actual, $delta=0.0, $canonicalize=false, $ignoreCase=false)

Private Member Functions
	formatEnum (Enum $enum=null)

Detailed Description

Use this Comparator to get nice output when using PHPUnit assertEquals() with Enums.

Add this to your PHPUnit bootstrap PHP file:

\SebastianBergmann\Comparator\Factory::getInstance()->register(new \MyCLabs\Enum\PHPUnit\Comparator());

Definition at line 15 of file Comparator.php.

Member Function Documentation

accepts()

MyCLabs\Enum\PHPUnit\Comparator::accepts	(		$expected,
			$actual
	)

Definition at line 17 of file Comparator.php.

    {
        return $expected instanceof Enum && (
                $actual instanceof Enum || $actual === null
            );
    }

assertEquals()

MyCLabs\Enum\PHPUnit\Comparator::assertEquals	(		$expected,
			$actual,
			$delta = 0.0,
			$canonicalize = false,
			$ignoreCase = false
	)

Parameters

Enum	$expected
Enum | null	$actual

Returns

void

Definition at line 30 of file Comparator.php.

    {
        if ($expected->equals($actual)) {
            return;
        }
 
        throw new ComparisonFailure(
            $expected,
            $actual,
            $this->formatEnum($expected),
            $this->formatEnum($actual),
            false,
            'Failed asserting that two Enums are equal.'
        );
    }

References MyCLabs\Enum\PHPUnit\Comparator\formatEnum().

Here is the call graph for this function:

formatEnum()

MyCLabs\Enum\PHPUnit\Comparator::formatEnum ( Enum  $enum = null )

private

Definition at line 46 of file Comparator.php.

    {
        if ($enum === null) {
            return "null";
        }
 
        return get_class($enum)."::{$enum->getKey()}()";
    }

Referenced by MyCLabs\Enum\PHPUnit\Comparator\assertEquals().

Here is the caller graph for this function:

---

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

• libs/composer/vendor/myclabs/php-enum/src/PHPUnit/Comparator.php