This is meant to emulate what the ejhomes/restforce gem is doing for rails.
This library requires PHP 7.1 or later; we recommend using the latest available version of PHP.
$ composer require eventfarm/restforcephp
Or.
Add the following lines to your composer.json file.
{
"require": {
"eventfarm/restforcephp": "^2.0.0"
}
}$ composer install<?php
namespace App;
use EventFarm\Restforce\Rest\OAuthAccessToken;
use EventFarm\Restforce\Restforce;
use EventFarm\Restforce\RestforceInterface;
class DemoSalesforceApi
{
/** @var null|RestforceInterface $restforce */
private $restforce;
public function getRestforceClient(): RestforceInterface
{
if ($this->restforce === null) {
// You need either the OAuthAccessToken
// or the Username & Password,
// the other(s) can be null.
$this->restforce = new Restforce(
getenv('SF_CLIENT_ID'),
getenv('SF_CLIENT_SECRET'),
new OAuthAccessToken(...),
getenv('SF_USERNAME'),
getenv('SF_PASSWORD')
);
}
return $this->restforce;
}
}Consult the Salesforce OAuth 2.0 Documentation to find out what Available OAuth Scopes your app needs.
Links to Salesforce documentation pages can be found in each section. Alternatively, here is the holy grail of the Saleforce endpoints.
Docs Returns a list of daily API limits for the salesforce api. Refer to the docs for the full list of options.
public function limits(): \Psr\Http\Message\ResponseInterface
<?php
/** @var \EventFarm\Restforce\RestforceInterface $restforce */
$restforce = (new DemoSalesforceApi())->getClient();
/** @var \Psr\Http\Message\ResponseInterface $responseInterface */
$responseInterface = $restforce->limits();Docs Get info about the logged-in user.
public function limits(): \Psr\Http\Message\ResponseInterface
<?php
/** @var \EventFarm\Restforce\RestforceInterface $restforce */
$restforce = (new DemoSalesforceApi())->getClient();
/** @var \Psr\Http\Message\ResponseInterface $responseInterface */
$responseInterface = $restforce->userInfo();Docs Use the Query resource to execute a SOQL query that returns all the results in a single response.
public function query(string $query): \Psr\Http\Message\ResponseInterface
<?php
/** @var \EventFarm\Restforce\RestforceInterface $restforce */
$restforce = (new DemoSalesforceApi())->getClient();
/** @var \Psr\Http\Message\ResponseInterface $responseInterface */
$responseInterface = $restforce->query('SELECT Id, Name FROM Account');Docs Find resource $id of $sobject, optionally specify the fields you want to retrieve in the fields parameter and use the GET method of the resource.
public function find(string $sobject, string $id, array $fields = []): \Psr\Http\Message\ResponseInterface
<?php
/** @var \EventFarm\Restforce\RestforceInterface $restforce */
$restforce = (new DemoSalesforceApi())->getClient();
/** @var \Psr\Http\Message\ResponseInterface $responseInterface */
$responseInterface= $restforce->find('Account', '001410000056Kf0AAE');Docs Completely describes the individual metadata at all levels for the specified object.
public function describe(string $sobject): \Psr\Http\Message\ResponseInterface
<?php
/** @var \EventFarm\Restforce\RestforceInterface $restforce */
$restforce = (new DemoSalesforceApi())->getClient();
/** @var \Psr\Http\Message\ResponseInterface $responseInterface */
$responseInterface = $restforce->describe('Account');Docs Create new records of $sobject. The response body will contain the ID of the created record if the call is successful.
public function create(string $sobject, array $data): \Psr\Http\Message\ResponseInterface
<?php
/** @var \EventFarm\Restforce\RestforceInterface $restforce */
$restforce = (new DemoSalesforceApi())->getClient();
/** @var \Psr\Http\Message\ResponseInterface $responseInterface */
$responseInterface = $restforce->create('Account', [
'Name' => 'Foo Bar'
]);Docs You use the SObject Rows resource to update records. The response will be the a bool of $success.
public function update(string $sobject, string $id, array $data):bool
<?php
/** @var \EventFarm\Restforce\RestforceInterface $restforce */
$restforce = (new DemoSalesforceApi())->getClient();
/** @var \Psr\Http\Message\ResponseInterface $responseInterface */
$responseInterface = $restforce->update('Account', '001i000001ysdBGAAY', [
'Name' => 'Foo Bar Two'
]);Thanks for considering contributing to our Restforcephp project. Just a few things:
- Make sure your commit conforms to the PSR-2 coding standard.
- Make sure your commit messages are well defined.
- Make sure you have added the necessary unit tests for your changes.
- Run all the tests to assure nothing else was accidentally broken.
- Submit a pull request.
$ vendor/bin/phpunit$ vendor/bin/phpunit --coverage-text --coverage-html coverage_report$ vendor/bin/phpcs -p --standard=PSR2 src/ tests/Auto runs and resolves some low hanging PSR2 fixes, this might not get all of them, so rerun the check after.
$ vendor/bin/phpcbf --standard=PSR2 src/ tests/