From f9a8041d4a0a64a742c3b2ee02bf980271b841b7 Mon Sep 17 00:00:00 2001 From: Philipp Stracker Date: Tue, 21 Jan 2025 13:13:55 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A5=20Remove=20irrelevant=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../resources/js/data/payment/README.md | 45 ------------------- 1 file changed, 45 deletions(-) delete mode 100644 modules/ppcp-settings/resources/js/data/payment/README.md diff --git a/modules/ppcp-settings/resources/js/data/payment/README.md b/modules/ppcp-settings/resources/js/data/payment/README.md deleted file mode 100644 index b97f6ca4c..000000000 --- a/modules/ppcp-settings/resources/js/data/payment/README.md +++ /dev/null @@ -1,45 +0,0 @@ -# Store template - -This template contains all files for a Redux store. - -## New Store: Redux integration - -1. Copy this folder, give it a correct name. -2. Check each file for `` placeholders and `TODO` remarks. -3. Edit the main store-index file and add the relevant store integration there. -4. Check the debug-module, and add relevant debug code. - - Register the store in the `reset()` method. - ---- - -Main store-index: -`modules/ppcp-settings/resources/js/data/index.js` - -Sample store integration: -```js -import * as YourStore from './yourStore'; -// ... -YourStore.initStore(); -// ... -export const YourStoreHooks = YourStore.hooks; -// ... -export const YourStoreName = YourStore.STORE_NAME; -// ... -addDebugTools( window.ppcpSettings, [ ..., YourStoreName ] ); -``` - ---- - -### New Store: PHP integration - -1. Create the **REST endpoint** for hydrating and persisting data. - - `modules/ppcp-settings/src/Endpoint/YourStoreRestEndpoint.php` - - Extend from base class `RestEndpoint` -2. Create the **data model** class to manage the DB interaction. - - `modules/ppcp-settings/src/Data/YourStoreSettings.php` - - Extend from base class `AbstractDataModel` -3. Create relevant **DI services** for both files. - - `modules/ppcp-settings/services.php` -4. Register the REST endpoint in the **service module**. - - `modules/ppcp-settings/src/SettingsModule.php` - - Find the action `rest_api_init`