Configuration

The config file is located under $PHPLUG_HOME/config/config.xml

Syntax

The config file is in XML format and looks like the following:

<!ELEMENT ROOT		(config)>
<!ELEMENT config	(entry*)>
<!ELEMENT entry	EMPTY>

<!ATTLIST entry

                          key		ID	#REQUIRED

                          value	CDATA	#REQUIRED>

Directives

Name	Explanation	Example value
ch.thobens.phplug.plugindir	The directory where plugins should be installed, relative from document root.It must have read/write permissions for all (UNIX: 777 or 755)	./PHPlug/plugins
ch.thobens.phplug.packagedir	The directory, where plugin packages are uploaded and taken for install	./PHPlug/plugins/packages
ch.thobens.phplug.rootdir	The root direcrory of phplug, relative from document root	./PHPlug
ch.thobens.phplug.logcfg	The log configration for this application, relative from document root	./config/logging.xml
ch.thobens.phplug.logfile	The log file of this application, relative from document root	.log/out.log
ch.thobens.phplug.debugmode	Indicates whether this application runs in debug mode	true
ch.thobens.phplug.admin.mail	Email address of the administrator	your.name@provider.com
(deprecated) ch.thobens.phplug.php.extensions	PHP File Extensions. This should be a comma separated list of extensions, for example “php,inc”	php,inc

Read Configuration in your Plugin

The config file can be extended, so if you want to add a (for developers only) configurable value specific to your plugin, just add another entry with a key. Note that the attribute key is defined as XML ID, so a key must occur exactly once.

You can read a config entry like this:

use phplug\platform;
platform\PhplugPlatform::getConfig()->getConfigEntry($key);