Merge "Api method documentation tweaks"

[lhc/web/wiklou.git] / includes / api / ApiParse.php
diff --git a/includes/api/ApiParse.php b/includes/api/ApiParse.php

index 963fd85..dbcd43c 100644 (file)
--- a/includes/api/ApiParse.php
+++ b/includes/api/ApiParse.php
@@ -285,6 +285,9 @@ class ApiParse extends ApiBase {
                                 $result->setContent( $result_array['psttext'], $this->pstText );
                         }
                 }
+               if ( isset( $prop['properties'] ) ) {
+                       $result_array['properties'] = $this->formatProperties( $p_result->getProperties() );
+               }
  
                 $result_mapping = array(
                         'redirects' => 'r',
@@ -297,6 +300,7 @@ class ApiParse extends ApiBase {
                         'iwlinks' => 'iw',
                         'sections' => 's',
                         'headitems' => 'hi',
+                       'properties' => 'pp',
                 );
                 $this->setIndexedTagNames( $result_array, $result_mapping );
                 $result->addValue( null, $this->getModuleName(), $result_array );
@@ -464,6 +468,17 @@ class ApiParse extends ApiBase {
                 return $result;
         }
  
+       private function formatProperties( $properties ) {
+               $result = array();
+               foreach ( $properties as $name => $value ) {
+                       $entry = array();
+                       $entry['name'] = $name;
+                       $this->getResult()->setContent( $entry, $value );
+                       $result[] = $entry;
+               }
+               return $result;
+       }
+
         private function formatCss( $css ) {
                 $result = array();
                 foreach ( $css as $file => $link ) {
@@ -499,7 +514,7 @@ class ApiParse extends ApiBase {
                                 ApiBase::PARAM_TYPE => 'integer',
                         ),
                         'prop' => array(
-                               ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
+                               ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties',
                                 ApiBase::PARAM_ISMULTI => true,
                                 ApiBase::PARAM_TYPE => array(
                                         'text',
@@ -518,6 +533,7 @@ class ApiParse extends ApiBase {
                                         'headhtml',
                                         'iwlinks',
                                         'wikitext',
+                                       'properties',
                                 )
                         ),
                         'pst' => false,
@@ -556,6 +572,7 @@ class ApiParse extends ApiBase {
                                 ' headhtml       - Gives parsed <head> of the page',
                                 ' iwlinks        - Gives interwiki links in the parsed wikitext',
                                 ' wikitext       - Gives the original wikitext that was parsed',
+                               ' properties     - Gives various properties defined in the parsed wikitext',
                         ),
                         'pst' => array(
                                 'Do a pre-save transform on the input before parsing it',
@@ -572,7 +589,10 @@ class ApiParse extends ApiBase {
         }
  
         public function getDescription() {
-               return 'Parses wikitext and returns parser output';
+               return array(
+                       'Parses wikitext and returns parser output',
+                       'See the various prop-Modules of action=query to get information from the current version of a page',
+               );
         }
  
         public function getPossibleErrors() {