class ConstantContact in Constant Contact 5

Class to interact with the constant contact API This class enables you to easily subscribe and unsubscribe members

@package ConstantContact @license http://www.php.net/license/3_01.txt PHP License 3.01 @author James Benson @link http://www.jamesbenson.co.uk

Hierarchy

• class \ConstantContact

See also

http://www.constantcontact.com

File

./ConstantContact.php, line 38

class ConstantContact {

  /**
   * API URL used to subscribe
   *
   * @var        string
   */
  var $add_subscriber_url = "http://ui.constantcontact.com/roving/wdk/API_AddSiteVisitor.jsp";

  /**
   * API URL used to unsubscribe
   *
   * @var        string
   */
  var $remove_subscriber_url = 'http://ui.constantcontact.com/roving/wdk/API_UnsubscribeSiteVisitor.jsp';

  /**
   * Your CC account username
   *
   * @var        string
   */
  var $_username = '';

  /**
   * Your CC account password
   *
   * @var        string
   */
  var $_password = '';

  /**
   * The category to subscribe a member to
   *
   * @var        string
   */
  var $_category = '';

  /**
   * Sets the username used to access the CC API
   *
   * @param    string    The username for your CC account
   */
  function setUsername($username) {
    $this->username = $username;
  }

  /**
   * Sets the password used to access the CC API
   *
   * @param    string    The password for your CC account
   */
  function setPassword($password) {
    $this->password = $password;
  }

  /**
   * Sets the category used to add subscribers into
   *
   * @param    string    The interest category subscribers are added to
   */
  function setCategory($category) {
    $this->category = $category;
  }

  /**
   * Get the username used to access the CC API
   *
   */
  function getUsername() {
    return urlencode($this->username);
  }

  /**
   * Get the password used to access the CC API
   *
   */
  function getPassword() {
    return urlencode($this->password);
  }

  /**
   * Get the interest category
   *
   */
  function getCategory() {
    return urlencode($this->category);
  }

  /**
   * Add a subscriber to your constant contact account, can be used to update their details too
   *
   *
   * @param     string    The email to subscribe
   * @param     array     An array of extra fields to pass to CC, see docs for possible values
   * @return    bool      true on success false on failure
   */
  function add($email, $extra_fields = array()) {
    $email = urlencode(strip_tags($email));
    $data = 'loginName=' . $this
      ->getUsername();
    $data .= '&loginPassword=' . $this
      ->getPassword();
    $data .= '&ea=' . $email;
    $data .= '&ic=' . $this
      ->getCategory();
    if (is_array($extra_fields)) {
      foreach ($extra_fields as $k => $v) {
        $data .= "&" . urlencode(strip_tags($k)) . "=" . urlencode(strip_tags($v));
      }
    }
    return $this
      ->_send($data, $this->add_subscriber_url);
  }

  /**
   * Remove a subscriber from your constant contact account
   *
   *
   * @param     string    The email to unsubscribe
   * @return    bool      true on success false on failure
   */
  function remove($email) {
    $email = urlencode(strip_tags($email));
    $data = 'loginName=' . $this
      ->getUsername();
    $data .= '&loginPassword=' . $this
      ->getPassword();
    $data .= '&ea=' . $email;
    return $this
      ->_send($data, $this->remove_subscriber_url);
  }

  /**
   * Method used to send the data to the CC server
   *
   * @access        private
   */
  function _send($data, $url) {
    if (!function_exists('fopen')) {
      exit("fopen function does not exist");
    }
    if (!ini_get('allow_url_fopen')) {
      @ini_set('allow_url_fopen', '1');
    }
    if (!ini_get('allow_url_fopen')) {
      exit("allow_url_fopen is not enabled in your php config file");
    }
    $handle = fopen("{$url}?{$data}", "rb");
    $contents = '';
    while (!feof($handle)) {
      $contents .= fread($handle, 192);
    }
    fclose($handle);
    if (trim($contents) == 0) {
      return true;
    }
    return false;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConstantContact::$add_subscriber_url		property	API URL used to subscribe
ConstantContact::$remove_subscriber_url		property	API URL used to unsubscribe
ConstantContact::$_category		property	The category to subscribe a member to
ConstantContact::$_password		property	Your CC account password
ConstantContact::$_username		property	Your CC account username
ConstantContact::add		function	Add a subscriber to your constant contact account, can be used to update their details too
ConstantContact::getCategory		function	Get the interest category
ConstantContact::getPassword		function	Get the password used to access the CC API
ConstantContact::getUsername		function	Get the username used to access the CC API
ConstantContact::remove		function	Remove a subscriber from your constant contact account
ConstantContact::setCategory		function	Sets the category used to add subscribers into
ConstantContact::setPassword		function	Sets the password used to access the CC API
ConstantContact::setUsername		function	Sets the username used to access the CC API
ConstantContact::_send		function	Method used to send the data to the CC server