Documentation

SforceEnterpriseClient extends SforceBaseClient

SforceEnterpriseClient class.

Table of Contents

ENTERPRISE_NAMESPACE  = 'urn:enterprise.soap.sforce.com'
$allowFieldTruncationHeader  : mixed
$assignmentRuleHeader  : mixed
$callOptions  : mixed
$client_id  : mixed
$emailHeader  : mixed
$localeOptions  : mixed
$location  : mixed
$loginScopeHeader  : mixed
$mruHeader  : mixed
$namespace  : mixed
$packageVersionHeader  : mixed
$queryHeader  : mixed
$sessionHeader  : mixed
$sessionId  : mixed
$sforce  : mixed
$userTerritoryDeleteHeader  : mixed
$version  : mixed
__construct()  : mixed
convertLead()  : LeadConvertResult
Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
create()  : SaveResult
Adds one or more new individual objects to your organization's data.
createConnection()  : mixed
Connect method to www.salesforce.com
delete()  : DeleteResult
Deletes one or more new individual objects to your organization's data.
describeDataCategoryGroups()  : DescribeDataCategoryGroupResult
To enable data categories groups you must enable Answers or Knowledge Articles module in admin panel, after adding category group and assign it to Answers or Knowledge Articles
describeDataCategoryGroupStructures()  : DescribeLayoutResult
Retrieves available category groups along with their data category structure for objects specified in the request.
describeGlobal()  : DescribeGlobalResult
Retrieves a list of available objects for your organization's data.
describeLayout()  : DescribeLayoutResult
Use describeLayout to retrieve information about the layout (presentation of data to users) for a given object type. The describeLayout call returns metadata about a given page layout, including layouts for edit and display-only views and record type mappings. Note that field-level security and layout editability affects which fields appear in a layout.
describeSObject()  : DescribsSObjectResult
Describes metadata (field list and object properties) for the specified object.
describeSObjects()  : DescribsSObjectResult
An array-based version of describeSObject; describes metadata (field list and object properties) for the specified object or array of objects.
describeTabs()  : DescribeTabSetResult
The describeTabs call returns information about the standard apps and custom apps, if any, available for the user who sends the call, including the list of tabs defined for each app.
emptyRecycleBin()  : DeleteResult
Deletes one or more new individual objects to your organization's data.
getConnection()  : mixed
getDeleted()  : GetDeletedResult
Retrieves the list of individual objects that have been deleted within the given timespan for the specified object.
getFunctions()  : mixed
getLastRequest()  : mixed
getLastRequestHeaders()  : mixed
getLastResponse()  : mixed
getLastResponseHeaders()  : mixed
getLocation()  : mixed
getNamespace()  : mixed
getServerTimestamp()  : timestamp
Retrieves the current system timestamp (GMT) from the Web service.
getSessionId()  : mixed
getTypes()  : mixed
getUpdated()  : GetUpdatedResult
Retrieves the list of individual objects that have been updated (added or changed) within the given timespan for the specified object.
getUserInfo()  : mixed
invalidateSessions()  : invalidateSessionsResult
invalidate Sessions from the salseforce system`
login()  : LoginResult
Login to Salesforce.com and starts a client session.
logout()  : LogoutResult
log outs from the salseforce system`
merge()  : unknown
Merge records
printDebugInfo()  : mixed
processSubmitRequest()  : ProcessResult
Process Submit Request for Approval
processWorkitemRequest()  : ProcessResult
Process Work Item Request for Approval
query()  : QueryResult
Executes a query against the specified object and returns data that matches the specified criteria.
queryAll()  : QueryResult
Retrieves data from specified objects, whether or not they have been deleted.
queryMore()  : QueryResult
Retrieves the next batch of objects from a query.
resetPassword()  : password
Changes a user's password to a system-generated value.
retrieve()  : array<string|int, sObject>
Retrieves one or more objects based on the specified object IDs.
search()  : SearchResult
Executes a text search in your organization's data.
sendMassEmail()  : mixed
sendSingleEmail()  : mixed
setAllowFieldTruncationHeader()  : mixed
setAssignmentRuleHeader()  : mixed
setCallOptions()  : mixed
setEmailHeader()  : mixed
setEndpoint()  : mixed
Set the endpoint.
setLocaleOptions()  : mixed
setLoginScopeHeader()  : mixed
setMruHeader()  : mixed
setPackageVersionHeader()  : mixed
setPassword()  : mixed
Sets the specified user's password to the specified value.
setQueryOptions()  : mixed
setSessionHeader()  : mixed
setUserTerritoryDeleteHeader()  : mixed
undelete()  : DeleteResult
Deletes one or more new individual objects to your organization's data.
update()  : UpdateResult
Updates one or more new individual objects to your organization's data.
upsert()  : UpsertResult
Creates new objects and updates existing objects; uses a custom field to determine the presence of existing objects. In most cases, we recommend that you use upsert instead of create because upsert is idempotent.
_convertToAny()  : mixed
_create()  : mixed
_merge()  : mixed
_process()  : mixed
_sendEmail()  : mixed
_setLoginHeader()  : mixed
Specifies the session ID returned from the login server after a successful login.
_update()  : mixed
_upsert()  : mixed
getSoapClient()  : mixed
setHeaders()  : mixed

