Extension:ClassProcessor
 Release status: beta |
|
|---|---|
| Description | |
| Author(s) | Jean-Lou Dupont |
| Last version | 1.0.0 |
| MediaWiki | 1.11, 1.12 |
| License | No license specified |
| Download | SVN See SVN ($Id: ClassProcessor.doc.wikitext 979 2008-04-05 15:16:58Z jeanlou.dupont $) |
| Check usage and version matrix | |
Contents |
Purpose [edit]
Provides versatile PHP class autoloading.
Features [edit]
- Flexible: multiple class locations
- Secure: classes retrieved through the database must be in the Code namespace and be edit protected
- Extensible: the static method add can be used to register additional autoloaders
Theory Of Operation [edit]
When a class is required (e.g. Extension:FlowProcessor) for processing, the following options are available:
- do a require/include statement with the path to the class file
- rely on PHP's autoloading feature
This extension taps itself on the latter on provides flexible class loading by searching (in priority):
- The extra autoloaders registered through the extension's add static method
- The PEAR directory under MediaWiki/Classes/$class.php
- The MediaWiki installation extensions directory i.e. $IP/extensions/Classes/$class.php
- The MediaWiki page database under the namespace Code i.e. Code:$class
Dependency [edit]
None.
Installation [edit]
See the Mediawiki Extension table entry "download" above.[1]
LocalSettings.php [edit]
Extension:ExtensionManager: See footnote[2]
- Add the following to LocalSettings.php, if the extension was downloaded from Jean-Lou Dupont's MediaWiki SVN directory (link in the download entry of the table above)[2]:
require_once( "$IP/extensions/ClassProcessor/ClassProcessor.php" );
- Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.
PEAR [edit]PEAR is a repository of PHP software code.
require 'MediaWiki/ClassProcessor/ClassProcessor.php';
Upgrades through PEAR [edit]Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.
or use the force method:
PEAR Web Frontend [edit]For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here. |
RSS feed [edit]
To keep up-to-date with this channel, use the following RSS feed__
.
Notes [edit]
Other Extensions From the same author [edit]
Consult User Jldupont's page.
- ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
- ↑ 2.0 2.1 2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed. - ↑ Modifications to
LocalSettings.phpis only necessary if not using Extension:ExtensionManager
Usage [edit]
The extension is meant to be used in conjunction with Extension:FlowProcessor and others. By itself, it does not provide useful facilities to end-users.
History [edit]
| Release | Notes |
|---|---|
| 1.0.0 | Initial Release |
