[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

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

[Source view] [Print] [Project Stats]

Created on Sep 4, 2007 Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"

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

Defines 1 class

ApiBlock:: (9 methods):
  execute()
  mustBePosted()
  isWriteMode()
  getAllowedParams()
  getParamDescription()
  getDescription()
  needsToken()
  getExamples()
  getHelpUrls()


Class: ApiBlock  - X-Ref

API module that facilitates the blocking of users. Requires API write mode
to be enabled.

execute()   X-Ref
Blocks the user specified in the parameters for the given expiry, with the
given reason, and with all other settings provided in the params. If the block
succeeds, produces a result containing the details of the block and notice
of success. If it fails, the result will specify the nature of the error.


mustBePosted()   X-Ref
No description

isWriteMode()   X-Ref
No description

getAllowedParams()   X-Ref
No description

getParamDescription()   X-Ref
No description

getDescription()   X-Ref
No description

needsToken()   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