Using Platform Config Keys in Extensions

From osCommerce Wiki
Jump to navigation Jump to search

This manual explains how to create an extension that uses platform config keys and how these settings are applied during installation.

Follow the steps below to generate and install the extension.


1) Open the Extension Generator Tool

Go to the extension generator tool at:

https://generator.tllab.co.uk/

2) Complete the General Tab

  1. Fill in all required fields under the General tab.
  2. When finished, click Next.
Image 890.png


3) Enable Platform Config Keys

  1. Under the Common tab, enable the Use platform config keys option.
  2. Click Next to continue.
Image 889.png


4) Generate the Extension

1. In the Advanced tab, click the Generate button.

  • A ZIP file containing the extension will be created.
Image 888.png


5) Review the Setup File (Optional)

If you open the generated Setup file, you will notice that the only difference between platform config keys and standard config keys is one additional line included for platform config keys.

Image 887.png


6) Unpack the ZIP File

Unpack the generated ZIP file into the required directory on your server.

7) Install the Extension

1. Log in to the admin area of your website.

2. Install the extension as usual.

Image 886.png


8) Review Platform Settings During Installation

During installation, you will see that platform settings are automatically applied to the extension.

These settings include information related to the config keys.

If your website has multiple platforms, the platform-specific settings will be applied separately to each one.

Image 891.png
Retrieved from "https://www.oscommerce.com/wiki/index.php?title=Using_Platform_Config_Keys_in_Extensions&oldid=145526"