SebastianBergmann\Comparator\ObjectComparator Class Reference

Inheritance diagram for SebastianBergmann\Comparator\ObjectComparator:

Collaboration diagram for SebastianBergmann\Comparator\ObjectComparator:

Public Member Functions
	accepts ($expected, $actual)
	assertEquals ($expected, $actual, $delta=0.0, $canonicalize=false, $ignoreCase=false, array &$processed=[])
Public Member Functions inherited from SebastianBergmann\Comparator\Comparator
	setFactory (Factory $factory)
	assertEquals ($expected, $actual, $delta=0.0, $canonicalize=false, $ignoreCase=false)

Protected Member Functions
	toArray ($object)
Protected Member Functions inherited from SebastianBergmann\Comparator\ArrayComparator
	indent ($lines)

Additional Inherited Members
Protected Attributes inherited from SebastianBergmann\Comparator\Comparator
	$factory
	$exporter

Detailed Description

Compares objects for equality.

Member Function Documentation

accepts()

SebastianBergmann\Comparator\ObjectComparator::accepts	(		$expected,
			$actual
	)

Returns whether the comparator can compare two values.

Parameters

mixed	$expected	The first value to compare
mixed	$actual	The second value to compare

Returns

bool

Reimplemented from SebastianBergmann\Comparator\ArrayComparator.

Reimplemented in SebastianBergmann\Comparator\DOMNodeComparator, SebastianBergmann\Comparator\DateTimeComparator, SebastianBergmann\Comparator\ExceptionComparator, SebastianBergmann\Comparator\MockObjectComparator, and Prophecy\Comparator\ProphecyComparator.

assertEquals()

SebastianBergmann\Comparator\ObjectComparator::assertEquals	(		$expected,
			$actual,
			$delta = 0.0,
			$canonicalize = false,
			$ignoreCase = false,
		array &	$processed = []
	)

Asserts that two values are equal.

Parameters

mixed	$expected	First value to compare
mixed	$actual	Second value to compare
float	$delta	Allowed numerical distance between two values to consider them equal
bool	$canonicalize	Arrays are sorted before comparison when set to true
bool	$ignoreCase	Case is ignored when set to true
array	$processed	List of already processed elements (used to prevent infinite recursion)

Exceptions

ComparisonFailure

Reimplemented from SebastianBergmann\Comparator\ArrayComparator.

Reimplemented in Prophecy\Comparator\ProphecyComparator, and SebastianBergmann\Comparator\DOMNodeComparator.

toArray()

SebastianBergmann\Comparator\ObjectComparator::toArray (   $object )

protected

Converts an object to an array containing all of its private, protected and public properties.

Parameters

object

$object

Returns

array

Reimplemented in SebastianBergmann\Comparator\MockObjectComparator, and SebastianBergmann\Comparator\ExceptionComparator.

---

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

• vendor/sebastian/comparator/src/ObjectComparator.php