Wikibase\Lexeme\DataAccess\LexemeDescription Class Reference

Class for generating Lexeme description strings. More...

Public Member Functions
	__construct (LabelDescriptionLookup $lookup, EntityIdParser $idParser, Language $displayLanguage)
	getLabelOrDefault (EntityId $id=null, $default="")
	Get label or return empty string. More...
	createDescription (EntityId $id, $language, $category)
	Create short lexeme description, e.g. More...
	createFormDescription (EntityId $lexemeId, array $features, $lemma, $language, $category)
	Create Form descriptions, along the lines of: singular genitive for Leiter (L1): German noun. More...

Static Public Member Functions
static	parseOrNull ( $text, EntityIdParser $idParser)
	Parse entity ID or return null. More...

Private Attributes
	$lookup
	$idParser
	$displayLanguage

Detailed Description

Class for generating Lexeme description strings.

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Lexeme\DataAccess\LexemeDescription::__construct	(	LabelDescriptionLookup	$lookup,
		EntityIdParser	$idParser,
		Language	$displayLanguage
	)

Member Function Documentation

createDescription()

Wikibase\Lexeme\DataAccess\LexemeDescription::createDescription	(	EntityId	$id,
			$language,
			$category
	)

Create short lexeme description, e.g.

: "German noun" or "English verb" Currently not uses the ID, may change later

Parameters

EntityId	$id	Lexeme ID
string	$language	Language ID, as string
string	$category	Lexical category ID, as string

Returns

string

Exceptions

createFormDescription()

Wikibase\Lexeme\DataAccess\LexemeDescription::createFormDescription	(	EntityId	$lexemeId,
		array	$features,
			$lemma,
			$language,
			$category
	)

Create Form descriptions, along the lines of: singular genitive for Leiter (L1): German noun.

Parameters

EntityId	$lexemeId	Main lexeme
EntityId[]	$features	Form feature IDs list
string	$lemma	Lexeme's lemma
string	$language	Language ID, as string
string	$category	Lexical category ID, as string

Returns

string

Exceptions

getLabelOrDefault()

Wikibase\Lexeme\DataAccess\LexemeDescription::getLabelOrDefault	(	EntityId	$id = null,
			$default = ""
	)

Get label or return empty string.

Parameters

EntityId | null	$id
string	$default	Default value if unable to retrieve label

Returns

string Label or "" if does not exist.

parseOrNull()

static Wikibase\Lexeme\DataAccess\LexemeDescription::parseOrNull (   $text, EntityIdParser  $idParser  )

static

Parse entity ID or return null.

Parameters

string	$text
EntityIdParser	$idParser

Returns

null|EntityId

Member Data Documentation

$displayLanguage

Wikibase\Lexeme\DataAccess\LexemeDescription::$displayLanguage

private

$idParser

Wikibase\Lexeme\DataAccess\LexemeDescription::$idParser

private

$lookup

Wikibase\Lexeme\DataAccess\LexemeDescription::$lookup

private

---

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

• src/DataAccess/LexemeDescription.php