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
|
<?php
namespace MediaWiki\Page;
use InvalidArgumentException;
use MediaWiki\Linker\LinkTarget;
use Wikimedia\Rdbms\IDBAccessObject;
/**
* Service for looking up information about wiki pages.
*
* Default implementation is PageStore.
*
* @since 1.36
* @ingroup Page
*/
interface PageLookup {
/**
* Returns the PageIdentity for the given LinkTarget. The page does not have to exist.
* Fragments are ignored.
*
* The LinkTarget must refer to a proper page - that is, it must not be a relative section link,
* an interwiki link, or refer to a special page.
*
* @param LinkTarget $link
* @param int $queryFlags
*
* @throws InvalidArgumentException if $link does not refer to a proper page.
* @return ProperPageIdentity
*/
public function getPageForLink(
LinkTarget $link,
int $queryFlags = IDBAccessObject::READ_NORMAL
): ProperPageIdentity;
/**
* Returns the PageRecord of the given page.
*
* @param int $pageId
* @param int $queryFlags
*
* @throws InvalidArgumentException if $pageId is 0 or negative.
* @return ExistingPageRecord|null The page's PageRecord, or null if the page was not found.
*/
public function getPageById(
int $pageId,
int $queryFlags = IDBAccessObject::READ_NORMAL
): ?ExistingPageRecord;
/**
* Returns the PageRecord for the given name and namespace.
*
* @param int $namespace
* @param string $dbKey
* @param int $queryFlags
*
* @return ExistingPageRecord|null The page's PageRecord, or null if the page was not found.
* @throws InvalidArgumentException if $namespace is negative or $dbKey is empty.
*/
public function getPageByName(
int $namespace,
string $dbKey,
int $queryFlags = IDBAccessObject::READ_NORMAL
): ?ExistingPageRecord;
/**
* Returns a PageIdentity for a given user provided page name text.
* Returns null if the title is not a valid name of a proper page,
* e.g if it is a special page, an interwiki link, a relative section line, or simply invalid.
*
* @since 1.37
*
* @param string $text
* @param int $defaultNamespace Namespace to assume by default (usually NS_MAIN)
* @param int $queryFlags
*
* @return ProperPageIdentity|null
*/
public function getPageByText(
string $text,
int $defaultNamespace = NS_MAIN,
int $queryFlags = IDBAccessObject::READ_NORMAL
): ?ProperPageIdentity;
/**
* Returns an ExistingPageRecord for a given user provided page name text.
*
* Returns null if the page does not exist or if title is not a valid name of a proper page,
* e.g if it is a special page, an interwiki link, a relative section line, or simply invalid.
*
* @since 1.37
*
* @param string $text
* @param int $defaultNamespace Namespace to assume by default (usually NS_MAIN)
* @param int $queryFlags
*
* @return ExistingPageRecord|null
*/
public function getExistingPageByText(
string $text,
int $defaultNamespace = NS_MAIN,
int $queryFlags = IDBAccessObject::READ_NORMAL
): ?ExistingPageRecord;
/**
* Returns the PageRecord of the given page.
* May return $page if that already is a PageRecord.
* If $page is a PageIdentity, implementations may call methods like exists() and getId() on it.
*
* The PageReference must refer to a proper page - that is, it must not refer to a special page.
*
* @param PageReference $page
* @param int $queryFlags
*
* @return ExistingPageRecord|null The page's PageRecord, or null if the page was not found.
* @throws InvalidArgumentException if $page does not refer to a proper page.
*/
public function getPageByReference(
PageReference $page,
int $queryFlags = IDBAccessObject::READ_NORMAL
): ?ExistingPageRecord;
}
|
