DBALQueryInterface::newQueryBuilderFor() - Code Metrics - wmde/WikibaseDatabase - Measure and Improve Code Quality continuously with Scrutinizer

DBALQueryInterface::newQueryBuilderFor() A
last analyzed 2019-09-20 09:57 UTC

↳ Parent: DBALQueryInterface

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0

<?php

namespace Wikibase\Database\Doctrine;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Query\QueryBuilder;
use Iterator;
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 Doctrine DBAL.
 *
 * @since 0.1
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class DBALQueryInterface implements QueryInterface {

	/**
	 * @var Connection
	 */
	private $connection;

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

	/**
	 * @see QueryInterface::tableExists
	 *
	 * @since 0.1
	 *
	 * @param string $tableName
	 *
	 * @return bool
	 */
	public function tableExists( $tableName ) {
		return $this->connection->getSchemaManager()->tablesExist( array( $tableName ) );
	}

	/**
	 * @see QueryInterface::insert
	 *
	 * @since 0.1
	 *
	 * @param string $tableName
	 * @param array $values
	 *
	 * @throws InsertFailedException
	 */
	public function insert( $tableName, array $values ) {
		try {
			$this->connection->insert( $tableName, $values );
		}
		catch ( DBALException $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 {
			$this->connection->update( $tableName, $values, $conditions );
		}
		catch ( DBALException $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 {
			$this->connection->delete( $tableName, $conditions );
		}
		catch ( DBALException $ex ) {
			throw new DeleteFailedException( $tableName, $conditions, $ex->getMessage(), $ex );
		}
	}

	/**
	 * @see QueryInterface::getInsertId
	 *
	 * @since 0.1
	 *
	 * @throws QueryInterfaceException
	 * @return int
	 */
	public function getInsertId() {
		try {
			return (int)$this->connection->lastInsertId();
		}
		catch ( DBALException $ex ) {
			throw new QueryInterfaceException( 'Could not obtain the last inserted ID', 0, $ex );
		}
	}

	/**
	 * @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() ) {
		$queryBuilder = $this->newQueryBuilderFor( $tableName, $fieldNames );
		$this->addConditionsToQueryBuilder( $queryBuilder, $conditions );

		// TODO: handle $options

		try {
			return $queryBuilder->execute();
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());
}
		}
		catch ( DBALException $ex ) {
			throw new SelectFailedException( $tableName, $fieldNames, $conditions, $ex->getMessage(), $ex );
		}
	}

	/**
	 * @param string $tableName
	 * @param array $fields
	 *
	 * @return QueryBuilder
	 */
	private function newQueryBuilderFor( $tableName, array $fields ) {
		$queryBuilder = new QueryBuilder( $this->connection );

		$queryBuilder
			->select( array_map(
				function( $columnName ) {
					return 't.' . $columnName;
				},
				$fields
			) )
			->from( $tableName, 't' );

		return $queryBuilder;
	}

	/**
	 * @param QueryBuilder $queryBuilder
	 * @param array $conditions
	 */
	private function addConditionsToQueryBuilder( QueryBuilder $queryBuilder, array $conditions ) {
		foreach ( $conditions as $columnName => $value ) {
			$queryBuilder->andWhere( 't.' . $columnName . ' = :' . $columnName );
			$queryBuilder->setParameter( ':' . $columnName, $value );
		}
	}

}


1			<?php
2
3			namespace Wikibase\Database\Doctrine;
4
5			use Doctrine\DBAL\Connection;
6			use Doctrine\DBAL\DBALException;
7			use Doctrine\DBAL\Query\QueryBuilder;
8			use Iterator;
9			use Wikibase\Database\Exception\DeleteFailedException;
10			use Wikibase\Database\Exception\InsertFailedException;
11			use Wikibase\Database\Exception\QueryInterfaceException;
12			use Wikibase\Database\Exception\SelectFailedException;
13			use Wikibase\Database\Exception\UpdateFailedException;
14			use Wikibase\Database\QueryInterface;
15
16			/**
17			* Implementation of the QueryInterface interface using Doctrine DBAL.
18			*
19			* @since 0.1
20			* @licence GNU GPL v2+
21			* @author Jeroen De Dauw < [email protected] >
22			*/
23			class DBALQueryInterface implements QueryInterface {
24
25			/**
26			* @var Connection
27			*/
28			private $connection;
29
30			/**
31			* @since 0.1
32			*
33			* @param Connection $connection
34			*/
35			public function __construct( Connection $connection ) {
36			$this->connection = $connection;
37			}
38
39			/**
40			* @see QueryInterface::tableExists
41			*
42			* @since 0.1
43			*
44			* @param string $tableName
45			*
46			* @return bool
47			*/
48			public function tableExists( $tableName ) {
49			return $this->connection->getSchemaManager()->tablesExist( array( $tableName ) );
50			}
51
52			/**
53			* @see QueryInterface::insert
54			*
55			* @since 0.1
56			*
57			* @param string $tableName
58			* @param array $values
59			*
60			* @throws InsertFailedException
61			*/
62			public function insert( $tableName, array $values ) {
63			try {
64			$this->connection->insert( $tableName, $values );
65			}
66			catch ( DBALException $ex ) {
67			throw new InsertFailedException( $tableName, $values, $ex->getMessage(), $ex );
68			}
69			}
70
71			/**
72			* @see QueryInterface::update
73			*
74			* @since 0.1
75			*
76			* @param string $tableName
77			* @param array $values
78			* @param array $conditions
79			*
80			* @throws UpdateFailedException
81			*/
82			public function update( $tableName, array $values, array $conditions ) {
83			try {
84			$this->connection->update( $tableName, $values, $conditions );
85			}
86			catch ( DBALException $ex ) {
87			throw new UpdateFailedException( $tableName, $values, $conditions, $ex->getMessage(), $ex );
88			}
89			}
90
91			/**
92			* @see QueryInterface::delete
93			*
94			* @since 0.1
95			*
96			* @param string $tableName
97			* @param array $conditions
98			*
99			* @throws DeleteFailedException
100			*/
101			public function delete( $tableName, array $conditions ) {
102			try {
103			$this->connection->delete( $tableName, $conditions );
104			}
105			catch ( DBALException $ex ) {
106			throw new DeleteFailedException( $tableName, $conditions, $ex->getMessage(), $ex );
107			}
108			}
109
110			/**
111			* @see QueryInterface::getInsertId
112			*
113			* @since 0.1
114			*
115			* @throws QueryInterfaceException
116			* @return int
117			*/
118			public function getInsertId() {
119			try {
120			return (int)$this->connection->lastInsertId();
121			}
122			catch ( DBALException $ex ) {
123			throw new QueryInterfaceException( 'Could not obtain the last inserted ID', 0, $ex );
124			}
125			}
126
127			/**
128			* @see QueryInterface::select
129			*
130			* @since 0.1
131			*
132			* @param string $tableName
133			* @param string[] $fieldNames
134			* @param array $conditions
135			* @param array $options
136			*
137			* @throws SelectFailedException
138			* @return Iterator
139			*/
140			public function select( $tableName, array $fieldNames, array $conditions, array $options = array() ) {
141			$queryBuilder = $this->newQueryBuilderFor( $tableName, $fieldNames );
142			$this->addConditionsToQueryBuilder( $queryBuilder, $conditions );
143
144			// TODO: handle $options
145
146			try {
147			return $queryBuilder->execute();
			0 ignored issues – show Bug Best Practice introduced 2019-09-20 09:57 UTC by Report Bug Copy Issue Report The return type of `return $queryBuilder->execute();` (`Doctrine\DBAL\Driver\ResultStatement\|integer`) 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...
148			}
149			catch ( DBALException $ex ) {
150			throw new SelectFailedException( $tableName, $fieldNames, $conditions, $ex->getMessage(), $ex );
151			}
152			}
153
154			/**
155			* @param string $tableName
156			* @param array $fields
157			*
158			* @return QueryBuilder
159			*/
160			private function newQueryBuilderFor( $tableName, array $fields ) {
161			$queryBuilder = new QueryBuilder( $this->connection );
162
163			$queryBuilder
164			->select( array_map(
165			function( $columnName ) {
166			return 't.' . $columnName;
167			},
168			$fields
169			) )
170			->from( $tableName, 't' );
171
172			return $queryBuilder;
173			}
174
175			/**
176			* @param QueryBuilder $queryBuilder
177			* @param array $conditions
178			*/
179			private function addConditionsToQueryBuilder( QueryBuilder $queryBuilder, array $conditions ) {
180			foreach ( $conditions as $columnName => $value ) {
181			$queryBuilder->andWhere( 't.' . $columnName . ' = :' . $columnName );
182			$queryBuilder->setParameter( ':' . $columnName, $value );
183			}
184			}
185
186			}
187

wmde / WikibaseDatabase

DBALQueryInterface::newQueryBuilderFor() A last analyzed 2019-09-20 09:57 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DBALQueryInterface::newQueryBuilderFor() A
last analyzed 2019-09-20 09:57 UTC