README

The Official PERSCOM PHP SDK

A PHP package that helps kickstart your next PERSCOM integration.

Introduction

The PERSCOM PHP SDK is a powerful tool that enables seamless integration with the PERSCOM platform, allowing you to interact with PERSCOM's personnel data programmatically.

Getting Started

You can install the package using Composer:

composer require deschutesdesigngroupllc/perscom-php-sdk

Documentation

Visit our documentation here to get started.

Usage

Below is an overview of common usages for the SDK.

<?php

use Perscom\PerscomConnection;
use Perscom\Data\ResourceObject;
use Perscom\Data\SortObject;
use Perscom\Data\FilterObject;

// The following are examples on the user resource, but the same principles
// can be applied to any PERSCOM resource. 
$perscom = new PerscomConnection('YOUR_API_KEY');

// Optionally include your PERSCOM ID for better request identification
// $perscom = new PerscomConnection('YOUR_API_KEY', 'YOUR_PERSCOM_ID');

// For custom base URLs (advanced usage)
// $perscom = new PerscomConnection('YOUR_API_KEY', 'YOUR_PERSCOM_ID', 'https://staging.perscom.io');

// Get a list of a specific resource
$response = $perscom->users()->all();

// Get a specific resource
$response = $perscom->users()->get(id: 1);

// Create a resource
$response = $perscom->users()->create(data: [
    'name' => 'User 1',
    'email' => 'user1@email.com'
]);

// Update a resource
$response = $perscom->users()->update(id: 1, data: [
    'name' => 'User 1 New Name'
]);

// Delete a resource
$response = $perscom->users()->delete(id: 1);

// Search for a resource
$response = $perscom->users()->search(
    value: 'foobar', 
    sort: new SortObject('first_name', 'asc'), 
    filter: new FilterObject('created_at', '<', '2024-01-01')
);

// Batch create a resource
$response = $perscom->users()->batchCreate([
    new ResourceObject(data: [
        'name' => 'User 1',
        'email' => 'user1@email.com'
    ]),
    new ResourceObject(data: [
        'name' => 'User 2',
        'email' => 'user2@email.com'
    ])
]);

// Batch update a resource
$response = $perscom->users()->batchUpdate([
    new ResourceObject(id: 1, data: [
        'name' => 'User 1 New Name'
    ]),
    new ResourceObject(id: 2, data: [
        'name' => 'User 2 New Name'
    ])
]);

// Batch delete a resource
$response = $perscom->users()->batchDelete([
    new ResourceObject(id: 1),
    new ResourceObject(id: 2)
]);

// Uploading an attachment
$response = $perscom->users()->attachments(userId: 1)->create(data: [
    'name' => 'Attachment 1',
    'file' => fopen('/../file.pdf', 'r')
]);

// Other examples
$response = $perscom->users()->profilePhoto(userId: 1)->create(filePath: 'image.jpg');
$response = $perscom->users()->assignmentRecords(userId: 1)->delete(id: 1);

// Parse the response into a usable array
$data = $response->json();

Error Handling

The PERSCOM SDK throws exceptions when an API error occurs. You can catch these exceptions and handle them accordingly with a standard try/catch block. For a more elegant approach to error handling, consider using the promise-based approach.

use Perscom\PerscomConnection;
use Perscom\Exceptions\AuthenticationException;

try {
  $perscom = new PerscomConnection('YOUR_API_KEY');

  $response = $perscom->users()->all()->json();
} catch (AuthenticationException $exception) {
  Log::error('The provided API key is invalid');
}

Promise Support

The PERSCOM SDK can send asynchronous requests using a promise-based approach. This allows you to handle both successful and failed requests in a more fluent way.

use Perscom\PerscomConnection;
use Perscom\Http\Requests\Crud\GetAllRequest;
use Saloon\Http\Response;
use Saloon\Exceptions\Request\RequestException;

// Create a PERSCOM instance
$perscom = new PerscomConnection('YOUR_API_KEY');

// Create a promise
$promise = $perscom->sendAsync(new GetAllRequest('users'));

// Send the request
$promise
    ->then(function (Response $response) {
        // Handle successful response
    })
    ->otherwise(function (RequestException $exception) {
        // Handle failed request
    });

// Resolve the promise
$promise->wait();

Contributing

Please see here for more details about contributing.

deschutesdesigngroupllc / perscom-php-sdk

Maintainers

Details