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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Page;
use InvalidArgumentException;
use Wikimedia\Assert\Assert;
/**
* Immutable value object representing a page identity.
*
* Instances of this class are expected to always represent proper pages, that is,
* pages that can at least potentially exist as editable pages on the wiki.
* This class cannot represent Special pages, interwiki links, section links, etc.
*
* Code that deserializes instances of PageIdentityValue must ensure that the original
* meaning of the "local" Wiki ID is preserved: When an instance of PageIdentityValue
* is created with self::LOCAL as the Wiki ID on one wiki, gets serialized,
* stored, and later read and unserialized on another wiki, the value of the Wiki ID
* must be adjusted to refer to the original wiki.
*
* @see https://www.mediawiki.org/wiki/Manual:Modeling_pages
*
* @since 1.36
*/
class PageIdentityValue extends PageReferenceValue implements ProperPageIdentity {
/** @var int */
private $pageId;
/**
* Constructs a PageIdentityValue, or returns null if the parameters are not valid.
*
* @note This does not perform any normalization, and only basic validation.
* For full normalization and validation, use TitleParser::makeTitleValueSafe()
* together with PageLookup::getPageForLink().
*
* @param int $pageId The ID of this page, or 0 if the page does not exist.
* @param int $namespace A valid namespace ID. Validation is the caller's responsibility!
* @param string $dbKey A valid DB key. Validation is the caller's responsibility!
* @param string|false $wikiId The Id of the wiki this page belongs to,
* or self::LOCAL for the local wiki.
*
* @return PageIdentityValue|null
*/
public static function tryNew( int $pageId, int $namespace, string $dbKey, $wikiId ) {
try {
return new static( $pageId, $namespace, $dbKey, $wikiId );
} catch ( InvalidArgumentException $ex ) {
return null;
}
}
/**
* @param int $pageId The ID of this page, or 0 if the page does not exist.
* @param int $namespace A valid namespace ID. Validation is the caller's responsibility!
* @param string $dbKey A valid DB key. Validation is the caller's responsibility!
* @param string|false $wikiId The Id of the wiki this page belongs to,
* or self::LOCAL for the local wiki.
*/
public function __construct( int $pageId, int $namespace, string $dbKey, $wikiId ) {
Assert::parameter( $pageId >= 0, '$pageId', 'must not be negative' );
Assert::parameter( $namespace >= 0, '$namespace', 'must not be negative' );
// Not full validation, intended to help detect lack of validation in the caller.
Assert::parameter(
!preg_match( '/[#|]/', $dbKey ),
'$dbKey',
'must not contain pipes or hashes: ' . $dbKey
);
parent::__construct( $namespace, $dbKey, $wikiId );
$this->pageId = $pageId;
}
/**
* Create PageIdentity for a local page.
*
* @param int $pageId
* @param int $namespace
* @param string $dbKey
* @return PageIdentityValue
*/
public static function localIdentity( int $pageId, int $namespace, string $dbKey ): self {
return new self( $pageId, $namespace, $dbKey, self::LOCAL );
}
/**
* The numerical page ID provided to the constructor.
*
* @param string|false $wikiId The wiki ID expected by the caller.
* Omit if expecting the local wiki.
*
* @return int
*/
public function getId( $wikiId = self::LOCAL ): int {
$this->assertWiki( $wikiId );
return $this->pageId;
}
/**
* Returns whether the page currently exists.
* Returns true if getId() returns a value greater than zero.
* @return bool
*/
public function exists(): bool {
return $this->getId( $this->getWikiId() ) > 0;
}
/**
* @return bool always true
*/
public function canExist(): bool {
return true;
}
}
|
