CI Events for Third-Party integrations

Background information

Please make sure you tick (add an x between the square brackets with no spaces) the following check boxes:

[x] Reporting an issue of an unmodified OSPOS installation
[x] Checked open and closed issues and no similar issue was already reported (please make sure you searched!)
[x] Read README, WHATS_NEW, INSTALL.md and UPGRADE
[x] Read the FAQ for any known install and/or upgrade gotchas (in specific PHP extensions installed)
[x] Read the wiki
[x] Executed any database upgrade scripts if an upgrade pre 3.0.0 (e.g. database/2.4_to_3.0.sql)
[x] Aware the installation code is in bintray (see README), and GitHub master is for developers only and therefore not complete nor stable

Installation information

OSPOS version is: 3.3.1
OSPOS git commit hash is:
PHP version is: 7.3.6
MySQL or MariaDB version is: 5.7.24
OS and version is: FreeBSD 11.2
WebServer is: Apache 2.4
Selected language is: English
(If applicable) Docker installation:
(If applicable) Installation package for the LAMP/LEMP stack is:

New Feature

As discussed in #2315 and #1680 there is a need for us to have an Event Dispatcher to separate but facilitate Third-Party Integrations. I would like to use the CI library found at https://github.com/nathanmac/CodeIgniter-Events to do this. This is a light weight event listener/trigger library for CI to allow us to trigger events on CRUD operations. The listener third-party integrations can then take the data presented to it by the trigger (contents of the CRUD operation) and do its thing (send it to an API, process it, etc).

I'm guessing that in order for multiple third-party integrations to use the same data we will need to write a general listener/trigger pair for each CRUD operation type and then the Third-Party integrations call their own methods from within the listener. Otherwise if we left it up the the third party integrations to write their own listeners we could end up with a cluttered codespace with listeners.

For example, an Update Trigger would be placed into the Sales Controller or Model (The same trigger would get placed into Items since updates can be done there as well)

Events::trigger('item_update', $data_we_want_to_give_to_apis, 'array')

Then in an events library we put something like:

class Events { public function __construct() { Events::register('item_update', array($this, 'update_integrations')); }

public function update_integrations() { //call to this integration function with update data //call to another integration function with update data ... return $error_results; } }

Thoughts?

opensourcepos / opensourcepos