MediaWikiQueryInterface - Code Metrics - wmde/WikibaseDatabase - Measure and Improve Code Quality continuously with Scrutinizer

MediaWikiQueryInterface A
last analyzed 2019-09-20 09:57 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
dl	0
loc	152
rs	10
c	0
b	0
f	0
wmc	16
lcom	1
cbo	6

8 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
A	getDB()	3	1
A	tableExists()	3	1
A	insert()	11	3
A	update()	11	3
A	delete()	11	3
A	getInsertId()	9	2
A	select()	16	2

<?php

namespace Wikibase\Database\MediaWiki;

use DatabaseBase;
use Iterator;
use MWException;
use Wikibase\Database\Exception\DeleteFailedException;
use Wikibase\Database\Exception\InsertFailedException;
use Wikibase\Database\Exception\QueryInterfaceException;
use Wikibase\Database\Exception\SelectFailedException;
use Wikibase\Database\Exception\UpdateFailedException;
use Wikibase\Database\QueryInterface;

/**
 * Implementation of the QueryInterface interface using the MediaWiki
 * database abstraction layer where possible.
 *
 * @since 0.1
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 * @author Thiemo Kreuz
 */
class MediaWikiQueryInterface implements QueryInterface {

	/**
	 * @var DBConnectionProvider
	 */
	private $connectionProvider;

	/**
	 * @since 0.1
	 *
	 * @param DBConnectionProvider $connectionProvider
	 */
	public function __construct( DBConnectionProvider $connectionProvider ) {
		$this->connectionProvider = $connectionProvider;
	}

	/**
	 * @return DatabaseBase
	 */
	private function getDB() {
		return $this->connectionProvider->getConnection();
	}

	/**
	 * @see QueryInterface::tableExists
	 *
	 * @since 0.1
	 *
	 * @param string $tableName
	 *
	 * @return bool
	 */
	public function tableExists( $tableName ) {
		return $this->getDB()->tableExists( $tableName, __METHOD__ );
	}

	/**
	 * @see QueryInterface::insert
	 *
	 * @since 0.1
	 *
	 * @param string $tableName
	 * @param array $values
	 *
	 * @throws InsertFailedException
	 */
	public function insert( $tableName, array $values ) {
		try {
			$result = $this->getDB()->insert( $tableName, $values, __METHOD__ );

			if ( $result === false ) {
				throw new InsertFailedException( $tableName, $values );
			}
		} catch ( MWException $ex ) {

			throw new InsertFailedException( $tableName, $values, $ex->getMessage(), $ex );
		}
	}

	/**
	 * @see QueryInterface::update
	 *
	 * @since 0.1
	 *
	 * @param string $tableName
	 * @param array $values
	 * @param array $conditions
	 *
	 * @throws UpdateFailedException
	 */
	public function update( $tableName, array $values, array $conditions ) {
		try {
			$result = $this->getDB()->update( $tableName, $values, $conditions, __METHOD__ );

			if ( $result === false ) {
				throw new UpdateFailedException( $tableName, $values, $conditions );
			}
		} catch ( MWException $ex ) {

			throw new UpdateFailedException( $tableName, $values, $conditions, $ex->getMessage(), $ex );
		}
	}

	/**
	 * @see QueryInterface::delete
	 *
	 * @since 0.1
	 *
	 * @param string $tableName
	 * @param array $conditions
	 *
	 * @throws DeleteFailedException
	 */
	public function delete( $tableName, array $conditions ) {
		try {
			$result = $this->getDB()->delete( $tableName, $conditions, __METHOD__ );

			if ( $result === false ) {
				throw new DeleteFailedException( $tableName, $conditions );
			}
		} catch ( MWException $ex ) {

			throw new DeleteFailedException( $tableName, $conditions, $ex->getMessage(), $ex );
		}
	}

	/**
	 * @see QueryInterface::getInsertId
	 *
	 * @since 0.1
	 *
	 * @throws QueryInterfaceException
	 * @return int
	 */
	public function getInsertId() {
		$databaseBase = $this->getDB();

		if ( !method_exists( $databaseBase, 'insertId' ) ) {
			throw new QueryInterfaceException( 'Connection does not support obtain the last inserted ID' );
		}

		return (int)$databaseBase->insertId();
	}

	/**
	 * @see QueryInterface::select
	 *
	 * @since 0.1
	 *
	 * @param string $tableName
	 * @param string[] $fieldNames
	 * @param array $conditions
	 * @param array $options
	 *
	 * @throws SelectFailedException
	 * @return Iterator
	 */
	public function select( $tableName, array $fieldNames, array $conditions, array $options = array() ) {
		$selectionResult = $this->getDB()->select(
			$tableName,
			$fieldNames,
			$conditions,
			__METHOD__,
			$options
		);

		if ( $selectionResult instanceof \ResultWrapper ) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			// TODO: change to return arrays instead of objects
			return $selectionResult;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
		}

		throw new SelectFailedException( $tableName, $fieldNames, $conditions );
	}

}


