DatabaseLogReader::clearCache() - Code Metrics - SemanticMediaWiki/SemanticApprovedRevs - Measure and Improve Code Quality continuously with Scrutinizer

DatabaseLogReader::clearCache() A
last analyzed 2021-11-13 12:01 UTC

↳ Parent: DatabaseLogReader

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	2
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

namespace SMW\ApprovedRevs;

use ArrayIterator;
use DatabaseLogEntry;
filter:
    dependency_paths: ["lib/*"]
use MWTimestamp;
filter:
    dependency_paths: ["lib/*"]
use Title;
filter:
    dependency_paths: ["lib/*"]
use User;
filter:
    dependency_paths: ["lib/*"]
use Wikimedia\Rdbms\IDatabase;
filter:
    dependency_paths: ["lib/*"]

class DatabaseLogReader {

	/**
	 * @var array
	 */
	private static $titleCache = [];

	/**
	 * @var DatabaseBase
filter:
    dependency_paths: ["lib/*"]
	 */
	private $dbr;

	/**
	 * @var string
	 */
	private $query;

	/**
	 * @var string
	 */
	private $log;

	/**
	 * @var string
	 */
	private $dbKey;

	/**
	 * @var string
	 */
	private $type;

	/**
	 * @since 1.0
	 *
	 * @param DatabaseaBase $dbr injected connection
filter:
    dependency_paths: ["lib/*"]
	 * @param Title|null $title
	 * @param string $type of log (default: approval)
	 */
	public function __construct( IDatabase $dbr, Title $title = null , $type = 'approval' ) {
		$this->dbr = $dbr;
		$this->dbKey = $title instanceof Title ? $title->getDBkey() : null;
		$this->type = $type;
	}

	/**
	 * @since 1.0
	 */
	public function clearCache() {
		self::$titleCache = [];
	}

	/**
	 * Fetch the query parameters for later calls
	 *
	 * @since 1.0
	 *
	 * @return array of parameters for SELECT call
	 */
	public function getQuery() {
		return $this->query;

	}

	/**
	 * @since 1.0
	 *
	 * @param Title|null $title
	 * @param string $type
	 *
	 * @return User
	 */
	public function getUserForLogEntry( Title $title = null, $type = 'approval' ) {

		$this->init( $title, $type );
		$logLine = $this->getLog()->current();

		if ( $logLine && $logLine->user_id ) {
			return User::newFromID( $logLine->user_id );
		}
	}

	/**
	 * @since 1.0
	 *
	 * @param Title|null $title
	 * @param string $type
	 *
	 * @return Timestamp
filter:
    dependency_paths: ["lib/*"]
	 */
	public function getDateOfLogEntry( Title $title = null, $type = 'approval' ) {

		$this->init( $title, $type );
		$logLine = $this->getLog()->current();

		if ( $logLine && $logLine->log_timestamp ) {
			return new MWTimestamp( $logLine->log_timestamp );
		}
	}

	/**
	 * @since 1.0
	 *
	 * @param Title|null $title
	 * @param string $type
	 *
	 * @return string
	 */
	public function getStatusOfLogEntry( Title $title = null, $type = 'approval' ) {

		$this->init( $title, $type );
		$logLine = $this->getLog()->current();

		if ( $logLine && $logLine->log_action ) {
			return $logLine->log_action;
		}
	}

	/**
	 * Take care of loading from the cache or filling the query.
	 */
	private function init( $title, $type ) {

		$this->dbKey = $title instanceof Title ? $title->getDBkey() : null;
		$this->type = $type;

		if ( $this->query ) {
			return;
		}

		if ( !isset( self::$titleCache[ $this->dbKey . '#' . $this->type ] ) ) {
			$this->query = DatabaseLogEntry::getSelectQueryData();

			$this->query['conds'] = [
				'log_type' => $this->type,
				'log_title' => $this->dbKey
			];
			$this->query['options'] = [ 'ORDER BY' => 'log_timestamp desc' ];
			self::$titleCache[ $this->dbKey ] = $this;
		} else {
			$cache = self::$titleCache[ $this->dbKey . '#' . $this->type ];
			$this->query = $cache->getQuery();
			$this->log = $cache->getLog();
		}

	}

	/**
	 * Fetch the results using our conditions
	 *
	 * @return IResultWrapper
filter:
    dependency_paths: ["lib/*"]
	 * @throws DBError
	 */
	private function getLog() {

		if ( $this->log !== null ) {
			return $this->log;

		}

		$query = $this->getQuery();

		$this->log = $this->dbr->select(
			$query['tables'],
			$query['fields'],
			$query['conds'],
			__METHOD__,
			$query['options'],
			$query['join_conds']
		);

		if ( $this->log === null ) {
			$this->log = new ArrayIterator(

				[ (object)[
					'user_id' => null,
					'log_timestamp' => null,
					'log_action' => null
				] ]
			);
		}

		return $this->log;
	}

}


