InstallDocFormatter::execute()   B
last analyzed

Complexity

Conditions 2
Paths 1

Size

Total Lines 40
Code Lines 25

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 25
nc 1
nop 0
dl 0
loc 40
rs 8.8571
c 0
b 0
f 0
1
<?php
2
/**
3
 * Installer-specific wikitext formatting.
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of the GNU General Public License as published by
7
 * the Free Software Foundation; either version 2 of the License, or
8
 * (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License along
16
 * with this program; if not, write to the Free Software Foundation, Inc.,
17
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
 * http://www.gnu.org/copyleft/gpl.html
19
 *
20
 * @file
21
 */
22
23
class InstallDocFormatter {
24
	static function format( $text ) {
25
		$obj = new self( $text );
26
27
		return $obj->execute();
28
	}
29
30
	protected function __construct( $text ) {
31
		$this->text = $text;
0 ignored issues
show
Bug introduced by
The property text does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
32
	}
33
34
	protected function execute() {
35
		$text = $this->text;
36
		// Use Unix line endings, escape some wikitext stuff
37
		$text = str_replace( [ '<', '{{', '[[', '__', "\r" ],
38
			[ '&lt;', '&#123;&#123;', '&#91;&#91;', '&#95;&#95;', '' ], $text );
39
		// join word-wrapped lines into one
40
		do {
41
			$prev = $text;
42
			$text = preg_replace( "/\n([\\*#\t])([^\n]*?)\n([^\n#\\*:]+)/", "\n\\1\\2 \\3", $text );
43
		} while ( $text != $prev );
44
		// Replace tab indents with colons
45
		$text = preg_replace( '/^\t\t/m', '::', $text );
46
		$text = preg_replace( '/^\t/m', ':', $text );
47
48
		$linkStart = '<span class="config-plainlink">[';
49
		$linkEnd = ' $0]</span>';
50
51
		// turn (Tnnnn) into links
52
		$text = preg_replace(
53
			'/T\d+/',
54
			"{$linkStart}https://phabricator.wikimedia.org/$0{$linkEnd}",
55
			$text
56
		);
57
58
		// turn (bug nnnn) into links
59
		$text = preg_replace(
60
			'/bug (\d+)/',
61
			"{$linkStart}https://bugzilla.wikimedia.org/$1{$linkEnd}",
62
			$text
63
		);
64
65
		// add links to manual to every global variable mentioned
66
		$text = preg_replace(
67
			'/\$wg[a-z0-9_]+/i',
68
			"{$linkStart}https://www.mediawiki.org/wiki/Manual:$0{$linkEnd}",
69
			$text
70
		);
71
72
		return $text;
73
	}
74
}
75