Docs For Class SforceBaseClient

method convertLead [line 441]

LeadConvertResult convertLead(
array
$leadConverts)

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

Tags:

access:

public

Parameters:

array

$leadConverts

Array of LeadConvert

[ Top ]

method createConnection [line 94]

void createConnection(
string
$wsdl, [
$proxy = null])

Connect method to www.salesforce.com

Tags:

access:

public

Parameters:

string	$wsdl	Salesforce.com Partner WSDL
	$proxy

[ Top ]

method delete [line 454]

DeleteResult delete(
array
$ids)

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

Tags:

access:

public

Parameters:

array

$ids

Array of fields

[ Top ]

method describeGlobal [line 530]

DescribeGlobalResult describeGlobal(
)

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

Tags:

access:

public

[ Top ]

method describeLayout [line 545]

DescribeLayoutResult describeLayout(
string
$type)

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.

Tags:

access:

public

Parameters:

string

$type

Type Object Type

[ Top ]

method describeSObject [line 559]

DescribsSObjectResult describeSObject(
string
$type)

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

Tags:

access:

public

Parameters:

string

$type

Object type

[ Top ]

method describeSObjects [line 573]

DescribsSObjectResult describeSObjects(
array
$arrayOfTypes)

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

Tags:

access:

public

Parameters:

array

$arrayOfTypes

Array of object types.

[ Top ]

method describeTabs [line 585]

DescribeTabSetResult 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.

Tags:

access:

public

[ Top ]

method emptyRecycleBin [line 480]

DeleteResult emptyRecycleBin(
array
$ids)

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

Tags:

access:

public

Parameters:

array

$ids

Array of fields

[ Top ]

method getConnection [line 338]

void getConnection(
)

Tags:

access:

public

[ Top ]

method getDeleted [line 599]

GetDeletedResult getDeleted(
string
$type, date
$startDate, date
$endDate)

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

Tags:

access:

public

Parameters:

string	$type	Ojbect type
date	$startDate	Start date
date	$endDate	End Date

[ Top ]

method getFunctions [line 342]

void getFunctions(
)

Tags:

access:

public

[ Top ]

method getLastRequest [line 350]

void getLastRequest(
)

Tags:

access:

public

[ Top ]

method getLastRequestHeaders [line 354]

void getLastRequestHeaders(
)

Tags:

access:

public

[ Top ]

method getLastResponse [line 358]

void getLastResponse(
)

Tags:

access:

public

[ Top ]

method getLastResponseHeaders [line 362]

void getLastResponseHeaders(
)

Tags:

access:

public

[ Top ]

method getLocation [line 334]

void getLocation(
)

Tags:

access:

public

[ Top ]

method getNamespace [line 59]

void getNamespace(
)

Tags:

access:

public

[ Top ]

method getServerTimestamp [line 724]

timestamp getServerTimestamp(
)

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

Tags:

access:

public

[ Top ]

method getSessionId [line 330]

void getSessionId(
)

Tags:

access:

public

[ Top ]

method getTypes [line 346]

void getTypes(
)

Tags:

access:

public

[ Top ]

method getUpdated [line 617]

GetUpdatedResult getUpdated(
string
$type, date
$startDate, date
$endDate)

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

Tags:

access:

public

Parameters:

string	$type	Ojbect type
date	$startDate	Start date
date	$endDate	End Date

[ Top ]

method getUserInfo [line 729]

void getUserInfo(
)

Tags:

access:

public

[ Top ]

method login [line 144]

LoginResult login(
string
$username, string
$password)

Tags:

access:

public

Parameters:

string	$username	Username
string	$password	Password

[ Top ]

method printDebugInfo [line 70]

void printDebugInfo(
)

Tags:

access:

public

[ Top ]

method processSubmitRequest [line 493]

ProcessResult processSubmitRequest(
array
$processRequestArray)

Process Submit Request for Approval

Tags:

access:

public

Parameters:

array

$processRequestArray

[ Top ]

method processWorkitemRequest [line 512]

ProcessResult processWorkitemRequest(
array
$processRequestArray)

Process Work Item Request for Approval

Tags:

access:

public

Parameters:

array

$processRequestArray

[ Top ]

method query [line 634]

QueryResult query(
String
$query, QueryOptions
$queryOptions)

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

Tags:

access:

public

Parameters:

String	$query	Query String
QueryOptions	$queryOptions	Batch size limit. OPTIONAL

[ Top ]

method queryAll [line 666]

QueryResult queryAll(
String
$query, [QueryOptions
$queryOptions = NULL])

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

Tags:

access:

public

Parameters:

String	$query	Query String
QueryOptions	$queryOptions	Batch size limit. OPTIONAL

[ Top ]

method queryMore [line 650]

QueryResult queryMore(
QueryLocator
$queryLocator, QueryOptions
$queryOptions)

Retrieves the next batch of objects from a query.

Tags:

access:

public

Parameters:

QueryLocator	$queryLocator	Represents the server-side cursor that tracks the current processing location in the query result set.
QueryOptions	$queryOptions	Batch size limit. OPTIONAL

[ Top ]

method resetPassword [line 754]

