1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Wikibase\Repo\Hooks\Formatters; |
4
|
|
|
|
5
|
|
|
use HtmlArmor; |
6
|
|
|
use Language; |
7
|
|
|
use Wikibase\DataModel\Entity\EntityId; |
8
|
|
|
use Wikibase\Lib\Store\EntityTitleTextLookup; |
9
|
|
|
|
10
|
|
|
/** |
11
|
|
|
* Utility class to format entity links with labels for usage in hooks. |
12
|
|
|
*/ |
13
|
|
|
class DefaultEntityLinkFormatter implements EntityLinkFormatter { |
14
|
|
|
|
15
|
|
|
/** |
16
|
|
|
* @var Language |
17
|
|
|
*/ |
18
|
|
|
private $pageLanguage; |
19
|
|
|
|
20
|
|
|
/** |
21
|
|
|
* @var EntityTitleTextLookup |
22
|
|
|
*/ |
23
|
|
|
private $entityTitleTextLookup; |
24
|
|
|
|
25
|
|
|
public function __construct( Language $pageLanguage, EntityTitleTextLookup $entityTitleTextLookup ) { |
26
|
|
|
$this->pageLanguage = $pageLanguage; |
27
|
|
|
$this->entityTitleTextLookup = $entityTitleTextLookup; |
28
|
|
|
} |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* @inheritDoc |
32
|
|
|
*/ |
33
|
|
|
public function getHtml( EntityId $entityId, array $labelData = null ) { |
34
|
|
|
/** @var Language $labelLang */ |
35
|
|
|
list( $labelText, $labelLang ) = $this->extractTextAndLanguage( $labelData ); |
|
|
|
|
36
|
|
|
|
37
|
|
|
$idHtml = '<span class="wb-itemlink-id">' |
38
|
|
|
. wfMessage( |
39
|
|
|
'wikibase-itemlink-id-wrapper', |
40
|
|
|
$entityId->getSerialization() |
41
|
|
|
)->inContentLanguage()->escaped() |
42
|
|
|
. '</span>'; |
43
|
|
|
|
44
|
|
|
$labelHtml = '<span class="wb-itemlink-label"' |
45
|
|
|
. ' lang="' . htmlspecialchars( $labelLang->getHtmlCode() ) . '"' |
46
|
|
|
. ' dir="' . htmlspecialchars( $labelLang->getDir() ) . '">' |
47
|
|
|
. HtmlArmor::getHtml( $labelText ) |
48
|
|
|
. '</span>'; |
49
|
|
|
|
50
|
|
|
return '<span class="wb-itemlink">' |
51
|
|
|
. wfMessage( 'wikibase-itemlink' )->rawParams( |
52
|
|
|
$labelHtml, |
53
|
|
|
$idHtml |
54
|
|
|
)->inContentLanguage()->escaped() |
55
|
|
|
. '</span>'; |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* @param string[]|null $termData A term record as returned by |
60
|
|
|
* TermLanguageFallbackChain::extractPreferredValueOrAny(), |
61
|
|
|
* containing the 'value' and 'language' fields, or null |
62
|
|
|
* or an empty array. |
63
|
|
|
* |
64
|
|
|
* @see TermLanguageFallbackChain::extractPreferredValueOrAny |
65
|
|
|
* |
66
|
|
|
* @return array list( string $text, Language $language ) |
67
|
|
|
*/ |
68
|
|
|
private function extractTextAndLanguage( array $termData = null ) { |
69
|
|
|
if ( $termData ) { |
70
|
|
|
return [ |
71
|
|
|
$termData['value'], |
72
|
|
|
Language::factory( $termData['language'] ) |
73
|
|
|
]; |
74
|
|
|
} else { |
75
|
|
|
return [ |
76
|
|
|
'', |
77
|
|
|
$this->pageLanguage |
78
|
|
|
]; |
79
|
|
|
} |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
/** |
83
|
|
|
* @inheritDoc |
84
|
|
|
*/ |
85
|
|
|
public function getTitleAttribute( |
86
|
|
|
EntityId $entityId, |
87
|
|
|
array $labelData = null, |
88
|
|
|
array $descriptionData = null |
89
|
|
|
) { |
90
|
|
|
/** @var Language $labelLang */ |
91
|
|
|
/** @var Language $descriptionLang */ |
92
|
|
|
|
93
|
|
|
list( $labelText, $labelLang ) = $this->extractTextAndLanguage( $labelData ); |
|
|
|
|
94
|
|
|
list( $descriptionText, $descriptionLang ) = $this->extractTextAndLanguage( $descriptionData ); |
|
|
|
|
95
|
|
|
|
96
|
|
|
// Set title attribute for constructed link, and make tricks with the directionality to get it right |
97
|
|
|
$titleText = ( $labelText !== '' ) |
98
|
|
|
? $labelLang->getDirMark() . $labelText |
99
|
|
|
. $this->pageLanguage->getDirMark() |
100
|
|
|
: $this->entityTitleTextLookup->getPrefixedText( $entityId ); |
101
|
|
|
|
102
|
|
|
if ( $descriptionText !== '' ) { |
103
|
|
|
$descriptionText = $descriptionLang->getDirMark() . $descriptionText |
104
|
|
|
. $this->pageLanguage->getDirMark(); |
105
|
|
|
return wfMessage( |
106
|
|
|
'wikibase-itemlink-title', |
107
|
|
|
$titleText, |
108
|
|
|
$descriptionText |
109
|
|
|
)->inContentLanguage()->text(); |
110
|
|
|
} else { |
111
|
|
|
return $titleText; // no description, just display the title then |
112
|
|
|
} |
113
|
|
|
} |
114
|
|
|
|
115
|
|
|
public function getFragment( EntityId $entityId, $fragment ) { |
116
|
|
|
return $fragment; |
117
|
|
|
} |
118
|
|
|
|
119
|
|
|
} |
120
|
|
|
|
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.