Merge pull request #12 from dnadesign/feature/get-contact-improvements

Improving documentation and validation of getContact function.

src/Services/UbiquityService.php

@@ -180,26 +180,31 @@ public function call($method = null, string $uri = null, $query = null, $data =
     }
 
     /**
-     * Retrieves the ID of an existing entry if it exists
+     * Retrieves an array of subscriber data for an existing contact if it exists
      *
-     * @param Array $emailField the field containing the email address to check
-     * @return Int (ID) or false if it doesn't exist
+     * @param array The $params array should contain the fieldID of the email field (in the Ubiquity Database) and the value (an email address) of a subscriber
+     * @return array|false array of user data or false if it doesn't exist
      */
-    public function getContact($emailData)
+    public function getContact($params)
     {
+        // check the function has been passed a fieldID
+        $fieldID = (isset($params['fieldID'])) ? $params['fieldID'] : null;
+        if (!$fieldID) {
+            throw new Exception('The fieldID of the email field is required.');
+        }
+
         // get the email address submitted
-        $email = (isset($emailData['value'])) ? $emailData['value'] : null;
+        $email = (isset($params['value'])) ? $params['value'] : null;
 
         // check the email address is valid
         if (filter_var($email, FILTER_VALIDATE_EMAIL) === false) {
             throw new Exception('Email field value is not a valid email address');
         }
 
         $query = [
-            'filter' => $this->buildFilterQueryString(array($emailData))
+            'filter' => $this->buildFilterQueryString(array($params))
         ];
 
-        //self::get()?
         $response = $this->call(self::METHOD_GET, 'database/contacts', $query);
 
         if ($response->getStatusCode() !== 200) {