Extension:StubManager

This is extension is required for many other extensions developed by User:Jldupont. This extension is meant for 'extension writers' and for users of extensions that depend on StubManager.

Important Note
Please do not use version 1.3.1 as it is buggy. Once the PHP PDT plugin for Eclipse/Ganymede is working, I'll update this extension. Thanks. Jean-Lou Dupont 13:08, 11 November 2008 (UTC)

Purpose
This extension lowers loading times which speeds up MediaWiki sites. This is done by addressing 'rare events' handling through class object 'stubs'. For infrequent events (of course this is relative!), use this extension to create a 'stub object' for the required hooks.

Features

 * Provides extension status messages through Special:Version
 * Customizable through MediaWiki:ExtensionState page
 * Handles 'hook' registration (e.g.  etc.)
 * Handles 'parser function' registration (e.g. )
 * Handles 'parser magic word' registration
 * Handles 'parser tag' registration (e.g. )
 * Handles extensions which implement logging functionality
 * Handles 'namespace triggering' & 'namespace exclusion'
 * reduces even further the load time per transaction

Dependency
None.

Installation
Important: To work correctly, make sure that this extension is listed first in LocalSettings.php before any other extensions depending on this one.

1. Add the following to : 2. The most recent tgz file, currently StubManager-1.3.0.tgz.

3. Unzip the tgz file.

4. Drag and drop the entire "Stubmanager" folder into your /extensions folder, making sure that no folders or files locations are moved around.

5. Change the file name to "Stubmanager" only, with no version numbers.

6. Check to see if the Stubmanager is installed. There should be a line like the following on the Special:Version page:
 * StubManager (version x.x.x), Provides stubbing facility for extensions handling rare events. $1Extensions registered:, by Jean-Lou Dupont

PEAR

 * Install PEAR channel http://mediawiki.googlecode.com/svn
 * Install extension through PEAR:
 * Add the following to
 * Add the following to
 * Add the following to

SVN

 * Download archive: SVN
 * Place extension files in /extensions
 * Add the following to :

Usage
To create a stub, use: or, for example: in  after the require line

Examples
See Email Log extension.

Special:Version Customization
Customization of the extensions' state message can be done through the page MediaWiki:ExtensionState. The first parameter passed to the template is the state variable.

Troubleshooting
Extensions that depend on StubManager will show up in Special:Version under Extensions registered. If the extension you are installing does not appear on this list, then it can possibly mean that the require statement of the extension is listed before StubManager in your  file. To correct this problem, place the dependent extension after the require statement of StubManager.