API: fix copyright symbol, coding style cleanup, more braces
[lhc/web/wiklou.git] / includes / api / ApiParse.php
index f978ece..a943d34 100644 (file)
@@ -1,11 +1,11 @@
 <?php
 
-/*
+/**
  * Created on Dec 01, 2007
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -25,7 +25,7 @@
 
 if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ( "ApiBase.php" );
+       require_once( "ApiBase.php" );
 }
 
 /**
@@ -34,7 +34,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiParse extends ApiBase {
 
        public function __construct( $main, $action ) {
-               parent :: __construct( $main, $action );
+               parent::__construct( $main, $action );
        }
 
        public function execute() {
@@ -44,8 +44,9 @@ class ApiParse extends ApiBase {
                $title = $params['title'];
                $page = $params['page'];
                $oldid = $params['oldid'];
-               if ( !is_null( $page ) && ( !is_null( $text ) || $title != "API" ) )
-                       $this->dieUsage( "The page parameter cannot be used together with the text and title parameters", 'params' );
+               if ( !is_null( $page ) && ( !is_null( $text ) || $title != 'API' ) ) {
+                       $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
+               }
                $prop = array_flip( $params['prop'] );
                $revid = false;
 
@@ -56,26 +57,23 @@ class ApiParse extends ApiBase {
                $popts->setTidy( true );
                $popts->enableLimitReport();
                $redirValues = null;
-               if ( !is_null( $oldid ) || !is_null( $page ) )
-               {
-                       if ( !is_null( $oldid ) )
-                       {
+               if ( !is_null( $oldid ) || !is_null( $page ) ) {
+                       if ( !is_null( $oldid ) ) {
                                // Don't use the parser cache
                                $rev = Revision::newFromID( $oldid );
-                               if ( !$rev )
+                               if ( !$rev ) {
                                        $this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
-                               if ( !$rev->userCan( Revision::DELETED_TEXT ) )
+                               }
+                               if ( !$rev->userCan( Revision::DELETED_TEXT ) ) {
                                        $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
+                               }
 
                                $text = $rev->getText( Revision::FOR_THIS_USER );
                                $titleObj = $rev->getTitle();
                                $wgTitle = $titleObj;
                                $p_result = $wgParser->parse( $text, $titleObj, $popts );
-                       }
-                       else
-                       {
-                               if ( $params['redirects'] )
-                               {
+                       } else {
+                               if ( $params['redirects'] ) {
                                        $req = new FauxRequest( array(
                                                'action' => 'query',
                                                'redirects' => '',
@@ -86,42 +84,45 @@ class ApiParse extends ApiBase {
                                        $data = $main->getResultData();
                                        $redirValues = @$data['query']['redirects'];
                                        $to = $page;
-                                       foreach ( (array)$redirValues as $r )
+                                       foreach ( (array)$redirValues as $r ) {
                                                $to = $r['to'];
-                               }
-                               else
+                                       }
+                               } else {
                                        $to = $page;
+                               }
                                $titleObj = Title::newFromText( $to );
-                               if ( !$titleObj )
+                               if ( !$titleObj ) {
                                        $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' );
+                               }
 
                                $articleObj = new Article( $titleObj );
-                               if ( isset( $prop['revid'] ) )
+                               if ( isset( $prop['revid'] ) ) {
                                        $oldid = $articleObj->getRevIdFetched();
+                               }
                                // Try the parser cache first
                                $p_result = false;
                                $pcache = ParserCache::singleton();
-                               if ( $wgEnableParserCache )
+                               if ( $wgEnableParserCache ) {
                                        $p_result = $pcache->get( $articleObj, $wgUser );
-                               if ( !$p_result )
-                               {
+                               }
+                               if ( !$p_result ) {
                                        $p_result = $wgParser->parse( $articleObj->getContent(), $titleObj, $popts );
-                                       
-                                       if ( $wgEnableParserCache )
+
+                                       if ( $wgEnableParserCache ) {
                                                $pcache->save( $p_result, $articleObj, $popts );
+                                       }
                                }
                        }
-               }
-               else
-               {
+               } else {
                        $titleObj = Title::newFromText( $title );
-                       if ( !$titleObj )
-                               $titleObj = Title::newFromText( "API" );
+                       if ( !$titleObj ) {
+                               $titleObj = Title::newFromText( 'API' );
+                       }
                        $wgTitle = $titleObj;
-                       if ( $params['pst'] || $params['onlypst'] )
+                       if ( $params['pst'] || $params['onlypst'] ) {
                                $text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts );
-                       if ( $params['onlypst'] )
-                       {
+                       }
+                       if ( $params['onlypst'] ) {
                                // Build a result and bail out
                                $result_array['text'] = array();
                                $this->getResult()->setContent( $result_array['text'], $text );
@@ -134,50 +135,61 @@ class ApiParse extends ApiBase {
                // Return result
                $result = $this->getResult();
                $result_array = array();
-               if ( $params['redirects'] && !is_null( $redirValues ) )
+               if ( $params['redirects'] && !is_null( $redirValues ) ) {
                        $result_array['redirects'] = $redirValues;
-               
+               }
+
                if ( isset( $prop['text'] ) ) {
                        $result_array['text'] = array();
                        $result->setContent( $result_array['text'], $p_result->getText() );
                }
-               
+
                if ( !is_null( $params['summary'] ) ) {
                        $result_array['parsedsummary'] = array();
                        $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) );
                }
-               
-               if ( isset( $prop['langlinks'] ) )
+
+               if ( isset( $prop['langlinks'] ) ) {
                        $result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() );
-               if ( isset( $prop['categories'] ) )
+               }
+               if ( isset( $prop['categories'] ) ) {
                        $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
-               if ( isset( $prop['links'] ) )
+               }
+               if ( isset( $prop['links'] ) ) {
                        $result_array['links'] = $this->formatLinks( $p_result->getLinks() );
-               if ( isset( $prop['templates'] ) )
+               }
+               if ( isset( $prop['templates'] ) ) {
                        $result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
-               if ( isset( $prop['images'] ) )
+               }
+               if ( isset( $prop['images'] ) ) {
                        $result_array['images'] = array_keys( $p_result->getImages() );
-               if ( isset( $prop['externallinks'] ) )
+               }
+               if ( isset( $prop['externallinks'] ) ) {
                        $result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
-               if ( isset( $prop['sections'] ) )
+               }
+               if ( isset( $prop['sections'] ) ) {
                        $result_array['sections'] = $p_result->getSections();
-               if ( isset( $prop['displaytitle'] ) )
+               }
+               if ( isset( $prop['displaytitle'] ) ) {
                        $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
                                                        $p_result->getDisplayTitle() :
                                                        $titleObj->getPrefixedText();
-                       
-               if ( isset( $prop['headitems'] ) )
+               }
+
+               if ( isset( $prop['headitems'] ) ) {
                        $result_array['headitems'] = $this->formatHeadItems( $p_result->getHeadItems() );
-               
+               }
+
                if ( isset( $prop['headhtml'] ) ) {
                        $out = new OutputPage;
                        $out->addParserOutputNoText( $p_result );
                        $result_array['headhtml'] = array();
                        $result->setContent( $result_array['headhtml'], $out->headElement( $wgUser->getSkin() ) );
                }
-               
-               if ( !is_null( $oldid ) )
+
+               if ( !is_null( $oldid ) ) {
                        $result_array['revid'] = intval( $oldid );
+               }
 
                $result_mapping = array(
                        'redirects' => 'r',
@@ -224,8 +236,9 @@ class ApiParse extends ApiBase {
                                $entry = array();
                                $entry['ns'] = $ns;
                                $this->getResult()->setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() );
-                               if ( $id != 0 )
+                               if ( $id != 0 ) {
                                        $entry['exists'] = '';
+                               }
                                $result[] = $entry;
                        }
                }
@@ -245,15 +258,16 @@ class ApiParse extends ApiBase {
 
        private function setIndexedTagNames( &$array, $mapping ) {
                foreach ( $mapping as $key => $name ) {
-                       if ( isset( $array[$key] ) )
+                       if ( isset( $array[$key] ) ) {
                                $this->getResult()->setIndexedTagName( $array[$key], $name );
+                       }
                }
        }
 
        public function getAllowedParams() {
-               return array (
+               return array(
                        'title' => array(
-                               ApiBase :: PARAM_DFLT => 'API',
+                               ApiBase::PARAM_DFLT => 'API',
                        ),
                        'text' => null,
                        'summary' => null,
@@ -261,9 +275,9 @@ class ApiParse extends ApiBase {
                        'redirects' => false,
                        'oldid' => null,
                        'prop' => array(
-                               ApiBase :: PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
-                               ApiBase :: PARAM_ISMULTI => true,
-                               ApiBase :: PARAM_TYPE => array(
+                               ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => array(
                                        'text',
                                        'langlinks',
                                        'categories',
@@ -284,7 +298,7 @@ class ApiParse extends ApiBase {
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'text' => 'Wikitext to parse',
                        'summary' => 'Summary to parse',
                        'redirects' => 'If the page parameter is set to a redirect, resolve it',
@@ -306,7 +320,7 @@ class ApiParse extends ApiBase {
        public function getDescription() {
                return 'This module parses wikitext and returns parser output';
        }
-       
+
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
@@ -317,7 +331,7 @@ class ApiParse extends ApiBase {
        }
 
        protected function getExamples() {
-               return array (
+               return array(
                        'api.php?action=parse&text={{Project:Sandbox}}'
                );
        }