MediaWiki  REL1_24
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
WebInstallerOutput Class Reference
Deployment

Output class modelled on OutputPage. More...

Collaboration diagram for WebInstallerOutput:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

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

Definition at line 72 of file WebInstallerOutput.php.

Member Function Documentation

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

Definition at line 79 of file WebInstallerOutput.php.

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

Definition at line 94 of file WebInstallerOutput.php.

WebInstallerOutput::addWikiText ( $  text)
Parameters:
string$text

Definition at line 87 of file WebInstallerOutput.php.

WebInstallerOutput::allowFrames ( $  allow = true)

Definition at line 185 of file WebInstallerOutput.php.

WebInstallerOutput::flush ( )

Definition at line 189 of file WebInstallerOutput.php.

WebInstallerOutput::getCSS ( )

Get the stylesheet of the MediaWiki skin.

Returns:
string

Definition at line 120 of file WebInstallerOutput.php.

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

WebInstallerOutput::getCssUrl ( ) [private]

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

Returns:
string

Definition at line 177 of file WebInstallerOutput.php.

References Html\linkedStyle().

WebInstallerOutput::getDir ( )
Returns:
string

Definition at line 203 of file WebInstallerOutput.php.

WebInstallerOutput::getHeadAttribs ( )
Returns:
string[]

Definition at line 221 of file WebInstallerOutput.php.

WebInstallerOutput::getJQuery ( )
Returns:
string

Definition at line 328 of file WebInstallerOutput.php.

WebInstallerOutput::getLanguageCode ( )
Returns:
string

Definition at line 212 of file WebInstallerOutput.php.

Referenced by getCSS().

WebInstallerOutput::headerDone ( )

Get whether the header has been output.

Returns:
bool

Definition at line 233 of file WebInstallerOutput.php.

WebInstallerOutput::output ( )

Definition at line 110 of file WebInstallerOutput.php.

WebInstallerOutput::outputFooter ( )

Definition at line 277 of file WebInstallerOutput.php.

WebInstallerOutput::outputHeader ( )

Definition at line 237 of file WebInstallerOutput.php.

WebInstallerOutput::outputShortHeader ( )

Definition at line 304 of file WebInstallerOutput.php.

WebInstallerOutput::outputTitle ( )

Definition at line 320 of file WebInstallerOutput.php.

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

Definition at line 103 of file WebInstallerOutput.php.

WebInstallerOutput::useShortHeader ( $  use = true)

Definition at line 181 of file WebInstallerOutput.php.

Member Data Documentation

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.

string WebInstallerOutput::$contents = '' [private]

Buffered contents that haven't been output yet.

Definition at line 46 of file WebInstallerOutput.php.

bool WebInstallerOutput::$headerDone = false [private]

Has the header (or short header) been output?

Definition at line 51 of file WebInstallerOutput.php.

WebInstaller WebInstallerOutput::$parent

The WebInstaller object this WebInstallerOutput is used by.

Definition at line 41 of file WebInstallerOutput.php.

string WebInstallerOutput::$redirectTarget

Definition at line 55 of file WebInstallerOutput.php.

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: