Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler Class Reference

Handler for the "OutputPageBeforeHTML" hook. More...

Public Member Functions
	__construct (TemplateFactory $templateFactory, UserLanguageLookup $userLanguageLookup, ContentLanguages $termsLanguages, EntityRevisionLookup $entityRevisionLookup, LanguageNameLookup $languageNameLookup, OutputPageEntityIdReader $outputPageEntityIdReader, EntityFactory $entityFactory, $cookiePrefix, OutputPageEditability $editability, $isExternallyRendered, UserPreferredContentLanguagesLookup $userPreferredTermsLanguages)
	doOutputPageBeforeHTML (OutputPage $out, &$html)

Static Public Member Functions
static	newFromGlobalState ()
static	onOutputPageBeforeHTML (OutputPage $out, &$html)
	Called when pushing HTML from the ParserOutput into OutputPage.

Private Member Functions
	replacePlaceholders (OutputPage $out, $html)
	addJsUserLanguages (OutputPage $out)
	getEntity (OutputPage $out)
	needsRealEntity (OutputPage $out)
	getPlaceholderExpander (EntityDocument $entity, OutputPage $out)
	getLocallyRenderedEntityViewPlaceholderExpander (EntityDocument $entity, OutputPage $out)
	getExternallyRenderedEntityViewPlaceholderExpander (OutputPage $out)
	getEntityTermsListHtml (OutputPage $out)
	showOrHideEditLinks (OutputPage $out, $html)
	getEntityId (OutputPage $out)

Private Attributes
	$templateFactory
	$userLanguageLookup
	$termsLanguages
	$entityRevisionLookup
	$languageNameLookup
	$outputPageEntityIdReader
	$entityFactory
	$cookiePrefix
	$editability
	$isExternallyRendered
	$userPreferredTermsLanguages

Detailed Description

Handler for the "OutputPageBeforeHTML" hook.

Copyright

GPL-2.0-or-later

Author

Marius Hoch < hoo@o.nosp@m.nlin.nosp@m.e.de >

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::__construct	(	TemplateFactory	$templateFactory,
		UserLanguageLookup	$userLanguageLookup,
		ContentLanguages	$termsLanguages,
		EntityRevisionLookup	$entityRevisionLookup,
		LanguageNameLookup	$languageNameLookup,
		OutputPageEntityIdReader	$outputPageEntityIdReader,
		EntityFactory	$entityFactory,
			$cookiePrefix,
		OutputPageEditability	$editability,
			$isExternallyRendered,
		UserPreferredContentLanguagesLookup	$userPreferredTermsLanguages
	)

Member Function Documentation

addJsUserLanguages()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::addJsUserLanguages ( OutputPage  $out )

private

doOutputPageBeforeHTML()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::doOutputPageBeforeHTML	(	OutputPage	$out,
		&	$html
	)

Parameters

OutputPage	$out
string	&$html

getEntity()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::getEntity ( OutputPage  $out )

private

Parameters

OutputPage

$out

Returns

EntityDocument|null

getEntityId()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::getEntityId ( OutputPage  $out )

private

Parameters

OutputPage

$out

Returns

EntityId|null

getEntityTermsListHtml()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::getEntityTermsListHtml ( OutputPage  $out )

private

getExternallyRenderedEntityViewPlaceholderExpander()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::getExternallyRenderedEntityViewPlaceholderExpander ( OutputPage  $out )

private

getLocallyRenderedEntityViewPlaceholderExpander()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::getLocallyRenderedEntityViewPlaceholderExpander ( EntityDocument  $entity, OutputPage  $out  )

private

Parameters

EntityDocument	$entity
OutputPage	$out

Returns

EntityViewPlaceholderExpander

getPlaceholderExpander()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::getPlaceholderExpander ( EntityDocument  $entity, OutputPage  $out  )

private

needsRealEntity()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::needsRealEntity ( OutputPage  $out )

private

newFromGlobalState()

static Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::newFromGlobalState ( )

static

Returns

self

onOutputPageBeforeHTML()

static Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::onOutputPageBeforeHTML ( OutputPage  $out, &  $html  )

static

Called when pushing HTML from the ParserOutput into OutputPage.

Used to expand any placeholders in the OutputPage's 'wb-placeholders' property in the HTML.

Parameters

OutputPage	$out
string	&$html	the HTML to mangle

replacePlaceholders()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::replacePlaceholders ( OutputPage  $out,   $html  )

private

Parameters

OutputPage	$out
string	$html

Returns

string

showOrHideEditLinks()

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::showOrHideEditLinks ( OutputPage  $out,   $html  )

private

Member Data Documentation

$cookiePrefix

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$cookiePrefix

private

$editability

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$editability

private

$entityFactory

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$entityFactory

private

$entityRevisionLookup

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$entityRevisionLookup

private

$isExternallyRendered

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$isExternallyRendered

private

$languageNameLookup

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$languageNameLookup

private

$outputPageEntityIdReader

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$outputPageEntityIdReader

private

$templateFactory

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$templateFactory

private

$termsLanguages

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$termsLanguages

private

$userLanguageLookup

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$userLanguageLookup

private

$userPreferredTermsLanguages

Wikibase\Repo\Hooks\OutputPageBeforeHTMLHookHandler::$userPreferredTermsLanguages

private

---

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

• repo/includes/Hooks/OutputPageBeforeHTMLHookHandler.php