File: RemexMungerData.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (128 lines) | stat: -rw-r--r-- 3,221 bytes parent folder | download
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
<?php

namespace MediaWiki\Tidy;

use InvalidArgumentException;
use Wikimedia\RemexHtml\Serializer\SerializerNode;
use Wikimedia\RemexHtml\TreeBuilder\Element;

/**
 * @internal
 */
class RemexMungerData {
	/**
	 * The Element for the mw:p-wrap which is a child of the current node. If
	 * this is set, inline insertions into this node will be diverted so that
	 * they insert into the p-wrap.
	 *
	 * @var Element|null
	 */
	public $childPElement;

	/**
	 * This tracks the mw:p-wrap node in the Serializer stack which is an
	 * ancestor of this node. If there is no mw:p-wrap ancestor, it is null.
	 *
	 * @var SerializerNode|null
	 */
	public $ancestorPNode;

	/**
	 * The wrap base node is the body or blockquote node which is the parent
	 * of active p-wrappers. This is set if there is an ancestor p-wrapper,
	 * or if a p-wrapper was closed due to a block element being encountered
	 * inside it.
	 *
	 * @var SerializerNode|null
	 */
	public $wrapBaseNode;

	/**
	 * Stack splitting (essentially our idea of AFE reconstruction) can clone
	 * formatting elements which are split over multiple paragraphs.
	 * TreeBuilder is not aware of the cloning, and continues to insert into
	 * the original element. This is set to the newer clone if this node was
	 * cloned, i.e. if there is an active diversion of the insertion location.
	 *
	 * @var Element|null
	 */
	public $currentCloneElement;

	/**
	 * Is the node a p-wrapper, with name mw:p-wrap?
	 *
	 * @var bool
	 */
	public $isPWrapper = false;

	/**
	 * Is the node splittable, i.e. a formatting element or a node with a
	 * formatting element ancestor which is under an active or deactivated
	 * p-wrapper.
	 *
	 * @var bool
	 */
	public $isSplittable = false;

	/**
	 * This is true if the node is a body or blockquote, which activates
	 * p-wrapping of child nodes.
	 *
	 * @var bool
	 */
	public $needsPWrapping = false;

	/**
	 * The number of child nodes, not counting whitespace-only text nodes or
	 * comments.
	 *
	 * @var int
	 */
	public $nonblankNodeCount = 0;

	public function __set( $name, $value ) {
		// @phan-suppress-previous-line PhanPluginNeverReturnMethod
		throw new InvalidArgumentException( "Cannot set property \"$name\"" );
	}

	/**
	 * Get a text representation of the current state of the serializer, for
	 * debugging.
	 *
	 * @return string
	 */
	public function dump() {
		$parts = [];

		if ( $this->childPElement ) {
			$parts[] = 'childPElement=' . $this->childPElement->getDebugTag();
		}
		if ( $this->ancestorPNode ) {
			$parts[] = "ancestorPNode=<{$this->ancestorPNode->name}>";
		}
		if ( $this->wrapBaseNode ) {
			$parts[] = "wrapBaseNode=<{$this->wrapBaseNode->name}>";
		}
		if ( $this->currentCloneElement ) {
			$parts[] = "currentCloneElement=" . $this->currentCloneElement->getDebugTag();
		}
		if ( $this->isPWrapper ) {
			$parts[] = 'isPWrapper';
		}
		if ( $this->isSplittable ) {
			$parts[] = 'isSplittable';
		}
		if ( $this->needsPWrapping ) {
			$parts[] = 'needsPWrapping';
		}
		if ( $this->nonblankNodeCount ) {
			$parts[] = "nonblankNodeCount={$this->nonblankNodeCount}";
		}
		$s = "RemexMungerData {\n";
		foreach ( $parts as $part ) {
			$s .= "  $part\n";
		}
		$s .= "}\n";
		return $s;
	}
}