Manual:PageIdentityValue.php
| MediaWiki file: PageIdentityValue.php | |
|---|---|
| Location: | includes/page/ |
| Source code: | master • 1.43.0 • 1.42.4 • 1.39.11 |
| Classes: | MediaWiki\Page\PageIdentityValue |
Immutable value object representing a page identity. Extends PageReferenceValue and implements ProperPageIdentity.
- 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 this class must ensure that the original meaning of the "local" Wiki ID is preserved: when an instance of
PageIdentityValueis created withself::LOCALas the Wiki ID on one wiki, gets serialized, stored, and later read and unserialized on another wiki, then the value of the Wiki ID must be adjusted to refer to the original wiki.
Public methods
[edit]- tryNew() - construct a PageIdentityValue, or return null if the parameters are not valid.
- localIdentity() - create PageIdentity for a local page.
- getId() - get the numerical page ID provided to the constructor.
- exists() - returns whether the page currently exists (boolean).
- canExist()