herurahmat/salesforce-bulk-api

Client for Salesforce Bulk Api. Easy way to manipulate your Salesforce data.

1.1.10 2020-01-24 18:27 UTC

Requires

• php: >=5.6
• guzzlehttp/guzzle: ^6.2
• shubinmi/helpers: ^1.0

Requires (Dev)

• phpunit/phpunit: ^5.7

BSD-3-Clause

• Maxim Shubin

• api
• client
• salesforce
• bulk

README

Easy way to manipulate your Salesforce data

Don't worry, Be happy

Features

• INSERT job
• UPDATE job
• UPSERT job
• DELETE job
• QUERY (SELECT) job

For example see to the tests

Installation

Install the latest version with

$ composer require shubinmi/salesforce-bulk-api

Basic Usage

<?php

use SalesforceBulkApi\dto\CreateJobDto;
use SalesforceBulkApi\objects\SFBatchErrors;
use SalesforceBulkApi\conf\LoginParams;
use SalesforceBulkApi\services\JobSFApiService;

// Set up API Client
$params = (new LoginParams)
    ->setUserName('mySFLogin')
    ->setUserPass('MySFPass')
    ->setUserSecretToken('mySecretTokenFomSF');

// Set up Insert SF job
$jobRequest = (new CreateJobDto)
    ->setObject('My_User__c')
    ->setOperation(CreateJobDto::OPERATION_INSERT);

// Data for Insert to custom SF entity
$data1 = [
    [
        'Email__c' => '[e-mail]',
        'First_Name__c' => 'New Net'
    ],
    [
        'Email__c' => '[e-mail]',
        'First_Name__c' => 'New Org'
    ]
];
$data2 = [
    [
        'Email__c' => '[e-mail]',
        'First_Name__c' => 'New1 Net'
    ],
    [
        'Email__c' => '[e-mail]',
        'First_Name__c' => 'New1 Org'
    ]
];

// Init Insert job and pull data
$insertJob = (new JobSFApiService($params))
    ->initJob($jobRequest)
    ->addBatchToJob($data1)
    ->addBatchToJob($data2)
    ->closeJob();

// Set up params for Upsert SF job
$jobRequest
    ->setOperation(CreateJobDto::OPERATION_UPSERT)
    ->setExternalIdFieldName('Email__c');

// Do Upsert job
$upsertJob = new JobSFApiService($params);
$upsertJob->initJob($jobRequest);

$data = [
    [
        'Email__c' => '[e-mail]',
        'First_Name__c' => 'Not new Net'
    ],
    [
        'Email__c' => '[e-mail]',
        'First_Name__c' => 'New Com'
    ]
];
$upsertJob
    ->addBatchToJob($data)
    ->closeJob();

// Collect jobs errors
$errorsOnInsert = $insertJob->waitingForComplete()->getErrors();
$errorsOnUpsert = $upsertJob->waitingForComplete()->getErrors();

// Operate with errors
foreach ($errorsOnInsert as $error) {
    /** @var SFBatchErrors $error */
    $errorsBatch         = $error->getBatchInfo();
    $errorsMsg           = $error->getErrorMessages();
    $errorsElementNumber = $error->getErrorNumbers();
    if (empty($errorsElementNumber)) {
        echo 'Batch ' . $errorsBatch->getId() . ' return ' . $errorsBatch->getState() . PHP_EOL;
    } else {
        echo 'Batch ' . $errorsBatch->getId() . ' fail for next rows:' . PHP_EOL;
        foreach ($errorsElementNumber as $errorMsgKey => $errorRowNumber) {
            echo 'Row number = ' . $errorRowNumber 
                . ' Error message = ' . $errorsMsg[$errorMsgKey] . PHP_EOL;
        }
    }
}

Contribute safely

$ sh ./vendor/phpunit/phpunit/phpunit ./tests/services