phpforce / soap-client
A PHP client for the Salesforce SOAP API
Installs: 1 894 241
Dependents: 8
Suggesters: 0
Security: 0
Stars: 81
Watchers: 15
Forks: 75
Open Issues: 23
Requires
- php: >=5.3.0
- phpforce/common: dev-master
- psr/log: *
Requires (Dev)
- doctrine/common: >=2.3
Suggests
- doctrine/common: For caching SOAP responses
- monolog/monolog: For logging SOAP transactions
This package is auto-updated.
Last update: 2024-12-06 09:02:38 UTC
README
###I’m looking for maintainers!
PHPForce Soap Client: a PHP client for the Salesforce SOAP API
Introduction
This library is a client for the Salesforce SOAP API, and intended as a replacement for the Force.com Tookit for PHP.
Features
This library’s features include the following.
- Automatic conversion between PHP and SOAP date and datetime objects.
- Automatic conversion of Salesforce (UTC) times to your local timezone.
- Easily extensible through events: add custom logging, caching, error handling etc.
- Iterating over large results sets that require multiple calls to the API is easy through the record iterator.
- The BulkSaver helps you stay within your Salesforce API limits by using bulk creates, deletes, updates and upserts.
- Completely unit tested (still working on that one).
- Use the client in conjunction with the Symfony2 Mapper Bundle to get even easier access to your Salesforce data.
Installation
This library is available on Packagist. The recommended way to install this library is through Composer:
$ php composer.phar require phpforce/soap-client dev-master
Usage
The client
Use the client to query and manipulate your organisation’s Salesforce data. First construct a client using the builder:
$builder = new \Phpforce\SoapClient\ClientBuilder( '/path/to/your/salesforce/wsdl/sandbox.enterprise.wsdl.xml', 'username', 'password', 'security_token' ); $client = $builder->build();
SOQL queries
$results = $client->query('select Name, SystemModstamp from Account limit 5');
This will fetch five accounts from Salesforce and return them as a
RecordIterator
. You can now iterate over the results. The account’s
SystemModstamp
is returned as a \DateTime
object:
foreach ($results as $account) { echo 'Last modified: ' . $account->SystemModstamp->format('Y-m-d H:i:') . "\n"; }
One-to-many relations (subqueries)
Results from subqueries are themselves returned as record iterators. So:
$accounts = $client->query( 'select Id, (select Id, Name from Contacts) from Account limit 10' ); foreach ($accounts as $account) { if (isset($account->Contacts)) { foreach ($account->Contacts as $contact) { echo sprintf("Contact %s has name %s\n", $contact->Id, $contact->Name); } } }
Fetching large numbers of records
If you issue a query that returns over 2000 records, only the first 2000 records
will be returned by the Salesforce API. Using the queryLocator
, you can then
fetch the following results in batches of 2000. The record iterator does this
automatically for you:
$accounts = $client->query('Select Name from Account'); echo $accounts->count() . ' accounts returned'; foreach ($accounts as $account) { // This will iterate over the 2000 first accounts, then fetch the next 2000 // and iterate over these, etc. In the end, all your organisations’s accounts // will be iterated over. }
Logging
To enable logging for the client, call withLog()
on the builder. For instance when using Monolog:
$log = new \Monolog\Logger('name'); $log->pushHandler(new \Monolog\Handler\StreamHandler('path/to/your.log')); $builder = new \Phpforce\SoapClient\ClientBuilder( '/path/to/your/salesforce/wsdl/sandbox.enterprise.wsdl.xml', 'username', 'password', 'security_token' ); $client = $builder->withLog($log) ->build();
All requests to the Salesforce API, as well as the responses and any errors that it returns, will now be logged.