Constants

Properties

Methods

convertLead()

Converts a Lead into an Account, Contact, or (optionally) an Opportunity.

public convertLead(array<string|int, mixed> $leadConverts) : LeadConvertResult
Parameters
$leadConverts : array<string|int, mixed>

Array of LeadConvert

Return values
LeadConvertResult

create()

Adds one or more new individual objects to your organization's data.

public create(array<string|int, mixed> $sObjects, mixed $type) : SaveResult
Parameters
$sObjects : array<string|int, mixed>

Array of one or more sObjects (up to 200) to create.

$type : mixed
Return values
SaveResult

createConnection()

Connect method to www.salesforce.com

public createConnection(string $wsdl[, object $proxy = null ][, array<string|int, mixed> $soap_options = array() ]) : mixed
Parameters
$wsdl : string

Salesforce.com Partner WSDL

$proxy : object = null

(optional) proxy settings with properties host, port, login and password

$soap_options : array<string|int, mixed> = array()

(optional) Additional options to send to the SoapClient constructor. @see http://php.net/manual/en/soapclient.soapclient.php

Return values
mixed

delete()

Deletes one or more new individual objects to your organization's data.

public delete(array<string|int, mixed> $ids) : DeleteResult
Parameters
$ids : array<string|int, mixed>

Array of fields

Return values
DeleteResult

describeDataCategoryGroups()

To enable data categories groups you must enable Answers or Knowledge Articles module in admin panel, after adding category group and assign it to Answers or Knowledge Articles

public describeDataCategoryGroups(string $sObjectType) : DescribeDataCategoryGroupResult
Parameters
$sObjectType : string

sObject Type

Return values
DescribeDataCategoryGroupResult

describeDataCategoryGroupStructures()

Retrieves available category groups along with their data category structure for objects specified in the request.

public describeDataCategoryGroupStructures(DataCategoryGroupSobjectTypePair $pairs, bool $topCategoriesOnly) : DescribeLayoutResult
Parameters
$pairs : DataCategoryGroupSobjectTypePair
$topCategoriesOnly : bool

Object Type

Return values
DescribeLayoutResult

describeGlobal()

Retrieves a list of available objects for your organization's data.

public describeGlobal() : DescribeGlobalResult
Return values
DescribeGlobalResult

describeLayout()

Use describeLayout to retrieve information about the layout (presentation of data to users) for a given object type. The describeLayout call returns metadata about a given page layout, including layouts for edit and display-only views and record type mappings. Note that field-level security and layout editability affects which fields appear in a layout.

public describeLayout(mixed $type[, array<string|int, mixed> $recordTypeIds = null ]) : DescribeLayoutResult
Parameters
$type : mixed
$recordTypeIds : array<string|int, mixed> = null
Return values
DescribeLayoutResult

describeSObject()

Describes metadata (field list and object properties) for the specified object.

public describeSObject(string $type) : DescribsSObjectResult
Parameters
$type : string

Object type

Return values
DescribsSObjectResult

describeSObjects()

