etsvthor / laravel-cashregister-bridge
Connect a laravel application with the Thor cash register
Requires
- php: ^8.2
- laravel/framework: ^10.0|^11.0
- spatie/laravel-data: ^4.0
- spatie/laravel-package-tools: ^1.16.2
Requires (Dev)
- larastan/larastan: ^2.0.1
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.0|^8.0
- orchestra/testbench: ^9.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- dev-main
- 4.1.4
- 4.1.3
- 4.1.2
- 4.1.1
- 4.1.0
- 4.0.0
- 3.0.1
- 3.0.0
- 2.0.0
- 1.0.0
- 0.1.0
- dev-bugfix/with_thrashed
- dev-features_teslan
- dev-bugfix/nvm
- dev-feature/fuck-database-permissions
- dev-to_laravel_11
- dev-laravel_11
- dev-changelog_302
- dev-fix/improve-completed-bool
- dev-feature/set-completed
- dev-delete_refund_sync
- dev-bridge
This package is auto-updated.
Last update: 2024-09-04 11:51:11 UTC
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.