Filesystem directories for ConfigBox

These are locations of relevant folders in ConfigBox. Each path is relative to the platform's root directory.

This article covers the directory locations mentioned in the customization articles. There is also a comprehensive article on CB directories. 

ConfigBox application folder (appDir):

Joomla: /components/com_configbox/
Wordpress: /wp-content/plugins/configbox/app/
Magento 2: /vendor/rovexo/configbox-php/src/Rovexo/Configbox/

Function to return the location

KenedoPlatform::p()->getComponentDir()

Application assets folder:

Joomla: /components/com_configbox/assets/
Wordpress: /wp-content/plugins/configbox/app/assets/
Magento 2: /vendor/rovexo/configbox-magento2/view/base/web/lib-assets

Function to return the location:

KenedoPlatform::p()→getUrlAssets()
KenedoPlatform::p()->getDirAssets()

Customization folder (customizationDir):

In CB you have a central directory for all files involved in customizations.

Joomla: /components/com_configbox/data/customization/
Wordpress: /wp-content/plugins/configbox-customization/
Magento 2: /app/code/Rovexo/ConfigboxCustomizations/view/customizations/

(for Magento 2 you need to install the Magento 2 Customization Module, see this article.)

Function to return the location:

KenedoPlatform::p()->getUrlCustomization()
KenedoPlatform::p()->getDirCustomization()

Customization assets folder

This folder contains stylesheets, JavaScript, images, fonts etc. Files that need to be publicly available via HTTP 

Joomla: /components/com_configbox/data/customization/assets/
Wordpress: /wp-content/plugins/configbox-customization/assets/
Magento 2: /app/code/Rovexo/ConfigboxCustomizations/view/base/web/

(for Magento 2 you need to install the Magento 2 Customization Module, see this article.)

Function to return the location:

KenedoPlatform::p()->getUrlCustomizationAssets()
KenedoPlatform::p()->getDirCustomizationAssets()

Store data folder

This folder contains all files for product data. There is a sub folder public and private - one publicly accessible and one protected against access via HTTP

Joomla: /components/com_configbox/data/store/
Wordpress: /wp-content/uploads/cb-store-data/
Magento 2: /pub/media/rovexo/store/

Function to return the location:

KenedoPlatform::p()->getDirDataStore()
KenedoPlatform::p()->getUrlDataStore()

Customer data folder

This folder contains all files for customer data (e.g. uploaded files, invoices, quotation PDFs). There is a sub folder public and private - one publicly accessible and one protected against access via HTTP

Joomla: /components/com_configbox/data/customer/
Wordpress: /wp-content/uploads/cb-customer-data/
Magento 2: /pub/media/rovexo/customer/

Function to return the location:

KenedoPlatform::p()->getDirDataCustomer()
KenedoPlatform::p()->getUrlDataCustomer()

Log folder

This folder contains log files for post-incident-analysis and debugging.

Joomla: (Joomla log dir location)/configbox
Wordpress: /wp-content/uploads/cb-logs
Magento2: /var/log/configbox

Function to return the location:

KenedoPlatform::p()→getLogPath()

See KLog::log($message, $logLevel) on how to write your own log messages.