risscsolutions/printformer-php-sdk

SDK for the printformer API

v0.2.3 2024-06-25 06:51 UTC

Requires

• php: ^8.0
• guzzlehttp/guzzle: ^7.4
• illuminate/config: ^8.0|^9.0|^10.0|^11.0
• illuminate/support: ^8.0|^9.0|^10.0|^11.0
• lcobucci/jwt: ^4.1
• symfony/http-foundation: ^6.0|^7.0

Requires (Dev)

• infection/infection: ^0.26.16
• jetbrains/phpstorm-attributes: ^1.0
• nyholm/nsa: ^1.3
• phpunit/phpunit: 9.6.8

MIT

• Luca Perna

• printformer
• web2print

README

Documentation

Installation

composer require risscsolutions/printformer-php-sdk

Usage

Create a new Instance of the printformer-SDK

use Rissc\Printformer;

$config = [
    'base_uri' => 'YOUR printformer URL',
    'identifier' => 'YOUR TENANT IDENTIFIER',
    'api_key' => 'YOUR TENANT API KEY',
];

$printformer = new Printformer($config);

Create a new User

$pfUser = $this->printformer->clientFactory()->user()->create([
    'first_name' => 'John',
    'last_name' => 'Doe',
    'locale' => 'en',
    'email' => '[e-mail]', 
]);

Create a new Draft

by passing an array to the DraftClient

$draftClient = $printformer->clientFactory()->draft();
$draft = $draftClient
    ->create([
        'templateIdentifier' => 'YOUR MASTER TEMPLATE IDENTIFIER',
        'user_identifier' => $pfUser->getIdentifier(),
        'intent' => 'customize'
    ]);

or with a fluid builder

$draftBuilder = $printformer->builderFactory()->draft();
$draft = $draftBuilder
    ->template('YOUR MASTER TEMPLATE IDENTIFIER')
    ->user($pfUser->getIdentifier())
    ->intent('customize')
    ->create();

Create a URL to the Editor

$url = (string)$printformer->urlGenerator()->editor()
        ->draft($draft->getIdentifier())
        ->callback('https://YOUR-CALLBACK-URL-HERE')
        ->callbackCancel('https://YOUR-CANCEL-CALLBACK-URL-HERE') // Optional, if omitted the callback URL is used
        ->callbackHalt('https://YOUR-HALT-CALLBACK-URL-HERE') // Optional, if omitted the callbackCancel URL is used
        ->user($pfUser->getIdentifier())
        ->step('preview') // Optional, if omitted the editor jumps to the last visited step

Create a Print PDF

$printformer->clientFactory()->processing()->create(
    [$draft->getIdentifier(), $otherDraft->getIdentifier()],
    'https://YOUR-CALLBACK-URL-HERE'
);

Create a URL to the Print PDF

(string)$printformer->urlGenerator()
->draftFiles()
->printFile($draft->getIdentifier())
->expiresAt((new \DateTimeImmutable())->modify('+1 hour'))

Replicate a draft

$draftClient = $printformer->clientFactory()->draft();
$draft = $draftClient
    ->replicate($draft, []);