orchesty / php-sdk
PHP sdk for Orchesty
3.0.4
2023-08-25 09:07 UTC
Requires
- php: ^8.2
- ext-fileinfo: *
- ext-json: *
- ext-mongodb: *
- ext-oauth: *
- hanaboso/commons-bundle: ^2.9
- hanaboso/mongo-data-grid: ^1.7
- league/oauth2-client: ^2.7
- phpoffice/phpspreadsheet: ^1.28
- symfony/monolog-bundle: ^v3.8
- symfony/yaml: ^v6.2
Requires (Dev)
- hanaboso/php-check-utils: ^1.5
- symfony/debug-bundle: ^v6.2
- symfony/security-bundle: ^v6.2
- symfony/serializer: ^v6.2
README
How to use ?
- Install package
orchesty/php-sdk
- Register bundles from PHP SDK into your Symfony Application:
# config/Bundles.php
...
HbPFApplicationBundle::class => ['all' => TRUE],
HbPFCommonsBundle::class => ['all' => TRUE],
HbPFConnectorBundle::class => ['all' => TRUE],
HbPFConnectorsBundle::class => ['all' => TRUE],
HbPFCustomNodeBundle::class => ['all' => TRUE],
...
- Register routes from PHP SDK into your Symfony Application:
# config/routes/routing.yaml
...
hb_pf_applications:
resource: "@HbPFApplicationBundle/Controller"
type: annotation
hb_pf_connector:
resource: "@HbPFConnectorBundle/Controller"
type: annotation
hb_pf_custom_node:
resource: "@HbPFCustomNodeBundle/Controller"
type: annotation
hb_pf_batch:
resource: "@HbPFBatchBundle/Controller"
type: annotation
- Add parameters where will be your nodes and application registered:
# config/services.yaml
parameters:
node_services_dirs:
- '%kernel.project_dir%/config'
applications:
- '%kernel.project_dir%/config'
- Add required environment variables:
Example values:
BACKEND_DSN: 'http://127.0.0.10:8080'
STARTING_POINT_DSN: 'http://starting-point:8080'
WORKER_API_HOST: 'http://worker-api:8000'
ORCHESTY_API_KEY: 'ThisIsNotSoSecretApiKey'
How to develop
- Run
make init
for start dev environment - Tests can be run by
make test
ormake fasttest