Output class modelled on OutputPage. More...

Collaboration diagram for WebInstallerOutput:

[legend]

Public Member Functions
	__construct (WebInstaller $parent)

	addHTML ( $html)

	addHTMLNoFlush ( $html)

	addWikiText ( $text)

	allowFrames ( $allow=true)

	flush ()

	getCSS ( $dir)
	Get the raw vector CSS, flipping if needed. More...

	getDir ()

	getHeadAttribs ()

	getJQuery ()

	getLanguageCode ()

	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=foobar for the "<head>" More...

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

Definition at line 35 of file WebInstallerOutput.php.

Constructor & Destructor Documentation

◆ __construct()

WebInstallerOutput::__construct ( WebInstaller $parent )

Parameters

WebInstaller $parent

Definition at line 72 of file WebInstallerOutput.php.

References $parent.

Member Function Documentation

◆ addHTML()

WebInstallerOutput::addHTML ( $html )

Parameters

string $html

Definition at line 79 of file WebInstallerOutput.php.

References $html, contents, and flush().

Referenced by addWikiText().

◆ addHTMLNoFlush()

WebInstallerOutput::addHTMLNoFlush ( $html )

Parameters

string $html

Definition at line 94 of file WebInstallerOutput.php.

References $html, and contents.

◆ addWikiText()

WebInstallerOutput::addWikiText ( $text )

Parameters

string $text

Definition at line 87 of file WebInstallerOutput.php.

References addHTML().

◆ allowFrames()

WebInstallerOutput::allowFrames ( $allow = true )

Definition at line 217 of file WebInstallerOutput.php.

Referenced by outputHeader().

◆ flush()

WebInstallerOutput::flush ( )

Definition at line 221 of file WebInstallerOutput.php.

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

Referenced by addHTML(), and output().

◆ getCSS()

WebInstallerOutput::getCSS ( $dir )

Get the raw vector CSS, flipping if needed.

Todo:: Possibly get rid of this function and use ResourceLoader in the manner it was designed to be used in, rather than just grabbing a list of filenames from it, and not properly handling such details as media types in module definitions.

Parameters

string $dir 'ltr' or 'rtl'

Returns: String

Definition at line 126 of file WebInstallerOutput.php.

References $css, $dir, $e, $GLOBALS, $resourceLoader, array(), as, ResourceLoader\formatException(), ResourceLoader\getLessCompiler(), ResourceLoader\makeComment(), CSSMin\remap(), CSSJanus\transform(), wfRestoreWarnings(), and wfSuppressWarnings().

◆ getCssUrl()

WebInstallerOutput::getCssUrl ( )

private

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

Returns: String

Definition at line 209 of file WebInstallerOutput.php.

References getDir(), and Html\linkedStyle().

Referenced by outputHeader(), and outputShortHeader().

◆ getDir()

WebInstallerOutput::getDir ( )

Returns: string

Definition at line 235 of file WebInstallerOutput.php.

References $wgLang, and global.

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

◆ getHeadAttribs()

WebInstallerOutput::getHeadAttribs ( )

Returns: string[]

Definition at line 253 of file WebInstallerOutput.php.

References array(), getDir(), and getLanguageCode().

Referenced by outputHeader(), and outputShortHeader().

◆ getJQuery()

WebInstallerOutput::getJQuery ( )

Returns: string

Definition at line 360 of file WebInstallerOutput.php.

References Html\linkedScript().

Referenced by outputHeader(), and outputShortHeader().

◆ getLanguageCode()

WebInstallerOutput::getLanguageCode ( )

Returns: string

Definition at line 244 of file WebInstallerOutput.php.

References $wgLang, and global.

Referenced by getHeadAttribs().

◆ headerDone()

WebInstallerOutput::headerDone ( )

Get whether the header has been output.

Returns: bool

Definition at line 265 of file WebInstallerOutput.php.

References $headerDone.

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

◆ output()

WebInstallerOutput::output ( )

Definition at line 110 of file WebInstallerOutput.php.

References flush(), and outputFooter().

◆ outputFooter()

WebInstallerOutput::outputFooter ( )

Definition at line 309 of file WebInstallerOutput.php.

References Html\closeElement(), href, php, title, useShortHeader(), and wfMessage().

Referenced by output().

◆ outputHeader()

WebInstallerOutput::outputHeader ( )

Definition at line 269 of file WebInstallerOutput.php.

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

Referenced by flush().

◆ outputShortHeader()

WebInstallerOutput::outputShortHeader ( )

Definition at line 336 of file WebInstallerOutput.php.

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

Referenced by outputHeader().

◆ outputTitle()

WebInstallerOutput::outputTitle ( )

Definition at line 352 of file WebInstallerOutput.php.

References global, and wfMessage().

Referenced by outputHeader(), and outputShortHeader().

◆ redirect()

WebInstallerOutput::redirect ( $url )

Parameters

string $url

Exceptions

MWException

Definition at line 103 of file WebInstallerOutput.php.

References headerDone().

◆ useShortHeader()

WebInstallerOutput::useShortHeader ( $use = true )

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

◆ $contents

String WebInstallerOutput::$contents = ''

private

Buffered contents that haven't been output yet.

Definition at line 46 of file WebInstallerOutput.php.

Referenced by flush().

◆ $headerDone

bool WebInstallerOutput::$headerDone = false

private

Has the header (or short header) been output?

Definition at line 51 of file WebInstallerOutput.php.

Referenced by headerDone().

◆ $parent

WebInstaller WebInstallerOutput::$parent

The WebInstaller object this WebInstallerOutput is used by.

Definition at line 41 of file WebInstallerOutput.php.

Referenced by __construct().

◆ $redirectTarget

string WebInstallerOutput::$redirectTarget

Definition at line 55 of file WebInstallerOutput.php.

◆ $useShortHeader

bool WebInstallerOutput::$useShortHeader = false

private

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

Definition at line 67 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()

◆ 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