Merge "Fixup some returns, documentation"
authorNikerabbit <niklas.laxstrom@gmail.com>
Fri, 19 Oct 2012 07:32:52 +0000 (07:32 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Fri, 19 Oct 2012 07:32:52 +0000 (07:32 +0000)
1  2 
includes/EditPage.php

diff --combined includes/EditPage.php
@@@ -471,7 -471,7 +471,7 @@@ class EditPage 
                $content = $this->getContentObject();
  
                # Use the normal message if there's nothing to display
 -              if ( $this->firsttime && $content->isEmpty() ) {
 +              if ( $this->firsttime && ( $content === false || $content->isEmpty() ) ) {
                        $action = $this->mTitle->exists() ? 'edit' :
                                ( $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage' );
                        throw new PermissionsError( $action, $permErrors );
        /**
         * Fetch initial editing page content.
         *
-        * @param $def_text string
+        * @param $def_text string|bool
         * @return mixed string on success, $def_text for invalid sections
         * @private
         * @deprecated since 1.21, get WikiPage::getContent() instead.
        }
  
        /**
-        * @param Content|false $def_content The default value to return
+        * @param Content|null $def_content The default value to return
         *
         * @return mixed Content on success, $def_content for invalid sections
         *
         * to the original text of the edit.
         *
         * This difers from Article::getContent() that when a missing revision is
 -       * encountered the result will be an empty string and not the
 +       * encountered the result will be null and not the
         * 'missing-revision' message.
         *
         * @since 1.19
 -       * @return string
 +       * @return Content|null
         */
        private function getOriginalContent() {
                if ( $this->section == 'new' ) {
                $parserOptions = ParserOptions::newFromUser( $wgUser );
                $content = $page->getContent( Revision::RAW );
  
 +              if ( !$content ) {
 +                      return $handler->makeEmptyContent();
 +              }
 +
                return $content->preloadTransform( $title, $parserOptions );
        }
  
                if ( $ok ) {
                        $editText = $this->toEditText( $editContent );
                        return true;
-               } else {
-                       return false;
                }
+               return false;
        }
  
        /**
         * @private
         * @todo document
         *
-        * @parma $editText string
-        *
+        * @param $editContent
         * @return bool
         * @since since 1.WD
         */
  
                // This is the revision the editor started from
                $baseRevision = $this->getBaseRevision();
 -              if ( is_null( $baseRevision ) ) {
 +              $baseContent = $baseRevision ? $baseRevision->getContent() : null;
 +
 +              if ( is_null( $baseContent ) ) {
                        wfProfileOut( __METHOD__ );
                        return false;
                }
 -              $baseContent = $baseRevision->getContent();
  
                // The current state, we want to merge updates into it
                $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
 -              if ( is_null( $currentRevision ) ) {
 +              $currentContent = $currentRevision ? $currentRevision->getContent() : null;
 +
 +              if ( is_null( $currentContent ) ) {
                        wfProfileOut( __METHOD__ );
                        return false;
                }
 -              $currentContent = $currentRevision->getContent();
  
                $handler = ContentHandler::getForModelID( $baseContent->getModel() );
  
                # Give a notice if the user is editing a deleted/moved page...
                if ( !$this->mTitle->exists() ) {
                        LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle,
-                               '', array( 'lim' => 10,
-                                          'conds' => array( "log_action != 'revision'" ),
-                                          'showIfEmpty' => false,
-                                          'msgKey' => array( 'recreate-moveddeleted-warn' ) )
+                               '',
+                               array(
+                                       'lim' => 10,
+                                       'conds' => array( "log_action != 'revision'" ),
+                                       'showIfEmpty' => false,
+                                       'msgKey' => array( 'recreate-moveddeleted-warn' )
+                               )
                        );
                }
        }
                                // Added using template syntax, to take <noinclude>'s into account.
                                $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle );
                                return true;
-                       } else {
-                               return false;
                        }
-               } else {
-                       return false;
                }
+               return false;
        }
  
        /**
 -       * Gets an editable textual representation of the given Content object.
 +       * Gets an editable textual representation of $content.
         * The textual representation can be turned by into a Content object by the
         * toEditContent() method.
         *
 +       * If $content is null or false or a string, $content is returned unchanged.
 +       *
         * If the given Content object is not of a type that can be edited using the text base EditPage,
         * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
         * content.
         *
 -       * @param Content $content
 +       * @param Content|null|false|string $content
         * @return String the editable text form of the content.
         *
         * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
         */
 -      protected function toEditText( Content $content ) {
 +      protected function toEditText( $content ) {
 +              if ( $content === null || $content === false ) {
 +                      return $content;
 +              }
 +
 +              if ( is_string( $content ) ) {
 +                      return $content;
 +              }
 +
                if ( !$this->allowNonTextContent && !( $content instanceof TextContent ) ) {
                        throw new MWException( "This content model can not be edited as text: "
                                                                . ContentHandler::getLocalizedName( $content->getModel() ) );
         * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
         * content.
         *
-        * @param String|null|false $text Text to unserialize
+        * @param String|null|bool $text Text to unserialize
         * @return Content The content object created from $text. If $text was false or null, false resp. null will be
         *                 returned instead.
         *
  
        /**
         * Send the edit form and related headers to $wgOut
-        * @param $formCallback Callback that takes an OutputPage parameter; will be called
+        * @param $formCallback Callback|null that takes an OutputPage parameter; will be called
         *     during form output near the top, for captchas and the like.
         */
        function showEditForm( $formCallback = null ) {
@@@ -2542,8 -2524,9 +2540,9 @@@ HTM
        protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
                global $wgOut;
                $classes = array();
-               if ( $isOnTop )
+               if ( $isOnTop ) {
                        $classes[] = 'ontop';
+               }
  
                $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
  
         * save and then make a comparison.
         */
        function showDiff() {
-               global $wgUser, $wgContLang, $wgParser, $wgOut;
+               global $wgUser, $wgContLang, $wgOut;
  
                $oldtitlemsg = 'currentrev';
                # if message does not exist, show diff against the preloaded default
                                                        $this->section, $textboxContent,
                                                        $this->summary, $this->edittime );
  
 -              ContentHandler::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
 -              wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
 +              if ( $newContent ) {
 +                      ContentHandler::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
 +                      wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
  
 -              $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
 -              $newContent = $newContent->preSaveTransform( $this->mTitle, $wgUser, $popts );
 +                      $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
 +                      $newContent = $newContent->preSaveTransform( $this->mTitle, $wgUser, $popts );
 +              }
  
                if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
                        $oldtitle = wfMessage( $oldtitlemsg )->parse();
                        $newtitle = wfMessage( 'yourtext' )->parse();
  
 +                      if ( !$oldContent ) {
 +                              $oldContent = $newContent->getContentHandler()->makeEmptyContent();
 +                      }
 +
 +                      if ( !$newContent ) {
 +                              $newContent = $oldContent->getContentHandler()->makeEmptyContent();
 +                      }
 +
                        $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle->getContext() );
                        $de->setContent( $oldContent, $newContent );
  
         * @return string
         */
        function getPreviewText() {
-               global $wgOut, $wgUser, $wgParser, $wgRawHtml, $wgLang;
+               global $wgOut, $wgUser, $wgRawHtml, $wgLang;
  
                wfProfileIn( __METHOD__ );
  
        /**
         * Produce the stock "your edit contains spam" page
         *
-        * @param $match string Text which triggered one or more filters
+        * @param $match string|bool Text which triggered one or more filters
         * @deprecated since 1.17 Use method spamPageWithContent() instead
         */
        static function spamPage( $match = false ) {