[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/api/ -> ApiHelp.php (summary)

[Source view] [Print] [Project Stats]

Created on Sep 6, 2006 Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"

File Size: 177 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ApiHelp:: (9 methods):
  execute()
  buildModuleHelp()
  shouldCheckMaxlag()
  isReadMode()
  getAllowedParams()
  getParamDescription()
  getDescription()
  getExamples()
  getHelpUrls()


Class: ApiHelp  - X-Ref

This is a simple class to handle action=help

execute()   X-Ref
Module for displaying help


buildModuleHelp( $module, $type )   X-Ref

param: ApiBase $module
param: string $type What type of request is this? e.g. action, query, list, prop, meta, format
return: string

shouldCheckMaxlag()   X-Ref
No description

isReadMode()   X-Ref
No description

getAllowedParams()   X-Ref
No description

getParamDescription()   X-Ref
No description

getDescription()   X-Ref
No description

getExamples()   X-Ref
No description

getHelpUrls()   X-Ref
No description


Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1