An array-based version of describeSObject; describes metadata (field list and object properties) for the specified object or array of objects.

public describeSObjects(array<string|int, mixed> $arrayOfTypes) : DescribsSObjectResult
Parameters
$arrayOfTypes : array<string|int, mixed>

Array of object types.

Return values
DescribsSObjectResult

describeTabs()

The describeTabs call returns information about the standard apps and custom apps, if any, available for the user who sends the call, including the list of tabs defined for each app.

public describeTabs() : DescribeTabSetResult
Return values
DescribeTabSetResult

emptyRecycleBin()

Deletes one or more new individual objects to your organization's data.

public emptyRecycleBin(array<string|int, mixed> $ids) : DeleteResult
Parameters
$ids : array<string|int, mixed>

Array of fields

Return values
DeleteResult

getDeleted()

Retrieves the list of individual objects that have been deleted within the given timespan for the specified object.

public getDeleted(string $type, date $startDate, date $endDate) : GetDeletedResult
Parameters
$type : string

Ojbect type

$startDate : date

Start date

$endDate : date

End Date

Return values
GetDeletedResult

getLastRequest()

public getLastRequest() : mixed
Return values
mixed

getLastRequestHeaders()

public getLastRequestHeaders() : mixed
Return values
mixed

getLastResponse()

public getLastResponse() : mixed
Return values
mixed

getLastResponseHeaders()

public getLastResponseHeaders() : mixed
Return values
mixed

getServerTimestamp()

Retrieves the current system timestamp (GMT) from the Web service.

public getServerTimestamp() : timestamp
Return values
timestamp

getUpdated()

Retrieves the list of individual objects that have been updated (added or changed) within the given timespan for the specified object.

public getUpdated(string $type, date $startDate, date $endDate) : GetUpdatedResult
Parameters
$type : string

Ojbect type

$startDate : date

Start date

$endDate : date

End Date

Return values
GetUpdatedResult

invalidateSessions()

invalidate Sessions from the salseforce system`

public invalidateSessions() : invalidateSessionsResult
Return values
invalidateSessionsResult

login()

Login to Salesforce.com and starts a client session.

public login(string $username, string $password) : LoginResult
Parameters
$username : string

Username

$password : string

Password

Return values
LoginResult

logout()

log outs from the salseforce system`

public logout() : LogoutResult
Return values
LogoutResult

merge()

Merge records

public merge(stdclass $mergeRequest, string $type) : unknown
Parameters
$mergeRequest : stdclass
$type : string
Return values
unknown

printDebugInfo()

public printDebugInfo() : mixed
Return values
mixed

processSubmitRequest()

Process Submit Request for Approval

public processSubmitRequest(array<string|int, mixed> $processRequestArray) : ProcessResult
Parameters
$processRequestArray : array<string|int, mixed>
Return values
ProcessResult

processWorkitemRequest()

Process Work Item Request for Approval

public processWorkitemRequest(array<string|int, mixed> $processRequestArray) : ProcessResult
Parameters
$processRequestArray : array<string|int, mixed>
Return values
ProcessResult

query()

Executes a query against the specified object and returns data that matches the specified criteria.

public query(string $query) : QueryResult
Parameters
$query : string

Query String

Return values
QueryResult

queryAll()

Retrieves data from specified objects, whether or not they have been deleted.

public queryAll(string $query[, QueryOptions $queryOptions = NULL ]) : QueryResult
Parameters
$query : string

Query String

$queryOptions : QueryOptions = NULL

Batch size limit. OPTIONAL

Return values
QueryResult

queryMore()

Retrieves the next batch of objects from a query.

public queryMore(QueryLocator $queryLocator) : QueryResult
Parameters
$queryLocator : QueryLocator

Represents the server-side cursor that tracks the current processing location in the query result set.

Return values
QueryResult

resetPassword()

Changes a user's password to a system-generated value.

public resetPassword(string $userId) : password
Parameters
$userId : string

Id of the User

Return values
password

retrieve()

Retrieves one or more objects based on the specified object IDs.

public retrieve(string $fieldList, string $sObjectType, array<string|int, mixed> $ids) : array<string|int, sObject>
Parameters
$fieldList : string

One or more fields separated by commas.

