rossity/laravel-quickbase

A wrapper around rossity/php-quickbase for Laravel.

v0.2 2021-01-08 15:02 UTC

This package is auto-updated.

Last update: 2021-11-08 17:12:56 UTC


README

Latest Version on Packagist Total Downloads

A wrapper around rossity/php-quickbase that makes it easy to consume the Quick Base REST API in your Laravel application.

Intended for use with Laravel 8+

Installation

Via Composer

$ composer require rossity/laravel-quickbase

The Service Provider and Facade will automatically be registered.

Usage

In your .env file, define the following:

QUICKBASE_DEFAULT_REALM={your quickbase realm i.e. 'demo' in 'demo.quickbase.com'}
QUICKBASE_DEFAULT_USER_TOKEN={your user token that you assign inside QuickBase}

You are now able to do things such as:

// Get QuickBase table info
Quickbase::tables()->getTable('q1w2e3r4', 'w2e3r4t5');

// Insert or update a QuickBase record
Quickbase::records()->upsert([
    'to' => 'q1w2e3r4',
    'data' => [
        [
            '10' => [
                'value' => 'A string',
            ],
        ],
    ],
]);

You have access to the following:

Quickbase::apps();
Quickbase::fields();
Quickbase::files();
Quickbase::records();
Quickbase::reports();
Quickbase::tables();

For more information on the API and methods available, see the documentation for rossity/php-quickbase and the Quick Base REST API developer docs.

Security

If you discover any security related issues, please email w.ross.ball@gmail.com instead of using the issue tracker.

Credits

License

MIT. Please see the license file for more information.