class DrupalSalesforce in Salesforce Suite 7

Hierarchy

• class \DrupalSalesforce

File

salesforce_api/salesforce.class.inc, line 14

Defines the class used for communicating with the Salesforce server.

class DrupalSalesforce {

  // Define the object object used to connect to Salesforce.
  public $client;

  // Define variables for the API credentials.
  public $username = '';
  public $password = '';
  public $token = '';

  /**
   * Constructs a DrupalSalesforce object with a set of API credentials.
   *
   * @param $username
   *   The username used to login to Salesforce; should be an e-mail address.
   * @param $password
   *   The password used to login to Salesforce.
   * @param $token
   *   The security token appended to the password for logging in via the web
   *     service. Set by logging into Salesforce and navigating to Setup >
   *     My Personal Information > Reset My Security Token.
   */
  function __construct($username, $password, $token) {

    // Set the appropriate member values.
    $this->username = $username;
    $this->password = $password;
    $this->token = $token;

    // Create the client object.
    $this->client = new SforceEnterpriseClient();
  }

  /**
   * Establishes a connection and logs in to the Salesforce server.
   *
   * @return
   *   TRUE or FALSE indicating the success of the login.
   */
  function login() {

    // Default to the WSDL downloaded from the user account if available.
    $wsdl = SALESFORCE_DIR_WSDL . '/enterprise.wsdl.xml';

    // Otherwise fall back to the one included with the Toolkit.
    if (!file_exists($wsdl)) {
      $wsdl = SALESFORCE_DIR_SOAPCLIENT . '/enterprise.wsdl.xml';
    }

    // Connect to the server and login, logging any failures to the watchdog.
    try {

      // Connect to the server.
      $this->client
        ->createConnection($wsdl);

      // Attempt a login with the credentials entered by the user.
      $this->login = $this->client
        ->login($this->username, $this->password . $this->token);

      // Log the login occurence.
      $this
        ->watchdog(SALESFORCE_LOG_ALL, '@user (@email) logged into Salesforce.', array(
        '@user' => $this->login->userInfo->userFullName,
        '@email' => $this->login->userInfo->userEmail,
      ));
    } catch (Exception $e) {

      // Log the error message.
      $this
        ->watchdog(SALESFORCE_LOG_SOME, 'Could not login to Salesforce: %message. <pre>!debug</pre>', array(
        '%message' => $e->faultstring,
        '!debug' => check_plain($this->client
          ->getLastRequest()),
      ), WATCHDOG_ERROR);

      // Indicate the failed login.
      return FALSE;
    }

    // Indicate the successful login.
    return TRUE;
  }

  /**
   * Logs a message to the watchdog based on the Salesforce log settings.
   *
   * @param $level
   * @param $message
   * @param $vars
   * @param $severity
   * @param $link
   */
  static function watchdog($level, $message, $vars = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {

    // Log nothing for notices if the related log level is not greater than or
    // equal to the level of this message.
    switch ($severity) {
      case WATCHDOG_NOTICE:
        if (variable_get('salesforce_api_activity_log', SALESFORCE_LOG_SOME) < $level) {
          return;
        }
        break;
      case WATCHDOG_WARNING:
      case WATCHDOG_ERROR:
        if (variable_get('salesforce_api_error_log', SALESFORCE_LOG_ALL) < $level) {
          return;
        }
        break;
      default:
        break;
    }

    // Log the message to the watchdog.
    watchdog('salesforce', $message, $vars, $severity, $link);
  }

  /**
   * Retrieves an object from Salesforce with standard fields and any data in
   *   fields defined in the fieldmap object.
   *
   * @param $ids
   *   An array of Salesforce IDs for the objects to retrieve.
   * @param $fieldmap
   *   The fieldmap through which to filter the data.
   * @return
   *   The single matching Salesforce objects or an array of all the objects
   *     if more than one are returned.
   */
  function retrieve($ids, $fieldmap) {

    // Load the fieldmap so we can get the object name.
    $map = salesforce_api_fieldmap_load($fieldmap);
    $object = salesforce_api_fieldmap_objects_load('salesforce', 'salesforce', $map['salesforce']);
    $fields = array_keys($object['fields']);
    return $this->client
      ->retrieve(implode(', ', $fields), $map['salesforce'], $ids);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DrupalSalesforce::$client	public	property
DrupalSalesforce::$password	public	property
DrupalSalesforce::$token	public	property
DrupalSalesforce::$username	public	property
DrupalSalesforce::login		function	Establishes a connection and logs in to the Salesforce server.
DrupalSalesforce::retrieve		function	Retrieves an object from Salesforce with standard fields and any data in fields defined in the fieldmap object.
DrupalSalesforce::watchdog	static	function	Logs a message to the watchdog based on the Salesforce log settings.
DrupalSalesforce::__construct		function	Constructs a DrupalSalesforce object with a set of API credentials.