password resetPassword(
string
$userId)

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

Tags:

access:

public

Parameters:

string

$userId

Id of the User

[ Top ]

method retrieve [line 697]

sObject[] retrieve(
string
$fieldList, string
$sObjectType, array
$ids)

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

Tags:

access:

public

Parameters:

string	$fieldList	One or more fields separated by commas.
string	$sObjectType	Object from which to retrieve data.
array	$ids	Array of one or more IDs of the objects to retrieve.

[ Top ]

method search [line 712]

SearchResult search(
string
$searchString)

Executes a text search in your organization's data.

Tags:

access:

public

Parameters:

string

$searchString

Search string that specifies the text expression to search for.

[ Top ]

method sendMassEmail [line 414]

void sendMassEmail(

$request)

Parameters:

$request

[ Top ]

method sendSingleEmail [line 399]

void sendSingleEmail(

$request)

Parameters:

$request

[ Top ]

method setAssignmentRuleHeader [line 253]

void setAssignmentRuleHeader(

$header)

Tags:

access:

public

Parameters:

$header

[ Top ]

method setCallOptions [line 125]

void setCallOptions(

$header)

Tags:

access:

public

Parameters:

$header

[ Top ]

method setEmailHeader [line 264]

void setEmailHeader(

$header)

Tags:

access:

public

Parameters:

$header

[ Top ]

method setEndpoint [line 177]

void setEndpoint(
string
$location)

Set the endpoint.

Tags:

access:

public

Parameters:

string

$location

Location

[ Top ]

method setLoginScopeHeader [line 276]

void setLoginScopeHeader(

$header)

Tags:

access:

public

Parameters:

$header

[ Top ]

method setMruHeader [line 288]

void setMruHeader(

$header)

Tags:

access:

public

Parameters:

$header

[ Top ]

method setPassword [line 740]

void setPassword(
string
$userId, string
$password)

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

Tags:

access:

public

Parameters:

string	$userId	ID of the User.
string	$password	New password

[ Top ]

method setQueryOptions [line 320]

void setQueryOptions(

$header)

Tags:

access:

public

Parameters:

$header

[ Top ]

method setSessionHeader [line 298]

void setSessionHeader(

$id)

Tags:

access:

public

Parameters:

$id

[ Top ]

method setUserTerritoryDeleteHeader [line 310]

void setUserTerritoryDeleteHeader(

$header)

Tags:

access:

public

Parameters:

$header

[ Top ]

method undelete [line 467]

DeleteResult undelete(
array
$ids)

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

Tags:

access:

public

Parameters:

array

$ids

Array of fields

[ Top ]

method _convertToAny [line 366]

void _convertToAny(

$fields)

Tags:

access:

protected

Parameters:

$fields

[ Top ]

method _create [line 374]

void _create(

$arg)

Tags:

access:

protected

Parameters:

$arg

[ Top ]

method _merge [line 379]

void _merge(

$arg)

Tags:

access:

protected

Parameters:

$arg

[ Top ]

method _process [line 384]

void _process(

$arg)

Tags:

access:

protected

Parameters:

$arg

[ Top ]

method _sendEmail [line 429]

void _sendEmail(

$arg)

Tags:

access:

protected

Parameters:

$arg

[ Top ]

method _setLoginHeader [line 165]

void _setLoginHeader(

$loginResult)

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

Tags:

access:

protected

Parameters:

$loginResult

[ Top ]

method _update [line 389]

void _update(

$arg)

Tags:

access:

protected

Parameters:

$arg

[ Top ]

method _upsert [line 394]

void _upsert(

$arg)

Tags:

access:

protected

Parameters:

$arg

[ Top ]

Class: SforceBaseClient

Class Overview

Variables

Methods

Child classes:

Class Details

Class Variables

$assignmentRuleHeader =

Tags:

$callOptions =

Tags:

$client_id =

Tags:

$emailHeader =

Tags:

$location =

Tags:

$loginScopeHeader =

Tags:

$mruHeader =

Tags:

$namespace =

Tags:

$queryHeader =

Tags:

$sessionHeader =

Tags:

$sessionId =

Tags:

$sforce =

Tags:

$userTerritoryDeleteHeader =

Tags:

$version = '11.0'

Tags:

Class Methods

method convertLead [line 441]

Tags:

Parameters:

method createConnection [line 94]

Tags:

Parameters:

method delete [line 454]

Tags:

Parameters:

method describeGlobal [line 530]

Tags:

method describeLayout [line 545]

Tags:

Parameters:

method describeSObject [line 559]

Tags:

Parameters:

method describeSObjects [line 573]

Tags:

Parameters:

method describeTabs [line 585]

Tags:

method emptyRecycleBin [line 480]

Tags:

Parameters:

method getConnection [line 338]

Tags:

method getDeleted [line 599]

Tags:

Parameters:

method getFunctions [line 342]

Tags:

method getLastRequest [line 350]

Tags:

method getLastRequestHeaders [line 354]

Tags:

method getLastResponse [line 358]

Tags:

method getLastResponseHeaders [line 362]

Tags:

method getLocation [line 334]

Tags:

method getNamespace [line 59]

Tags: