Feature plugins framework #4255

objecttothis · 2025-05-29T13:57:35Z

This framework provides the custom events which, when triggered, can be used by plugins to make API calls or other read-only data manipulations.

A plugins folder will be created in app/Controllers, and app/Models for plugins to place their code to be called.
Model code for now will be restricted to read-only function calls. Plans for a API endpoints allowing controlled read and write operations are in place.
Each plugin will be allowed a table in the database for its use. Read and write operations will be allowed by the plugin to this table.
A plugin_settings table will be created for plugin settings storage (api keys, behavioral settings, etc). keys will be named [pluginName]_[keyName] format.

- Add custom events for item changes, sales, returns, and inventory. - Add custom events for item and customer csv imports. Signed-off-by: objecttothis <objecttothis@gmail.com>

- Add custom events for item changes, sales, returns, and inventory. - Add custom events for item and customer csv imports. - Refactor variable names for PSR-12 compliance. - Refactor function names for PSR-12 compliance. - Moved retrieving of $employeeId to actually where it's going to be used for readability. - Added trigger point for item save. - Added trigger point for item delete. - Added debug logging for item_change event trigger. - Added itemId to be sent in the item_change event. Signed-off-by: objecttothis <objecttothis@gmail.com>

objecttothis · 2025-05-29T13:58:16Z

app/Config/Events.php

@@ -65,3 +65,52 @@

 $method = new Method();
 Events::on('pre_controller', [$method, 'validate_method']);
+


@jekkos can you think of other events that we want to include?

objecttothis · 2025-05-29T13:59:30Z

app/Controllers/Items.php


-                echo json_encode(['success' => true, 'message' => $message, 'id' => $item_id]);
+                Events::trigger('item_change', $itemId);


@jekkos this is an example of the trigger. It's nice and clean because none of the plugin code gets injected here. Just these triggers.

objecttothis · 2025-05-29T14:01:51Z

app/Config/Events.php

+ * This event triggered when an item is changed. This can be an item create, update or delete.
+ * Plugin functionality is triggered here.
+ */
+Events::on('item_change', static function (int $itemId): void {


$itemId is an example of being able to pass data from the trigger point. So for example, when someone changes an item, it sends the itemId that was changed here and, let's say a plugin decides to make an API call to a website to update the item on the website. In this static function we could call the controller method of the plugin to make the API call. Easy peasy. Plugin Controller code is in it's own space.

objecttothis · 2025-05-29T16:30:07Z

The refactoring of variable and function names to camelCase are variables and functions in sections of code I am modifying and are for PSR-12 compliance.

- Place trigger in Sale Controller. - Refactor variable names to camelCase for PSR-12 compliance - Refactor function names to camelCase for PSR-12 compliance - Minor readability refactoring of if/else to ternary notation - Removed hungarian notation Signed-off-by: objecttothis <objecttothis@gmail.com>

- Refactor function names to camelCase for PSR-12 compliance Signed-off-by: objecttothis <objecttothis@gmail.com>

- This fix properly creates Primary Keys on both MariaDB and MySQL Signed-off-by: objecttothis <objecttothis@gmail.com>

- Migration to create the table in the database - Removed unneeded using statements Signed-off-by: objecttothis <objecttothis@gmail.com>

objecttothis · 2025-05-31T20:30:57Z

@jekkos we need to make a few design decisions with this.

We need to refactor Integrations to Plugins. This means the Config.integrations and Config.Integrations_configuration need to be renamed to Config.Plugins and Config.Plugins_configuration. How do we do this in such a way that weblate retains the values that were in the former fields? People can then update the translations through weblate.
I think Mailchimp API is a prime candidate to refactor into the first plugin. It's already in the codebase and functioning. We just need to move the settings variables from ospos_app_config to ospos_plugin_config.
I think we need to create a new language file called Plugins.php which will contain all the language strings for plugins. This keeps with our efforts to segregate plugin code from the rest of the codebase.

The question is how to do 1 and 3 so that weblate does not flip out. Also, do you have any objection to 2?

- Renamed view from integrations_config to plugins_config.php - Added Plugin - Added todo in the code for refactoring - Refactored config.php strings - Moved mailchimp strings to Plugins.php for en. We will need to do this for all the languages perhaps to retain current translations. - Refactored view to use plugins naming Signed-off-by: objecttothis <objecttothis@gmail.com>

- Renamed view from integrations_config to plugins_config.php - Added Plugin - Added todo in the code for refactoring - Refactored config.php strings - Moved mailchimp strings to Plugins.php for en. We will need to do this for all the languages perhaps to retain current translations. - Refactored view to use plugins naming - Refactored Savefunction name - Refactored view identifiers to be more generic - Added Plugins folders in Controllers, Models and Views - Refactored check_encryption function for PSR-12 compliance Signed-off-by: objecttothis <objecttothis@gmail.com>

odiea · 2025-05-31T21:16:13Z

I don't know why the following is happening when trying to get a migration.

CRITICAL - 2025-05-31 15:06:25 --> Error: Call to undefined function App\Database\Migrations\execute_script()
[Method: POST, Route: login]
in APPPATH\Database\Migrations\20250531000000_PluginConfigTableCreate.php on line 16.
 1 SYSTEMPATH\Database\MigrationRunner.php(866): App\Database\Migrations\PluginConfigTableCreate->up()
 2 SYSTEMPATH\Database\MigrationRunner.php(182): CodeIgniter\Database\MigrationRunner->migrate('up', Object(stdClass))
 3 APPPATH\Controllers\Login.php(67): CodeIgniter\Database\MigrationRunner->latest()
 4 SYSTEMPATH\CodeIgniter.php(933): App\Controllers\Login->index()
 5 SYSTEMPATH\CodeIgniter.php(507): CodeIgniter\CodeIgniter->runController(Object(App\Controllers\Login))
 6 SYSTEMPATH\CodeIgniter.php(354): CodeIgniter\CodeIgniter->handleRequest(null, Object(Config\Cache), false)
 7 SYSTEMPATH\Boot.php(334): CodeIgniter\CodeIgniter->run()
 8 SYSTEMPATH\Boot.php(67): CodeIgniter\Boot::runCodeIgniter(Object(CodeIgniter\CodeIgniter))
 9 FCPATH\index.php(56): CodeIgniter\Boot::bootWeb(Object(Config\Paths))

objecttothis · 2025-06-02T08:12:19Z

I don't know why the following is happening when trying to get a migration.

CRITICAL - 2025-05-31 15:06:25 --> Error: Call to undefined function App\Database\Migrations\execute_script()
[Method: POST, Route: login]
in APPPATH\Database\Migrations\20250531000000_PluginConfigTableCreate.php on line 16.
 1 SYSTEMPATH\Database\MigrationRunner.php(866): App\Database\Migrations\PluginConfigTableCreate->up()
 2 SYSTEMPATH\Database\MigrationRunner.php(182): CodeIgniter\Database\MigrationRunner->migrate('up', Object(stdClass))
 3 APPPATH\Controllers\Login.php(67): CodeIgniter\Database\MigrationRunner->latest()
 4 SYSTEMPATH\CodeIgniter.php(933): App\Controllers\Login->index()
 5 SYSTEMPATH\CodeIgniter.php(507): CodeIgniter\CodeIgniter->runController(Object(App\Controllers\Login))
 6 SYSTEMPATH\CodeIgniter.php(354): CodeIgniter\CodeIgniter->handleRequest(null, Object(Config\Cache), false)
 7 SYSTEMPATH\Boot.php(334): CodeIgniter\CodeIgniter->run()
 8 SYSTEMPATH\Boot.php(67): CodeIgniter\Boot::runCodeIgniter(Object(CodeIgniter\CodeIgniter))
 9 FCPATH\index.php(56): CodeIgniter\Boot::bootWeb(Object(Config\Paths))

This happened to me the other day but it was because I tried to run a migration when my .env file had already been modified by the upgrade to CI4 which converts encryption from CI3 encryption to CI4 in the database and lengthens the encryption key. I've thought about making it more robust, but really it's a use case that should only be encountered during testing. Are you migrating a clean or pre-existing database? before running the migration did you have a CI3 key or was it a CI4 key?

odiea · 2025-06-02T09:28:35Z

I really don't know. I use what db happens to be available at the time. Probably multiple pre-existing ci3 databases.

objecttothis added 2 commits May 29, 2025 17:01

Custom Events for plugin triggers

6540a49

- Add custom events for item changes, sales, returns, and inventory. - Add custom events for item and customer csv imports. Signed-off-by: objecttothis <objecttothis@gmail.com>

objecttothis added this to the 3.5.0 milestone May 29, 2025

objecttothis self-assigned this May 29, 2025

objecttothis added the enhancement label May 29, 2025

objecttothis commented May 29, 2025

View reviewed changes

objecttothis and others added 4 commits May 29, 2025 21:07

Sale_event trigger

8fa30e3

- Refactor function names to camelCase for PSR-12 compliance Signed-off-by: objecttothis <objecttothis@gmail.com>

Migration fix for MariaDB databases

888dec2

- This fix properly creates Primary Keys on both MariaDB and MySQL Signed-off-by: objecttothis <objecttothis@gmail.com>

Merge branch 'master' into feature-plugins-framework

4e513e8

objecttothis mentioned this pull request May 31, 2025

[Bug]: Migrating from 3.3.3 to 3.4.0 (dev [e1feda]) fails #4256

Closed

1 task

Create ospos_plugin_config table

b1536ee

- Migration to create the table in the database - Removed unneeded using statements Signed-off-by: objecttothis <objecttothis@gmail.com>

objecttothis added 2 commits June 1, 2025 00:45

objecttothis mentioned this pull request Jun 11, 2025

How to add other payment types besides Cash? #4067

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Feature plugins framework #4255

Feature plugins framework #4255

Uh oh!

objecttothis commented May 29, 2025

Uh oh!

objecttothis May 29, 2025

Uh oh!

objecttothis May 29, 2025

Uh oh!

objecttothis May 29, 2025

Uh oh!

objecttothis commented May 29, 2025

Uh oh!

objecttothis commented May 31, 2025

Uh oh!

odiea commented May 31, 2025

Uh oh!

objecttothis commented Jun 2, 2025

Uh oh!

odiea commented Jun 2, 2025

Uh oh!

Uh oh!

		@@ -65,3 +65,52 @@

		$method = new Method();
		Events::on('pre_controller', [$method, 'validate_method']);


		echo json_encode(['success' => true, 'message' => $message, 'id' => $item_id]);
		Events::trigger('item_change', $itemId);

Uh oh!

Feature plugins framework #4255

Are you sure you want to change the base?

Feature plugins framework #4255

Uh oh!

Conversation

objecttothis commented May 29, 2025

Uh oh!

objecttothis May 29, 2025

Choose a reason for hiding this comment

Uh oh!

objecttothis May 29, 2025

Choose a reason for hiding this comment

Uh oh!

objecttothis May 29, 2025

Choose a reason for hiding this comment

Uh oh!

objecttothis commented May 29, 2025

Uh oh!

objecttothis commented May 31, 2025

Uh oh!

odiea commented May 31, 2025

Uh oh!

objecttothis commented Jun 2, 2025

Uh oh!

odiea commented Jun 2, 2025

Uh oh!

Uh oh!