Wikibase\Client\Hooks\LinkedDataSchemaGenerator Class Reference

Inheritance diagram for Wikibase\Client\Hooks\LinkedDataSchemaGenerator:

Collaboration diagram for Wikibase\Client\Hooks\LinkedDataSchemaGenerator:

Public Member Functions
	__construct (RevisionLookup $revisionLookup, EntityIdParser $entityIdParser, RepoLinker $repoLinker, array $pageSchemaNamespaces, ?PageImages $pageImages)
	createSchemaElement (Title $title, ?string $revisionTimestamp, ?string $firstRevisionTimestamp, EntityId $entityId, ?string $description)
	onSkinAfterBottomScripts ( $skin, &$html)
	Injects a Wikidata inline JSON-LD script schema for search engine optimization.
	onOutputPageParserOutput ( $outputPage, $parserOutput)

Static Public Member Functions
static	factory (RevisionLookup $revisionLookup, EntityIdParser $entityIdParser, RepoLinker $repoLinker, SettingsArray $settings, ?PageImages $pageImages)

Private Member Functions
	createSchema (Title $title, ?string $revisionTimestamp, ?string $firstRevisionTimestamp, string $entityConceptUri, ?File $imageFile, ?string $description)
	queryPageImage (Title $title)
	If available, query the canonical page image injected into the og:image meta tag.
	parseEntityId (?string $prefixedId)

Private Attributes
RevisionLookup	$revisionLookup
EntityIdParser	$entityIdParser
RepoLinker	$repoLinker
array	$pageSchemaNamespaces
PageImages	$pageImages

Detailed Description

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Client\Hooks\LinkedDataSchemaGenerator::__construct	(	RevisionLookup	$revisionLookup,
		EntityIdParser	$entityIdParser,
		RepoLinker	$repoLinker,
		array	$pageSchemaNamespaces,
		?PageImages	$pageImages )

Member Function Documentation

createSchema()

Wikibase\Client\Hooks\LinkedDataSchemaGenerator::createSchema ( Title $title, ?string $revisionTimestamp, ?string $firstRevisionTimestamp, string $entityConceptUri, ?File $imageFile, ?string $description )

private

createSchemaElement()

Wikibase\Client\Hooks\LinkedDataSchemaGenerator::createSchemaElement	(	Title	$title,
		?string	$revisionTimestamp,
		?string	$firstRevisionTimestamp,
		EntityId	$entityId,
		?string	$description )

Parameters

Title	$title
string | null	$revisionTimestamp
string | null	$firstRevisionTimestamp
EntityId	$entityId
string | null	$description

Returns

string

factory()

static Wikibase\Client\Hooks\LinkedDataSchemaGenerator::factory ( RevisionLookup $revisionLookup, EntityIdParser $entityIdParser, RepoLinker $repoLinker, SettingsArray $settings, ?PageImages $pageImages )

static

onOutputPageParserOutput()

Wikibase\Client\Hooks\LinkedDataSchemaGenerator::onOutputPageParserOutput	(		$outputPage,
			$parserOutput )

onSkinAfterBottomScripts()

Wikibase\Client\Hooks\LinkedDataSchemaGenerator::onSkinAfterBottomScripts	(		$skin,
		&	$html )

Injects a Wikidata inline JSON-LD script schema for search engine optimization.

Parameters

Skin	$skin
string	&$html

Returns

bool Always true.

parseEntityId()

Wikibase\Client\Hooks\LinkedDataSchemaGenerator::parseEntityId ( ?string $prefixedId )

private

queryPageImage()

Wikibase\Client\Hooks\LinkedDataSchemaGenerator::queryPageImage ( Title $title )

private

If available, query the canonical page image injected into the og:image meta tag.

It's important that the schema image match the page meta image since the schema describes the page.

Parameters

Title

$title

Returns

File|null

Member Data Documentation

$entityIdParser

EntityIdParser Wikibase\Client\Hooks\LinkedDataSchemaGenerator::$entityIdParser

private

$pageImages

PageImages Wikibase\Client\Hooks\LinkedDataSchemaGenerator::$pageImages

private

$pageSchemaNamespaces

array Wikibase\Client\Hooks\LinkedDataSchemaGenerator::$pageSchemaNamespaces

private

$repoLinker

RepoLinker Wikibase\Client\Hooks\LinkedDataSchemaGenerator::$repoLinker

private

$revisionLookup

RevisionLookup Wikibase\Client\Hooks\LinkedDataSchemaGenerator::$revisionLookup

private

---

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

• client/includes/Hooks/LinkedDataSchemaGenerator.php