1		<?php
2
3		namespace SMW\ApprovedRevs;
4
5		use ArrayIterator;
6		use DatabaseLogEntry;
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `DatabaseLogEntry` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
7		use MWTimestamp;
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `MWTimestamp` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8		use Title;
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `Title` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9		use User;
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `User` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10		use Wikimedia\Rdbms\IDatabase;
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `Wikimedia\Rdbms\IDatabase` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11
12		class DatabaseLogReader {
13
14		/**
15		* @var array
16		*/
17		private static $titleCache = [];
18
19		/**
20		* @var DatabaseBase
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `SMW\ApprovedRevs\DatabaseBase` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21		*/
22		private $dbr;
23
24		/**
25		* @var string
26		*/
27		private $query;
28
29		/**
30		* @var string
31		*/
32		private $log;
33
34		/**
35		* @var string
36		*/
37		private $dbKey;
38
39		/**
40		* @var string
41		*/
42		private $type;
43
44		/**
45		* @since 1.0
46		*
47		* @param DatabaseaBase $dbr injected connection
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `SMW\ApprovedRevs\DatabaseaBase` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
48		* @param Title\|null $title
49		* @param string $type of log (default: approval)
50		*/
51	6	public function __construct( IDatabase $dbr, Title $title = null , $type = 'approval' ) {
52	6	$this->dbr = $dbr;
53	6	$this->dbKey = $title instanceof Title ? $title->getDBkey() : null;
54	6	$this->type = $type;
55	6	}
56
57		/**
58		* @since 1.0
59		*/
60	1	public function clearCache() {
61	1	self::$titleCache = [];
62	1	}
63
64		/**
65		* Fetch the query parameters for later calls
66		*
67		* @since 1.0
68		*
69		* @return array of parameters for SELECT call
70		*/
71	5	public function getQuery() {
72	5	return $this->query;
		0 ignored issues – show Bug Best Practice introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The expression `return $this->query` returns the type `string` which is incompatible with the documented return type `array`. Loading history...
73		}
74
75		/**
76		* @since 1.0
77		*
78		* @param Title\|null $title
79		* @param string $type
80		*
81		* @return User
82		*/
83	4	public function getUserForLogEntry( Title $title = null, $type = 'approval' ) {
84
85	4	$this->init( $title, $type );
86	4	$logLine = $this->getLog()->current();
87
88	4	if ( $logLine && $logLine->user_id ) {
89	2	return User::newFromID( $logLine->user_id );
90		}
91	2	}
92
93		/**
94		* @since 1.0
95		*
96		* @param Title\|null $title
97		* @param string $type
98		*
99		* @return Timestamp
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `SMW\ApprovedRevs\Timestamp` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
100		*/
101	2	public function getDateOfLogEntry( Title $title = null, $type = 'approval' ) {
102
103	2	$this->init( $title, $type );
104	2	$logLine = $this->getLog()->current();
105
106	2	if ( $logLine && $logLine->log_timestamp ) {
107	1	return new MWTimestamp( $logLine->log_timestamp );
108		}
109	1	}
110
111		/**
112		* @since 1.0
113		*
114		* @param Title\|null $title
115		* @param string $type
116		*
117		* @return string
118		*/
119	2	public function getStatusOfLogEntry( Title $title = null, $type = 'approval' ) {
120
121	2	$this->init( $title, $type );
122	2	$logLine = $this->getLog()->current();
123
124	2	if ( $logLine && $logLine->log_action ) {
125	1	return $logLine->log_action;
126		}
127	1	}
128
129		/**
130		* Take care of loading from the cache or filling the query.
131		*/
132	4	private function init( $title, $type ) {
133
134	4	$this->dbKey = $title instanceof Title ? $title->getDBkey() : null;
135	4	$this->type = $type;
136
137	4	if ( $this->query ) {
138	3	return;
139		}
140
141	4	if ( !isset( self::$titleCache[ $this->dbKey . '#' . $this->type ] ) ) {
142	4	$this->query = DatabaseLogEntry::getSelectQueryData();
143
144	4	$this->query['conds'] = [
145	4	'log_type' => $this->type,
146	4	'log_title' => $this->dbKey
147		];
148	4	$this->query['options'] = [ 'ORDER BY' => 'log_timestamp desc' ];
149	4	self::$titleCache[ $this->dbKey ] = $this;
150		} else {
151		$cache = self::$titleCache[ $this->dbKey . '#' . $this->type ];
152		$this->query = $cache->getQuery();
153		$this->log = $cache->getLog();
154		}
155
156	4	}
157
158		/**
159		* Fetch the results using our conditions
160		*
161		* @return IResultWrapper
		0 ignored issues – show Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The type `SMW\ApprovedRevs\IResultWrapper` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
162		* @throws DBError
163		*/
164	4	private function getLog() {
165
166	4	if ( $this->log !== null ) {
167	3	return $this->log;
		0 ignored issues – show Bug Best Practice introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report The expression `return $this->log` returns the type `string` which is incompatible with the documented return type `SMW\ApprovedRevs\IResultWrapper`. Loading history...
168		}
169
170	4	$query = $this->getQuery();
171
172	4	$this->log = $this->dbr->select(
173	4	$query['tables'],
174	4	$query['fields'],
175	4	$query['conds'],
176	4	__METHOD__,
177	4	$query['options'],
178	4	$query['join_conds']
179		);
180
181	4	if ( $this->log === null ) {
182		$this->log = new ArrayIterator(
		0 ignored issues – show Documentation Bug introduced 2021-09-22 11:49 UTC by Report Bug Copy Issue Report It seems like `new ArrayIterator(array(...'log_action' => null)))` of type `ArrayIterator` is incompatible with the declared type `string` of property `$log`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
183		[ (object)[
184		'user_id' => null,
185		'log_timestamp' => null,
186		'log_action' => null
187		] ]
188		);
189		}
190
191	4	return $this->log;
192		}
193
194		}
195

SemanticMediaWiki / SemanticApprovedRevs

DatabaseLogReader::clearCache() A last analyzed 2021-11-13 12:01 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DatabaseLogReader::clearCache() A
last analyzed 2021-11-13 12:01 UTC