Code Coverage for /src/src/Config/PageConfig.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 3	CRAP	0.00% covered (danger)	0.00%	0 / 4
PageConfig	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 3	756	0.00% covered (danger)	0.00%	0 / 4
getContentModel					n/a	0 / 0	1		n/a	0 / 0
hasLintableContentModel					n/a	0 / 0	1		n/a	0 / 0
getTitle					n/a	0 / 0	1		n/a	0 / 0
getNs					n/a	0 / 0	1		n/a	0 / 0
getPageId					n/a	0 / 0	1		n/a	0 / 0
getPageLanguage					n/a	0 / 0	1		n/a	0 / 0
getPageLanguageDir					n/a	0 / 0	1		n/a	0 / 0
getRevisionId					n/a	0 / 0	2		n/a	0 / 0
getParentRevisionId					n/a	0 / 0	2		n/a	0 / 0
getRevisionTimestamp					n/a	0 / 0	2		n/a	0 / 0
getRevisionUser					n/a	0 / 0	2		n/a	0 / 0
getRevisionUserId					n/a	0 / 0	2		n/a	0 / 0
getRevisionSha1					n/a	0 / 0	2		n/a	0 / 0
getRevisionSize					n/a	0 / 0	2		n/a	0 / 0
getRevisionContent					n/a	0 / 0	2		n/a	0 / 0
getVariant				0.00% covered (danger)	0.00%	0 / 1	6	0.00% covered (danger)	0.00%	0 / 1
setVariant				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 2
getPageMainContent				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 1

1	<?php
2	declare( strict_types = 1 );
3
4	namespace Wikimedia\Parsoid\Config;
5
6	use DOMDocument;
7
8	/**
9	* Page-level configuration interface for Parsoid
10	*/
11	abstract class PageConfig {
12
13	/**
14	* The owner document of the page. Used to transfer context between WikitextSerializer and
15	* some extensions, see WikitextSerializer::serializeDOM.
16	* PORT-FIXME this should not be here.
17	* @var DOMDocument\|null
18	*/
19	public $editedDoc;
20
21	/**
22	* Non-null to record the fact that conversion has been done on
23	* this page (to the specified variant).
24	* @var ?string
25	*/
26	private $htmlVariant = null;
27
28	/**
29	* Get content model
30	* @return string
31	*/
32	abstract public function getContentModel(): string;
33
34	/**
35	* Whether the page has a lintable content model
36	* @return bool
37	*/
38	abstract public function hasLintableContentModel(): bool;
39
40	/**
41	* The page's title, as a string.
42	* @return string With namespace, spaces not underscores
43	*/
44	abstract public function getTitle(): string;
45
46	/**
47	* The page's namespace ID
48	* @return int
49	*/
50	abstract public function getNs(): int;
51
52	/**
53	* The page's ID, if any
54	* @return int 0 if the page doesn't exist
55	*/
56	abstract public function getPageId(): int;
57
58	/**
59	* The page's language code
60	* @return string
61	*/
62	abstract public function getPageLanguage(): string;
63
64	/**
65	* The page's language direction
66	* @return string 'ltr' or 'rtl'
67	*/
68	abstract public function getPageLanguageDir(): string;
69
70	/**
71	* The revision's ID, if any
72	* @return int\|null
73	*/
74	abstract public function getRevisionId(): ?int;
75
76	/**
77	* The revision's parent ID, if any
78	* @return int\|null
79	*/
80	abstract public function getParentRevisionId(): ?int;
81
82	/**
83	* The revision's timestamp, if any
84	* @return string\|null "YYYYMMDDHHIISS" format
85	*/
86	abstract public function getRevisionTimestamp(): ?string;
87
88	/**
89	* The revision's author's user name, if any
90	* @return string\|null
91	*/
92	abstract public function getRevisionUser(): ?string;
93
94	/**
95	* The revision's author's user ID, if any
96	* @return int\|null 0 if the user is not registered
97	*/
98	abstract public function getRevisionUserId(): ?int;
99
100	/**
101	* The revision's SHA1 checksum, if any
102	* @return string\|null Hex encoded
103	*/
104	abstract public function getRevisionSha1(): ?string;
105
106	/**
107	* The revision's length, if known
108	* @return int\|null Bytes
109	*/
110	abstract public function getRevisionSize(): ?int;
111
112	/**
113	* The revision's content
114	* @return PageContent\|null
115	*/
116	abstract public function getRevisionContent(): ?PageContent;
117
118	/**
119	* Get the page's language variant
120	* @return string\|null
121	*/
122	public function getVariant(): ?string {
123	return $this->htmlVariant;
124	}
125
126	/**
127	* Set the page's language variant. (Records the fact that
128	* conversion has been done in the parser pipeline.)
129	* @param string $htmlVariant
130	*/
131	public function setVariant( $htmlVariant ): void {
132	$this->htmlVariant = $htmlVariant;
133	}
134
135	/**
136	* FIXME: Once we remove the hardcoded slot name here,
137	* the name of this method could be updated, if necessary.
138	*
139	* Shortcut method to get page source
140	* @deprecated Use $this->topFrame->getSrcText()
141	* @return string
142	*/
143	public function getPageMainContent(): string {
144	return $this->getRevisionContent()->getContent( 'main' );
145	}
146
147	}