README

This package allows paying items from the website with the Thor cash register, for instance activity subscriptions from the Thorsite or TesLAN tickets. If an item is paid on the website, it's synced to the cash register. An item that is paid on the cash register gets synced to the external website as well.

Installation

You can install the package via composer:

composer require etsvthor/laravel-cashregister-bridge

Optionally, you can publish the config file. This is not necessary normally, but you can do it with:

php artisan vendor:publish --tag="cashregister-bridge-config"

This is the contents of the published config file:

return [
    'service_id' => env('CASHREGISTER_SERVICE_ID'),
    'secret' => env('CASHREGISTER_SECRET'),
    'base_url' => env('CASHREGISTER_BASE_URL', 'https://kassa.thor.edu`'),
];

Create a service via https://finances.thor.edu/admin/services and put the service id + secret in the .env.

Usage

There are 2 types of models that needs to have an interface implemented. See the thorsite as example.

External Product

A product that you can sell. This can be an activity or a merch item to sell, etc. (For the thorsite: webform)

Implement the EtsvThor\CashRegisterBridge\Contracts\HasExternalProduct interface
Use the EtsvThor\CashRegisterBridge\Traits\PushesExternalProduct trait

This will make you implement a conversion from the model to the linked DTO

External Product Item

The model that keeps track of what you sold. E.g. an activity subscription or someone who buys a merch item. (For the thorsite: webform submission)

Implement the EtsvThor\CashRegisterBridge\Contracts\HasExternalProductItem interface
Use the EtsvThor\CashRegisterBridge\Traits\PushesExternalProduct trait

This will make you implement a conversion from the model to the linked DTO

Migration

If you have existing models in your database with the HasExternalProduct and HasExternalProductItem interface, then you need to touch them, so they get put on the cash register E.g.

foreach(Webform::all() as $webform){
    $webform->touch();
}

foreach(WebformSubmission::all() as $webform_submission){
    $webform_submission->touch();
}

You may need to throttle this, to not send too many http requests

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.

etsvthor / laravel-cashregister-bridge

Maintainers

Details