Added iterator interface to ResultWrapper. No support in Oracle yet. Updated document...

[lhc/web/wiklou.git] / includes / SpecialBooksources.php

diff --git a/includes/SpecialBooksources.php b/includes/SpecialBooksources.php
index 85b34ca..5f10349 100644 (file)
--- a/includes/SpecialBooksources.php
+++ b/includes/SpecialBooksources.php
@@ -4,8 +4,7 @@
  * Special page outputs information on sourcing a book with a particular ISBN
  * The parser creates links to this page when dealing with ISBNs in wikitext
  *
- * @package MediaWiki
- * @subpackage Special pages
+ * @addtogroup SpecialPage
  * @author Rob Church <robchur@gmail.com>
  * @todo Validate ISBNs using the standard check-digit method
  */
@@ -15,28 +14,29 @@ class SpecialBookSources extends SpecialPage {
         * ISBN passed to the page, if any
         */
        private $isbn = '';
-       
+
        /**
         * Constructor
         */
        public function __construct() {
                parent::__construct( 'Booksources' );
        }
-       
+
        /**
         * Show the special page
         *
         * @param $isbn ISBN passed as a subpage parameter
         */
-       public function execute( $isbn = false ) {
+       public function execute( $isbn ) {
                global $wgOut, $wgRequest;
                $this->setHeaders();
                $this->isbn = $this->cleanIsbn( $isbn ? $isbn : $wgRequest->getText( 'isbn' ) );
+               $wgOut->addWikiText( wfMsgNoTrans( 'booksources-summary' ) );
                $wgOut->addHtml( $this->makeForm() );
-               if( strlen( $this->isbn) > 0 )
-                       $wgOut->addHtml( $this->makeList() );
+               if( strlen( $this->isbn ) > 0 )
+                       $this->showList();
        }
-       
+
        /**
         * Trim ISBN and remove characters which aren't required
         *
@@ -46,7 +46,7 @@ class SpecialBookSources extends SpecialPage {
        private function cleanIsbn( $isbn ) {
                return trim( preg_replace( '![^0-9X]!', '', $isbn ) );
        }
-       
+
        /**
         * Generate a form to allow users to enter an ISBN
         *
@@ -58,36 +58,42 @@ class SpecialBookSources extends SpecialPage {
                $form  = '<fieldset><legend>' . wfMsgHtml( 'booksources-search-legend' ) . '</legend>';
                $form .= Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) );
                $form .= Xml::hidden( 'title', $title->getPrefixedText() );
-               $form .= '<p>' . Xml::inputLabel( wfMsg( 'booksources-isbn' ), 'isbn', 'isbn', false, $this->isbn );
+               $form .= '<p>' . Xml::inputLabel( wfMsg( 'booksources-isbn' ), 'isbn', 'isbn', 20, $this->isbn );
                $form .= '&nbsp;' . Xml::submitButton( wfMsg( 'booksources-go' ) ) . '</p>';
-               $form .= '</fieldset>';
                $form .= Xml::closeElement( 'form' );
+               $form .= '</fieldset>';
                return $form;
        }
-       
+
        /**
-        * Generate the list of book sources
+        * Determine where to get the list of book sources from,
+        * format and output them
         *
         * @return string
         */
-       private function makeList() {
+       private function showList() {
                global $wgOut, $wgContLang;
-               
+
+               # Hook to allow extensions to insert additional HTML,
+               # e.g. for API-interacting plugins and so on
+               wfRunHooks( 'BookInformation', array( $this->isbn, &$wgOut ) );
+
                # Check for a local page such as Project:Book_sources and use that if available
-               $title = Title::makeTitleSafe( NS_PROJECT, wfMsg( 'booksources' ) ); # Should this be wfMsgForContent()? -- RC
+               $title = Title::makeTitleSafe( NS_PROJECT, wfMsgForContent( 'booksources' ) ); # Show list in content language
                if( is_object( $title ) && $title->exists() ) {
                        $rev = Revision::newFromTitle( $title );
-                       return $wgOut->parse( str_replace( 'MAGICNUMBER', $this->isbn, $rev->getText() ) );
+                       $wgOut->addWikiText( str_replace( 'MAGICNUMBER', $this->isbn, $rev->getText() ) );
+                       return true;
                }
-               
+
                # Fall back to the defaults given in the language file
-               $html  = $wgOut->parse( wfMsg( 'booksources-text' ) );
-               $html .= '<ul>';
+               $wgOut->addWikiText( wfMsgNoTrans( 'booksources-text' ) );
+               $wgOut->addHtml( '<ul>' );
                $items = $wgContLang->getBookstoreList();
                foreach( $items as $label => $url )
-                       $html .= $this->makeListItem( $label, $url );
-               $html .= '</ul>';
-               return $html;           
+                       $wgOut->addHtml( $this->makeListItem( $label, $url ) );
+               $wgOut->addHtml( '</ul>' );
+               return true;
        }
        
        /**
@@ -104,4 +110,4 @@ class SpecialBookSources extends SpecialPage {
 
 }
 
-?>
+