MWDocGen::init() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

MWDocGen::init() B
last analyzed 2016-11-13 17:42 UTC

↳ Parent: MWDocGen

Complexity

Conditions	3
Paths	4

Size

Total Lines	31
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	21
nc	4
nop	0
dl	0
loc	31
rs	8.8571
c	0
b	0
f	0

<?php

/**
 * Generate class and file reference documentation for MediaWiki using doxygen.
 *
 * If the dot DOT language processor is available, attempt call graph
 * generation.
 *
 * Usage:
 *   php mwdocgen.php
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @todo document
 * @ingroup Maintenance
 *
 * @author Antoine Musso <hashar at free dot fr>
 * @author Brion Vibber
 * @author Alexandre Emsenhuber
 * @version first release
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Maintenance script that builds doxygen documentation.
 * @ingroup Maintenance
 */
class MWDocGen extends Maintenance {

	/**
	 * Prepare Maintenance class
	 */
	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Build doxygen documentation' );

		$this->addOption( 'doxygen',
			'Path to doxygen',
			false, true );
		$this->addOption( 'version',
			'Pass a MediaWiki version',
			false, true );
		$this->addOption( 'generate-man',
			'Whether to generate man files' );
		$this->addOption( 'file',
			"Only process given file or directory. Multiple values " .
			"accepted with comma separation. Path relative to \$IP.",
			false, true );
		$this->addOption( 'output',
			'Path to write doc to',
			false, true );
		$this->addOption( 'no-extensions',
			'Ignore extensions' );
	}

	public function getDbType() {
		return Maintenance::DB_NONE;
	}

	protected function init() {
		global $IP;

		$this->doxygen = $this->getOption( 'doxygen', 'doxygen' );
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->mwVersion = $this->getOption( 'version', 'master' );
class MyClass { }

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

		$this->input = '';
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$inputs = explode( ',', $this->getOption( 'file', '' ) );
		foreach ( $inputs as $input ) {
			# Doxygen inputs are space separted and double quoted
			$this->input .= " \"$IP/$input\"";
		}

		$this->output = $this->getOption( 'output', "$IP/docs" );
class MyClass { }

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

		$this->inputFilter = wfShellWikiCmd( $IP . '/maintenance/mwdoc-filter.php' );
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->template = $IP . '/maintenance/Doxyfile';
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->excludes = [
class MyClass { }

$x = new MyClass();
$x->foo = true;
			'vendor',
			'node_modules',
			'images',
			'static',
		];
		$this->excludePatterns = [];
class MyClass { }

$x = new MyClass();
$x->foo = true;
		if ( $this->hasOption( 'no-extensions' ) ) {
			$this->excludePatterns[] = 'extensions';
		}

		$this->doDot = `which dot`;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->doMan = $this->hasOption( 'generate-man' );
class MyClass { }

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

	public function execute() {
		global $IP;

		$this->init();

		# Build out directories we want to exclude
		$exclude = '';
		foreach ( $this->excludes as $item ) {
			$exclude .= " $IP/$item";
		}

		$excludePatterns = implode( ' ', $this->excludePatterns );

		$conf = strtr( file_get_contents( $this->template ),
			[
				'{{OUTPUT_DIRECTORY}}' => $this->output,
				'{{STRIP_FROM_PATH}}' => $IP,
				'{{CURRENT_VERSION}}' => $this->mwVersion,
				'{{INPUT}}' => $this->input,
				'{{EXCLUDE}}' => $exclude,
				'{{EXCLUDE_PATTERNS}}' => $excludePatterns,
				'{{HAVE_DOT}}' => $this->doDot ? 'YES' : 'NO',
				'{{GENERATE_MAN}}' => $this->doMan ? 'YES' : 'NO',
				'{{INPUT_FILTER}}' => $this->inputFilter,
			]
		);

		$tmpFile = tempnam( wfTempDir(), 'MWDocGen-' );
		if ( file_put_contents( $tmpFile, $conf ) === false ) {
			$this->error( "Could not write doxygen configuration to file $tmpFile\n",
				/** exit code: */ 1 );
		}

		$command = $this->doxygen . ' ' . $tmpFile;
		$this->output( "Executing command:\n$command\n" );

		$exitcode = 1;
		system( $command, $exitcode );

		$this->output( <<<TEXT
---------------------------------------------------
Doxygen execution finished.
Check above for possible errors.

You might want to delete the temporary file:
 $tmpFile
---------------------------------------------------

TEXT
		);

		if ( $exitcode !== 0 ) {
			$this->error( "Something went wrong (exit: $exitcode)\n",
				$exitcode );
		}
	}
}

