/**
* For all modules in $moduleList, generate help messages and join them together
* @param $moduleList Array array(modulename => classname)
* @param $paramName string Parameter name
* @return string
*/
private function makeHelpMsgHelper($moduleList, $paramName)
{
$moduleDescriptions = array();
foreach ($moduleList as $moduleName => $moduleClass) {
$module = new $moduleClass($this, $moduleName, null);
$msg = ApiMain::makeHelpMsgHeader($module, $paramName);
$msg2 = $module->makeHelpMsg();
if ($msg2 !== false) {
$msg .= $msg2;
}
$moduleDescriptions[] = $msg;
}
return implode("\n", $moduleDescriptions);
}
/**
* For all modules of a given group, generate help messages and join them together
* @param string $group Module group
* @return string
*/
private function makeHelpMsgHelper($group)
{
$moduleDescriptions = array();
$moduleNames = $this->mModuleMgr->getNames($group);
sort($moduleNames);
foreach ($moduleNames as $name) {
/**
* @var $module ApiQueryBase
*/
$module = $this->mModuleMgr->getModule($name);
$msg = ApiMain::makeHelpMsgHeader($module, $group);
$msg2 = $module->makeHelpMsg();
if ($msg2 !== false) {
$msg .= $msg2;
}
if ($module instanceof ApiQueryGeneratorBase) {
$msg .= "Generator:\n This module may be used as a generator\n";
}
$moduleDescriptions[] = $msg;
}
return implode("\n", $moduleDescriptions);
}
/**
* For all modules in $moduleList, generate help messages and join them together
* @param $moduleList Array array(modulename => classname)
* @param $paramName string Parameter name
* @return string
*/
private function makeHelpMsgHelper($moduleList, $paramName)
{
$moduleDescriptions = array();
foreach ($moduleList as $moduleName => $moduleClass) {
$module = new $moduleClass($this, $moduleName, null);
$msg = ApiMain::makeHelpMsgHeader($module, $paramName);
$msg2 = $module->makeHelpMsg();
if ($msg2 !== false) {
$msg .= $msg2;
}
if ($module instanceof ApiQueryGeneratorBase) {
$this->mAllowedGenerators[] = $moduleName;
$msg .= "Generator:\n This module may be used as a generator\n";
}
$moduleDescriptions[] = $msg;
}
return implode("\n", $moduleDescriptions);
}
/**
* @param $module ApiBase
* @param $type String What type of request is this? e.g. action, query, list, prop, meta, format
* @return string
*/
private function buildModuleHelp($module, $type)
{
$msg = ApiMain::makeHelpMsgHeader($module, $type);
$msg2 = $module->makeHelpMsg();
if ($msg2 !== false) {
$msg .= $msg2;
}
return $msg;
}
