From 4ea94ebd911a891a78ab7037385612c8ee15b447 Mon Sep 17 00:00:00 2001 From: Jeroen De Dauw Date: Wed, 21 Jul 2010 09:42:07 +0000 Subject: [PATCH] Clarified field and method visibility and doc improvements --- includes/installer/WebInstaller.php | 16 ++--- includes/installer/WebInstallerOutput.php | 71 ++++++++++++++--------- includes/installer/WebInstallerPage.php | 6 +- 3 files changed, 55 insertions(+), 38 deletions(-) diff --git a/includes/installer/WebInstaller.php b/includes/installer/WebInstaller.php index 6f64a78c4b..a336b2b4bb 100644 --- a/includes/installer/WebInstaller.php +++ b/includes/installer/WebInstaller.php @@ -128,7 +128,7 @@ class WebInstaller extends Installer { $lowestUnhappy = $this->getLowestUnhappy(); - # Special case for Creative Commons partner chooser box + # Special case for Creative Commons partner chooser box. if ( $this->request->getVal( 'SubmitCC' ) ) { $page = $this->getPageByName( 'Options' ); $this->output->useShortHeader(); @@ -143,7 +143,7 @@ class WebInstaller extends Installer { return $this->finish(); } - # Get the page name + # Get the page name. $pageName = $this->request->getVal( 'page' ); if ( in_array( $pageName, $this->otherPages ) ) { @@ -162,7 +162,7 @@ class WebInstaller extends Installer { if ( $pageId > $lowestUnhappy ) { $pageId = $lowestUnhappy; if ( $lowestUnhappy == 0 ) { - # Knocked back to start, possible loss of session data + # Knocked back to start, possible loss of session data. $this->showSessionWarning = true; } } @@ -171,7 +171,7 @@ class WebInstaller extends Installer { $page = $this->getPageByName( $pageName ); } - # If a back button was submitted, go back without submitting the form data + # If a back button was submitted, go back without submitting the form data. if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) { if ( $this->request->getVal( 'lastPage' ) ) { $nextPage = $this->request->getVal( 'lastPage' ); @@ -192,7 +192,7 @@ class WebInstaller extends Installer { return $this->finish(); } - # Execute the page + # Execute the page. $this->currentPageName = $page->getName(); $this->startPageWrapper( $pageName ); $localSettings = $this->getLocalSettingsStatus(); @@ -207,15 +207,15 @@ class WebInstaller extends Installer { $this->endPageWrapper(); if ( $result == 'skip' ) { - # Page skipped without explicit submission - # Skip it when we click "back" so that we don't just go forward again + # Page skipped without explicit submission. + # Skip it when we click "back" so that we don't just go forward again. $this->skippedPages[$pageName] = true; $result = 'continue'; } else { unset( $this->skippedPages[$pageName] ); } - # If it was posted, the page can request a continue to the next page + # If it was posted, the page can request a continue to the next page. if ( $result === 'continue' && !$this->output->headerDone() ) { if ( $pageId !== false ) { $this->happyPages[$pageId] = true; diff --git a/includes/installer/WebInstallerOutput.php b/includes/installer/WebInstallerOutput.php index 2cb987d3ae..019fd6cfc4 100644 --- a/includes/installer/WebInstallerOutput.php +++ b/includes/installer/WebInstallerOutput.php @@ -9,58 +9,70 @@ * that wouldn't be immediately obvious. */ class WebInstallerOutput { - var $parent; - var $contents = ''; - var $warnings = ''; - var $headerDone = false; - var $redirectTarget; - var $debug = true; - var $useShortHeader = false; - - function __construct( $parent ) { + + /** + * The WebInstaller object this WebInstallerOutput is used by. + * + * @var WebInstaller + */ + public $parent; + + public $contents = ''; + public $warnings = ''; + public $headerDone = false; + public $redirectTarget; + public $debug = true; + public $useShortHeader = false; + + /** + * Constructor. + * + * @param WebInstaller $parent + */ + public function __construct( WebInstaller $parent ) { $this->parent = $parent; } - function addHTML( $html ) { + public function addHTML( $html ) { $this->contents .= $html; $this->flush(); } - function addWikiText( $text ) { + public function addWikiText( $text ) { $this->addHTML( $this->parent->parse( $text ) ); } - function addHTMLNoFlush( $html ) { + public function addHTMLNoFlush( $html ) { $this->contents .= $html; } - function addWarning( $msg ) { + public function addWarning( $msg ) { $this->warnings .= "

$msg

\n"; } - function addWarningMsg( $msg /*, ... */ ) { + public function addWarningMsg( $msg /*, ... */ ) { $params = func_get_args(); array_shift( $params ); $this->addWarning( wfMsg( $msg, $params ) ); } - function redirect( $url ) { + public function redirect( $url ) { if ( $this->headerDone ) { throw new MWException( __METHOD__ . ' called after sending headers' ); } $this->redirectTarget = $url; } - function output() { + public function output() { $this->flush(); $this->outputFooter(); } - function useShortHeader( $use = true ) { + public function useShortHeader( $use = true ) { $this->useShortHeader = $use; } - function flush() { + public function flush() { if ( !$this->headerDone ) { $this->outputHeader(); } @@ -72,7 +84,7 @@ class WebInstallerOutput { } } - function getDir() { + public function getDir() { global $wgLang; if( !is_object( $wgLang ) || !$wgLang->isRtl() ) return 'ltr'; @@ -80,7 +92,7 @@ class WebInstallerOutput { return 'rtl'; } - function getLanguageCode() { + public function getLanguageCode() { global $wgLang; if( !is_object( $wgLang ) ) return 'en'; @@ -88,18 +100,18 @@ class WebInstallerOutput { return $wgLang->getCode(); } - function getHeadAttribs() { + public function getHeadAttribs() { return array( 'dir' => $this->getDir(), 'lang' => $this->getLanguageCode(), ); } - function headerDone() { + public function headerDone() { return $this->headerDone; } - function outputHeader() { + public function outputHeader() { $this->headerDone = true; $dbTypes = $this->parent->getDBTypes(); @@ -144,7 +156,7 @@ class WebInstallerOutput { outputWarnings(); if ( $this->useShortHeader ) { @@ -179,7 +191,7 @@ class WebInstallerOutput { getHeadAttribs() ); ?> @@ -196,18 +208,19 @@ class WebInstallerOutput { addHTML( $this->warnings ); $this->warnings = ''; } -} + +} \ No newline at end of file diff --git a/includes/installer/WebInstallerPage.php b/includes/installer/WebInstallerPage.php index 60d4a13da3..640e6f4311 100644 --- a/includes/installer/WebInstallerPage.php +++ b/includes/installer/WebInstallerPage.php @@ -14,8 +14,12 @@ abstract class WebInstallerPage { public abstract function execute(); + /** + * Constructor. + * + * @param WebInstaller $parent + */ public function __construct( WebInstaller $parent ) { - // TODO: This field is not defined?? $this->parent = $parent; } -- 2.20.1