wakeonweb/salesforce-client

WakeOnWeb Salesforce client

v1.0.4 2018-08-27 08:02 UTC

This package is auto-updated.

Last update: 2022-08-08 02:59:41 UTC


README

Build Status

Supported technologies:

- rest
    - oauth2 grant type: password.

Please, contribute to support other one.

Usage

use WakeOnWeb\SalesforceClient\REST;
use WakeOnWeb\SalesforceClient\ClientInterface;

$client = new REST\Client(
    new REST\Gateway('https://cs81.salesforce.com', '41.0'),
    new REST\GrantType\PasswordStrategy(
        'consumer_key',
        'consumer_secret',
        'login',
        'password',
        'security_token'
    )
);

Available exception -------------------

  • DuplicatesDetectedException
  • EntityIsDeletedException (when try to delete an entity already deleted)
  • NotFoundException (when an object cannot be found)
  • ...

Get object

try {
    $salesforceObject = $client->getObject( 'Account', '1337ID')); // all fields
} catch (\WakeOnWeb\SalesforceClient\Exception\NotFoundException) {
    // this object does not exist, do a specifig thing.
}

//$salesforceObject->getAttributes();
//$salesforceObject->getFields();

//$client->getObject( 'Account', '1337ID', ['Name', 'OwnerId', 'CreatedAt'] )); // specific fields

Create object

// creation will be a SalesforceObjectCreationObject
$creation = $client->createObject( 'Account', ['name' => 'Chuck Norrs'] );
// $creation->getId();
// $creation->isSuccess();
// $creation->getErrors();
// $creation->getWarnings();

Edit object

$client->patchObject( 'Account', '1337ID', ['name' => 'Chuck Norris'] ));

Delete object

$client->deleteObject( 'Account', '1337ID'));

SOQL

// creation will be a SalesforceObjectCreationObjectResults
$client->searchSOQL('SELECT name from Account'); // NOT_ALL by default.
$client->searchSOQL('SELECT name from Account', ClientInterface::ALL);
// $creation->getTotalSize();
// $creation->isDone();
// $creation->getRecords();

Other

$client->getAvailableResources();
$client->getAllObjects();
$client->describeObjectMetadata('Account');