Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Language Reference : Classes and Objects (PHP 4) : Comparing objects

Comparing objects

In PHP 4, objects are compared in a very simple manner, namely: Two object instances are equal if they have the same attributes and values, and are instances of the same class. Similar rules are applied when comparing two objects using the identity operator (===).

If we were to execute the code in the example below:

Example 9.1. Example of object comparison in PHP 4

<?php
function bool2str($bool) {
   if (
$bool === false) {
           return
'FALSE';
   } else {
           return
'TRUE';
   }
}

function
compareObjects(&$o1, &$o2) {
   echo
'o1 == o2 : '.bool2str($o1 == $o2)."\n";
   echo
'o1 != o2 : '.bool2str($o1 != $o2)."\n";
   echo
'o1 === o2 : '.bool2str($o1 === $o2)."\n";
   echo
'o1 !== o2 : '.bool2str($o1 !== $o2)."\n";
}

class
Flag {
   var
$flag;

   function
Flag($flag=true) {
           
$this->flag = $flag;
   }
}

class
SwitchableFlag extends Flag {

   function
turnOn() {
       
$this->flag = true;
   }

   function
turnOff() {
       
$this->flag = false;
   }
}

$o = new Flag();
$p = new Flag(false);
$q = new Flag();

$r = new SwitchableFlag();

echo
"Compare instances created with the same parameters\n";
compareObjects($o, $q);

echo
"\nCompare instances created with different parameters\n";
compareObjects($o, $p);

echo
"\nCompare an instance of a parent class with one from a subclass\n";
compareObjects($o, $r);
?>

The above example will output:

Compare instances created with the same parameters
o1 == o2 : TRUE
o1 != o2 : FALSE
o1 === o2 : TRUE
o1 !== o2 : FALSE

Compare instances created with different parameters
o1 == o2 : FALSE
o1 != o2 : TRUE
o1 === o2 : FALSE
o1 !== o2 : TRUE

Compare an instance of a parent class with one from a subclass
o1 == o2 : FALSE
o1 != o2 : TRUE
o1 === o2 : FALSE
o1 !== o2 : TRUE


Which is the output we will expect to obtain given the comparison rules above. Only instances with the same values for their attributes and from the same class are considered equal and identical.

Even in the cases where we have object composition, the same comparison rules apply. In the example below we create a container class that stores an associative array of Flag objects.

Example 9.2. Compound object comparisons in PHP 4

<?php
class FlagSet {
   var
$set;

   function
FlagSet($flagArr = array()) {
       
$this->set = $flagArr;
   }

   function
addFlag($name, $flag) {
       
$this->set[$name] = $flag;
   }

   function
removeFlag($name) {
       if (
array_key_exists($name, $this->set)) {
           unset(
$this->set[$name]);
       }
   }
}


$u = new FlagSet();
$u->addFlag('flag1', $o);
$u->addFlag('flag2', $p);
$v = new FlagSet(array('flag1'=>$q, 'flag2'=>$p));
$w = new FlagSet(array('flag1'=>$q));

echo
"\nComposite objects u(o,p) and v(q,p)\n";
compareObjects($u, $v);

echo
"\nu(o,p) and w(q)\n";
compareObjects($u, $w);
?>

The above example will output:

Composite objects u(o,p) and v(q,p)
o1 == o2 : TRUE
o1 != o2 : FALSE
o1 === o2 : TRUE
o1 !== o2 : FALSE

u(o,p) and w(q)
o1 == o2 : FALSE
o1 != o2 : TRUE
o1 === o2 : FALSE
o1 !== o2 : TRUE


Code Examples / Notes » language.oop.object_comparison

pferlet

Using globals isn't really well... you can use pattern singleton to verify this.

jazfresh

PHP4 compares two objects (say, $a and $b) by comparing the type and all the attributes. If an attribute is an object, PHP4 will recursively call "if($a.attribute === $b.attribute)" to determine equality. However, this is a problem if a circular reference has been formed. The recursion will go on forever, and you will get the error message:
"Fatal error: Nesting level too deep - recursive dependency?"
Example, where the comparison will never terminate because PHP4 will forever recurse with comparisons of the attribute.
<?php
class Test {
       var $obj;
}
$foo =& new Test;
$bar =& new Test;
$foo->obj =& $bar; // Make circular reference
$bar->obj =& $foo;
if($foo === $bar) {
       baz();
}
?>
First PHP4 does ($foo === $bar), which expands into ($foo.obj === $bar.obj), which expands into ($bar.obj === $foo.obj), and so on and so on.
To avoid this situation, you must compare objects manually by comparing the two object's attributes and avoiding comparisons on attributes where a circular reference could arise.
This issue is easily avoided in PHP5, where objects can be compared via references rather than the object contents.


magicturkey

If youre just checking to see if the variables both reference the same object, instead of having a variable set up beforehand you could do away with the GLOBALS and have something like..
e.g.
<?php
class Foo {
 var $serial;
 function Foo() {
  // Rest of constructor...
 }
 // Rest of class definition...
}
$baz->serial = -1;
$bar->serial = time();
if($bar->serial == $baz->serial) {
 echo "Same";
}
?>


mildred
If you want to test the existance of objects in arrays like in_array but with very strict checking in PHP4 (in order to avoid the "Nesting level too deep - recursive dependency?" error). i wrote the following function.
All objects that can be compared must extends comparable and call the comparable constructor. It will then create a serial number different on each objects.
I don't think it is the ultimate solution because arrays can contains loops and this won't be checked here. And if there is a recursive dependency between objects that do not extends comparable, you will still have the error.
Sometimes I think I don't like PHP very much ...
<?php
class comparable {
   // Don't forget to call this constructor in sub-classes
   function comparable(){
       if(!isset($GLOBALS[__FILE__.'/class:comparable']))
           $GLOBALS[__FILE__.'/class:comparable'] = 1;
       $this->comparableSerial = $GLOBALS[__FILE__.'/class:comparable']++;
   }
}
function exact_in_array(&$needle, &$haystack){
   foreach($haystack as $k=>$v){
       $elem = &$haystack[$k];
       if(
           is_object($needle) and is_object($elem) and
           is_a($needle, 'comparable') and is_a($elem, 'comparable'))
       {
           if( get_class($needle) === get_class($elem) and
               $needle->comparableSerial == $elem->comparableSerial)
               return true;
       }else{
           // Uncomment this line to know which classes do not extends
           // comparable and fail the test with Nesting level too deep error
           //printf(
           //    "%s(%s) === %s(%s)",
           //    $needle, get_class($needle), $elem, get_class($elem));
           if($needle === $elem) return true;
       }
       unset($elem);
   }
   return false;
}
?>


jazfresh

An addendum to the post below:
If you are comparing two objects and you know that they will be of the same type (you're just not sure if they refer to the same object or not), then there is an easier and faster way to do the comparison, and this also avoids the infinite recursion problem with circular references described in the post below.
In the constructor of your object, set a "serial" attribute from a global variable that is incremented whenever a new object is created. Then you just have to compare serial numbers to see if the objects are the same.
e.g.
<?php
$FooSerial = 0;
class Foo {
 var $serial;
 function Foo() {
   $this->serial = $GLOBALS['FooSerial']++;
   // Rest of constructor...
 }
 // Rest of class definition...
}
if($bar->serial == $baz->serial) {
 echo "Same";
}
?>


Change Language


Follow Navioo On Twitter
class
extends
Constructors
Scope Resolution Operator (::)
parent
Serializing objects - objects in sessions
The magic functions __sleep and __wakeup
References inside the constructor
Comparing objects
eXTReMe Tracker