Output class modelled on OutputPage. More...

Collaboration diagram for WebInstallerOutput:

[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.

	getDir ()

	getHeadAttribs ()

	getJQuery ()

	getLanguageCode ()

	headerDone ()
	Get whether the header has been output.

	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.

WebInstaller	$parent
	The WebInstaller object this WebInstallerOutput is used by.

string	$redirectTarget

Private Member Functions
	getCssUrl ()
	"<link>" to index.php?css=1 for the "<head>"

Private Attributes
string	$contents = ''
	Buffered contents that haven't been output yet.

bool	$headerDone = false
	Has the header (or short header) been output?

bool	$useShortHeader = false
	Whether to use the limited header (used during CC license callbacks)

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

Definition at line 35 of file WebInstallerOutput.php.

Constructor & Destructor Documentation

◆ __construct()

WebInstallerOutput::__construct ( WebInstaller $parent )

Parameters

WebInstaller $parent

Definition at line 78 of file WebInstallerOutput.php.

References $parent.

Member Function Documentation

◆ addHTML()

WebInstallerOutput::addHTML ( $html )

Parameters

string $html

Definition at line 85 of file WebInstallerOutput.php.

References $html, contents, and flush().

Referenced by addWikiTextAsInterface().

◆ addHTMLNoFlush()

WebInstallerOutput::addHTMLNoFlush ( $html )

Parameters

string $html

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

References addWikiTextAsInterface(), and wfDeprecated().

◆ addWikiTextAsInterface()

WebInstallerOutput::addWikiTextAsInterface ( $text )

Parameters

string $text

Since: 1.32

Definition at line 103 of file WebInstallerOutput.php.

References addHTML().

Referenced by addWikiText().

◆ allowFrames()

WebInstallerOutput::allowFrames ( $allow = true )

Definition at line 207 of file WebInstallerOutput.php.

References allowFrames().

Referenced by allowFrames(), and outputHeader().

◆ flush()

WebInstallerOutput::flush ( )

Definition at line 211 of file WebInstallerOutput.php.

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

Referenced by addHTML(), flush(), and output().

◆ getCSS()

WebInstallerOutput::getCSS ( )

Get the stylesheet of the MediaWiki skin.

Returns: string

Definition at line 139 of file WebInstallerOutput.php.

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

◆ getCssUrl()

WebInstallerOutput::getCssUrl ( )

private

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

Returns: string

Definition at line 199 of file WebInstallerOutput.php.

Referenced by outputHeader(), and outputShortHeader().

◆ getDir()

WebInstallerOutput::getDir ( )

Returns: string

Definition at line 225 of file WebInstallerOutput.php.

References $wgLang.

Referenced by getHeadAttribs(), and outputHeader().

◆ getHeadAttribs()

WebInstallerOutput::getHeadAttribs ( )

Returns: string[]

Definition at line 243 of file WebInstallerOutput.php.

References getDir(), and getLanguageCode().

Referenced by outputHeader(), and outputShortHeader().

◆ getJQuery()

WebInstallerOutput::getJQuery ( )

Returns: string

Definition at line 354 of file WebInstallerOutput.php.

Referenced by outputHeader(), and outputShortHeader().

◆ getLanguageCode()

WebInstallerOutput::getLanguageCode ( )

Returns: string

Definition at line 234 of file WebInstallerOutput.php.

References $wgLang.

Referenced by getCSS(), and getHeadAttribs().

◆ headerDone()

WebInstallerOutput::headerDone ( )

Get whether the header has been output.

Returns: bool

Definition at line 255 of file WebInstallerOutput.php.

References $headerDone.

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

◆ output()

WebInstallerOutput::output ( )

Definition at line 126 of file WebInstallerOutput.php.

References flush(), and outputFooter().

◆ outputFooter()

WebInstallerOutput::outputFooter ( )

Definition at line 300 of file WebInstallerOutput.php.

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

Referenced by output().

◆ outputHeader()

WebInstallerOutput::outputHeader ( )

Definition at line 259 of file WebInstallerOutput.php.

References allowFrames(), content, div, getCssUrl(), getDir(), getHeadAttribs(), getJQuery(), headerDone(), http, name, outputShortHeader(), outputTitle(), php, title, and useShortHeader().

Referenced by flush().

◆ outputShortHeader()

WebInstallerOutput::outputShortHeader ( )

Definition at line 330 of file WebInstallerOutput.php.

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

Referenced by outputHeader().

◆ outputTitle()

WebInstallerOutput::outputTitle ( )

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

References headerDone().

◆ useShortHeader()

WebInstallerOutput::useShortHeader ( $use = true )

Definition at line 203 of file WebInstallerOutput.php.

References useShortHeader().

Referenced by outputFooter(), outputHeader(), and useShortHeader().

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 67 of file WebInstallerOutput.php.

◆ $contents

string WebInstallerOutput::$contents = ''

private

Buffered contents that haven't been output yet.

Definition at line 48 of file WebInstallerOutput.php.

Referenced by flush().

◆ $headerDone

bool WebInstallerOutput::$headerDone = false

private

Has the header (or short header) been output?

Definition at line 54 of file WebInstallerOutput.php.

Referenced by headerDone().

◆ $parent

WebInstaller WebInstallerOutput::$parent

The WebInstaller object this WebInstallerOutput is used by.

Definition at line 42 of file WebInstallerOutput.php.

Referenced by __construct().

◆ $redirectTarget

string WebInstallerOutput::$redirectTarget

Definition at line 59 of file WebInstallerOutput.php.

◆ $useShortHeader

bool WebInstallerOutput::$useShortHeader = false

private

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

Definition at line 73 of file WebInstallerOutput.php.

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

includes/installer/WebInstallerOutput.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHTML()

◆ addHTMLNoFlush()

◆ addWikiText()

◆ addWikiTextAsInterface()

◆ allowFrames()

◆ flush()

◆ getCSS()

◆ getCssUrl()

◆ getDir()

◆ getHeadAttribs()

◆ getJQuery()

◆ getLanguageCode()

◆ headerDone()

◆ output()

◆ outputFooter()

◆ outputHeader()

◆ outputShortHeader()

◆ outputTitle()

◆ redirect()

◆ useShortHeader()

Member Data Documentation

◆ $allowFrames

◆ $contents

◆ $headerDone

◆ $parent

◆ $redirectTarget

◆ $useShortHeader