Building A Module

Modules are very easy to build. All you need to do to integrate your code with the system is to create a directory under the web/services directory with the name of the module. Each page then has it's own PHP file with a class that extends the Action class. Each page, known as an action, should mimic the Action class by implementing a method called 'launch'.

Your module can make use of the underlying Solr Data Repository by including the SOLR.php file found in the web/sys directory. The class is instantiated with the path to the Solr Repository

Your module can also take advantage of the configuration file found in the web/conf directory. You can simply state

    global $configArray;

To access the array of configuration options in your method.

Here is a shell for an action class:

<?php
require_once 'Action.php';
class MyAction extends Action
{
    function launch()
    {
        global $interface;
        global $configArray;
 
        $interface->setPageTitle('My Action');
        $interface->setTemplate('myaction.tpl');
 
        // Do Something Here
 
        $interface->display('layout.tpl');
    }
}
?>