function salesforce_api_describeSObject in Salesforce Suite 7.2

Same name and namespace in other branches

1. 6.2 salesforce_api/salesforce_api.module \salesforce_api_describeSObject()
2. 7 salesforce_api/salesforce_api.module \salesforce_api_describeSObject()

Wrapper for SOAP SforceBaseClient::describeSObject Given an sf object type, return the SF Object definition

Parameters

string type : the machine-readable name of the SF object type:

1 call to salesforce_api_describeSObject()

drush_salesforce_api_soql_describe in salesforce_api/salesforce_api.drush.inc

Examine a salesforce table. Allows for deep inspection using dot syntax similar to sql databases.

File

salesforce_api/salesforce_api.module, line 1931

Defines an API that enables modules to interact with the Salesforce server.

Code

function salesforce_api_describeSObject($type) {
  if (!is_string($type)) {
    if (user_access('administer salesforce')) {
      drupal_set_message(t('DescribeSObject expects a string. ' . gettype($type) . ' received.'), 'error');
    }
    return FALSE;
  }
  $objects = salesforce_api_describeSObjects($type);
  if (!empty($objects[$type])) {
    return $objects[$type];
  }
  else {
    if (user_access('administer salesforce')) {
      drupal_set_message(t('DescribeSObject failed to find ' . $type), 'error');
    }
    return FALSE;
  }
}