Extension:ClassProcessor

From MediaWiki.org

Jump to: navigation, search
Manual on MediaWiki Extensions
List of MediaWiki Extensions
ClassProcessor

Release status: beta
Description
Author(s) Jean-Lou Dupont
Version 1.0.0
MediaWiki 1.11, 1.12
Download SVN
See SVN ($Id: ClassProcessor.doc.wikitext 979 2008-04-05 15:16:58Z jeanlou.dupont $)

Contents

[edit] Purpose

Provides versatile PHP class autoloading.

[edit] Features

  • 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

[edit] Theory Of Operation

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


[edit] Dependency

None.



[edit] Installation

See the Mediawiki Extension table entry "download" above.[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote[2]

require_once( "$IP/extensions/ClassProcessor/ClassProcessor.php" );

[edit] PEAR

PEAR is a repository of software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/ClassProcessor
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/ClassProcessor/ClassProcessor.php';

[edit] Upgrades through PEAR

Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.

pear clear-cache

or use the force method:

pear upgrade --force mediawiki/ClassProcessor

[edit] PEAR Web Frontend

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.

[edit] RSS feed

To keep kept up-to-date with this channel, use the following RSS feedImage:Rss2.jpg.

[edit] Notes

  1. ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
  2. ↑ 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.
  3. ↑ Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] Usage

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.

[edit] History

Release Notes
1.0.0 Initial Release
Retrieved from "http://www.mediawiki.org/wiki/Extension:ClassProcessor"
Personal tools
In other languages