|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace SBL; |
|
4
|
|
|
|
|
5
|
|
|
use SMW\DIWikiPage; |
|
6
|
|
|
use SMW\ParserData; |
|
7
|
|
|
use SMW\DIProperty; |
|
8
|
|
|
use Title; |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* @license GNU GPL v2+ |
|
12
|
|
|
* @since 1.3 |
|
13
|
|
|
* |
|
14
|
|
|
* @author mwjames |
|
15
|
|
|
*/ |
|
16
|
|
|
class SubpageParentAnnotator { |
|
17
|
|
|
|
|
18
|
|
|
/** |
|
19
|
|
|
* @var ParserData |
|
20
|
|
|
*/ |
|
21
|
|
|
private $parserData; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* @var boolean |
|
25
|
|
|
*/ |
|
26
|
|
|
private $enableSubpageParentAnnotation = true; |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* @var boolean |
|
30
|
|
|
*/ |
|
31
|
|
|
private $disableTranslationSubpageAnnotation = false; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @since 1.3 |
|
35
|
|
|
* |
|
36
|
|
|
* @param ParserData $parserData |
|
37
|
|
|
*/ |
|
38
|
6 |
|
public function __construct( ParserData $parserData ) { |
|
39
|
6 |
|
$this->parserData = $parserData; |
|
40
|
6 |
|
} |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* @since 1.3 |
|
44
|
|
|
* |
|
45
|
|
|
* @param boolean $enableSubpageParentAnnotation |
|
46
|
|
|
*/ |
|
47
|
3 |
|
public function enableSubpageParentAnnotation( $enableSubpageParentAnnotation ) { |
|
48
|
3 |
|
$this->enableSubpageParentAnnotation = (bool)$enableSubpageParentAnnotation; |
|
49
|
3 |
|
} |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* @since 1.3 |
|
53
|
|
|
* |
|
54
|
|
|
* @param boolean $enableSubpageParentAnnotation |
|
|
|
|
|
|
55
|
|
|
*/ |
|
56
|
1 |
|
public function disableTranslationSubpageAnnotation( $disableTranslationSubpageAnnotation ) { |
|
57
|
1 |
|
$this->disableTranslationSubpageAnnotation = (bool)$disableTranslationSubpageAnnotation; |
|
58
|
1 |
|
} |
|
59
|
|
|
|
|
60
|
|
|
/** |
|
61
|
|
|
* @since 1.3 |
|
62
|
|
|
*/ |
|
63
|
5 |
|
public function addAnnotation() { |
|
64
|
|
|
|
|
65
|
5 |
|
$title = $this->parserData->getTitle(); |
|
66
|
|
|
|
|
67
|
5 |
|
if ( !$this->enableSubpageParentAnnotation || strpos( $title->getText(), '/' ) === false ) { |
|
68
|
1 |
|
return; |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
// Is a ranslation page? bail-out! |
|
72
|
|
|
// @see https://github.com/SemanticMediaWiki/SemanticMediaWiki/pull/3293 |
|
73
|
4 |
|
if ( $this->disableTranslationSubpageAnnotation && $this->parserData->getOutput()->getExtensionData( 'translate-translation-page' ) ) { |
|
74
|
1 |
|
return; |
|
75
|
|
|
} |
|
76
|
|
|
|
|
77
|
3 |
|
$property = DIProperty::newFromUserLabel( SBL_PROP_PARENTPAGE ); |
|
78
|
|
|
|
|
79
|
|
|
// Don't override any "man"-made annotation |
|
80
|
3 |
|
if ( $this->parserData->getSemanticData()->getPropertyValues( $property ) !== [] ) { |
|
81
|
1 |
|
return; |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
2 |
|
$base = $this->getBaseText( $title ); |
|
85
|
|
|
|
|
86
|
|
|
// #23 |
|
87
|
2 |
|
if ( substr( $base, -1 ) === ' ' ) { |
|
88
|
1 |
|
return; |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
1 |
|
$this->parserData->getSemanticData()->addPropertyObjectValue( |
|
92
|
1 |
|
$property, |
|
93
|
1 |
|
DIWikiPage::newFromText( $base, $title->getNamespace() ) |
|
94
|
1 |
|
); |
|
95
|
|
|
|
|
96
|
1 |
|
$this->parserData->pushSemanticDataToParserOutput(); |
|
|
|
|
|
|
97
|
1 |
|
} |
|
98
|
|
|
|
|
99
|
|
|
// Don't rely on Title::getBaseText as it depends on the wgNamespacesWithSubpages |
|
100
|
|
|
// setting and if set false will return the normal text including its subparts |
|
101
|
2 |
|
private function getBaseText( $title ) { |
|
102
|
|
|
|
|
103
|
2 |
|
$parts = explode( '/', $title->getText() ); |
|
104
|
|
|
# Don't discard the real title if there's no subpage involved |
|
105
|
2 |
|
if ( count( $parts ) > 1 ) { |
|
106
|
2 |
|
unset( $parts[count( $parts ) - 1] ); |
|
107
|
2 |
|
} |
|
108
|
|
|
|
|
109
|
2 |
|
return implode( '/', $parts ); |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
} |
|
113
|
|
|
|
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italyis not defined by the methodfinale(...).The most likely cause is that the parameter was removed, but the annotation was not.