EditInfo::__construct() - Code Metrics - Inspection of "Include maxlag parameter" - addwiki/mediawiki-datamodel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

unknown

created 2018-07-16 16:26 UTC

EditInfo::__construct() B

↳ Parent: EditInfo

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	6.0702

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	14
cts	16
cp	0.875
rs	8.9617
c	0
b	0
f	0
cc	6
nc	6
nop	4
crap	6.0702

<?php

namespace Mediawiki\DataModel;

use InvalidArgumentException;

/**
 * Represents flags that can be used when edits are made
 * @author Addshore
 */
class EditInfo {

	//minor flags
	const MINOR = true;
	const NOTMINOR = false;
	//bot flags
	const BOT = true;
	const NOTBOT = false;
	//maxlag flags
	const OFFLAG = 0;

	/**
	 * @var EditInfo::MINOR|self::NOTMINOR
	 */
	protected $minor = false;

	/**
	 * @var EditInfo::BOT|self::NOTBOT
	 */
	protected $bot = false;
	
	/**
	 * @var integer
	 */
	protected $maxlag = 0;

	/**
	 * @var string
	 */
	protected $summary = null;

	/**
	 * @param string $summary
	 * @param bool $minor
	 * @param bool $bot
	 * @param int $maxlag
	 *
	 * @throws InvalidArgumentException
	 */
	public function __construct( $summary = '', $minor = self::NOTMINOR, $bot = self::NOTBOT, $maxlag = self::OFFLAG ) {
		if( !is_string( $summary ) ) {
			throw new InvalidArgumentException( '$summary must be a string' );
		}
		if( !is_bool( $minor ) ) {
			throw new InvalidArgumentException( '$minor must be a bool' );
		}
		if( !is_bool( $bot ) ) {
			throw new InvalidArgumentException( '$bot must be a bool' );
		}
		if( !is_int( $maxlag ) ) {
			throw new InvalidArgumentException( '$maxlag must be an integer' );	
		} 
		elseif( $maxlag < 0 ) {
			throw new InvalidArgumentException( '$maxlag must have a positive value' );
		}
		$this->summary = $summary;
		$this->bot = $bot;
		$this->minor = $minor;
		$this->maxlag = $maxlag;
	}

	/**
	 * @return EditInfo::BOT|self::NOTBOT

	 */
	public function getBot() {
		return $this->bot;
	}

	/**
	 * @return EditInfo::MINOR|self::NOTMINOR

	 */
	public function getMinor() {
		return $this->minor;
	}
	
	/**
	 * @return integer
	 */
	public function getMaxlag() {
		return $this->maxlag;
	}

	/**
	 * @return string
	 */
	public function getSummary() {
		return $this->summary;
	}

}


1		<?php
2
3		namespace Mediawiki\DataModel;
4
5		use InvalidArgumentException;
6
7		/**
8		* Represents flags that can be used when edits are made
9		* @author Addshore
10		*/
11		class EditInfo {
12
13		//minor flags
14		const MINOR = true;
15		const NOTMINOR = false;
16		//bot flags
17		const BOT = true;
18		const NOTBOT = false;
19		//maxlag flags
20		const OFFLAG = 0;
21
22		/**
23		* @var EditInfo::MINOR\|self::NOTMINOR
24		*/
25		protected $minor = false;
26
27		/**
28		* @var EditInfo::BOT\|self::NOTBOT
29		*/
30		protected $bot = false;
31
32		/**
33		* @var integer
34		*/
35		protected $maxlag = 0;
36
37		/**
38		* @var string
39		*/
40		protected $summary = null;
41
42		/**
43		* @param string $summary
44		* @param bool $minor
45		* @param bool $bot
46		* @param int $maxlag
47		*
48		* @throws InvalidArgumentException
49		*/
50	9	public function __construct( $summary = '', $minor = self::NOTMINOR, $bot = self::NOTBOT, $maxlag = self::OFFLAG ) {
51	9	if( !is_string( $summary ) ) {
52	2	throw new InvalidArgumentException( '$summary must be a string' );
53		}
54	7	if( !is_bool( $minor ) ) {
55	1	throw new InvalidArgumentException( '$minor must be a bool' );
56		}
57	6	if( !is_bool( $bot ) ) {
58	1	throw new InvalidArgumentException( '$bot must be a bool' );
59		}
60	5	if( !is_int( $maxlag ) ) {
61		throw new InvalidArgumentException( '$maxlag must be an integer' );
62		}
63	5	elseif( $maxlag < 0 ) {
64		throw new InvalidArgumentException( '$maxlag must have a positive value' );
65		}
66	5	$this->summary = $summary;
67	5	$this->bot = $bot;
68	5	$this->minor = $minor;
69	5	$this->maxlag = $maxlag;
70	5	}
71
72		/**
73		* @return EditInfo::BOT\|self::NOTBOT
		0 ignored issues – show Documentation introduced 2016-01-27 10:44 UTC by Report Bug Copy Issue Report The doc-type `EditInfo::BOT\|self::NOTBOT` could not be parsed: Unknown type name "EditInfo::BOT" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
74		*/
75	5	public function getBot() {
76	5	return $this->bot;
77		}
78
79		/**
80		* @return EditInfo::MINOR\|self::NOTMINOR
		0 ignored issues – show Documentation introduced 2016-01-27 10:44 UTC by Report Bug Copy Issue Report The doc-type `EditInfo::MINOR\|self::NOTMINOR` could not be parsed: Unknown type name "EditInfo::MINOR" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
81		*/
82	5	public function getMinor() {
83	5	return $this->minor;
84		}
85
86		/**
87		* @return integer
88		*/
89		public function getMaxlag() {
90		return $this->maxlag;
91		}
92
93		/**
94		* @return string
95		*/
96	5	public function getSummary() {
97	5	return $this->summary;
98		}
99
100		}
101

addwiki / mediawiki-datamodel

Pull Request — master (#7)

EditInfo::__construct() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like