MediaWiki  master
WebInstallerOutput Class Reference

Output class modelled on OutputPage. More...

Collaboration diagram for WebInstallerOutput:

Public Member Functions

 __construct (WebInstaller $parent)
 
 addHTML ( $html)
 
 addHTMLNoFlush ( $html)
 
 addWikiTextAsInterface ( $text)
 
 allowFrames ( $allow=true)
 
 flush ()
 
 getCSS ()
 Get the stylesheet of the MediaWiki skin. More...
 
 getHeadAttribs ()
 
 getJQuery ()
 
 headerDone ()
 Get whether the header has been output. More...
 
 output ()
 
 outputFooter ()
 
 outputHeader ()
 
 outputShortHeader ()
 
 outputTitle ()
 
 redirect ( $url)
 
 useShortHeader ( $use=true)
 

Public Attributes

bool $allowFrames = false
 Does the current page need to allow being used as a frame? If not, X-Frame-Options will be output to forbid it. More...
 
WebInstaller $parent
 The WebInstaller object this WebInstallerOutput is used by. More...
 
string $redirectTarget
 

Detailed Description

Output class modelled on OutputPage.

I've opted to use a distinct class rather than derive from OutputPage here in the interests of separation of concerns: if we used a subclass, there would be quite a lot of things you could do in OutputPage that would break the installer, that wouldn't be immediately obvious.

Since
1.17
Access: internal

Definition at line 41 of file WebInstallerOutput.php.

Constructor & Destructor Documentation

◆ __construct()

WebInstallerOutput::__construct ( WebInstaller  $parent)
Parameters
WebInstaller$parent

Definition at line 84 of file WebInstallerOutput.php.

References $parent.

Member Function Documentation

◆ addHTML()

WebInstallerOutput::addHTML (   $html)
Parameters
string$html

Definition at line 91 of file WebInstallerOutput.php.

References flush().

Referenced by addWikiTextAsInterface().

◆ addHTMLNoFlush()

WebInstallerOutput::addHTMLNoFlush (   $html)
Parameters
string$html

Definition at line 107 of file WebInstallerOutput.php.

◆ addWikiTextAsInterface()

WebInstallerOutput::addWikiTextAsInterface (   $text)
Parameters
string$text
Since
1.32

Definition at line 100 of file WebInstallerOutput.php.

References addHTML().

◆ allowFrames()

WebInstallerOutput::allowFrames (   $allow = true)

Definition at line 179 of file WebInstallerOutput.php.

Referenced by outputHeader().

◆ flush()

WebInstallerOutput::flush ( )

Definition at line 183 of file WebInstallerOutput.php.

References headerDone(), and outputHeader().

Referenced by addHTML(), and output().

◆ getCSS()

WebInstallerOutput::getCSS ( )

Get the stylesheet of the MediaWiki skin.

Returns
string

Definition at line 136 of file WebInstallerOutput.php.

◆ getHeadAttribs()

WebInstallerOutput::getHeadAttribs ( )
Returns
string[]

Definition at line 208 of file WebInstallerOutput.php.

Referenced by outputHeader(), and outputShortHeader().

◆ getJQuery()

WebInstallerOutput::getJQuery ( )
Returns
string

Definition at line 333 of file WebInstallerOutput.php.

References Html\linkedScript().

Referenced by outputHeader(), and outputShortHeader().

◆ headerDone()

WebInstallerOutput::headerDone ( )

Get whether the header has been output.

Returns
bool

Definition at line 220 of file WebInstallerOutput.php.

Referenced by flush(), outputHeader(), and redirect().

◆ output()

WebInstallerOutput::output ( )

Definition at line 123 of file WebInstallerOutput.php.

References flush(), and outputFooter().

◆ outputFooter()

WebInstallerOutput::outputFooter ( )

Definition at line 266 of file WebInstallerOutput.php.

References Html\closeElement(), useShortHeader(), and wfMessage().

Referenced by output().

◆ outputHeader()

◆ outputShortHeader()

WebInstallerOutput::outputShortHeader ( )

◆ outputTitle()

WebInstallerOutput::outputTitle ( )

Definition at line 326 of file WebInstallerOutput.php.

References MW_VERSION, and wfMessage().

Referenced by outputHeader(), and outputShortHeader().

◆ redirect()

WebInstallerOutput::redirect (   $url)
Parameters
string$url
Exceptions
MWException

Definition at line 116 of file WebInstallerOutput.php.

References headerDone().

◆ useShortHeader()

WebInstallerOutput::useShortHeader (   $use = true)

Definition at line 175 of file WebInstallerOutput.php.

Referenced by outputFooter(), and outputHeader().

Member Data Documentation

◆ $allowFrames

bool WebInstallerOutput::$allowFrames = false

Does the current page need to allow being used as a frame? If not, X-Frame-Options will be output to forbid it.

Definition at line 73 of file WebInstallerOutput.php.

◆ $parent

WebInstaller WebInstallerOutput::$parent

The WebInstaller object this WebInstallerOutput is used by.

Definition at line 48 of file WebInstallerOutput.php.

Referenced by __construct().

◆ $redirectTarget

string WebInstallerOutput::$redirectTarget

Definition at line 65 of file WebInstallerOutput.php.


The documentation for this class was generated from the following file: