https://github.com/arbor-education/sis-sdk-php
Arbor Education PHP SDK
https://github.com/arbor-education/sis-sdk-php
rest-api sdk sis
Last synced: 5 days ago
JSON representation
Arbor Education PHP SDK
- Host: GitHub
- URL: https://github.com/arbor-education/sis-sdk-php
- Owner: arbor-education
- License: mit
- Created: 2017-04-06T10:18:47.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2026-04-01T11:43:55.000Z (5 days ago)
- Last Synced: 2026-04-01T13:31:02.963Z (5 days ago)
- Topics: rest-api, sdk, sis
- Language: PHP
- Homepage:
- Size: 2.07 MB
- Stars: 11
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arbor SDK
Arbor Education SDK library.
## Introduction
PHP SDK is a library which simplifies the process of integrating the Arbor REST API with your own software.
Rather than handling XML and making HTTP requests in your code, you can simply include the SDK and use getters and setters on models in order to access data from Arbor. PHP SDK includes hundreds of models as well as a gateway pattern for querying the API via a query model.
SDK supports and requires any PSR 18 based HTTP client. Make sure to install one prior to using the SDK.
## Requirements
* PHP 8.1 or higher
* [Composer](https://getcomposer.org/download)
## Installation
Simply download the project and run `composer install` from the root of the project to use as standalone for testing purposes.
Find the latest version on Packagist [Arbor Education - PHP SDK](https://packagist.org/packages/arbor-education/arbor-sdk-php) and install it with composer directly in your project `composer require arbor-education/arbor-sdk-php`
Once setup use the `examples/config-dist.php` to create your own config. For this you will need your apps credentials added on [Arbor Education - Developers Portal](https://developers-portal.arbor.sc) in order to be able to make requests to a sandbox environment.
## Usage
The `PsrRestGateway` class is a gateway implementation for interacting with REST APIs using PSR-compliant HTTP clients. It provides methods for CRUD operations, bulk creation, querying, and handling API responses.
In the `examples/example-bootstrap` you will find the configuration needed to make requests, either using it directly from `examples/config.php` or using your own configuration. The entire `examples` directory is focused on helping you develop your app faster. Scripts written represent some of the most frequently used queries.
## Example
When initializing the `PsrRestGateway` you will need to pass the `Arbor\Api\Gateway\HttpClient\HttpClientInterface`.
```php
$httpClient = new \Arbor\Api\Gateway\HttpClient\HttpClient(
new \Arbor\Api\Gateway\HttpClient\TypedRequestFactory(),
null,
null,
$config['api']['baseUrl'],
$config['api']['auth']['user'],
$config['api']['auth']['password']
);
$api = new \Arbor\Api\Gateway\PsrRestGateway(
$httpClient,
new \Arbor\Model\Hydrator(),
new \Arbor\Filter\CamelCaseToDash(),
new \Arbor\Filter\PluralizeFilter(),
);
```
This will create a new instance of the `PsrRestGateway` which you can use to interact with the Arbor API. It will try to find any existing installed PSR-18 HTTP client, or you can pass your own implementation of `Psr\Http\Client\ClientInterface` to the `HttpClient` class.
This will set the default gateway for all models, allowing you to use the SDK without needing to pass the gateway instance every time you want to retrieve or manipulate a model.
```php
\Arbor\Model\ModelBase::setDefaultGateway($api);
```
Use `Arbor\Api\Gateway\PsrRestGateway` to make GET, POST, PUT and DELETE requests and use `Arbor\Query\Query` to add filters to your requests.
#### Multipart upload request
Use the `upload()` method to submit files as `multipart/form-data`.
```php
use Arbor\Api\Gateway\UploadFile;
$fileContent = file_get_contents('/path/to/document.pdf');
$response = $api->upload(
'/rest-v2/documents/upload',
new UploadFile(name: 'file', contents: $fileContent, filename: 'document.pdf')
);
```
For large files, pass a PSR-7 stream to avoid loading the entire file into memory:
```php
// $streamFactory can be any PSR-17 StreamFactoryInterface implementation
$stream = $streamFactory->createStreamFromFile('/path/to/large-video.mp4');
$response = $api->upload(
'/rest-v2/documents/upload',
new UploadFile(name: 'file', contents: $stream, filename: 'large-video.mp4')
);
```
#### GET request:
```php
$student = \Arbor\Model\Student::retrieve(16);
```
or use [examples/student-retrieve.php](https://github.com/arbor-education/sis-sdk-php/blob/master/examples/student-retrieve.php) to see how to retrieve a record.
#### POST request:
use [examples/staff-create.php](https://github.com/arbor-education/sis-sdk-php/blob/master/examples/staff-create.php) to see how to create a new record.
#### PUT request:
use [examples/staff-create.php](https://github.com/arbor-education/sis-sdk-php/blob/master/examples/staff-update.php) to see how to update an existing record.
#### DELETE request:
```php
$api->delete($staff->getPerson()); // assuming that you are deleting your newly created staff record
```
#### Query filters:
List of filters can be found in `Arbor\Query\Query`
```php
$query = new \Arbor\Query\Query(Arbor\Resource\ResourceType::ARBOR_MODEL);
$query->addPropertyFilter(ArborModel::PROPERTY_NAME, OPERATOR, $value);
$query->addPropertyFilter(ArborModel::PROPERTY_NAME, SECOND_OPERATOR, $value);
...
$records = \Arbor\Model\ArborModel::query($query); // will return an array of records
foreach ($records as $record) {
// e.g. $record->getDisplayName();
}
```
Check `examples` directory to see usages of filters.