PHPackages                             playable-cn/forrest - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. playable-cn/forrest

ActiveLibrary[HTTP & Networking](/categories/http)

playable-cn/forrest
===================

A Laravel library for Salesforce

v2.5.14(3y ago)091MITPHPPHP >=5.6

Since Nov 7Pushed 3y agoCompare

[ Source](https://github.com/playable-cn/forrest)[ Packagist](https://packagist.org/packages/playable-cn/forrest)[ RSS](/packages/playable-cn-forrest/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependencies (8)Versions (56)Used By (0)

Salesforce REST API Client for Laravel [![](https://raw.githubusercontent.com/omniphx/images/master/Forrest.png)](https://raw.githubusercontent.com/omniphx/images/master/Forrest.png)
======================================================================================================================================================================================

[](#salesforce-rest-api-client-for-laravel-)

[![Laravel](https://camo.githubusercontent.com/82712b86dcbe462a71d448be3f9eea478c37383044fb29ecfdd6ed8c6dab4c12/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d362e302d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](http://laravel.com)[![Latest Stable Version](https://camo.githubusercontent.com/e5a3a48d9f71c59503bc598ca520074218a79ec78868360ef60cc50ce6d111be/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6f6d6e697068782f666f72726573742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/omniphx/forrest)[![Total Downloads](https://camo.githubusercontent.com/e679084b6737ece2d4bc3488579f10a164babb7b069ad2dedd2c87eef2db8b9c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f6d6e697068782f666f72726573742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/omniphx/forrest)[![License](https://camo.githubusercontent.com/6a7c803bd9e94472fd8f0739733738aa0f3999eabae4ee273fb8e1cf073b4fed/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6f6d6e697068782f666f72726573742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/omniphx/forrest)[![Build Status](https://camo.githubusercontent.com/c53f2f74263b0109ec14274cf12ef360e64aa31fdbe107730b56368498b37f0f/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6f6d6e697068782f666f72726573742e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/omniphx/forrest)

Salesforce/Force.com REST API client for Laravel. While it acts as more of a wrapper of the API methods, it should provide you with all the flexibility you will need to interact with the REST service.

Currently the only support is for Laravel and Lumen.

Interested in Eloquent Salesforce Models? Check out [@roblesterjr04](https://github.com/roblesterjr04)'s [EloquentSalesForce](https://github.com/roblesterjr04/EloquentSalesForce) project that utilizes Forrest as it's API layer.

Installation
------------

[](#installation)

> If you are upgrading to Version 2.0, be sure to re-publish your config file.

Forrest can be installed through composer. Open your `composer.json` file and add the following to the `require` key:

```
"omniphx/forrest": "2.*"
```

Next run `composer update` from the command line to install the package.

### Laravel Installation

[](#laravel-installation)

Add the service provider and alias to your `config/app.php` file:

```
Omniphx\Forrest\Providers\Laravel\ForrestServiceProvider::class
'Forrest' => Omniphx\Forrest\Providers\Laravel\Facades\Forrest::class
```

> For Laravel 4, add `Omniphx\Forrest\Providers\Laravel4\ForrestServiceProvider` in `app/config/app.php`. Alias will remain the same.

### Lumen Installation

[](#lumen-installation)

```
class_alias('Omniphx\Forrest\Providers\Laravel\Facades\Forrest', 'Forrest');
$app->register(Omniphx\Forrest\Providers\Lumen\ForrestServiceProvider::class);
$app->configure('forrest');
$app->withFacades();
```

Then you'll utilize the Lumen service provider by registering it in the `bootstrap/app.php` file.

### Configuration

[](#configuration)

You will need a configuration file to add your credentials. Publish a config file using the `artisan` command:

```
php artisan vendor:publish
```

This will publish a `config/forrest.php` file that can switch between authentication types as well as other settings.

After adding the config file, update your `.env` to include the following values (details for getting a consumer key and secret are outlined below):

```
CONSUMER_KEY=123455
CONSUMER_SECRET=ABCDEF
CALLBACK_URI=https://test.app/callback
LOGIN_URL=https://login.salesforce.com
USERNAME=mattjmitchener@gmail.com
PASSWORD=password123

```

> For Lumen, you should copy the config file from `src/config/config.php` and add it to a `forrest.php` configuration file under a config directory in the root of your application.

> For Laravel 4, run `php artisan config:publish omniphx/forrest` which create `app/config/omniphx/forrest/config.php`

Getting Started
---------------

[](#getting-started)

### Setting up a Connected App

[](#setting-up-a-connected-app)

1. Log into to your Salesforce org
2. Click on Setup in the upper right-hand menu
3. Under Build click `Create > Apps`
4. Scroll to the bottom and click `New` under Connected Apps.
5. Enter the following details for the remote application:
    - Connected App Name
    - API Name
    - Contact Email
    - Enable OAuth Settings under the API dropdown
    - Callback URL
    - Select access scope (If you need a refresh token, specify it here)
6. Click `Save`

After saving, you will now be given a Consumer Key and Consumer Secret. Update your config file with values for `consumerKey`, `consumerSecret`, `loginURL` and `callbackURI`.

### Setup

[](#setup)

Creating authentication routes

##### Web Server authentication flow

[](#web-server-authentication-flow)

```
Route::get('/authenticate', function()
{
    return Forrest::authenticate();
});

Route::get('/callback', function()
{
    Forrest::callback();

    return Redirect::to('/');
});
```

##### Username-Password authentication flow

[](#username-password-authentication-flow)

With the Username Password flow, you can directly authenticate with the `Forrest::authenticate()` method.

> To use this authentication you must add your username, and password to the config file. Security token might need to be ammended to your password unless your IP address is whitelisted.

```
Route::get('/authenticate', function()
{
    Forrest::authenticate();
    return Redirect::to('/');
});
```

##### SOAP authentication flow

[](#soap-authentication-flow)

(When you cannot create a connected App in Salesforce)

1. Salesforce allows individual logins via a SOAP Login
2. The Bearer access token returned from the SOAP login can be used similar to Oauth key
3. Update your config file and set the `authentication` value to `UserPasswordSoap`
4. Update your config file with values for `loginURL`, `username`, and `password`. With the Username Password SOAP flow, you can directly authenticate with the `Forrest::authenticate()` method.

> To use this authentication you can add your username, and password to the config file. Security token might need to be ammended to your password unless your IP address is whitelisted.

```
Route::get('/authenticate', function()
{
    Forrest::authenticate();
    return Redirect::to('/');
});
```

If your application requires logging in to salesforce as different users, you can alternatively pass in the login url, username, and password to the `Forrest::authenticateUser()` method.

> Security token might need to be ammended to your password unless your IP address is whitelisted.

```
Route::Post('/authenticate', function(Request $request)
{
    Forrest::authenticateUser('https://login.salesforce.com',$request->username, $request->password);
    return Redirect::to('/');
});
```

#### Custom login urls

[](#custom-login-urls)

Sometimes users will need to connect to a sandbox or custom url. To do this, simply pass the url as an argument for the authenticatation method:

```
Route::get('/authenticate', function()
{
    $loginURL = 'https://test.salesforce.com';

    return Forrest::authenticate($loginURL);
});
```

> Note: You can specify a default login URL in your config file.

Basic usage
-----------

[](#basic-usage)

After authentication, your app will store an encrypted authentication token which can be used to make API requests.

### Query a record

[](#query-a-record)

```
Forrest::query('SELECT Id FROM Account');
```

Sample result:

```
{
    "totalSize": 2,
    "done": true,
    "records": [
        {
            "attributes": {
                "type": "Account",
                "url": "\/services\/data\/v30.0\/sobjects\/Account\/001i000000xxx"
            },
            "Id": "001i000000xxx"
        },
        {
            "attributes": {
                "type": "Account",
                "url": "\/services\/data\/v30.0\/sobjects\/Account\/001i000000xxx"
            },
            "Id": "001i000000xxx"
        }
    ]
}
```

If you are querying more than 2000 records, you response will include:

```
{
    "nextRecordsUrl" : "/services/data/v20.0/query/01gD0000002HU6KIAW-2000"
}
```

Simply, call `Forrest::next($nextRecordsUrl)` to return the next 2000 records.

### Create a new record

[](#create-a-new-record)

Records can be created using the following format.

```
Forrest::sobjects('Account',[
    'method' => 'post',
    'body'   => ['Name' => 'Dunder Mifflin']
]);
```

### Update a record

[](#update-a-record)

Update a record with the PUT method.

```
Forrest::sobjects('Account/001i000000xxx',[
    'method' => 'put',
    'body'   => [
        'Name'  => 'Dunder Mifflin',
        'Phone' => '555-555-5555'
    ]
]);
```

### Upsert a record

[](#upsert-a-record)

Update a record with the PATCH method and if the external Id doesn't exist, it will insert a new record.

```
$externalId = 'XYZ1234';

Forrest::sobjects('Account/External_Id__c/' + $externalId, [
    'method' => 'patch',
    'body'   => [
        'Name'  => 'Dunder Mifflin',
        'Phone' => '555-555-5555'
    ]
]);
```

### Delete a record

[](#delete-a-record)

Delete a record with the DELETE method.

```
Forrest::sobjects('Account/001i000000xxx', ['method' => 'delete']);
```

### Setting headers

[](#setting-headers)

Sometimes you need the ability to set custom headers (e.g., creating a Lead with an assignment rule)

```
Forrest::sobjects('Lead',[
    'method' => 'post',
    'body' => [
        'Company' => 'Dunder Mifflin',
        'LastName' => 'Scott'
    ],
    'headers' => [
        'Sforce-Auto-Assign' => '01Q1N000000yMQZUA2'
    ]
]);
```

> To disable assignment rules, use `'Sforce-Auto-Assign' => 'false'`

### XML format

[](#xml-format)

Change the request/response format to XML with the `format` key or make it default in your config file.

```
Forrest::sobjects('Account',['format'=>'xml']);
```

API Requests
------------

[](#api-requests)

With the exception of the `search` and `query` resources, all resources are requested dynamically using method overloading.

You can determine which resources you have access to by calling with the resource method

```
Forrest::resources();
```

This sample output shows the resourses available to call via the API:

```
Array
(
    [sobjects] => /services/data/v30.0/sobjects
    [connect] => /services/data/v30.0/connect
    [query] => /services/data/v30.0/query
    [theme] => /services/data/v30.0/theme
    [queryAll] => /services/data/v30.0/queryAll
    [tooling] => /services/data/v30.0/tooling
    [chatter] => /services/data/v30.0/chatter
    [analytics] => /services/data/v30.0/analytics
    [recent] => /services/data/v30.0/recent
    [process] => /services/data/v30.0/process
    [identity] => https://login.salesforce.com/id/00Di0000000XXXXXX/005i0000000aaaaAAA
    [flexiPage] => /services/data/v30.0/flexiPage
    [search] => /services/data/v30.0/search
    [quickActions] => /services/data/v30.0/quickActions
    [appMenu] => /services/data/v30.0/appMenu
)
```

From the list above, I can call resources by referring to the specified key.

```
Forrest::theme();
```

Or...

```
Forrest::appMenu();
```

Additional resource url parameters can also be passed in

```
Forrest::sobjects('Account/describe/approvalLayouts/');
```

As well as new formatting options, headers or other configurations

```
Forrest::theme(['format'=>'xml']);
```

### Upsert multiple records (Bulk API 2.0)

[](#upsert-multiple-records-bulk-api-20)

Bulk API requests are especially handy when you need to quickly load large amounts of data into your Salesforce org. The key differences is that it requires at least three separate requests (Create, Add, Close), and the data being loaded is sent in a CSV format.

To illustrate, following are three requests to upsert a CSV of `Contacts` records.

#### Create

[](#create)

Create a bulk upload job with the POST method, the body contains the following job properties:

- `object` is the type of objects you're loading (they must all be the same type per job)
- `externalIdFieldName` is the external ID, if this exists it'll update and if it doesn't a new record will be inserted. Only needed for upsert operations.
- `contentType` is CSV, this is currently the only valid value.
- `operation` is set to `upsert` to both add and update records.

We're storing the response in `$bulkJob` in order to reference the unique Job ID in the Add and Close requests below.

> See [Create a Job](https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/create_job.htm) for the full list of options available here.

```
$bulkJob = Forrest::jobs('ingest', [
    'method' => 'post',
    'body' => [
        "object" => "Contact",
        "externalIdFieldName" => "externalId",
        "contentType" => "CSV",
        "operation" => "upsert"
    ]
]);
```

#### Add Data

[](#add-data)

Using the Job ID from the Create POST request, you then send the CSV data to be processed using a PUT request. This assumes you've loaded your CSV contents to `$csv`

> See [Prepare CSV Files](https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/datafiles_prepare_csv.htm) for details on how it should be formatted.

```
Forrest::jobs('ingest/' . $bulkJob['id'] . '/batches', [
    'method' => 'put',
    'headers' => [
        'Content-Type' => 'text/csv'
    ],
    'body' => $csv
]);
```

#### Close

[](#close)

You must close the job before the records can be processed, to do so you send an `UploadComplete` state using a PATCH request to the Job ID.

> See [Close or Abort a Job](https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/close_job.htm) for more options and details on how to abort a job.

```
$response = Forrest::jobs('ingest/' . $bulkJob['id'] . '/', [
    'method' => 'patch',
    'body' => [
        "state" => "UploadComplete"
    ]
]);
```

> **Bulk API 2.0 is available in API version 41.0 and later**. For more information on Salesforce Bulk API, check out the [official documentation](https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/introduction_bulk_api_2.htm) and [this tutorial](https://trailhead.salesforce.com/en/content/learn/modules/api_basics/api_basics_bulk) on how to perform a successful Bulk Upload.

### Additional API Requests

[](#additional-api-requests)

#### Refresh

[](#refresh)

If a refresh token is set, the server can refresh the access token on the user's behalf. Refresh tokens are only for the Web Server flow.

```
Forrest::refresh();
```

> If you need a refresh token, be sure to specify this under `access scope` in your [Connected App](#setting-up-connected-app). You can also specify this in your configuration file by adding `'scope' => 'full refresh_token'`. Setting scope access in the config file is optional, the default scope access is determined by your Salesforce org.

#### Revoke

[](#revoke)

This will revoke the authorization token. The session will continue to store a token, but it will become invalid.

```
Forrest::revoke();
```

#### Versions

[](#versions)

Returns all currently supported versions. Includes the verison, label and link to each version's root:

```
Forrest::versions();
```

#### Resources

[](#resources)

Returns list of available resources based on the logged in user's permission and API version.

```
Forrest::resources();
```

#### Identity

[](#identity)

Returns information about the logged-in user.

```
Forrest::identity();
```

For a complete listing of API resources, refer to the [Force.com REST API Developer's Guide](http://www.salesforce.com/us/developer/docs/api_rest/api_rest.pdf)

### Custom Apex endpoints

[](#custom-apex-endpoints)

If you create a custom API using Apex, you can use the `custom()` method for consuming them.

```
Forrest::custom('/myEndpoint');
```

Additional options and parameters can be passed in like this:

```
Forrest::custom('/myEndpoint', [
    'method' => 'post',
    'body' => ['foo' => 'bar'],
    'parameters' => ['flim' => 'flam']]);
```

> Read [Creating REST APIs using Apex REST](https://developer.salesforce.com/page/Creating_REST_APIs_using_Apex_REST) for more information.

### Raw Requests

[](#raw-requests)

If needed, you can make raw requests to an endpoint of your choice.

```
Forrest::get('/services/data/v20.0/endpoint');
Forrest::head('/services/data/v20.0/endpoint');
Forrest::post('/services/data/v20.0/endpoint', ['my'=>'param']);
Forrest::put('/services/data/v20.0/endpoint', ['my'=>'param']);
Forrest::patch('/services/data/v20.0/endpoint', ['my'=>'param']);
Forrest::delete('/services/data/v20.0/endpoint');
```

### Raw response output

[](#raw-response-output)

By default, this package will return the body of a response as either a deserialized JSON object or a SimpleXMLElement object.

There might be times, when you would rather handle this differently. To do this, simply use any format other than 'json' or 'xml' and the code will return a Guzzle response object.

```
$response = Forrest::sobjects($resource, ['format'=> 'none']);
$content = (string) $response->getBody(); // Guzzle response
```

### Event Listener

[](#event-listener)

This package makes use of Guzzle's event listers

```
Event::listen('forrest.response', function($request, $response) {
    dd((string) $response);
});
```

For more information about Guzzle responses and event listeners, refer to their [documentation](http://guzzle.readthedocs.org).

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor1

Top contributor holds 74.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~60 days

Recently: every ~166 days

Total

50

Last Release

1256d ago

Major Versions

v1.4.0 → v2.0.02015-05-06

PHP version history (3 changes)v1.0.1PHP >=5.4.0

v2.1.2PHP >=5.5.0

v2.4.0PHP >=5.6

### Community

Maintainers

![](https://www.gravatar.com/avatar/e6b9c8c93c642d1881e77d2371d440fc03cc16727500c3a3e2930d4c564c3c1d?d=identicon)[developer-playable](/maintainers/developer-playable)

---

Top Contributors

[![omniphx](https://avatars.githubusercontent.com/u/3722405?v=4)](https://github.com/omniphx "omniphx (226 commits)")[![developer-playable](https://avatars.githubusercontent.com/u/39359029?v=4)](https://github.com/developer-playable "developer-playable (25 commits)")[![tabirkeland](https://avatars.githubusercontent.com/u/10934808?v=4)](https://github.com/tabirkeland "tabirkeland (10 commits)")[![rtconner](https://avatars.githubusercontent.com/u/334533?v=4)](https://github.com/rtconner "rtconner (7 commits)")[![Olofguard](https://avatars.githubusercontent.com/u/1020137?v=4)](https://github.com/Olofguard "Olofguard (6 commits)")[![scottwakefield](https://avatars.githubusercontent.com/u/4173571?v=4)](https://github.com/scottwakefield "scottwakefield (4 commits)")[![RobvH](https://avatars.githubusercontent.com/u/2434699?v=4)](https://github.com/RobvH "RobvH (4 commits)")[![rkeppner](https://avatars.githubusercontent.com/u/3485765?v=4)](https://github.com/rkeppner "rkeppner (3 commits)")[![camiloherbertv](https://avatars.githubusercontent.com/u/171182396?v=4)](https://github.com/camiloherbertv "camiloherbertv (2 commits)")[![pravindahal](https://avatars.githubusercontent.com/u/894731?v=4)](https://github.com/pravindahal "pravindahal (2 commits)")[![diggersworld](https://avatars.githubusercontent.com/u/3224105?v=4)](https://github.com/diggersworld "diggersworld (2 commits)")[![bitdeli-chef](https://avatars.githubusercontent.com/u/3092978?v=4)](https://github.com/bitdeli-chef "bitdeli-chef (1 commits)")[![yannzeeuwe](https://avatars.githubusercontent.com/u/16141944?v=4)](https://github.com/yannzeeuwe "yannzeeuwe (1 commits)")[![blocher](https://avatars.githubusercontent.com/u/5084741?v=4)](https://github.com/blocher "blocher (1 commits)")[![clemblanco](https://avatars.githubusercontent.com/u/668419?v=4)](https://github.com/clemblanco "clemblanco (1 commits)")[![justb81](https://avatars.githubusercontent.com/u/3680539?v=4)](https://github.com/justb81 "justb81 (1 commits)")[![kpapagno](https://avatars.githubusercontent.com/u/5309480?v=4)](https://github.com/kpapagno "kpapagno (1 commits)")[![metropolisiii](https://avatars.githubusercontent.com/u/5178393?v=4)](https://github.com/metropolisiii "metropolisiii (1 commits)")[![N4COM](https://avatars.githubusercontent.com/u/16939210?v=4)](https://github.com/N4COM "N4COM (1 commits)")[![rajjanorkar](https://avatars.githubusercontent.com/u/7500838?v=4)](https://github.com/rajjanorkar "rajjanorkar (1 commits)")

---

Tags

laravelrestsalesforceforce.comforce

### Embed Badge

![Health badge](/badges/playable-cn-forrest/health.svg)

```
[![Health](https://phpackages.com/badges/playable-cn-forrest/health.svg)](https://phpackages.com/packages/playable-cn-forrest)
```

###  Alternatives

[omniphx/forrest

A Laravel library for Salesforce

2724.4M8](/packages/omniphx-forrest)[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9682.1M97](/packages/roots-acorn)[laravel/pulse

Laravel Pulse is a real-time application performance monitoring tool and dashboard for your Laravel application.

1.7k12.1M99](/packages/laravel-pulse)[api-platform/laravel

API Platform support for Laravel

59126.4k6](/packages/api-platform-laravel)[laravel-zero/framework

The Laravel Zero Framework.

3371.4M369](/packages/laravel-zero-framework)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)