*
* Created on Sep 5, 2006
*
- * Copyright © 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006, 2010 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/**
* Get the name of the module as shown in the profiler log
*
- * @param $db DatabaseBase
+ * @param $db DatabaseBase|bool
*
* @return string
*/
* automated identification of the error, e.g., 'unknown_action'
* @param $httpRespCode int HTTP response code
* @param $extradata array Data to add to the "<error>" element; array in ApiResult format
+ * @throws UsageException
*/
public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) {
Profiler::instance()->close();
}
/**
- * Returns whether this module requires a Token to execute
+ * Returns whether this module requires a token to execute
+ * It is used to show possible errors in action=paraminfo
+ * see bug 25248
* @return bool
*/
public function needsToken() {
}
/**
- * Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token
- * @return bool|string
+ * Returns the token salt if there is one,
+ * '' if the module doesn't require a salt,
+ * else false if the module doesn't need a token
+ * You have also to override needsToken()
+ * Value is passed to User::getEditToken
+ * @return bool|string|array
*/
public function getTokenSalt() {
return false;