$sObjectType : string

Object from which to retrieve data.

$ids : array<string|int, mixed>

Array of one or more IDs of the objects to retrieve.

Return values
array<string|int, sObject>

Executes a text search in your organization's data.

public search(string $searchString) : SearchResult
Parameters
$searchString : string

Search string that specifies the text expression to search for.

Return values
SearchResult

sendMassEmail()

public sendMassEmail(mixed $request) : mixed
Parameters
$request : mixed
Return values
mixed

sendSingleEmail()

public sendSingleEmail(mixed $request) : mixed
Parameters
$request : mixed
Return values
mixed

setAllowFieldTruncationHeader()

public setAllowFieldTruncationHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setAssignmentRuleHeader()

public setAssignmentRuleHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setCallOptions()

public setCallOptions(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setEmailHeader()

public setEmailHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setEndpoint()

Set the endpoint.

public setEndpoint(string $location) : mixed
Parameters
$location : string

Location

Return values
mixed

setLocaleOptions()

public setLocaleOptions(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setLoginScopeHeader()

public setLoginScopeHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setMruHeader()

public setMruHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setPackageVersionHeader()

public setPackageVersionHeader( $header) : mixed
Parameters
$header :
Return values
mixed

setPassword()

Sets the specified user's password to the specified value.

public setPassword(string $userId, string $password) : mixed
Parameters
$userId : string

ID of the User.

$password : string

New password

Return values
mixed

setQueryOptions()

public setQueryOptions(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

setSessionHeader()

public setSessionHeader(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

setUserTerritoryDeleteHeader()

public setUserTerritoryDeleteHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

undelete()

Deletes one or more new individual objects to your organization's data.

public undelete(array<string|int, mixed> $ids) : DeleteResult
Parameters
$ids : array<string|int, mixed>

Array of fields

Return values
DeleteResult

update()

Updates one or more new individual objects to your organization's data.

public update(mixed $sObjects, mixed $type[, AssignmentRuleHeader $assignment_header = NULL ][, MruHeader $mru_header = NULL ]) : UpdateResult
Parameters
$sObjects : mixed
$type : mixed
$assignment_header : AssignmentRuleHeader = NULL

is optional. Defaults to NULL

$mru_header : MruHeader = NULL

is optional. Defaults to NULL

Return values
UpdateResult

upsert()

Creates new objects and updates existing objects; uses a custom field to determine the presence of existing objects. In most cases, we recommend that you use upsert instead of create because upsert is idempotent.

public upsert(string $ext_Id, array<string|int, mixed> $sObjects[, string $type = 'Contact' ]) : UpsertResult

Available in the API version 7.0 and later.

Parameters
$ext_Id : string

External Id

$sObjects : array<string|int, mixed>

Array of sObjects

$type : string = 'Contact'

The type of objects being upserted.

Return values
UpsertResult

_convertToAny()

protected _convertToAny(mixed $fields) : mixed
Parameters
$fields : mixed
Return values
mixed

_create()

protected _create(mixed $arg) : mixed
Parameters
$arg : mixed
Return values
mixed

_merge()

protected _merge(mixed $arg) : mixed
Parameters
$arg : mixed
Return values
mixed

_process()

protected _process(mixed $arg) : mixed
Parameters
$arg : mixed
Return values
mixed

_sendEmail()

protected _sendEmail(mixed $arg) : mixed
Parameters
$arg : mixed
Return values
mixed

_setLoginHeader()

Specifies the session ID returned from the login server after a successful login.

protected _setLoginHeader(mixed $loginResult) : mixed
Parameters
$loginResult : mixed
Return values
mixed

_update()

protected _update(mixed $arg) : mixed
Parameters
$arg : mixed
Return values
mixed

_upsert()

protected _upsert(mixed $arg) : mixed
Parameters
$arg : mixed
Return values
mixed

getSoapClient()

protected getSoapClient(mixed $wsdl, mixed $options) : mixed
Parameters
$wsdl : mixed
$options : mixed
Return values
mixed

setHeaders()

private setHeaders([mixed $call = NULL ]) : mixed
Parameters
$call : mixed = NULL
Return values
mixed

Search results