README

This is a package meant to make interacting with the onOffice API enjoyable and easy. We try our best to make all rules from the API as explicit as possible in code. This means you shouldn't be able to create invalid requests. It is based on the official php sdk and saloon.

Installation

You can install the package via composer:

composer require kauffinger/onoffice-laravel-adapter

You can publish the config file with:

php artisan vendor:publish --tag="onoffice-laravel-adapter-config"

This is the contents of the published config file:

return [
    'token' => env('ON_OFFICE_TOKEN'),
    'secret' => env('ON_OFFICE_SECRET'),
    'base_url' => env('ON_OFFICE_BASE_URL', 'https://api.onoffice.de/api/stable/api.php'),
];

Usage

$api = new OnOfficeApi(config('onoffice.token'), config('onoffice.secret'));
$request = new OnOfficeApiRequest();
$request->addAction(
    Action::read()
        ->address()
        ->formatOutput()
        ->outputInLanguage(Language::German)
        ->addMobileUrl()
        ->fieldsToRead('phone', 'mobile')
        ->setListLimit(200)
);

$response = $api->send($request);

Or, if you like your code even cleaner, how about this:

$request = OnOfficeApiRequest::with(
    Action::read()
        ->task()
        ->fieldsToRead('Eintragsdatum', 'modified')
        ->setRelatedEstateId(2)
        ->setRelatedProjectId(1)
        ->setListLimit(200)
);

$response = OnOfficeApi::for(
    config('onoffice.token'), config('onoffice.secret')
)
    ->send($request);

You can easily send multiple actions in one request:

$request = OnOfficeApiRequest::with(
    Action::read()->estate()
)->withAction(
    Action::read()->address()
);

With the custom response class, you can easily manage the response. For example, when onOffice returns the HTTP status code 200, but the response contains status.code == 500, the response will not be marked as OK:

$response = OnOfficeApi::send($request);
$response->ok(); // would be false

Furthermore, it provides easy access to both the results of an onOffice response:

$response->results();
// or as a collection
$response->collectedResults();

If you don't need the full results array, because you maybe only sent a single action, you can access action data directly:

$response->getData();
// or as a collection
$response->getCollectedData();
// get the first data array
$response->getData(0);

You can determine if a response is cacheable by calling the cacheable method. It checks the response for each action in the request and checks cacheability:

$response->cacheable();

Since the goal of this SDK is to streamline onOffice API usage as much as possible, a lot of endpoints are still missing. You can then still use the library to send custom actions:

$request->addAction(
    Action::read()
        ->custom() // this will give you full control over the action, except for the action type
        ->setResourceType('estate')
        ->setResourceId(123)
        ->setParameters([
            'data' => ['Id', 'kaufpreis']
        ])
);

Known Issues

Currently, no identifier seems to be returned from the onOffice API.

Future Features

Access all onOffice API endpoints in a way that is as typesafe as possible (in progress)
Integrate optional saloon based caching of requests (todo)
Add saloon resource classes for the most used basic actions (todo)

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

kauffinger / onoffice-laravel-adapter

Maintainers

Details