PHP Macro

PHP Macro

This macro executes embedded PHP scripts.

Usage:

{{php}}<?php echo 'Hello World!'; ?>{{/php}}

Result:
Hello World!

Installation

To use the php macro, you need to install the following three libraries inside WEB-INF/lib directory of your XE installation:

• XWiki PHP Macro (select a version compatible with your wiki)
• Quercus library (select the latest version)
• Resin utils (select the same version as the quercus library)

Unfortunately, the quercus library does not contain all the PHP libraries, so at startup you will get some exceptions in the logs, like:

INFO: Failed loading com.caucho.quercus.lib.dom.DOMText
java.lang.ClassNotFoundException: com.caucho.quercus.lib.dom.DOMText

The missing modules are: bam, dom, pdf, and resin. If you want to use them, they are found in the main Resin jar.

Usage

Unlike the other scripting languages available for XWiki, PHP is a semi-templating scripting language, which means that it must explicitly wrap code sections inside <?php ?> markers:

Some *wiki* content.
{{php}} Some static content inside the PHP macro,
<?php echo("and some dynamic content."); ?> {{/php}}

A current limitation of the Quercus library is that variables and class definitions are only valid inside the same macro block.

{{php}} <?php $i = 5; ?>
$i will be visible inside the same macro block:
<?php echo ($i); ?>
The correct value of i will be printed, 5.
{{/php}}

Unfortunately, here $i will not be valid:

{{php}} <?php echo ($i); ?> {{/php}}

Licensing

Quercus is licensed under the GPL, so using it inside your wiki will force the entire software to respect the GPL license.