1			<?php
2
3			namespace Wikibase\Database\MediaWiki;
4
5			use DatabaseBase;
6			use Iterator;
7			use MWException;
8			use Wikibase\Database\Exception\DeleteFailedException;
9			use Wikibase\Database\Exception\InsertFailedException;
10			use Wikibase\Database\Exception\QueryInterfaceException;
11			use Wikibase\Database\Exception\SelectFailedException;
12			use Wikibase\Database\Exception\UpdateFailedException;
13			use Wikibase\Database\QueryInterface;
14
15			/**
16			* Implementation of the QueryInterface interface using the MediaWiki
17			* database abstraction layer where possible.
18			*
19			* @since 0.1
20			* @licence GNU GPL v2+
21			* @author Jeroen De Dauw < [email protected] >
22			* @author Thiemo Kreuz
23			*/
24			class MediaWikiQueryInterface implements QueryInterface {
25
26			/**
27			* @var DBConnectionProvider
28			*/
29			private $connectionProvider;
30
31			/**
32			* @since 0.1
33			*
34			* @param DBConnectionProvider $connectionProvider
35			*/
36			public function __construct( DBConnectionProvider $connectionProvider ) {
37			$this->connectionProvider = $connectionProvider;
38			}
39
40			/**
41			* @return DatabaseBase
42			*/
43			private function getDB() {
44			return $this->connectionProvider->getConnection();
45			}
46
47			/**
48			* @see QueryInterface::tableExists
49			*
50			* @since 0.1
51			*
52			* @param string $tableName
53			*
54			* @return bool
55			*/
56			public function tableExists( $tableName ) {
57			return $this->getDB()->tableExists( $tableName, __METHOD__ );
58			}
59
60			/**
61			* @see QueryInterface::insert
62			*
63			* @since 0.1
64			*
65			* @param string $tableName
66			* @param array $values
67			*
68			* @throws InsertFailedException
69			*/
70			public function insert( $tableName, array $values ) {
71			try {
72			$result = $this->getDB()->insert( $tableName, $values, __METHOD__ );
73
74			if ( $result === false ) {
75			throw new InsertFailedException( $tableName, $values );
76			}
77			} catch ( MWException $ex ) {
			0 ignored issues – show Bug introduced 2018-05-10 18:42 UTC by Report Bug Copy Issue Report The class `MWException` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
78			throw new InsertFailedException( $tableName, $values, $ex->getMessage(), $ex );
79			}
80			}
81
82			/**
83			* @see QueryInterface::update
84			*
85			* @since 0.1
86			*
87			* @param string $tableName
88			* @param array $values
89			* @param array $conditions
90			*
91			* @throws UpdateFailedException
92			*/
93			public function update( $tableName, array $values, array $conditions ) {
94			try {
95			$result = $this->getDB()->update( $tableName, $values, $conditions, __METHOD__ );
96
97			if ( $result === false ) {
98			throw new UpdateFailedException( $tableName, $values, $conditions );
99			}
100			} catch ( MWException $ex ) {
			0 ignored issues – show Bug introduced 2018-05-10 18:42 UTC by Report Bug Copy Issue Report The class `MWException` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
101			throw new UpdateFailedException( $tableName, $values, $conditions, $ex->getMessage(), $ex );
102			}
103			}
104
105			/**
106			* @see QueryInterface::delete
107			*
108			* @since 0.1
109			*
110			* @param string $tableName
111			* @param array $conditions
112			*
113			* @throws DeleteFailedException
114			*/
115			public function delete( $tableName, array $conditions ) {
116			try {
117			$result = $this->getDB()->delete( $tableName, $conditions, __METHOD__ );
118
119			if ( $result === false ) {
120			throw new DeleteFailedException( $tableName, $conditions );
121			}
122			} catch ( MWException $ex ) {
			0 ignored issues – show Bug introduced 2018-05-10 18:42 UTC by Report Bug Copy Issue Report The class `MWException` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
123			throw new DeleteFailedException( $tableName, $conditions, $ex->getMessage(), $ex );
124			}
125			}
126
127			/**
128			* @see QueryInterface::getInsertId
129			*
130			* @since 0.1
131			*
132			* @throws QueryInterfaceException
133			* @return int
134			*/
135			public function getInsertId() {
136			$databaseBase = $this->getDB();
137
138			if ( !method_exists( $databaseBase, 'insertId' ) ) {
139			throw new QueryInterfaceException( 'Connection does not support obtain the last inserted ID' );
140			}
141
142			return (int)$databaseBase->insertId();
143			}
144
145			/**
146			* @see QueryInterface::select
147			*
148			* @since 0.1
149			*
150			* @param string $tableName
151			* @param string[] $fieldNames
152			* @param array $conditions
153			* @param array $options
154			*
155			* @throws SelectFailedException
156			* @return Iterator
157			*/
158			public function select( $tableName, array $fieldNames, array $conditions, array $options = array() ) {
159			$selectionResult = $this->getDB()->select(
160			$tableName,
161			$fieldNames,
162			$conditions,
163			__METHOD__,
164			$options
165			);
166
167			if ( $selectionResult instanceof \ResultWrapper ) {
			0 ignored issues – show Bug introduced 2018-05-10 18:42 UTC by Report Bug Copy Issue Report The class `ResultWrapper` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
168			// TODO: change to return arrays instead of objects
169			return $selectionResult;
			0 ignored issues – show Bug Best Practice introduced 2018-05-10 18:42 UTC by Report Bug Copy Issue Report The return type of `return $selectionResult;` (`ResultWrapper`) is incompatible with the return type declared by the interface `Wikibase\Database\QueryInterface::select` of type `Iterator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
170			}
171
172			throw new SelectFailedException( $tableName, $fieldNames, $conditions );
173			}
174
175			}
176

wmde / WikibaseDatabase

MediaWikiQueryInterface A last analyzed 2019-09-20 09:57 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

MediaWikiQueryInterface A
last analyzed 2019-09-20 09:57 UTC