ZP-953 Added getNameFromPropertyValue function to SyncObject.

Released under the Affero GNU General Public License (AGPL) version 3.

src/lib/syncobjects/syncobject.php

@@ -254,13 +254,12 @@ abstract class SyncObject extends Streamer {
                     // else just compare their values and print human friendly if necessary
                     else {
                         if($this->$val == $odo->$val) {
-                            $out[$keyprefix.$val] = (isset($v[self::STREAMER_VALUEMAP][$this->$val])) ? $v[self::STREAMER_VALUEMAP][$this->$val] : $this->$val;
+                            $out[$keyprefix.$val] = $this->getNameFromPropertyValue($v, $this->$val);
                         }
                         else {
-                            $out[$keyprefix.$val] = (strlen($this->$val) ?
-                                    ((isset($v[self::STREAMER_VALUEMAP][$this->$val])) ? $v[self::STREAMER_VALUEMAP][$this->$val] : $this->$val) : "undefined") .
+                            $out[$keyprefix.$val] = (strlen($this->$val) ? $this->getNameFromPropertyValue($v, $this->$val) : "undefined") .
                                     " - ". $odoName .": ".
-                                    (strlen($odo->$val) ? ((isset($v[self::STREAMER_VALUEMAP][$odo->$val])) ? $v[self::STREAMER_VALUEMAP][$odo->$val] : $odo->$val) : "undefined");
+                                    (strlen($odo->$val) ? $this->getNameFromPropertyValue($v, $odo->$val) : "undefined");
                         }
                     }
                 }
@@ -275,7 +274,7 @@ abstract class SyncObject extends Streamer {
                 else {
                     if($this->$val == $odo->$val) {
                         if (! ($this instanceof SyncRecurrence)) {
-                            $out[$keyprefix.$val] = (isset($v[self::STREAMER_VALUEMAP][$this->$val])) ? $v[self::STREAMER_VALUEMAP][$this->$val] : $this->$val;
+                            $out[$keyprefix.$val] = ($this->getNameFromPropertyValue($v, $this->$val));
                         }
                     }
                     else {
@@ -283,10 +282,9 @@ abstract class SyncObject extends Streamer {
                             $out["Recurrence"] = "Recurrence changed";
                         }
                         else {
-                            $out[$keyprefix.$val] = (strlen($this->$val) ?
-                                    ((isset($v[self::STREAMER_VALUEMAP][$this->$val])) ? $v[self::STREAMER_VALUEMAP][$this->$val] : $this->$val) : "undefined") .
+                            $out[$keyprefix.$val] = (strlen($this->$val) ? $this->getNameFromPropertyValue($v, $this->$val) : "undefined") .
                                     " - ". $odoName .": ".
-                                    (strlen($odo->$val) ? ((isset($v[self::STREAMER_VALUEMAP][$odo->$val])) ? $v[self::STREAMER_VALUEMAP][$odo->$val] : $odo->$val) : "undefined");
+                                    (strlen($odo->$val) ? ($this->getNameFromPropertyValue($v, $odo->$val)) : "undefined");
                         }
                     }
                 }
@@ -297,8 +295,7 @@ abstract class SyncObject extends Streamer {
                 // Otherwise it's a ghosted property and the device didn't send it, so we don't have to care about that case.
                 if (in_array($k, $supportedFields)) {
                     if ((is_scalar($this->$val) && strlen($this->$val)) || (!is_scalar($this->$val) && !empty($this->$val))) {
-                        $out[$keyprefix.$val] = (is_array($this->$val) ?
-                                implode(",", $this->$val) : ((isset($v[self::STREAMER_VALUEMAP][$this->$val])) ? $v[self::STREAMER_VALUEMAP][$this->$val] : $this->$val)) .
+                        $out[$keyprefix.$val] = (is_array($this->$val) ? implode(",", $this->$val) : $this->getNameFromPropertyValue($v, $this->$val)) .
                         " - " . $odoName .": value completely removed";
                     }
                 }
@@ -308,7 +305,7 @@ abstract class SyncObject extends Streamer {
                         $out[$keyprefix.$val] = Utils::GetFormattedTime($this->$val);
                     }
                     else {
-                        $out[$keyprefix.$val] = (isset($v[self::STREAMER_VALUEMAP][$this->$val])) ? $v[self::STREAMER_VALUEMAP][$this->$val] : $this->$val;
+                        $out[$keyprefix.$val] = $this->getNameFromPropertyValue($v, $this->$val);
                     }
                 }
             }
@@ -322,7 +319,7 @@ abstract class SyncObject extends Streamer {
                         $out[$keyprefix.$val] = "Not set - " . $odoName . ": an exception was added";
                     }
                     else {
-                        $out[$keyprefix.$val] = "Not set - " . $odoName . ": " . ((isset($v[self::STREAMER_VALUEMAP][$odo->$val])) ? $v[self::STREAMER_VALUEMAP][$odo->$val] : $odo->$val) . " (value added)";
+                        $out[$keyprefix.$val] = "Not set - " . $odoName . ": " . $this->getNameFromPropertyValue($v, $odo->$val) . " (value added)";
                     }
                 }
                 else if (isset($v[self::STREAMER_ARRAY])) {
@@ -330,7 +327,7 @@ abstract class SyncObject extends Streamer {
                     $out[$keyprefix.$val] = "Not set - ". $odoName .": ". implode(", ", $odo->$val) . " (value added)";
                 }
                 else {
-                    $out[$keyprefix.$val] = "Not set - " . $odoName . ": " . ((isset($v[self::STREAMER_VALUEMAP][$odo->$val])) ? $v[self::STREAMER_VALUEMAP][$odo->$val] : $odo->$val) . " (value added)";
+                    $out[$keyprefix.$val] = "Not set - " . $odoName . ": " . $this->getNameFromPropertyValue($v, $odo->$val) . " (value added)";
                 }
             }
         }
@@ -595,4 +592,20 @@ abstract class SyncObject extends Streamer {
 
         return true;
     }
+
+    /**
+     * Returns human friendly property name from its value if a mapping is available.
+     *
+     * @param array $v
+     * @param mixed $val
+     *
+     * @access private
+     * @return mixed
+     */
+    private function getNameFromPropertyValue($v, $val) {
+        if (isset($v[self::STREAMER_VALUEMAP][$val])) {
+            return $v[self::STREAMER_VALUEMAP][$val];
+        }
+        return $val;
+    }
 }