1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
<?php
namespace SMW;
use Html;
use SMW\Exception\PropertyNotFoundException;
use SMWDIError;
use SMWTypesValue;
/**
* Query page that provides content to Special:UnusedProperties
*
* @ingroup QueryPage
*
* @licence GNU GPL v2+
* @since 1.9
*
* @author Markus Krötzsch
* @author mwjames
*/
class UnusedPropertiesQueryPage extends QueryPage {
/** @var Store */
protected $store;
/** @var Settings */
protected $settings;
/**
* @var ListLookup
*/
private $listLookup;
/**
* @since 1.9
*
* @param Store $store
* @param Settings $settings
*/
public function __construct( Store $store, Settings $settings ) {
$this->store = $store;
$this->settings = $settings;
}
/**
* @codeCoverageIgnore
* @return string
*/
function getName() {
return "UnusedProperties";
}
/**
* @codeCoverageIgnore
* @return boolean
*/
function isExpensive() {
return false; // Disables caching for now
}
/**
* @codeCoverageIgnore
* @return boolean
*/
function isSyndicated() {
return false; // TODO: why not?
}
/**
* @codeCoverageIgnore
* Returns available cache information (takes into account user preferences)
*
* @since 1.9
*
* @return string
*/
public function getCacheInfo() {
if ( $this->listLookup->isFromCache() ) {
return $this->msg( 'smw-sp-properties-cache-info', $this->getLanguage()->userTimeAndDate( $this->listLookup->getTimestamp(), $this->getUser() ) )->parse();
}
return '';
}
/**
* @codeCoverageIgnore
* @return string
*/
function getPageHeader() {
return Html::rawElement(
'p',
[ 'class' => 'smw-unusedproperties-docu' ],
$this->msg( 'smw-unusedproperties-docu' )->parse()
) . $this->getSearchForm( $this->getRequest()->getVal( 'property' ), $this->getCacheInfo() ) .
Html::element(
'h2',
[],
$this->msg( 'smw-sp-properties-header-label' )->text()
);
}
/**
* Format a result in the list of results as a string. We expect the
* result to be an object of type SMWDIProperty (normally) or maybe
* SMWDIError (if something went wrong).
*
* @param Skin $skin provided by MediaWiki, not needed here
* @param mixed $result
*
* @return String
* @throws InvalidResultException if the result was not of a supported type
*/
function formatResult( $skin, $result ) {
if ( $result instanceof DIProperty ) {
return $this->formatPropertyItem( $result );
} elseif ( $result instanceof SMWDIError ) {
return $this->getMessageFormatter()->clear()
->setType( 'warning' )
->addFromArray( [ $result->getErrors() ] )
->getHtml();
}
throw new PropertyNotFoundException( 'UnusedPropertiesQueryPage expects results that are properties or errors.' );
}
/**
* Produce a formatted string representation for showing a property in
* the list of unused properties.
*
* @since 1.8
*
* @param DIProperty $property
*
* @return string
*/
protected function formatPropertyItem( DIProperty $property ) {
// Clear formatter before invoking messages and
// avoid having previous data to be present
$this->getMessageFormatter()->clear();
if ( $property->isUserDefined() ) {
$title = $property->getDiWikiPage()->getTitle();
if ( !$title instanceof \Title ) {
return '';
}
$propertyLink = $this->getLinker()->link(
$title,
$property->getLabel()
);
$types = $this->store->getPropertyValues( $property->getDiWikiPage(), new DIProperty( '_TYPE' ) );
if ( is_array( $types ) && count( $types ) >= 1 ) {
$typeDataValue = DataValueFactory::getInstance()->newDataValueByItem( current( $types ), new DIProperty( '_TYPE' ) );
} else {
$typeDataValue = SMWTypesValue::newFromTypeId( '_wpg' );
$this->getMessageFormatter()->addFromKey( 'smw_propertylackstype', $typeDataValue->getLongHTMLText() );
}
} else {
$typeDataValue = SMWTypesValue::newFromTypeId( $property->findPropertyTypeID() );
$propertyLink = DataValueFactory::getInstance()->newDataValueByItem( $property, null )->getShortHtmlText( $this->getLinker() );
}
return $this->msg( 'smw-unusedproperty-template', $propertyLink, $typeDataValue->getLongHTMLText( $this->getLinker() ) )->text() . ' ' .
$this->getMessageFormatter()->getHtml();
}
/**
* Get the list of results.
*
* @param SMWRequestOptions $requestOptions
* @return array of SMWDIProperty|SMWDIError
*/
function getResults( $requestOptions ) {
$this->listLookup = $this->store->getUnusedPropertiesSpecial( $requestOptions );
return $this->listLookup->fetchList();
}
}
|
