$this->context->setLanguage( $this->getMain()->getLanguage() );
if ( is_array( $params['modules'] ) ) {
- $modules = $params['modules'];
+ $modules = [];
+ foreach ( $params['modules'] as $path ) {
+ if ( $path === '*' || $path === '**' ) {
+ $path = "main+$path";
+ }
+ if ( substr( $path, -2 ) === '+*' || substr( $path, -2 ) === ' *' ) {
+ $submodules = true;
+ $path = substr( $path, 0, -2 );
+ $recursive = false;
+ } elseif ( substr( $path, -3 ) === '+**' || substr( $path, -3 ) === ' **' ) {
+ $submodules = true;
+ $path = substr( $path, 0, -3 );
+ $recursive = true;
+ } else {
+ $submodules = false;
+ }
+
+ if ( $submodules ) {
+ try {
+ $module = $this->getModuleFromPath( $path );
+ } catch ( UsageException $ex ) {
+ $this->setWarning( $ex->getMessage() );
+ }
+ $submodules = $this->listAllSubmodules( $module, $recursive );
+ if ( $submodules ) {
+ $modules = array_merge( $modules, $submodules );
+ } else {
+ $this->setWarning( "Module $path has no submodules" );
+ }
+ } else {
+ $modules[] = $path;
+ }
+ }
} else {
- $modules = array();
+ $modules = [];
}
if ( is_array( $params['querymodules'] ) ) {
$modules[] = 'query+' . $m;
}
} else {
- $queryModules = array();
+ $queryModules = [];
}
if ( is_array( $params['formatmodules'] ) ) {
$modules[] = $m;
}
} else {
- $formatModules = array();
+ $formatModules = [];
}
- $res = array();
+ $modules = array_unique( $modules );
+
+ $res = [];
foreach ( $modules as $m ) {
try {
}
$result = $this->getResult();
- $result->addValue( array( $this->getModuleName() ), 'helpformat', $this->helpFormat );
+ $result->addValue( [ $this->getModuleName() ], 'helpformat', $this->helpFormat );
foreach ( $res as $key => $stuff ) {
ApiResult::setIndexedTagName( $res[$key], 'module' );
$result->addValue( null, $this->getModuleName(), $res );
}
+ /**
+ * List all submodules of a module
+ * @param ApiBase $module
+ * @param boolean $recursive
+ * @return string[]
+ */
+ private function listAllSubmodules( ApiBase $module, $recursive ) {
+ $manager = $module->getModuleManager();
+ if ( $manager ) {
+ $paths = [];
+ $names = $manager->getNames();
+ sort( $names );
+ foreach ( $names as $name ) {
+ $submodule = $manager->getModule( $name );
+ $paths[] = $submodule->getModulePath();
+ if ( $recursive && $submodule->getModuleManager() ) {
+ $paths = array_merge( $paths, $this->listAllSubmodules( $submodule, $recursive ) );
+ }
+ }
+ }
+ return $paths;
+ }
+
/**
* @param array $res Result array
* @param string $key Result key
break;
case 'wikitext':
- $ret = array();
+ $ret = [];
foreach ( $msgs as $m ) {
$ret[] = $m->setContext( $this->context )->text();
}
- $res[$key] = join( "\n\n", $ret );
+ $res[$key] = implode( "\n\n", $ret );
if ( $joinLists ) {
$res[$key] = preg_replace( '!^(([*#:;])[^\n]*)\n\n(?=\2)!m', "$1\n", $res[$key] );
}
break;
case 'html':
- $ret = array();
+ $ret = [];
foreach ( $msgs as $m ) {
$ret[] = $m->setContext( $this->context )->parseAsBlock();
}
- $ret = join( "\n", $ret );
+ $ret = implode( "\n", $ret );
if ( $joinLists ) {
$ret = preg_replace( '!\s*</([oud]l)>\s*<\1>\s*!', "\n", $ret );
}
break;
case 'raw':
- $res[$key] = array();
+ $res[$key] = [];
foreach ( $msgs as $m ) {
- $a = array(
+ $a = [
'key' => $m->getKey(),
'params' => $m->getParams(),
- );
+ ];
+ ApiResult::setIndexedTagName( $a['params'], 'param' );
if ( $m instanceof ApiHelpParamValueMessage ) {
$a['forvalue'] = $m->getParamValue();
}
* @return ApiResult
*/
private function getModuleInfo( $module ) {
- $ret = array();
+ $ret = [];
$path = $module->getModulePath();
$ret['name'] = $module->getModuleName();
$ret['helpurls'] = (array)$module->getHelpUrls();
if ( isset( $ret['helpurls'][0] ) && $ret['helpurls'][0] === false ) {
- $ret['helpurls'] = array();
+ $ret['helpurls'] = [];
}
ApiResult::setIndexedTagName( $ret['helpurls'], 'helpurl' );
if ( $this->helpFormat !== 'none' ) {
- $ret['examples'] = array();
+ $ret['examples'] = [];
$examples = $module->getExamplesMessages();
foreach ( $examples as $qs => $msg ) {
- $item = array(
+ $item = [
'query' => $qs
- );
- $msg = ApiBase::makeMessage( $msg, $this->context, array(
+ ];
+ $msg = ApiBase::makeMessage( $msg, $this->context, [
$module->getModulePrefix(),
$module->getModuleName(),
$module->getModulePath()
- ) );
- $this->formatHelpMessages( $item, 'description', array( $msg ) );
+ ] );
+ $this->formatHelpMessages( $item, 'description', [ $msg ] );
if ( isset( $item['description'] ) ) {
if ( is_array( $item['description'] ) ) {
$item['description'] = $item['description'][0];
ApiResult::setIndexedTagName( $ret['examples'], 'example' );
}
- $ret['parameters'] = array();
+ $ret['parameters'] = [];
$params = $module->getFinalParams( ApiBase::GET_VALUES_FOR_HELP );
$paramDesc = $module->getFinalParamDescription();
foreach ( $params as $name => $settings ) {
if ( !is_array( $settings ) ) {
- $settings = array( ApiBase::PARAM_DFLT => $settings );
+ $settings = [ ApiBase::PARAM_DFLT => $settings ];
}
- $item = array(
+ $item = [
'name' => $name
- );
+ ];
if ( isset( $paramDesc[$name] ) ) {
$this->formatHelpMessages( $item, 'description', $paramDesc[$name], true );
}
sort( $item['type'] );
$prefix = $module->isMain()
? '' : ( $module->getModulePath() . '+' );
- $item['submodules'] = array();
+ $item['submodules'] = [];
foreach ( $item['type'] as $v ) {
$item['submodules'][$v] = $prefix . $v;
}
}
if ( !empty( $settings[ApiBase::PARAM_HELP_MSG_INFO] ) ) {
- $item['info'] = array();
+ $item['info'] = [];
foreach ( $settings[ApiBase::PARAM_HELP_MSG_INFO] as $i ) {
$tag = array_shift( $i );
- $info = array(
+ $info = [
'name' => $tag,
- );
+ ];
if ( count( $i ) ) {
$info['values'] = $i;
ApiResult::setIndexedTagName( $info['values'], 'v' );
}
- $this->formatHelpMessages( $info, 'text', array(
+ $this->formatHelpMessages( $info, 'text', [
$this->context->msg( "apihelp-{$path}-paraminfo-{$tag}" )
->numParams( count( $i ) )
->params( $this->context->getLanguage()->commaList( $i ) )
->params( $module->getModulePrefix() )
- ) );
+ ] );
ApiResult::setSubelementsList( $info, 'text' );
$item['info'][] = $info;
}
if ( $this->helpFormat === 'none' ) {
$ret['dynamicparameters'] = true;
} else {
- $dynamicParams = ApiBase::makeMessage( $dynamicParams, $this->context, array(
+ $dynamicParams = ApiBase::makeMessage( $dynamicParams, $this->context, [
$module->getModulePrefix(),
$module->getModuleName(),
$module->getModulePath()
- ) );
- $this->formatHelpMessages( $ret, 'dynamicparameters', array( $dynamicParams ) );
+ ] );
+ $this->formatHelpMessages( $ret, 'dynamicparameters', [ $dynamicParams ] );
}
}
$formatmodules = $this->getMain()->getModuleManager()->getNames( 'format' );
sort( $formatmodules );
- return array(
- 'modules' => array(
+ return [
+ 'modules' => [
ApiBase::PARAM_ISMULTI => true,
- ),
- 'helpformat' => array(
+ ],
+ 'helpformat' => [
ApiBase::PARAM_DFLT => 'none',
- ApiBase::PARAM_TYPE => array( 'html', 'wikitext', 'raw', 'none' ),
- ),
+ ApiBase::PARAM_TYPE => [ 'html', 'wikitext', 'raw', 'none' ],
+ ],
- 'querymodules' => array(
+ 'querymodules' => [
ApiBase::PARAM_DEPRECATED => true,
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => $querymodules,
- ),
- 'mainmodule' => array(
+ ],
+ 'mainmodule' => [
ApiBase::PARAM_DEPRECATED => true,
- ),
- 'pagesetmodule' => array(
+ ],
+ 'pagesetmodule' => [
ApiBase::PARAM_DEPRECATED => true,
- ),
- 'formatmodules' => array(
+ ],
+ 'formatmodules' => [
ApiBase::PARAM_DEPRECATED => true,
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => $formatmodules,
- )
- );
+ ]
+ ];
}
protected function getExamplesMessages() {
- return array(
- 'action=paraminfo&modules=parse|phpfm|query+allpages|query+siteinfo'
+ return [
+ 'action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo'
=> 'apihelp-paraminfo-example-1',
- );
+ 'action=paraminfo&modules=query%2B*'
+ => 'apihelp-paraminfo-example-2',
+ ];
}
public function getHelpUrls() {
dépôts / lhc / web / wiklou.git / blobdiff