CC_Contact

Class that is used for ConstantConact CRUD management.

Defined (1)

The class is defined in the following location(s).

/api/cc_class.php  
  1. class CC_Contact extends CC_Utility { 
  2.  
  3. /** 
  4.  * Method that checks if a subscriber already exist 
  5.  * @param string $email 
  6.  * @return string|int subscriber`s id if it exists or false if it doesn't 
  7.  */ 
  8.  public    function subscriberExists($email = '') { 
  9.      $call = $this->apiPath.'/contacts?email='.rawurlencode( $email ); 
  10.      $return = $this->doServerCall($call); 
  11.      $xml = simplexml_load_string($return); 
  12.      $id = $xml->entry->id; 
  13.      if($id) { return $id; } 
  14.      else { return false; } 
  15.  } 
  16.  
  17.  /** 
  18.  * Method that retrieves from Constant Contact a collection with all the Subscribers 
  19.  * If email parameter is mentioned then only mentioned contact is retrieved. 
  20.  * @param string $email 
  21.  * @return array Bi-Dimenstional array with information about contacts. 
  22.  */ 
  23.  public    function getSubscribers($email = '', $page = '') { 
  24.         $contacts = array(); 
  25.         $contacts['items'] = array(); 
  26.  
  27.         if (! empty($email)) { 
  28.             $call = $this->apiPath.'/contacts?email='.rawurlencode( $email ); 
  29.         } else { 
  30.             if (! empty($page)) { 
  31.                 $call = $this->apiPath.$page; 
  32.             } else { 
  33.                 $call = $this->apiPath.'/contacts'; 
  34.             } 
  35.         } 
  36.  
  37.         $return = $this->doServerCall($call); 
  38.         $parsedReturn = simplexml_load_string($return); 
  39.         // We parse here the link array to establish which are the next page and previous page 
  40.         foreach ($parsedReturn->link as $item) { 
  41.             $attributes = $item->Attributes(); 
  42.  
  43.             if (! empty($attributes['rel']) && $attributes['rel'] == 'next') { 
  44.                 $tmp = explode($this->login, $attributes['href']); 
  45.                 $contacts['next'] = $tmp[1]; 
  46.             } 
  47.             if (! empty($attributes['rel']) && $attributes['rel'] == 'first') { 
  48.                 $tmp = explode($this->login, $attributes['href']); 
  49.                 $contacts['first'] = $tmp[1]; 
  50.             } 
  51.             if (! empty($attributes['rel']) && $attributes['rel'] == 'current') { 
  52.                 $tmp = explode($this->login, $attributes['href']); 
  53.                 $contacts['current'] = $tmp[1]; 
  54.             } 
  55.         } 
  56.  
  57.         foreach ($parsedReturn->entry as $item) { 
  58.             $tmp = array(); 
  59.             $tmp['id'] = (string) $item->id; 
  60.             $tmp['title'] = (string) $item->title; 
  61.             $tmp['status'] = (string) $item->content->Contact->Status; 
  62.             $tmp['EmailAddress'] = (string) $item->content->Contact->EmailAddress; 
  63.             $tmp['EmailType'] = (string) $item->content->Contact->EmailType; 
  64.             $tmp['Name'] = (string) $item->content->Contact->Name; 
  65.             $contacts['items'][] = $tmp; 
  66.         } 
  67.  
  68.         return $contacts; 
  69.     } 
  70.  
  71.  /** 
  72.  * Retrieves all the details for a specific contact identified by $email. 
  73.  * @param string $email 
  74.  * @return false|array with all information about the contact, or false if contact doesn't exist 
  75.  */ 
  76.  public    function getSubscriberDetails($email) { 
  77.         $contact = $this->getSubscribers($email); 
  78.          if ( empty( $contact['items'] ) ) { 
  79.              return false; 
  80.          } 
  81.         $fullContact = array(); 
  82.         $call = str_replace('http://', 'https://', $contact['items'][0]['id']); 
  83.         // Convert id URI to BASIC compliant 
  84.         $return = $this->doServerCall($call); 
  85.         $parsedReturn = simplexml_load_string($return); 
  86.         $fullContact['id'] = $parsedReturn->id; 
  87.         $fullContact['email_address'] = $parsedReturn->content->Contact->EmailAddress; 
  88.         $fullContact['first_name'] = $parsedReturn->content->Contact->FirstName; 
  89.         $fullContact['last_name'] = $parsedReturn->content->Contact->LastName; 
  90.         $fullContact['middle_name'] = $parsedReturn->content->Contact->MiddleName; 
  91.         $fullContact['company_name'] = $parsedReturn->content->Contact->CompanyName; 
  92.         $fullContact['job_title'] = $parsedReturn->content->Contact->JobTitle; 
  93.         $fullContact['home_number'] = $parsedReturn->content->Contact->HomePhone; 
  94.         $fullContact['work_number'] = $parsedReturn->content->Contact->WorkPhone; 
  95.         $fullContact['address_line_1'] = $parsedReturn->content->Contact->Addr1; 
  96.         $fullContact['address_line_2'] = $parsedReturn->content->Contact->Addr2; 
  97.         $fullContact['address_line_3'] = $parsedReturn->content->Contact->Addr3; 
  98.         $fullContact['city_name'] = (string) $parsedReturn->content->Contact->City; 
  99.         $fullContact['state_code'] = (string) $parsedReturn->content->Contact->StateCode; 
  100.         $fullContact['state_name'] = (string) $parsedReturn->content->Contact->StateName; 
  101.         $fullContact['country_code'] = $parsedReturn->content->Contact->CountryCode; 
  102.         $fullContact['zip_code'] = $parsedReturn->content->Contact->PostalCode; 
  103.         $fullContact['sub_zip_code'] = $parsedReturn->content->Contact->SubPostalCode; 
  104.         $fullContact['custom_field_1'] = $parsedReturn->content->Contact->CustomField1; 
  105.         $fullContact['custom_field_2'] = $parsedReturn->content->Contact->CustomField2; 
  106.         $fullContact['custom_field_3'] = $parsedReturn->content->Contact->CustomField3; 
  107.         $fullContact['custom_field_4'] = $parsedReturn->content->Contact->CustomField4; 
  108.         $fullContact['custom_field_5'] = $parsedReturn->content->Contact->CustomField5; 
  109.         $fullContact['custom_field_6'] = $parsedReturn->content->Contact->CustomField6; 
  110.         $fullContact['custom_field_7'] = $parsedReturn->content->Contact->CustomField7; 
  111.         $fullContact['custom_field_8'] = $parsedReturn->content->Contact->CustomField8; 
  112.         $fullContact['custom_field_9'] = $parsedReturn->content->Contact->CustomField9; 
  113.         $fullContact['custom_field_10'] = $parsedReturn->content->Contact->CustomField10; 
  114.         $fullContact['custom_field_11'] = $parsedReturn->content->Contact->CustomField11; 
  115.         $fullContact['custom_field_12'] = $parsedReturn->content->Contact->CustomField12; 
  116.         $fullContact['custom_field_13'] = $parsedReturn->content->Contact->CustomField13; 
  117.         $fullContact['custom_field_14'] = $parsedReturn->content->Contact->CustomField14; 
  118.         $fullContact['custom_field_15'] = $parsedReturn->content->Contact->CustomField15; 
  119.         $fullContact['notes'] = $parsedReturn->content->Contact->Note; 
  120.         $fullContact['mail_type'] = $parsedReturn->content->Contact->EmailType; 
  121.         $fullContact['status'] = $parsedReturn->content->Contact->Status; 
  122.         $fullContact['lists'] = array(); 
  123.  
  124.         if ($parsedReturn->content->Contact->ContactLists->ContactList) { 
  125.             foreach ($parsedReturn->content->Contact->ContactLists->ContactList as $item) { 
  126.                 $fullContact['lists'][] = trim((string) $item->Attributes()); 
  127.             } 
  128.         } 
  129.  
  130.         return $fullContact; 
  131.     } 
  132.  
  133.  /** 
  134.  * Method that modifies a contact State to DO NOT MAIL 
  135.  * @param string $email - contact email address 
  136.  * @return TRUE in case of success or FALSE otherwise 
  137.  */ 
  138.  public    function deleteSubscriber($email) { 
  139.         if ( empty($email)) {  return false;   } 
  140.         $contact = $this->getSubscribers($email); 
  141.         $id = $contact['items'][0]['id']; 
  142.         $return = $this->doServerCall($id, '', 'DELETE'); 
  143.         if (! empty($return)) {  return false;  } 
  144.         return true; 
  145.     } 
  146.  
  147.  /** 
  148.  * Method that modifies a contact State to REMOVED 
  149.  * @param string $email - contact email address 
  150.  * @return TRUE in case of success or FALSE otherwise 
  151.  */ 
  152.  public    function removeSubscriber($email) { 
  153.         $contact = $this->getSubscriberDetails($email); 
  154.         $contact['lists'] = array(); 
  155.         $xml = $this->createContactXML($contact['id'], $contact); 
  156.         if ($this->editSubscriber($contact['id'], $xml)) { 
  157.             return true; 
  158.         } else { 
  159.             return false; 
  160.         } 
  161.     } 
  162.  
  163.  /** 
  164.  * Upload a new contact to Constant Contact server 
  165.  * @param strong $contactXML - formatted XML with contact information 
  166.  * @return TRUE in case of success or FALSE otherwise 
  167.  */ 
  168.  public    function addSubscriber($contactXML) { 
  169.         $call = $this->apiPath.'/contacts'; 
  170.         $return = $this->doServerCall($call, $contactXML, 'POST'); 
  171.         $parsedReturn = simplexml_load_string($return); 
  172.  
  173.         if ($return) { 
  174.             return true; 
  175.         } else { 
  176.             $xml = simplexml_load_string($contactXML); 
  177.             $emailAddress = $xml->content->Contact->EmailAddress; 
  178.             if ($this->subscriberExists($emailAddress)) { 
  179.             $this->lastError = 'This contact already exists. <a href="edit_contact.php?email='.$emailAddress.'">Click here</a> to edit the contact details.'; 
  180.             } else { $this->lastError = 'An Error Occurred'; } 
  181.             return false; 
  182.         } 
  183.     } 
  184.  
  185.  /** 
  186.  * Modifies a contact 
  187.  * @param string $contactUrl - identifies the url for the modified contact 
  188.  * @param string $contactXML - formed XML with contact information 
  189.  * @return TRUE in case of success or FALSE otherwise 
  190.  */ 
  191.  public    function editSubscriber($contactUrl, $contactXML) { 
  192.         $return = $this->doServerCall($contactUrl, $contactXML, 'PUT'); 
  193.         if (! empty($return)) { 
  194.             if (strpos($return, '<') !== false) { 
  195.                 $parsedReturn = simplexml_load_string($return); 
  196.                 if (! empty($parsedReturn->message)) { 
  197.                     $this->lastError = $parsedReturn->message; 
  198.                 } 
  199.             } else { 
  200.                 $this->lastError = $parsedReturn->message; 
  201.             } 
  202.             return false; 
  203.         } 
  204.         return true; 
  205.     } 
  206.  
  207.  /** 
  208.  * Method that compose the needed XML format for a contact 
  209.  * @param string $id 
  210.  * @param array $params 
  211.  * @return string Formed XML 
  212.  */ 
  213.  public    function createContactXML($id, $params = array()) { 
  214.         if ( empty($id)) { 
  215.             $id = "urn:uuid:E8553C09F4xcvxCCC53F481214230867087"; 
  216.         } 
  217.  
  218.         $update_date = date("Y-m-d").'T'.date("H:i:s").'+01:00'; 
  219.         $xml_string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><entry xmlns='http://www.w3.org/2005/Atom'></entry>"; 
  220.         $xml_object = simplexml_load_string($xml_string); 
  221.         $title_node = $xml_object->addChild("title", htmlspecialchars(("TitleNode"), ENT_QUOTES, 'UTF-8')); 
  222.         $updated_node = $xml_object->addChild("updated", htmlspecialchars(($update_date), ENT_QUOTES, 'UTF-8')); 
  223.         $author_node = $xml_object->addChild("author"); 
  224.         $author_name = $author_node->addChild("name", ("CTCT Samples")); 
  225.         $id_node = $xml_object->addChild("id", htmlspecialchars(($id), ENT_QUOTES, 'UTF-8')); 
  226.         $summary_node = $xml_object->addChild("summary", htmlspecialchars(("Customer document"), ENT_QUOTES, 'UTF-8')); 
  227.         $summary_node->addAttribute("type", "text"); 
  228.         $content_node = $xml_object->addChild("content"); 
  229.         $content_node->addAttribute("type", "application/vnd.ctct+xml"); 
  230.         $contact_node = $content_node->addChild("Contact", htmlspecialchars(("Customer document"), ENT_QUOTES, 'UTF-8')); 
  231.         $contact_node->addAttribute("xmlns", "http://ws.constantcontact.com/ns/1.0/"); 
  232.         $email_node = $contact_node->addChild("EmailAddress", htmlspecialchars((@$params['email_address']), ENT_QUOTES, 'UTF-8')); 
  233.         $fname_node = $contact_node->addChild("FirstName", urldecode(htmlspecialchars((@$params['first_name']), ENT_QUOTES, 'UTF-8'))); 
  234.         $lname_node = $contact_node->addChild("LastName", urldecode(htmlspecialchars((@$params['last_name']), ENT_QUOTES, 'UTF-8'))); 
  235.         $lname_node = $contact_node->addChild("MiddleName", urldecode(htmlspecialchars((@$params['middle_name']), ENT_QUOTES, 'UTF-8'))); 
  236.         $lname_node = $contact_node->addChild("CompanyName", urldecode(htmlspecialchars((@$params['company_name']), ENT_QUOTES, 'UTF-8'))); 
  237.         $lname_node = $contact_node->addChild("JobTitle", urldecode(htmlspecialchars((@$params['job_title']), ENT_QUOTES, 'UTF-8'))); 
  238.  
  239.         if (@$params['status'] == 'Do Not Mail') { 
  240.             $this->actionBy = 'ACTION_BY_CONTACT'; 
  241.         } 
  242.  
  243.         $optin_node = $contact_node->addChild("OptInSource", htmlspecialchars($this->actionBy)); 
  244.         $hn_node = $contact_node->addChild("HomePhone", htmlspecialchars(@$params['home_number'], ENT_QUOTES, 'UTF-8')); 
  245.         $wn_node = $contact_node->addChild("WorkPhone", htmlspecialchars(@$params['work_number'], ENT_QUOTES, 'UTF-8')); 
  246.         $ad1_node = $contact_node->addChild("Addr1", htmlspecialchars(@$params['address_line_1'], ENT_QUOTES, 'UTF-8')); 
  247.         $ad2_node = $contact_node->addChild("Addr2", htmlspecialchars(@$params['address_line_2'], ENT_QUOTES, 'UTF-8')); 
  248.         $ad3_node = $contact_node->addChild("Addr3", htmlspecialchars(@$params['address_line_3'], ENT_QUOTES, 'UTF-8')); 
  249.         $city_node = $contact_node->addChild("City", htmlspecialchars(@$params['city_name'], ENT_QUOTES, 'UTF-8')); 
  250.         $state_node = $contact_node->addChild("StateCode", htmlspecialchars(@$params['state_code'], ENT_QUOTES, 'UTF-8')); 
  251.         $state_name = $contact_node->addChild("StateName", htmlspecialchars(@$params['state_name'], ENT_QUOTES, 'UTF-8')); 
  252.         $ctry_node = $contact_node->addChild("CountryCode", htmlspecialchars(@$params['country_code'], ENT_QUOTES, 'UTF-8')); 
  253.         $zip_node = $contact_node->addChild("PostalCode", htmlspecialchars(@$params['zip_code'], ENT_QUOTES, 'UTF-8')); 
  254.         $subzip_node = $contact_node->addChild("SubPostalCode", htmlspecialchars(@$params['sub_zip_code'], ENT_QUOTES, 'UTF-8')); 
  255.         $note_node = $contact_node->addChild("Note", htmlspecialchars(@$params['notes'], ENT_QUOTES, 'UTF-8')); 
  256.         $emailtype_node = $contact_node->addChild("EmailType", htmlspecialchars(@$params['mail_type'], ENT_QUOTES, 'UTF-8')); 
  257.  
  258.  
  259.         // Modified by ZK for Version 2.0.2 
  260.         for ($i = 1; $i < 16; $i++) { 
  261.             if (!empty($params['custom_field_'.$i]) && $params['custom_field_'.$i] !== 0) { 
  262.                 $content = htmlspecialchars((string)$params['custom_field_'.$i], ENT_QUOTES, 'UTF-8'); 
  263.                 $content = substr($content, 0, 50); 
  264.                 $content = preg_replace('/(.*)&([^;]+)?$/ism', '$1', $content); // This prevents unencoded endings 
  265.                 $contact_node->addChild("CustomField".$i, $content); 
  266.             } 
  267.         } 
  268.         // End modification 
  269.  
  270.         $contactlists_node = $contact_node->addChild("ContactLists"); 
  271.         if ($params['lists']) { 
  272.             foreach ($params['lists'] as $tmp) { 
  273.                 $contactlist_node = $contactlists_node->addChild("ContactList"); 
  274.                 $contactlist_node->addAttribute("id", $tmp); 
  275.             } 
  276.         } 
  277.  
  278.         $entry = $xml_object->asXML(); 
  279.         return $entry; 
  280.     } 
  281.  
  282. }