phprforce

Interact with Salesforce from PHP

Requirement

This library requires at least PHP 7.1 because it uses some new features of the language such as scalar type declarations or return type declarations. In addition, HTTP requests are performed with Guzzle.

Installation

Add following lines to your composer.json file to use phprforce in your project:

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/Lajule/phprforce"
        }
    ],
    "require": {
        "lajule/phprforce": "dev-master"
    }
}

Environment

This library uses the following environment variables:

Name	Value
CLIENT_ID	The client identifier of Salesforce connected app
CLIENT_SECRET	The client secret identifier of Salesforce connected app
LOGIN_URL	https://login.salesforce.com or https://test.salesforce.com
REDIRECT_URI	The callback URL to your server (if you use OAuth2::redirect())

How to use

Authentication

You have to obtain an OAuth 2.0 access token and interact with Salesforce REST API.

oauth2.php

<?php

use PHPRForce\Connexion;

$conn = new Connexion();
$conn->auth()->redirect();

callback.php

<?php

use PHPRForce\Connexion;

session_start();

$conn = new Connexion();
$_SESSION['config'] = $conn->auth()->authorize($_GET['code']);

Query

Fetch Salesforce records with SOQL queries.

accounts.php

<?php

use PHPRForce\Connexion;

session_start();

$conn = new Connexion($_SESSION['config']);
$accounts = $conn->query()->execute('SELECT Id, Name FROM Account');

SObject

"CRUD" operations for records in Salesforce.

account.php

<?php

use PHPRForce\Connexion;

session_start();

$conn = new Connexion($_SESSION['config']);
$account = $conn->sobject('Account')->get($_GET['Id']);

Apex

Call Apex REST classes in Salesforce.

action.php

<?php

use PHPRForce\Connexion;

session_start();

$conn = new Connexion($_SESSION['config']);
$result = $conn->apex('/Action')->get();

Search

Execute SOSL searches.

search.php

<?php

use PHPRForce\Connexion;

session_start();

$conn = new Connexion($_SESSION['config']);
$result = $conn->search()->get('FIND {Test}');

Batch

Execute up to 25 requests.

batch.php

<?php

use PHPRForce\Connexion;

session_start();

$conn = new Connexion($_SESSION['config']);
$result = $conn->batch()->execute([
    'batchRequests' => [
        [
            'method' => 'GET',
            'url'    => "v29.0/sobjects/Account/{$_GET['Id']}"
        ]
    ]
]);