Call Linker methods statically
[lhc/web/wiklou.git] / includes / api / ApiHelp.php
index 2e4e580..4a43047 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * API for MediaWiki 1.8+
+ *
  *
  * Created on Sep 6, 2006
  *
@@ -93,6 +93,11 @@ class ApiHelp extends ApiBase {
                $result->addValue( null, $this->getModuleName(), $r );
        }
 
+       /**
+        * @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 );
 
@@ -134,7 +139,7 @@ class ApiHelp extends ApiBase {
                return 'Display this help screen. Or the help screen for the specified module';
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'Whole help page:',
                        '  api.php?action=help',
@@ -142,13 +147,21 @@ class ApiHelp extends ApiBase {
                        '  api.php?action=help&modules=protect',
                        'Query (list) modules help page:',
                        '  api.php?action=help&querymodules=categorymembers',
-            'Query (prop) modules help page:',
+                       'Query (prop) modules help page:',
                        '  api.php?action=help&querymodules=info',
-            'Query (meta) modules help page:',
+                       'Query (meta) modules help page:',
                        '  api.php?action=help&querymodules=siteinfo',
                );
        }
 
+       public function getHelpUrls() {
+               return array(
+                       'http://www.mediawiki.org/wiki/API:Main_page',
+                       'http://www.mediawiki.org/wiki/API:FAQ',
+                       'http://www.mediawiki.org/wiki/API:Quick_start_guide',
+               );
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }