Minor doc tweaks to prevent some PHPDocumentor warnings or errors when run on the includes/ directory. PHPDocumentor uses a syntax very similar to javadoc - mostly we already use this, but there were a few scattered places that were adjusted to make them consistent with the rest of the code. In practical terms, these changes were made:
* @url becomes @link
* @fixme becomes @todo
* HTML tags in descriptions must be closed / balanced.
* @bug was removed (where the bug was long fixed), or changed into a @todo (in the few situations where the bug was still pending)
* @obsolete becomes @deprecated
* Things like "/**@{{" and "/**@}}*/" which cause "unknown tag" warnings were removed
* @access must be a valid access level.
* @desc tag not needed, removed.
* Doesn't seem to like @licence, will accept @license however.
* Use full comment block notation in a few places (i.e. open block with "/**", start each line with " *", and end block with " */")
Then additional to this, to get some class docs associated with their respective classes:
* Moved some docs to right above those classes (deleting blank lines, or moving descriptions from the file headers)
* Marked some classes without docs as "@todo document"
* (done up to "class MIMEsearchPage" on the "classtrees_MediaWiki.html" page for the includes/ directory)
require_once( 'AjaxFunctions.php' );
+/**
+ * @todo Document - e.g. Provide top-level description of this class.
+ */
class AjaxDispatcher {
var $mode;
var $func_name;
die( 1 );
}
-/** @todo document */
+/**
+ * @todo document
+ */
class AjaxResponse {
var $mCacheDuration;
var $mVary;
*
*/
class Article {
- /**@{{
+ /**
* @private
*/
var $mComment; //!<
var $mTouched; //!<
var $mUser; //!<
var $mUserText; //!<
- /**@}}*/
+ /** end private properties */
/**
* Constructor and clear the article
*
* @param Revision $rev
*
- * @fixme This is a shitty interface function. Kill it and replace the
+ * @todo This is a shitty interface function. Kill it and replace the
* other shitty functions like editUpdates and such so it's not needed
* anymore.
*/
<?php
-/*
-The "Categoryfinder" class takes a list of articles, creates an internal representation of all their parent
-categories (as well as parents of parents etc.). From this representation, it determines which of these articles
-are in one or all of a given subset of categories.
-
-Example use :
-
- # Determines wether the article with the page_id 12345 is in both
- # "Category 1" and "Category 2" or their subcategories, respectively
-
- $cf = new Categoryfinder ;
- $cf->seed (
- array ( 12345 ) ,
- array ( "Category 1","Category 2" ) ,
- "AND"
- ) ;
- $a = $cf->run() ;
- print implode ( "," , $a ) ;
-
-*/
-
+/**
+ * The "Categoryfinder" class takes a list of articles, creates an internal representation of all their parent
+ * categories (as well as parents of parents etc.). From this representation, it determines which of these articles
+ * are in one or all of a given subset of categories.
+ *
+ * Example use :
+ *
+ * # Determines wether the article with the page_id 12345 is in both
+ * # "Category 1" and "Category 2" or their subcategories, respectively
+ *
+ * $cf = new Categoryfinder ;
+ * $cf->seed (
+ * array ( 12345 ) ,
+ * array ( "Category 1","Category 2" ) ,
+ * "AND"
+ * ) ;
+ * $a = $cf->run() ;
+ * print implode ( "," , $a ) ;
+ *
+ *
+ */
class Categoryfinder {
var $articles = array () ; # The original article IDs passed to the seed function
<?php
-/**
- * Contain class to show various lists of change:
- * - what's link here
- * - related changes
- * - recent changes
- */
/**
* @todo document
} ;
/**
+ * Class to show various lists of changes:
+ * - what links here
+ * - related changes
+ * - recent changes
*/
class ChangesList {
# Called by history lists and recent changes
* Utility classes
*****************************************************************************/
+/**
+ * Utility class.
+ */
class DBObject {
public $mData;
}
};
+/**
+ * Utility class.
+ */
class MySQLField {
private $name, $tablename, $default, $max_length, $nullable,
$is_pk, $is_unique, $is_key, $type;
# Other functions
#------------------------------------------------------------------------------
- /**@{{
+ /**
+ * Constructor.
* @param string $server database server host
* @param string $user database user name
* @param string $password database user password
* @param string $dbname database name
- */
-
- /**
* @param failFunction
* @param $flags
* @param $tablePrefix String: database table prefixes. By default use the prefix gave in LocalSettings.php
wfProfileOut( __METHOD__ );
return $success;
}
- /**@}}*/
/**
* Closes a database connection.
}
/**
- * @desc: Fetch a number of table names into an zero-indexed numerical array
+ * Fetch a number of table names into an zero-indexed numerical array
* This is handy when you need to construct SQL for joins
*
* Example:
/**
* This is the Oracle database abstraction layer.
*/
-
class ORABlob {
var $mData;
function getData() {
return $this->mData;
}
-};
+}
-/*
+/**
* The oci8 extension is fairly weak and doesn't support oci_num_rows, among
* other things. We use a wrapper class to handle that and other
* Oracle-specific bits, like converting column names back to lowercase.
<?php
-/**
- * Date formatter, recognises dates in plain text and formats them accoding to user preferences.
- *
- * @addtogroup Parser
- */
/**
+ * Date formatter, recognises dates in plain text and formats them accoding to user preferences.
* @todo preferences, OutputPage
* @addtogroup Parser
*/
/** Sets the mime type definition file to use by MimeMagic.php.
* @global string $wgMimeTypeFile
*/
-#$wgMimeTypeFile= "/etc/mime.types";
$wgMimeTypeFile= "includes/mime.types";
+#$wgMimeTypeFile= "/etc/mime.types";
#$wgMimeTypeFile= NULL; #use built-in defaults only.
/** Sets the mime type info file to use by MimeMagic.php.
<?php
/**
* See diff.doc
+ * @todo indicate where diff.doc can be found.
* @addtogroup DifferenceEngine
*/
}
/**
- * FIXME: bad name.
- * @todo document
+ * @todo document, bad name.
* @private
* @addtogroup DifferenceEngine
*/
<?php
+
/**
- * Support for detecting/validating DjVu image files and getting
- * some basic file metadata (resolution etc)
- *
- * File format docs are available in source package for DjVuLibre:
- * http://djvulibre.djvuzone.org/
- *
*
* Copyright (C) 2006 Brion Vibber <brion@pobox.com>
* http://www.mediawiki.org/
*
*/
+/**
+ * Support for detecting/validating DjVu image files and getting
+ * some basic file metadata (resolution etc)
+ *
+ * File format docs are available in source package for DjVuLibre:
+ * http://djvulibre.djvuzone.org/
+ */
class DjVuImage {
function __construct( $filename ) {
$this->mFilename = $filename;
<?php
/**
- * Contain the EditPage class
+ * Contains the EditPage class
*/
/**
- * Splitting edit page/HTML interface from Article...
+ * The edit page/HTML interface (split from Article)
* The actual database and text munging is still in Article,
* but it should get easier to call those from alternate
* interfaces.
- *
*/
-
class EditPage {
var $mArticle;
var $mTitle;
* http://www.gnu.org/copyleft/gpl.html
*
* @link http://exif.org/Exif2-2.PDF The Exif 2.2 specification
- * @bug 1555, 1947
*/
/**
+ * @todo document (e.g. one-sentence class-overview description)
* @addtogroup Metadata
*/
class Exif {
}
/**
+ * @todo document (e.g. one-sentence class-overview description)
* @addtogroup Metadata
*/
class FormatExif {
<?php
-# Basic support for outputting syndication feeds in RSS, other formats
-#
+
# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
#
# http://www.gnu.org/copyleft/gpl.html
/**
+ * Basic support for outputting syndication feeds in RSS, other formats.
* Contain a feed class as well as classes to build rss / atom ... feeds
* Available feeds are defined in Defines.php
*/
-
/**
- * @todo document
+ * @todo document (needs one-sentence top-level class description + function descriptions).
*/
class FeedItem {
/**#@+
}
/**
- * @todo document
+ * @todo document (needs one-sentence top-level class description).
*/
class ChannelFeed extends FeedItem {
/**#@+
/**
* Generate a RSS feed
- * @todo document
*/
class RSSFeed extends ChannelFeed {
/**
* Generate an Atom feed
- * @todo document
*/
class AtomFeed extends ChannelFeed {
/**
<?php
+/**
+ * @todo document (needs one-sentence top-level class description).
+ */
class FileStore {
const DELETE_ORIGINAL = 1;
* suffer an uncaught error the lock will be released when the
* connection is closed.
*
- * @fixme Probably only works on MySQL. Abstract to the Database class?
+ * @todo Probably only works on MySQL. Abstract to the Database class?
*/
static function lock() {
global $wgDBtype;
* @throws FSException if file can't be deleted
* @return FSTransaction
*
- * @fixme Might be worth preliminary permissions check
+ * @todo Might be worth preliminary permissions check
*/
static function deleteFile( $path ) {
if( file_exists( $path ) ) {
* Returns message in the requested format
* @param string $key Key of the message
* @param array $options Processing rules:
- * <i>parse<i>: parses wikitext to html
- * <i>parseinline<i>: parses wikitext to html and removes the surrounding p's added by parser or tidy
- * <i>escape<i>: filters message trough htmlspecialchars
- * <i>replaceafter<i>: parameters are substituted after parsing or escaping
- * <i>parsemag<i>: transform the message using magic phrases
+ * <i>parse</i>: parses wikitext to html
+ * <i>parseinline</i>: parses wikitext to html and removes the surrounding p's added by parser or tidy
+ * <i>escape</i>: filters message trough htmlspecialchars
+ * <i>replaceafter</i>: parameters are substituted after parsing or escaping
+ * <i>parsemag</i>: transform the message using magic phrases
*/
function wfMsgExt( $key, $options ) {
global $wgOut, $wgParser;
* Just like exit() but makes a note of it.
* Commits open transactions except if the error parameter is set
*
- * @obsolete Please return control to the caller or throw an exception
+ * @deprecated Please return control to the caller or throw an exception
*/
function wfAbruptExit( $error = false ){
global $wgLoadBalancer;
}
/**
- * @obsolete Please return control the caller or throw an exception
+ * @deprecated Please return control the caller or throw an exception
*/
function wfErrorExit() {
wfAbruptExit( true );
/**
* An Exif timestamp (YYYY:MM:DD HH:MM:SS)
*
- * @url http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
+ * @link http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
* DateTime tag and page 36 for the DateTimeOriginal and
* DateTimeDigitized tags.
*/
}
}
+/**
+ * @todo document (e.g. one-sentence top-level class description).
+ */
class HTMLCacheUpdateJob extends Job {
var $table, $start, $end;
/**
* Pure virtual parent
+ * @todo document (needs a one-sentence top-level class description, that answers the question: "what is a HistoryBlob?")
*/
class HistoryBlob
{
/**
* The real object
+ * @todo document (needs one-sentence top-level class description + function descriptions).
*/
class ConcatenatedGzipHistoryBlob extends HistoryBlob
{
/**
+ * @todo document (needs one-sentence top-level class description + some function descriptions).
*/
class HistoryBlobStub {
var $mOldId, $mHash, $mRef;
$this->mOldId = $id;
}
- /**
- * Sets the location (old_id) of the referring object
- */
+ /**
+ * Sets the location (old_id) of the referring object
+ */
function setReferrer( $id ) {
$this->mRef = $id;
}
- /**
- * Gets the location of the referring object
- */
+ /**
+ * Gets the location of the referring object
+ */
function getReferrer() {
return $this->mRef;
}
*
* Serialized HistoryBlobCurStub objects will be inserted into the text table
* on conversion if $wgFastSchemaUpgrades is set to true.
- *
*/
class HistoryBlobCurStub {
var $mCurId;
<?php
/*
- * Collection of public static functions to play with IP address
- * and IP blocks.
- *
* @Author "Ashar Voultoiz" <hashar@altern.org>
* @License GPL v2 or later
*/
// This might be useful for regexps used elsewhere, matches any IPv6 or IPv6 address or network
define( 'IP_ADDRESS_STRING', RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)|' . RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)');
+/**
+ * A collection of public static functions to play with IP address
+ * and IP blocks.
+ */
class IP {
/**
* Given a string, determine if it as valid IP
die( "This file is part of MediaWiki, it is not a valid entry point\n" );
}
+/**
+ * @todo document (e.g. one-sentence top-level class description).
+ */
abstract class Job {
var $command,
$title,
}
}
+
+/**
+ * @todo document (e.g. one-sentence top-level class description).
+ */
class RefreshLinksJob extends Job {
function __construct( $title, $params = '', $id = 0 ) {
parent::__construct( 'refreshLinks', $title, $params, $id );
<?php
/**
* A License class for use on Special:Upload
- *
+ *
* @addtogroup SpecialPage
*
* @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
function getHtml() { return $this->html; }
}
+/**
+ * A License class for use on Special:Upload (represents a single type of license).
+ */
class License {
/**
* @var string
<?php
/**
* Cache for article titles (prefixed DB keys) and ids linked from one source
- * @addtogroup Cache
- */
-
-/**
+ *
* @addtogroup Cache
*/
class LinkCache {
<?php
/**
- * See deferred.txt
- */
-
-/**
- * @todo document
+ * See docs/deferred.txt
+ *
+ * @todo document (e.g. one-sentence top-level class description).
*/
class LinksUpdate {
- /**@{{
+ /**
* @private
*/
var $mId, //!< Page ID of the article linked from
$mDb, //!< Database connection reference
$mOptions, //!< SELECT options to be used (array)
$mRecursive; //!< Whether to queue jobs for recursive updates
- /**@}}*/
+ /** end private attributes */
/**
* Constructor
}
/**
- * @fixme: handle missing log types
+ * @todo handle missing log types
* @static
*/
function logHeader( $type ) {
$this->returnToMain( false );
}
- /** @obsolete */
+ /** @deprecated */
public function errorpage( $title, $msg ) {
throw new ErrorPageError( $title, $msg );
}
$this->returnToMain( true, $mainPage );
}
- /** @obsolete */
+ /** @deprecated */
public function databaseError( $fname, $sql, $error, $errno ) {
throw new MWException( "OutputPage::databaseError is obsolete\n" );
}
$this->returnToMain( false );
}
- /** @obsolete */
+ /** @deprecated */
public function fatalError( $message ) {
throw new FatalError( $message );
}
- /** @obsolete */
+ /** @deprecated */
public function unexpectedValueError( $name, $val ) {
throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
}
- /** @obsolete */
+ /** @deprecated */
public function fileCopyError( $old, $new ) {
throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
}
- /** @obsolete */
+ /** @deprecated */
public function fileRenameError( $old, $new ) {
throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
}
- /** @obsolete */
+ /** @deprecated */
public function fileDeleteError( $name ) {
throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
}
- /** @obsolete */
+ /** @deprecated */
public function fileNotFoundError( $name ) {
throw new FatalError( wfMsg( 'filenotfound', $name ) );
}
define( 'MW_COLON_STATE_COMMENTDASHDASH', 7 );
/**
- * PHP Parser
- *
- * Processes wiki markup
+ * PHP Parser - Processes wiki markup (which uses a more user-friendly
+ * syntax, such as "[[link]]" for making links), and provides a one-way
+ * transformation of that wiki markup it into XHTML output / markup
+ * (which in turn the browser understands, and can display).
*
* <pre>
* There are four main entry points into the Parser class:
* @param string
* @return string
* @static
- * @fixme This can merge genuinely required bits in the path or query string,
+ * @todo This can merge genuinely required bits in the path or query string,
* breaking legit URLs. A proper fix would treat the various parts of
* the URL differently; as a workaround, just use the output for
* statistical records, not for actual linking/output.
}
+/**
+ * @todo document, briefly.
+ */
class OnlyIncludeReplacer {
var $output = '';
}
}
+/**
+ * @todo document, briefly.
+ */
class StripState {
var $general, $nowiki;
*/
/**
- *
+ * @todo document
*/
class ParserCache {
/**
<?php
-/**
- * Simple profiler base class
- */
-/**
- * @todo document
- */
require_once(dirname(__FILE__).'/Profiler.php');
+/**
+ * Simple profiler base class.
+ * @todo document methods (?)
+ */
class ProfilerSimple extends Profiler {
var $mMinimumTime = 0;
var $mProfileID = false;
<?php
-/* ProfilerSimpleUDP class, that sends out messages for 'udpprofile' daemon
- (the one from mediawiki/trunk/udpprofile SVN )
-*/
require_once(dirname(__FILE__).'/Profiler.php');
require_once(dirname(__FILE__).'/ProfilerSimple.php');
+/**
+ * ProfilerSimpleUDP class, that sends out messages for 'udpprofile' daemon
+ * (the one from mediawiki/trunk/udpprofile SVN )
+ */
class ProfilerSimpleUDP extends ProfilerSimple {
function getFunctionReport() {
global $wgUDPProfilerHost;
* @addtogroup SpecialPage
*/
+/**
+ * @todo document, briefly.
+ */
class ProtectionForm {
var $mRestrictions = array();
var $mReason = '';
* name attributes
* @link http://www.w3.org/TR/html401/struct/links.html#h-12.2.3 Anchors with the id attribute
*
- * @bug 4461
- *
* @static
*
* @param string $id
}
/**
- *
+ * @todo document with one-sentence top-level class description.
*/
class SkinTemplate extends Skin {
/**#@+
*/
/**
- *
+ * @todo document, briefly.
* @addtogroup SpecialPage
*/
class AncientPagesPage extends QueryPage {
}
/**
- * Form object
+ * Form object for the Special:Blockip page.
*
* @addtogroup SpecialPage
*/
* @addtogroup SpecialPage
*/
-/**
- *
- */
require_once('UserMailer.php');
+/**
+ * @todo document
+ */
function wfSpecialEmailuser( $par ) {
global $wgUser, $wgOut, $wgRequest, $wgEnableEmail, $wgEnableUserEmail;
}
+/**
+ * @todo document (e.g. one-sentence class description).
+ */
class ImportStringSource {
function ImportStringSource( $string ) {
$this->mString = $string;
}
}
+/**
+ * @todo document (e.g. one-sentence class description).
+ */
class ImportStreamSource {
function ImportStreamSource( $handle ) {
$this->mHandle = $handle;
}
/**
- *
+ * @todo document
* @addtogroup SpecialPage
*/
class IPUnblockForm {
}
}
+/**
+ * @todo document
+ */
class IPBlocklistPager extends ReverseChronologicalPager {
public $mForm, $mConds;
*/
/**
+ * Special:Listredirects - Lists all the redirects on the wiki.
* @addtogroup SpecialPage
*/
-
class ListredirectsPage extends QueryPage {
function getName() { return( 'Listredirects' ); }
}
/**
- *
+ * @todo document - e.g. a one-sentence top-level class description.
* @addtogroup SpecialPage
*/
class DBLockForm {
}
/**
- *
+ * @todo document (needs one-sentence top-level class description)
* @addtogroup SpecialPage
*/
class LogReader {
}
/**
- *
+ * @todo document (needs one-sentence top-level class description)
* @addtogroup SpecialPage
*/
class LogViewer {
*/
/**
+ * Searches the database for files of the requested MIME type, comparing this with the
+ * 'img_major_mime' and 'img_minor_mime' fields in the image table.
* @addtogroup SpecialPage
*/
class MIMEsearchPage extends QueryPage {
}
/**
- * constructor
+ * Output the HTML search form, and constructs the MIMEsearchPage object.
*/
function wfSpecialMIMEsearch( $par = null ) {
global $wgRequest, $wgTitle, $wgOut;
}
/**
- *
+ * HTML form for Special:Movepage
* @addtogroup SpecialPage
*/
class MovePageForm {
*/
/**
- *
+ * @todo document
* @addtogroup SpecialPage
*/
class ProtectedPagesForm {
}
/**
- *
- *
+ * @todo document
*/
class ProtectedPagesPager extends ReverseChronologicalPager {
public $mForm, $mConds;
*
* @addtogroup Special pages
* @author Rob Church <robchur@gmail.com>
- * @licence GNU General Public Licence 2.0 or later
+ * @license GNU General Public Licence 2.0 or later
*/
/**
}
/**
- *
+ * @todo document (just needs one-sentence top-level class description)
* @addtogroup SpecialPage
*/
class PageArchive {
* if not a file page.
*
* @return ResultWrapper
- * @fixme Does this belong in Image for fuller encapsulation?
+ * @todo Does this belong in Image for fuller encapsulation?
*/
function listFiles() {
if( $this->title->getNamespace() == NS_IMAGE ) {
}
/**
- *
+ * The HTML form for Special:Undelete, which allows users with the appropriate
+ * permissions to view and restore deleted content.
* @addtogroup SpecialPage
*/
class UndeleteForm {
}
/**
- *
+ * @todo document, briefly.
* @addtogroup SpecialPage
*/
*
* @addtogroup SpecialPage
*
- * @bug 2019, 4531
- *
* @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
* @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
/**
* Retrieve the revision number of a Subversion working directory.
*
- * @bug 7335
- *
* @param string $dir
* @return mixed revision number as int, or false if not a SVN checkout
*/
/**
* Can $wgUser read this page?
* @return boolean
- * @fixme fold these checks into userCan()
+ * @todo fold these checks into userCan()
*/
public function userCanRead() {
global $wgUser;
* Cascading protection: Return true if cascading restrictions apply to this page, false if not.
*
* @return bool If the page is subject to cascading restrictions.
- * @access public.
+ * @access public
*/
function isCascadeProtected() {
list( $sources, $restrictions ) = $this->getCascadeProtectionSources( false );
* members directly, which is what Linker::formatComment was doing previously.
*
* @param string $fragment text
- * @access kind of public
+ * @access public
+ * @todo clarify whether access is supposed to be public (was marked as "kind of public")
*/
function setFragment( $fragment ) {
$this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
* addresses like this, if we allowed accounts like this to be created
* new users could get the old edits of these anonymous users.
*
- * @bug 3631
- *
* @static
* @param string $name Nickname of a user
* @return bool
* rejected valid addresses. Actually just check if there is '@' somewhere
* in the given address.
*
- * @todo Check for RFC 2822 compilance
- * @bug 959
+ * @todo Check for RFC 2822 compilance (bug 959)
*
* @param string $addr email address
* @static
/**
* Return a random password. Sourced from mt_rand, so it's not particularly secure.
- * @todo: hash random numbers to improve security, like generateToken()
+ * @todo hash random numbers to improve security, like generateToken()
*
* @return string
* @static
/**
* Add the user to the given group.
* This takes immediate effect.
- * @string $group
+ * @param string $group
*/
function addGroup( $group ) {
$this->load();
/**
* Remove the user from the given group.
* This takes immediate effect.
- * @string $group
+ * @param string $group
*/
function removeGroup( $group ) {
$this->load();
/**
* Save object settings into database
- * @fixme Only rarely do all these fields need to be set!
+ * @todo Only rarely do all these fields need to be set!
*/
function saveSettings() {
$this->load();
return '"' . $phrase . '"';
}
+/**
+ * Stores a single person's name and email address.
+ * These are passed in via the constructor, and will be returned in SMTP
+ * header format when requested.
+ */
class MailAddress {
/**
* @param mixed $address String with an email address, or a User object
*
*/
class EmailNotification {
- /**@{{
- * @private
+ /**
+ * @private member variables:
*/
var $to, $subject, $body, $replyto, $from;
var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
- /**@}}*/
-
/**
* @todo document
* @param $title Title object
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html
+
+/**
+ * Some entry points may use this file without first enabling the
+ * autoloader.
+ */
+if ( !function_exists( '__autoload' ) ) {
+ require_once( dirname(__FILE__) . '/normal/UtfNormal.php' );
+}
+
/**
* The WebRequest class encapsulates getting at data passed in the
* URL or via a POSTed form, handling remove of "magic quotes" slashes,
* input.
*
*/
-
-/**
- * Some entry points may use this file without first enabling the
- * autoloader.
- */
-if ( !function_exists( '__autoload' ) ) {
- require_once( dirname(__FILE__) . '/normal/UtfNormal.php' );
-}
-
class WebRequest {
function __construct() {
$this->checkMagicQuotes();
* http://www.gnu.org/copyleft/gpl.html
*/
+/**
+ * @todo Document - e.g. Provide top-level description of this class.
+ */
abstract class ApiBase {
// These constants allow modules to specify exactly how to treat incomming parameters.
* @addtogroup Spyc
*/
class YAMLNode {
- /**#@+
+ /**
* @access public
* @var string
*/
var $parent;
var $id;
- /**#@+*/
/**
* @access public
* @var mixed
/**** Private Properties ****/
- /**#@+
+ /**
* @access private
* @var mixed
*/
var $_isInline;
var $_dumpIndent;
var $_dumpWordWrap;
- /**#@+*/
/**** Private Methods ****/
dépôts / lhc / web / wiklou.git / commitdiff