PHP SDK overview

The PHP SDK is the package every PHP worker depends on to talk to the Orchesty platform. It ships as a Symfony bundle: the bundle wires the SDK's services into your container and gives your tagged Applications, Connectors, custom nodes, and batch nodes their HTTP routes.

Install #

composer require orchesty/php-sdk

Then enable the bundles in config/bundles.php:

return [
    Hanaboso\PipesPhpSdk\HbPFApplicationBundle\HbPFApplicationBundle::class => ['all' => true],
    Hanaboso\PipesPhpSdk\HbPFConnectorBundle\HbPFConnectorBundle::class     => ['all' => true],
    Hanaboso\PipesPhpSdk\HbPFCustomNodeBundle\HbPFCustomNodeBundle::class   => ['all' => true],
    Hanaboso\PipesPhpSdk\HbPFBatchBundle\HbPFBatchBundle::class             => ['all' => true],
];

Source #

Repository: Orchesty/orchesty-php-sdk
License and contribution guidelines live in the repo.

Versions and runtime #

Item	Value
Current version	`3.x`
Minimum PHP	`8.4`
Required extensions	`json`, `mongodb`, `oauth`, `fileinfo`
Symfony	`7.x`
Storage	MongoDB (used by the SDK for `ApplicationInstall`)

What's inside #

Namespace	What it gives you
`Application\Base`	`ApplicationAbstract`, `ApplicationInterface`
`Authorization\Base\Basic`	`BasicApplicationAbstract`
`Authorization\Base\OAuth1`	`OAuth1ApplicationAbstract`
`Authorization\Base\OAuth2`	`OAuth2ApplicationAbstract`
`Application\Document`	`ApplicationInstall`
`Application\Manager\Webhook`	`WebhookApplicationInterface`
`CustomNode`	`CommonNodeAbstract`
`Connector`	`ConnectorAbstract`
`Batch`	`BatchAbstract`
`Application\Model\Form`	`FormStack`, `Form`, `Field`
`Utils\Process`	`ProcessDto`, `BatchProcessDto`, `ProcessDtoAbstract`
`HbPF*Bundle`	Symfony bundles registering routes and services

PHP SDK overview

Install #

Source #

Versions and runtime #

What's inside #

Per-class pages #

See also #