One way for a module to participate in Perforce Chronicle operations is by implementing an integration class. When a module is enabled, disabled, loaded for use, or initialized, it can prepare or clean up the resources that it requires. In addition, modules can publish and subscribe to topics that enable it to create and respond to Chronicle events. These mechanisms provide you with great flexibility in enhancing Chronicle.

The Module.php file defines a module's integration with Chronicle. Example: for a module named "Foo," the basic structure of the integration is as follows:

<?php
/**
 * Description of the module.
 *
 * @copyright   Copyright information.
 * @license     License information.
 * @version     Version identifier(s)
 */
class Foo_Module extends P4Cms_Module_Integration
{
    /**
     * Perform early integration work (before load).
     */
    public static function init()
    {
        // subscribe to topics here
    }

    /**
     * Perform integration work at load time.
     */
    public static function load()
    {
    }

    /**
     * Perform work when this module is enabled.
     */
    public static function enable()
    {
    }

    /**
     * Perform work when this module is disabled.
     */
    public static function disable()
    {
    }
}