Added Preference methods

Author: zsmannheim

CHANGELOG

@@ -2,6 +2,17 @@ Date
 Version 
 - Due to more strict validation empty strings are not valid for editorVersion when creating Mails. Removed that parameter if not set from API call.
 
+Date 2021-11-08
+Version 1.8.4
+- Remove 'contacteventtype' and 'contacteventtypes' from XMLDeserializer
+- Added Preference and PreferenceCategory models to Contacts
+- Added preferences to Contact
+- Added 'getContactPreferenceCategories', 'createContactPreferenceCategory', 'getContactPreferenceCategoryByName', 'updateContactPreferenceCategory', 'deleteContactPreferenceCategory', 'getPreferencesOfContactPreferencesCategory', 'createContactPreference', 'getContactPreference', 'updateContactPreference', 'deleteContactPreference' to ContactsService
+- Complement get, post, put methods at ContactService to work with contact preferences
+- Added format and deviceType to Open and Click
+- Added messageId to Bounce
+- Added permissionStatus, permissonType, standard_fields, custom_fields to ReportContact
+
 Date 2021-10-25
 Version 1.8.3
 - Added functions 'getRecipientAlias', 'getTrackingStrategy', 'getSpeedLevel' and 'getPostSendoutCleanupState' to the MailingsService

src/contacts/Contact.php

@@ -24,6 +24,7 @@ class Contact extends AbstractXMLWrapper
     public $updated;
     public $standard_fields;
     public $custom_fields;
+    public $preferences;
 
     /**
      * Constructor initializing default values.
@@ -51,7 +52,8 @@ public function __construct(
         $standard_fields = array(),
         $custom_fields = array(),
         $created = null,
-        $updated = null
+        $updated = null,
+        $preferences = array()
     ) {
         $this->id = $id;
         $this->email = $email;
@@ -62,6 +64,7 @@ public function __construct(
         $this->custom_fields = $custom_fields;
         $this->created = $created;
         $this->updated = $updated;
+        $this->preferences = $preferences;
     }
 
     /**
@@ -110,6 +113,15 @@ public function fromXML($xmlElement)
                 // The trim is required to make a safer string from the object
             }
         }
+
+        if (isset($xmlElement->preferences)) {
+            $this->preferences = array();
+            foreach ($xmlElement->preferences->children() as $preference) {
+                $preference_obj = new Preference();
+                $preference_obj->fromXML($preference);
+                array_push($this->preferences, $preference_obj);
+            }
+        }
     }
 
     /**
@@ -146,7 +158,6 @@ public function toXML($addXMLDeclaration = true)
         if (isset($this->anonymous)) {
             $xml->addChild("anonymous", $this->anonymous);
         }
-
         if (isset($this->created)) {
             $xml->addChild("created", $this->created);
         }
@@ -176,6 +187,19 @@ public function toXML($addXMLDeclaration = true)
             }
         }
 
+        if (isset($this->preferences)) {
+            $preferences_field = $xml->addChild("preferences");
+            foreach ($this->preferences as $preference) {
+                $preference_field = $preferences_field->addChild("preference");
+                $preference_field->addChild("name", $preference->name);
+                $preference_field->addChild("category", $preference->category);
+                
+                XMLUtils::addChildAsCDATA($preference_field, "value", $preference->value);
+
+                $preference_field->addChild("source", $preference->source);
+            }
+        }
+
         return $xml;
     }
 
@@ -218,6 +242,14 @@ public function toString()
             $customfields = rtrim($customfields, ',');
         }
 
+        $preferences = "";
+        if (isset($this->preferences)) {
+            foreach ($this->preferences as $preference) {
+                $preferences .= $preference->toString() . ",";
+            }
+            $preferences = rtrim($preferences, ',');
+        }
+
         $permission = "";
         if (isset($this->permission)) {
             $permission = $this->permission->getCode();
@@ -227,7 +259,8 @@ public function toString()
         . $this->email . ", permission=" . $permission . ", external_id=" . $this->external_id
         . ", anonymous=" . (($this->anonymous == true) ? "true" : "false") .
         ", created=" . $this->created . ", updated=" . $this->updated
-        . ", standard_fields={" . $standard_fields . "}, customfields={" . $customfields . "}]";
+        . ", standard_fields={" . $standard_fields . "}, customfields={" . $customfields .
+        "}, preferences={" . $preferences . "}]";
     }
 
     /**
@@ -259,6 +292,16 @@ public function toCsvString()
         }
         $customfields .= "}";
 
+        // Generate preferences string
+        $preferences = "{";
+        if (isset($this->preferences)) {
+            foreach ($this->preferences as $preference) {
+                $preferences .= "{" . $preference->toCsvString() . "},";
+            }
+            $preferences = rtrim($preferences, ',');
+        }
+        $preferences .= "}";
+
         $permission = "";
         if (isset($this->permission)) {
             $permission = $this->permission->getCode();
@@ -272,6 +315,7 @@ public function toCsvString()
         . ";" . $this->created
         . ";" . $this->updated
         . ";\"" . $standard_fields . "\""
-        . ";\"" . $customfields . "\"";
+        . ";\"" . $customfields . "\""
+        . ";\"" . $preferences . "\"";
     }
 }