<?php
/**
- *
- *
- * Created on Aug 29, 2014
- *
* Copyright © 2014 Wikimedia Foundation and contributors
*
* This program is free software; you can redistribute it and/or modify
if ( $params['wrap'] ) {
$data = [
'mime' => 'text/html',
+ 'filename' => 'api-help.html',
'help' => $html,
];
ApiResult::setSubelementsList( $data, 'help' );
$result->reset();
$result->addValue( null, 'text', $html, ApiResult::NO_SIZE_CHECK );
$result->addValue( null, 'mime', 'text/html', ApiResult::NO_SIZE_CHECK );
+ $result->addValue( null, 'filename', 'api-help.html', ApiResult::NO_SIZE_CHECK );
}
}
}
}
+ // Templated?
+ if ( !empty( $settings[ApiBase::PARAM_TEMPLATE_VARS] ) ) {
+ $vars = [];
+ $msg = 'api-help-param-templated-var-first';
+ foreach ( $settings[ApiBase::PARAM_TEMPLATE_VARS] as $k => $v ) {
+ $vars[] = $context->msg( $msg, $k, $module->encodeParamName( $v ) );
+ $msg = 'api-help-param-templated-var';
+ }
+ $info[] = $context->msg( 'api-help-param-templated' )
+ ->numParams( count( $vars ) )
+ ->params( Message::listParam( $vars ) )
+ ->parse();
+ }
+
// Type documentation
if ( !isset( $settings[ApiBase::PARAM_TYPE] ) ) {
$dflt = isset( $settings[ApiBase::PARAM_DFLT] )
}
}
+ if ( isset( $settings[self::PARAM_MAX_BYTES] ) ) {
+ $info[] = $context->msg( 'api-help-param-maxbytes' )
+ ->numParams( $settings[self::PARAM_MAX_BYTES] );
+ }
+ if ( isset( $settings[self::PARAM_MAX_CHARS] ) ) {
+ $info[] = $context->msg( 'api-help-param-maxchars' )
+ ->numParams( $settings[self::PARAM_MAX_CHARS] );
+ }
+
// Add default
$default = isset( $settings[ApiBase::PARAM_DFLT] )
? $settings[ApiBase::PARAM_DFLT]