Compare two lookup values only by logical name and ID

Author: wizardist

src/Entity.php

@@ -270,17 +270,13 @@ public function __set( $property, $value ) {
                 return;
             }
 
-            /*
-             * NOTE: For fast work set STRING value with ENTITY ID
-             */
-
             /* If this is a Lookup field, it MUST be set to an Entity of an appropriate type */
             if ( $this->attributes[ $property ]->isLookup && $value != null ) {
                 /* Check the new value is an Entity */
-                if ( !$value instanceOf self ) {
+                if ( !$value instanceOf EntityReference ) {
                     $trace = debug_backtrace();
                     throw new Exception( 'Property ' . $property . ' of the ' . $this->entityLogicalName
-                                         . ' entity must be a object of ' . get_class()
+                                         . ' entity must be a object of Entity or EntityReference'
                                          . ' class in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_ERROR );
                 }
                 /* Check the new value is the right type of Entity */
@@ -293,8 +289,9 @@ public function __set( $property, $value ) {
                 /* Clear any AttributeOf related to this field */
                 $this->clearAttributesOf( $property );
             }
-            /* If this is an AlexaCRM\CRMToolkit\Entity\OptionSet field, it MUST be set to a valid OptionSetValue
-             * according to the definition of the AlexaCRM\CRMToolkit\Entity\OptionSet
+
+            /* If this is an OptionSet field, it MUST be set to a valid OptionSetValue
+             * according to the definition of the OptionSet
              */
             if ( $this->attributes[ $property ]->optionSet != null && $this->attributes[$property]->type !== 'Boolean' ) {
                 /* Container for the final value */
@@ -354,7 +351,16 @@ public function __set( $property, $value ) {
                 $value = (bool)$value;
             }
 
-            if ( $this->propertyValues[ $property ]['Value'] != $value ) {
+            if ( $this->attributes[$property]->isLookup ) {
+                if ( $this->propertyValues[$property]['Value'] instanceof EntityReference ) {
+                    if ( $this->propertyValues[$property]['Value']->equals( $value ) ) {
+                        return;
+                    }
+                }
+
+                $this->propertyValues[ $property ]['Value'] = $value;
+                $this->propertyValues[ $property ]['Changed'] = true;
+            } elseif ( $this->propertyValues[ $property ]['Value'] != $value ) {
                 /* Update the property value with whatever value was passed */
                 $this->propertyValues[ $property ]['Value'] = $value;
                 /* Mark the property as changed */
@@ -1306,4 +1312,16 @@ public static function generateCacheKey( $logicalName, $id, $columnSet = null )
 
         return sha1( "{$logicalName}_{$id}{$columnSetString}" );
     }
+
+    /**
+     * Converts the Entity to to a new EntityReference.
+     *
+     * @return EntityReference
+     */
+    public function toEntityReference() {
+        $ref = new EntityReference( $this->entityLogicalName, $this->getID() );
+        $ref->displayName = $this->displayName;
+
+        return $ref;
+    }
 }

src/Entity/EntityReference.php

@@ -18,6 +18,7 @@
 namespace AlexaCRM\CRMToolkit\Entity;
 
 use AlexaCRM\CRMToolkit\AbstractClient;
+use AlexaCRM\CRMToolkit\Entity;
 use AlexaCRM\CRMToolkit\KeyAttributes;
 use Exception;
 
@@ -33,14 +34,14 @@ class EntityReference extends AbstractClient {
     /**
      * The ID of the Entity
      *
-     * @var String corresponds GUID structure in Dynamics CRM
+     * @var string corresponds GUID structure in Dynamics CRM
      */
     protected $entityID = null;
 
     /**
-     * entityName, display name of Entity object record
+     * Display name of the Entity object record
      *
-     * @var String
+     * @var string
      */
     protected $displayName = null;
 
@@ -108,21 +109,20 @@ public function __toString() {
     /**
      * Private utility function to get the ID field; enforces NULL --> EmptyGUID
      *
-     * @ignore
-     * @return String GUID if it's existing record, empty GUID otherwise
+     * @return string GUID if it's existing record, empty GUID otherwise
      */
     protected function getID() {
         if ( $this->entityID == null ) {
             return self::EmptyGUID;
-        } else {
-            return $this->entityID;
         }
+
+        return $this->entityID;
     }
 
     /**
      * Private utility function to set the ID field; enforces "Set Once" logic
      *
-     * @param String $value
+     * @param string $value
      *
      * @throws Exception if the ID is already set
      * @return void
@@ -132,6 +132,7 @@ protected function setID( $value ) {
         if ( $this->entityID != null ) {
             throw new Exception( 'Cannot change the ID of an Entity' );
         }
+
         $this->entityID = $value;
     }
 
@@ -152,4 +153,27 @@ public function getFormattedValue( $property, $timezoneOffset = null ) {
         return null;
     }
 
+    /**
+     * Determines whether two entity references are equal.
+     *
+     * @param mixed $reference
+     *
+     * @return bool
+     */
+    public function equals( $reference ) {
+        if ( !( $reference instanceof EntityReference ) ) {
+            return false;
+        }
+
+        if ( strcasecmp( $this->entityLogicalName, $reference->entityLogicalName ) !== 0 ) {
+            return false;
+        }
+
+        if ( $this->getID() !== $reference->getID() ) {
+            return false;
+        }
+
+        return true;
+    }
+
 }