MediaWiki  master
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
WebInstallerOutput Class Reference
Deployment

Output class modelled on OutputPage. More...

Collaboration diagram for WebInstallerOutput:
Collaboration graph
[legend]

Public Member Functions

 __construct (WebInstaller $parent)
 
 addHTML ( $html)
 
 addHTMLNoFlush ( $html)
 
 addWikiText ( $text)
 
 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
 

Private Member Functions

 getCssUrl ()
 "<link>" to index.php?css=1 for the "<head>" More...
 
 getLanguage ()
 

Private Attributes

string $contents = ''
 Buffered contents that haven't been output yet. More...
 
bool $headerDone = false
 Has the header (or short header) been output? More...
 
bool $useShortHeader = false
 Whether to use the limited header (used during CC license callbacks) More...
 

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:
private

Definition at line 38 of file WebInstallerOutput.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 81 of file WebInstallerOutput.php.

References $parent.

Member Function Documentation

◆ addHTML()

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

Definition at line 88 of file WebInstallerOutput.php.

References $html, contents, and flush().

Referenced by addWikiTextAsInterface().

◆ addHTMLNoFlush()

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

Definition at line 113 of file WebInstallerOutput.php.

References $html, and contents.

◆ addWikiText()

WebInstallerOutput::addWikiText (   $text)
Parameters
string$text
Deprecated:
since 1.32; use addWikiTextAsInterface instead

Definition at line 97 of file WebInstallerOutput.php.

References addWikiTextAsInterface(), and wfDeprecated().

◆ addWikiTextAsInterface()

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

Definition at line 106 of file WebInstallerOutput.php.

References addHTML().

Referenced by addWikiText().

◆ allowFrames()

WebInstallerOutput::allowFrames (   $allow = true)

Definition at line 210 of file WebInstallerOutput.php.

Referenced by outputHeader().

◆ flush()

WebInstallerOutput::flush ( )

Definition at line 214 of file WebInstallerOutput.php.

References $contents, contents, headerDone(), and outputHeader().

Referenced by addHTML(), and output().

◆ getCSS()

WebInstallerOutput::getCSS ( )

Get the stylesheet of the MediaWiki skin.

Returns
string

Definition at line 142 of file WebInstallerOutput.php.

References $resourceLoader, $wgStyleDirectory, as, getLanguage(), and ResourceLoader\makeCombinedStyles().

◆ getCssUrl()

WebInstallerOutput::getCssUrl ( )
private

"<link>" to index.php?css=1 for the "<head>"

Returns
string

Definition at line 202 of file WebInstallerOutput.php.

References Html\linkedStyle().

Referenced by outputHeader(), and outputShortHeader().

◆ getHeadAttribs()

WebInstallerOutput::getHeadAttribs ( )
Returns
string[]

Definition at line 238 of file WebInstallerOutput.php.

References getLanguage().

Referenced by outputHeader(), and outputShortHeader().

◆ getJQuery()

WebInstallerOutput::getJQuery ( )
Returns
string

Definition at line 349 of file WebInstallerOutput.php.

References Html\linkedScript().

Referenced by outputHeader(), and outputShortHeader().

◆ getLanguage()

WebInstallerOutput::getLanguage ( )
private
Since
1.33
Returns
Language

Definition at line 229 of file WebInstallerOutput.php.

References $wgLang, and Language\factory().

Referenced by getCSS(), getHeadAttribs(), and outputHeader().

◆ headerDone()

WebInstallerOutput::headerDone ( )

Get whether the header has been output.

Returns
bool

Definition at line 250 of file WebInstallerOutput.php.

References $headerDone.

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

◆ output()

WebInstallerOutput::output ( )

Definition at line 129 of file WebInstallerOutput.php.

References flush(), and outputFooter().

◆ outputFooter()

WebInstallerOutput::outputFooter ( )

Definition at line 295 of file WebInstallerOutput.php.

References $section, as, Html\closeElement(), div, href, php, style, title, useShortHeader(), and wfMessage().

Referenced by output().

◆ outputHeader()

WebInstallerOutput::outputHeader ( )

Definition at line 254 of file WebInstallerOutput.php.

References allowFrames(), content, div, getCssUrl(), getHeadAttribs(), getJQuery(), getLanguage(), headerDone(), Html\htmlHeader(), http, Html\linkedScript(), name, Html\openElement(), outputShortHeader(), outputTitle(), php, title, and useShortHeader().

Referenced by flush().

◆ outputShortHeader()

WebInstallerOutput::outputShortHeader ( )

Definition at line 325 of file WebInstallerOutput.php.

References content, getCssUrl(), getHeadAttribs(), getJQuery(), Html\htmlHeader(), http, Html\linkedScript(), name, outputTitle(), php, style, and title.

Referenced by outputHeader().

◆ outputTitle()

WebInstallerOutput::outputTitle ( )

Definition at line 341 of file WebInstallerOutput.php.

References $wgVersion, and wfMessage().

Referenced by outputHeader(), and outputShortHeader().

◆ redirect()

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

Definition at line 122 of file WebInstallerOutput.php.

References headerDone().

◆ useShortHeader()

WebInstallerOutput::useShortHeader (   $use = true)

Definition at line 206 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 70 of file WebInstallerOutput.php.

◆ $contents

string WebInstallerOutput::$contents = ''
private

Buffered contents that haven't been output yet.

Definition at line 51 of file WebInstallerOutput.php.

Referenced by flush().

◆ $headerDone

bool WebInstallerOutput::$headerDone = false
private

Has the header (or short header) been output?

Definition at line 57 of file WebInstallerOutput.php.

Referenced by headerDone().

◆ $parent

WebInstaller WebInstallerOutput::$parent

The WebInstaller object this WebInstallerOutput is used by.

Definition at line 45 of file WebInstallerOutput.php.

Referenced by __construct().

◆ $redirectTarget

string WebInstallerOutput::$redirectTarget

Definition at line 62 of file WebInstallerOutput.php.

◆ $useShortHeader

bool WebInstallerOutput::$useShortHeader = false
private

Whether to use the limited header (used during CC license callbacks)

Definition at line 76 of file WebInstallerOutput.php.

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