aboutsummaryrefslogtreecommitdiffstats
path: root/includes/CommentFormatter/CommentItem.php
blob: c45fff34a6d9b0a2aef4bf6ebbdb7bd25dc9d819 (plain) (blame)
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
<?php

namespace MediaWiki\CommentFormatter;

use MediaWiki\Linker\LinkTarget;

/**
 * An object to represent one of the inputs to a batch formatting operation.
 *
 * @since 1.38
 * @newable
 */
class CommentItem {
	/**
	 * @var string
	 * @internal
	 */
	public $comment;

	/**
	 * @var LinkTarget|null
	 * @internal
	 */
	public $selfLinkTarget;

	/**
	 * @var bool|null
	 * @internal
	 */
	public $samePage;

	/**
	 * @var string|false|null
	 * @internal
	 */
	public $wikiId;

	/**
	 * @param string $comment The comment to format
	 */
	public function __construct( string $comment ) {
		$this->comment = $comment;
	}

	/**
	 * Set the self-link target.
	 *
	 * @param LinkTarget $selfLinkTarget The title used for fragment-only
	 *   and section links, formerly $title.
	 * @return $this
	 */
	public function selfLinkTarget( LinkTarget $selfLinkTarget ) {
		$this->selfLinkTarget = $selfLinkTarget;
		return $this;
	}

	/**
	 * Set the same-page flag.
	 *
	 * @param bool $samePage If true, self links are rendered with a fragment-
	 *   only URL. Formerly $local.
	 * @return $this
	 */
	public function samePage( $samePage = true ) {
		$this->samePage = $samePage;
		return $this;
	}

	/**
	 * ID of the wiki to link to (if not the local wiki), as used by WikiMap.
	 * This is used to render comments which are loaded from a foreign wiki.
	 * This only affects links which are syntactically internal -- it has no
	 * effect on interwiki links.
	 *
	 * @param string|false|null $wikiId
	 * @return $this
	 */
	public function wikiId( $wikiId ) {
		$this->wikiId = $wikiId;
		return $this;
	}
}