Download the PHP package robwdwd/arbor-api-bundle without Composer
On this page you can find all versions of the php package robwdwd/arbor-api-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download robwdwd/arbor-api-bundle
More information about robwdwd/arbor-api-bundle
Files in robwdwd/arbor-api-bundle
Package arbor-api-bundle
Short Description Arbor Sightline API Symfony Bundle.
License MIT
Homepage https://github.com/robwdwd/arbor-api-bundle
Informations about the package arbor-api-bundle
ArborAPI Symfony Bundle
Symfony Bundle for interfacing with the Arbor Sightline APIs.
What is the ArborAPI Bundle?
ArborAPI is a Symfony bundle to interface with Arbor Sightline deployments using REST, Web Services or SOAP.
Features
ArborAPI supports the following:
- Support for Arbor REST API as a service.
- Support for Arbor Web services API as a service.
- Support for Arbor SOAP API as a service.
- Optional caching of Sightline responses.
- Currently testing with Arbor SP 9.5 but should work with most 9.x versions and above.
Requirements
ArborAPI PHP Class requires the following:
- PHP 8.1 or higher
- symfony/http-client
- symfony/cache
- ext/dom
- ext/soap
Installation
Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.
Applications that use Symfony Flex
Open a command console, enter your project directory and execute:
Applications that don't use Symfony Flex
Step 1: Download the Bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the config/bundles.php
file of your project:
Configuration
Configuration is done in config/packages/robwdwd_arbor_api.yaml although this can be any filename.
Then in your .env.local (or any other Environment file you wish to use this in) add the following
Caching
By default the bundle does not cache the responses from Sightline/SP. Setting cache to to true in the configuration will cache the responses in the cache.app pool. By default it caches the response for five minutes (300 seconds). You can change this with the cache_ttl config setting.
You can turn on and off the cache in the current instance using the setShouldCache(bool)
function.
$restApi->setShouldCache(false)
If you are using the filesystem cache on your symfony application you will need to manually prune the cache to remove stale entries from time to time. You can set this up as a cron job.
Usage
Web Services and SOAP
REST API
All versions of arbor-api-bundle with dependencies
ext-dom Version *
ext-soap Version *
symfony/config Version >=6.0
symfony/cache Version >=6.0
symfony/dependency-injection Version >=6.0
symfony/framework-bundle Version >=6.0
symfony/http-client Version >=6.0