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

SearchEngineFactory::create() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: SearchEngineFactory

Complexity

Conditions	4
Paths	3

Size

Total Lines	18
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	13
nc	3
nop	1
dl	0
loc	18
rs	9.2
c	0
b	0
f	0

<?php

/**
 * Factory class for SearchEngine.
 * Allows to create engine of the specific type.
 */
class SearchEngineFactory {
	/**
	 * Configuration for SearchEngine classes.
	 * @var SearchEngineConfig
	 */
	private $config;

	public function __construct( SearchEngineConfig $config ) {
		$this->config = $config;
	}

	/**
	 * Create SearchEngine of the given type.
	 * @param string $type
	 * @return SearchEngine
	 */
	public function create( $type = null ) {
		$dbr = null;

		$configType = $this->config->getSearchType();
		$alternatives = $this->config->getSearchTypes();

		if ( $type && in_array( $type, $alternatives ) ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$class = $type;
		} elseif ( $configType !== null ) {
			$class = $configType;
		} else {
			$dbr = wfGetDB( DB_REPLICA );
			$class = self::getSearchEngineClass( $dbr );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		}

		$search = new $class( $dbr );
		return $search;
	}

	/**
	 * @param IDatabase $db
	 * @return string SearchEngine subclass name
	 * @since 1.28
	 */
	public static function getSearchEngineClass( IDatabase $db ) {
		switch ( $db->getType() ) {
			case 'sqlite':
				return 'SearchSqlite';
			case 'mysql':
				return 'SearchMySQL';
			case 'postgres':
				return 'SearchPostgres';
			case 'mssql':
				return 'SearchMssql';
			case 'oracle':
				return 'SearchOracle';
			default:
				return 'SearchEngineDummy';
		}
	}
}


1			<?php
2
3			/**
4			* Factory class for SearchEngine.
5			* Allows to create engine of the specific type.
6			*/
7			class SearchEngineFactory {
8			/**
9			* Configuration for SearchEngine classes.
10			* @var SearchEngineConfig
11			*/
12			private $config;
13
14			public function __construct( SearchEngineConfig $config ) {
15			$this->config = $config;
16			}
17
18			/**
19			* Create SearchEngine of the given type.
20			* @param string $type
21			* @return SearchEngine
22			*/
23			public function create( $type = null ) {
24			$dbr = null;
25
26			$configType = $this->config->getSearchType();
27			$alternatives = $this->config->getSearchTypes();
28
29			if ( $type && in_array( $type, $alternatives ) ) {
			0 ignored issues – show Bug Best Practice introduced 2016-04-27 17:46 UTC by Report Bug Copy Issue Report The expression `$type` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
30			$class = $type;
31			} elseif ( $configType !== null ) {
32			$class = $configType;
33			} else {
34			$dbr = wfGetDB( DB_REPLICA );
35			$class = self::getSearchEngineClass( $dbr );
			0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `$dbr` defined by `wfGetDB(DB_REPLICA)` on line `34` can be `null`; however, `SearchEngineFactory::getSearchEngineClass()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
36			}
37
38			$search = new $class( $dbr );
39			return $search;
40			}
41
42			/**
43			* @param IDatabase $db
44			* @return string SearchEngine subclass name
45			* @since 1.28
46			*/
47			public static function getSearchEngineClass( IDatabase $db ) {
48			switch ( $db->getType() ) {
49			case 'sqlite':
50			return 'SearchSqlite';
51			case 'mysql':
52			return 'SearchMySQL';
53			case 'postgres':
54			return 'SearchPostgres';
55			case 'mssql':
56			return 'SearchMssql';
57			case 'oracle':
58			return 'SearchOracle';
59			default:
60			return 'SearchEngineDummy';
61			}
62			}
63			}
64

wikimedia / mediawiki

SearchEngineFactory::create() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SearchEngineFactory::create() A
last analyzed 2016-11-13 17:42 UTC