$maintClass = 'MWDocGen';
require_once RUN_MAINTENANCE_IF_MAIN;


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 42 and the first side effect is on line 36. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* Generate class and file reference documentation for MediaWiki using doxygen.
4			*
5			* If the dot DOT language processor is available, attempt call graph
6			* generation.
7			*
8			* Usage:
9			* php mwdocgen.php
10			*
11			* This program is free software; you can redistribute it and/or modify
12			* it under the terms of the GNU General Public License as published by
13			* the Free Software Foundation; either version 2 of the License, or
14			* (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU General Public License along
22			* with this program; if not, write to the Free Software Foundation, Inc.,
23			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24			* http://www.gnu.org/copyleft/gpl.html
25			*
26			* @file
27			* @todo document
28			* @ingroup Maintenance
29			*
30			* @author Antoine Musso <hashar at free dot fr>
31			* @author Brion Vibber
32			* @author Alexandre Emsenhuber
33			* @version first release
34			*/
35
36			require_once __DIR__ . '/Maintenance.php';
37
38			/**
39			* Maintenance script that builds doxygen documentation.
40			* @ingroup Maintenance
41			*/
42			class MWDocGen extends Maintenance {
43
44			/**
45			* Prepare Maintenance class
46			*/
47			public function __construct() {
48			parent::__construct();
49			$this->addDescription( 'Build doxygen documentation' );
50
51			$this->addOption( 'doxygen',
52			'Path to doxygen',
53			false, true );
54			$this->addOption( 'version',
55			'Pass a MediaWiki version',
56			false, true );
57			$this->addOption( 'generate-man',
58			'Whether to generate man files' );
59			$this->addOption( 'file',
60			"Only process given file or directory. Multiple values " .
61			"accepted with comma separation. Path relative to \$IP.",
62			false, true );
63			$this->addOption( 'output',
64			'Path to write doc to',
65			false, true );
66			$this->addOption( 'no-extensions',
67			'Ignore extensions' );
68			}
69
70			public function getDbType() {
71			return Maintenance::DB_NONE;
72			}
73
74			protected function init() {
75			global $IP;
76
77			$this->doxygen = $this->getOption( 'doxygen', 'doxygen' );
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `doxygen` 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...
78			$this->mwVersion = $this->getOption( 'version', 'master' );
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `mwVersion` 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...
79
80			$this->input = '';
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `input` 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...
81			$inputs = explode( ',', $this->getOption( 'file', '' ) );
82			foreach ( $inputs as $input ) {
83			# Doxygen inputs are space separted and double quoted
84			$this->input .= " \"$IP/$input\"";
85			}
86
87			$this->output = $this->getOption( 'output', "$IP/docs" );
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `output` 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...
88
89			$this->inputFilter = wfShellWikiCmd( $IP . '/maintenance/mwdoc-filter.php' );
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `inputFilter` 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...
90			$this->template = $IP . '/maintenance/Doxyfile';
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `template` 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...
91			$this->excludes = [
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `excludes` 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...
92			'vendor',
93			'node_modules',
94			'images',
95			'static',
96			];
97			$this->excludePatterns = [];
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `excludePatterns` 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...
98			if ( $this->hasOption( 'no-extensions' ) ) {
99			$this->excludePatterns[] = 'extensions';
100			}
101
102			$this->doDot = `which dot`;
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `doDot` 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...
103			$this->doMan = $this->hasOption( 'generate-man' );
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `doMan` 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...
104			}
105
106			public function execute() {
107			global $IP;
108
109			$this->init();
110
111			# Build out directories we want to exclude
112			$exclude = '';
113			foreach ( $this->excludes as $item ) {
114			$exclude .= " $IP/$item";
115			}
116
117			$excludePatterns = implode( ' ', $this->excludePatterns );
118
119			$conf = strtr( file_get_contents( $this->template ),
120			[
121			'{{OUTPUT_DIRECTORY}}' => $this->output,
122			'{{STRIP_FROM_PATH}}' => $IP,
123			'{{CURRENT_VERSION}}' => $this->mwVersion,
124			'{{INPUT}}' => $this->input,
125			'{{EXCLUDE}}' => $exclude,
126			'{{EXCLUDE_PATTERNS}}' => $excludePatterns,
127			'{{HAVE_DOT}}' => $this->doDot ? 'YES' : 'NO',
128			'{{GENERATE_MAN}}' => $this->doMan ? 'YES' : 'NO',
129			'{{INPUT_FILTER}}' => $this->inputFilter,
130			]
131			);
132
133			$tmpFile = tempnam( wfTempDir(), 'MWDocGen-' );
134			if ( file_put_contents( $tmpFile, $conf ) === false ) {
135			$this->error( "Could not write doxygen configuration to file $tmpFile\n",
136			/** exit code: */ 1 );
137			}
138
139			$command = $this->doxygen . ' ' . $tmpFile;
140			$this->output( "Executing command:\n$command\n" );
141
142			$exitcode = 1;
143			system( $command, $exitcode );
144
145			$this->output( <<<TEXT
146			---------------------------------------------------
147			Doxygen execution finished.
148			Check above for possible errors.
149
150			You might want to delete the temporary file:
151			$tmpFile
152			---------------------------------------------------
153
154			TEXT
155			);
156
157			if ( $exitcode !== 0 ) {
158			$this->error( "Something went wrong (exit: $exitcode)\n",
159			$exitcode );
160			}
161			}
162			}
163
164			$maintClass = 'MWDocGen';
165			require_once RUN_MAINTENANCE_IF_MAIN;
166

wikimedia / mediawiki

MWDocGen::init() B last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MWDocGen::init() B
last analyzed 2016-11-13 17:42 UTC