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

RevisionItemBase::formatDate() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: RevisionItemBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Holders of revision list for a single page
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

/**
 * List for revision table items for a single page
 */
abstract class RevisionListBase extends ContextSource implements Iterator {
	/** @var Title */
	public $title;

	/** @var array */
	protected $ids;

	/** @var ResultWrapper|bool */
	protected $res;

	/** @var bool|object */
	protected $current;

	/**
	 * Construct a revision list for a given title
	 * @param IContextSource $context
	 * @param Title $title
	 */
	function __construct( IContextSource $context, Title $title ) {
		$this->setContext( $context );
		$this->title = $title;
	}

	/**
	 * Select items only where the ID is any of the specified values
	 * @param array $ids
	 */
	function filterByIds( array $ids ) {
		$this->ids = $ids;
	}

	/**
	 * Get the internal type name of this list. Equal to the table name.
	 * Override this function.
	 * @return null
	 */
	public function getType() {
		return null;
	}

	/**
	 * Initialise the current iteration pointer
	 */
	protected function initCurrent() {
		$row = $this->res->current();
		if ( $row ) {
			$this->current = $this->newItem( $row );
		} else {
			$this->current = false;
		}
	}

	/**
	 * Start iteration. This must be called before current() or next().
	 * @return Revision First list item
	 */
	public function reset() {
		if ( !$this->res ) {
			$this->res = $this->doQuery( wfGetDB( DB_REPLICA ) );
/** @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);
    }
}
		} else {
			$this->res->rewind();
		}
		$this->initCurrent();
		return $this->current;
	}

	public function rewind() {
		$this->reset();
	}

	/**
	 * Get the current list item, or false if we are at the end
	 * @return Revision
	 */
	public function current() {
		return $this->current;
	}

	/**
	 * Move the iteration pointer to the next list item, and return it.
	 * @return Revision
	 */
	public function next() {
		$this->res->next();
		$this->initCurrent();
		return $this->current;
	}

	public function key() {
		return $this->res ? $this->res->key(): 0;
	}

	public function valid() {
		return $this->res ? $this->res->valid() : false;
	}

	/**
	 * Get the number of items in the list.
	 * @return int
	 */
	public function length() {
		if ( !$this->res ) {
			return 0;
		} else {
			return $this->res->numRows();
		}
	}

	/**
	 * Do the DB query to iterate through the objects.
	 * @param IDatabase $db DB object to use for the query
	 */
	abstract public function doQuery( $db );

	/**
	 * Create an item object from a DB result row
	 * @param object $row
	 */
	abstract public function newItem( $row );
}

/**
 * Abstract base class for revision items
 */
abstract class RevisionItemBase {
	/** @var RevisionListBase The parent */
	protected $list;

	/** The database result row */
	protected $row;

	/**
	 * @param RevisionListBase $list
	 * @param object $row DB result row
	 */
	public function __construct( $list, $row ) {
		$this->list = $list;
		$this->row = $row;
	}

	/**
	 * Get the DB field name associated with the ID list.
	 * Override this function.
	 * @return null
	 */
	public function getIdField() {
		return null;
	}

	/**
	 * Get the DB field name storing timestamps.
	 * Override this function.
	 * @return bool
	 */
	public function getTimestampField() {
		return false;
	}

	/**
	 * Get the DB field name storing user ids.
	 * Override this function.
	 * @return bool
	 */
	public function getAuthorIdField() {
		return false;
	}

	/**
	 * Get the DB field name storing user names.
	 * Override this function.
	 * @return bool
	 */
	public function getAuthorNameField() {
		return false;
	}

	/**
	 * Get the ID, as it would appear in the ids URL parameter
	 * @return int
	 */
	public function getId() {
		$field = $this->getIdField();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		return $this->row->$field;
	}

	/**
	 * Get the date, formatted in user's language
	 * @return string
	 */
	public function formatDate() {
		return $this->list->getLanguage()->userDate( $this->getTimestamp(),
			$this->list->getUser() );
	}

	/**
	 * Get the time, formatted in user's language
	 * @return string
	 */
	public function formatTime() {
		return $this->list->getLanguage()->userTime( $this->getTimestamp(),
			$this->list->getUser() );
	}

	/**
	 * Get the timestamp in MW 14-char form
	 * @return mixed
	 */
	public function getTimestamp() {
		$field = $this->getTimestampField();
		return wfTimestamp( TS_MW, $this->row->$field );
	}

	/**
	 * Get the author user ID
	 * @return int
	 */
	public function getAuthorId() {
		$field = $this->getAuthorIdField();
		return intval( $this->row->$field );
	}

	/**
	 * Get the author user name
	 * @return string
	 */
	public function getAuthorName() {
		$field = $this->getAuthorNameField();
		return strval( $this->row->$field );
	}

	/**
	 * Returns true if the current user can view the item
	 */
	abstract public function canView();

	/**
	 * Returns true if the current user can view the item text/file
	 */
	abstract public function canViewContent();

	/**
	 * Get the HTML of the list item. Should be include "<li></li>" tags.
	 * This is used to show the list in HTML form, by the special page.
	 */
	abstract public function getHTML();
}

class RevisionList extends RevisionListBase {
	public function getType() {
		return 'revision';
	}

	/**
	 * @param IDatabase $db
	 * @return mixed
	 */
	public function doQuery( $db ) {
		$conds = [ 'rev_page' => $this->title->getArticleID() ];
		if ( $this->ids !== null ) {
			$conds['rev_id'] = array_map( 'intval', $this->ids );
		}
		return $db->select(
			[ 'revision', 'page', 'user' ],
			array_merge( Revision::selectFields(), Revision::selectUserFields() ),
			$conds,
			__METHOD__,
			[ 'ORDER BY' => 'rev_id DESC' ],
			[
				'page' => Revision::pageJoinCond(),
				'user' => Revision::userJoinCond() ]
		);
	}

	public function newItem( $row ) {
		return new RevisionItem( $this, $row );
	}
}

/**
 * Item class for a live revision table row
 */
class RevisionItem extends RevisionItemBase {
	/** @var Revision */
	protected $revision;

	/** @var RequestContext */
	protected $context;

	public function __construct( $list, $row ) {
		parent::__construct( $list, $row );
		$this->revision = new Revision( $row );
		$this->context = $list->getContext();
	}

	public function getIdField() {
		return 'rev_id';
	}

	public function getTimestampField() {
		return 'rev_timestamp';
	}

	public function getAuthorIdField() {
		return 'rev_user';
	}

	public function getAuthorNameField() {
		return 'rev_user_text';
	}

	public function canView() {
		return $this->revision->userCan( Revision::DELETED_RESTRICTED, $this->context->getUser() );
	}

	public function canViewContent() {
		return $this->revision->userCan( Revision::DELETED_TEXT, $this->context->getUser() );
	}

	public function isDeleted() {
		return $this->revision->isDeleted( Revision::DELETED_TEXT );
	}

	/**
	 * Get the HTML link to the revision text.
	 * @todo Essentially a copy of RevDelRevisionItem::getRevisionLink. That class
	 * should inherit from this one, and implement an appropriate interface instead
	 * of extending RevDelItem
	 * @return string
	 */
	protected function getRevisionLink() {
		$date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
			$this->revision->getTimestamp(), $this->list->getUser() ) );

		if ( $this->isDeleted() && !$this->canViewContent() ) {
			return $date;
		}
		return Linker::linkKnown(
			$this->list->title,
			$date,
			[],
			[
				'oldid' => $this->revision->getId(),
				'unhide' => 1
			]
		);
	}

	/**
	 * Get the HTML link to the diff.
	 * @todo Essentially a copy of RevDelRevisionItem::getDiffLink. That class
	 * should inherit from this one, and implement an appropriate interface instead
	 * of extending RevDelItem
	 * @return string
	 */
	protected function getDiffLink() {
		if ( $this->isDeleted() && !$this->canViewContent() ) {
			return $this->context->msg( 'diff' )->escaped();
		} else {
			return Linker::linkKnown(
					$this->list->title,
					$this->list->msg( 'diff' )->escaped(),
					[],
					[
						'diff' => $this->revision->getId(),
						'oldid' => 'prev',
						'unhide' => 1
					]
				);
		}
	}

	/**
	 * @todo Essentially a copy of RevDelRevisionItem::getHTML. That class
	 * should inherit from this one, and implement an appropriate interface instead
	 * of extending RevDelItem
	 * @return string
	 */
	public function getHTML() {
		$difflink = $this->context->msg( 'parentheses' )
			->rawParams( $this->getDiffLink() )->escaped();
		$revlink = $this->getRevisionLink();
		$userlink = Linker::revUserLink( $this->revision );
		$comment = Linker::revComment( $this->revision );
		if ( $this->isDeleted() ) {
			$revlink = "<span class=\"history-deleted\">$revlink</span>";
		}
		return "<li>$difflink $revlink $userlink $comment</li>";
	}
}


1		<?php
2		/**
3		* Holders of revision list for a single page
4		*
5		* This program is free software; you can redistribute it and/or modify
6		* it under the terms of the GNU General Public License as published by
7		* the Free Software Foundation; either version 2 of the License, or
8		* (at your option) any later version.
9		*
10		* This program is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License along
16		* with this program; if not, write to the Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		* http://www.gnu.org/copyleft/gpl.html
19		*
20		* @file
21		*/
22
23		/**
24		* List for revision table items for a single page
25		*/
26		abstract class RevisionListBase extends ContextSource implements Iterator {
27		/** @var Title */
28		public $title;
29
30		/** @var array */
31		protected $ids;
32
33		/** @var ResultWrapper\|bool */
34		protected $res;
35
36		/** @var bool\|object */
37		protected $current;
38
39		/**
40		* Construct a revision list for a given title
41		* @param IContextSource $context
42		* @param Title $title
43		*/
44		function __construct( IContextSource $context, Title $title ) {
45		$this->setContext( $context );
46		$this->title = $title;
47		}
48
49		/**
50		* Select items only where the ID is any of the specified values
51		* @param array $ids
52		*/
53		function filterByIds( array $ids ) {
54		$this->ids = $ids;
55		}
56
57		/**
58		* Get the internal type name of this list. Equal to the table name.
59		* Override this function.
60		* @return null
61		*/
62		public function getType() {
63		return null;
64		}
65
66		/**
67		* Initialise the current iteration pointer
68		*/
69		protected function initCurrent() {
70		$row = $this->res->current();
71		if ( $row ) {
72		$this->current = $this->newItem( $row );
73		} else {
74		$this->current = false;
75		}
76		}
77
78		/**
79		* Start iteration. This must be called before current() or next().
80		* @return Revision First list item
81		*/
82		public function reset() {
83		if ( !$this->res ) {
84		$this->res = $this->doQuery( wfGetDB( DB_REPLICA ) );
		0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `wfGetDB(DB_REPLICA)` can be `null`; however, `doQuery()` 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...
85		} else {
86		$this->res->rewind();
87		}
88		$this->initCurrent();
89		return $this->current;
90		}
91
92		public function rewind() {
93		$this->reset();
94		}
95
96		/**
97		* Get the current list item, or false if we are at the end
98		* @return Revision
99		*/
100		public function current() {
101		return $this->current;
102		}
103
104		/**
105		* Move the iteration pointer to the next list item, and return it.
106		* @return Revision
107		*/
108		public function next() {
109		$this->res->next();
110		$this->initCurrent();
111		return $this->current;
112		}
113
114		public function key() {
115		return $this->res ? $this->res->key(): 0;
116		}
117
118		public function valid() {
119		return $this->res ? $this->res->valid() : false;
120		}
121
122		/**
123		* Get the number of items in the list.
124		* @return int
125		*/
126		public function length() {
127		if ( !$this->res ) {
128		return 0;
129		} else {
130		return $this->res->numRows();
131		}
132		}
133
134		/**
135		* Do the DB query to iterate through the objects.
136		* @param IDatabase $db DB object to use for the query
137		*/
138		abstract public function doQuery( $db );
139
140		/**
141		* Create an item object from a DB result row
142		* @param object $row
143		*/
144		abstract public function newItem( $row );
145		}
146
147		/**
148		* Abstract base class for revision items
149		*/
150		abstract class RevisionItemBase {
151		/** @var RevisionListBase The parent */
152		protected $list;
153
154		/** The database result row */
155		protected $row;
156
157		/**
158		* @param RevisionListBase $list
159		* @param object $row DB result row
160		*/
161		public function __construct( $list, $row ) {
162		$this->list = $list;
163		$this->row = $row;
164		}
165
166		/**
167		* Get the DB field name associated with the ID list.
168		* Override this function.
169		* @return null
170		*/
171		public function getIdField() {
172		return null;
173		}
174
175		/**
176		* Get the DB field name storing timestamps.
177		* Override this function.
178		* @return bool
179		*/
180		public function getTimestampField() {
181		return false;
182		}
183
184		/**
185		* Get the DB field name storing user ids.
186		* Override this function.
187		* @return bool
188		*/
189		public function getAuthorIdField() {
190		return false;
191		}
192
193		/**
194		* Get the DB field name storing user names.
195		* Override this function.
196		* @return bool
197		*/
198		public function getAuthorNameField() {
199		return false;
200		}
201
202		/**
203		* Get the ID, as it would appear in the ids URL parameter
204		* @return int
205		*/
206		public function getId() {
207		$field = $this->getIdField();
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$field` is correct as `$this->getIdField()` (which targets `RevisionItemBase::getIdField()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
208		return $this->row->$field;
209		}
210
211		/**
212		* Get the date, formatted in user's language
213		* @return string
214		*/
215		public function formatDate() {
216		return $this->list->getLanguage()->userDate( $this->getTimestamp(),
217		$this->list->getUser() );
218		}
219
220		/**
221		* Get the time, formatted in user's language
222		* @return string
223		*/
224		public function formatTime() {
225		return $this->list->getLanguage()->userTime( $this->getTimestamp(),
226		$this->list->getUser() );
227		}
228
229		/**
230		* Get the timestamp in MW 14-char form
231		* @return mixed
232		*/
233		public function getTimestamp() {
234		$field = $this->getTimestampField();
235		return wfTimestamp( TS_MW, $this->row->$field );
236		}
237
238		/**
239		* Get the author user ID
240		* @return int
241		*/
242		public function getAuthorId() {
243		$field = $this->getAuthorIdField();
244		return intval( $this->row->$field );
245		}
246
247		/**
248		* Get the author user name
249		* @return string
250		*/
251		public function getAuthorName() {
252		$field = $this->getAuthorNameField();
253		return strval( $this->row->$field );
254		}
255
256		/**
257		* Returns true if the current user can view the item
258		*/
259		abstract public function canView();
260
261		/**
262		* Returns true if the current user can view the item text/file
263		*/
264		abstract public function canViewContent();
265
266		/**
267		* Get the HTML of the list item. Should be include "<li></li>" tags.
268		* This is used to show the list in HTML form, by the special page.
269		*/
270		abstract public function getHTML();
271		}
272
273		class RevisionList extends RevisionListBase {
274		public function getType() {
275		return 'revision';
276		}
277
278		/**
279		* @param IDatabase $db
280		* @return mixed
281		*/
282		public function doQuery( $db ) {
283		$conds = [ 'rev_page' => $this->title->getArticleID() ];
284		if ( $this->ids !== null ) {
285		$conds['rev_id'] = array_map( 'intval', $this->ids );
286		}
287		return $db->select(
288		[ 'revision', 'page', 'user' ],
289		array_merge( Revision::selectFields(), Revision::selectUserFields() ),
290		$conds,
291		__METHOD__,
292		[ 'ORDER BY' => 'rev_id DESC' ],
293		[
294		'page' => Revision::pageJoinCond(),
295		'user' => Revision::userJoinCond() ]
296		);
297		}
298
299		public function newItem( $row ) {
300		return new RevisionItem( $this, $row );
301		}
302		}
303
304		/**
305		* Item class for a live revision table row
306		*/
307		class RevisionItem extends RevisionItemBase {
308		/** @var Revision */
309		protected $revision;
310
311		/** @var RequestContext */
312		protected $context;
313
314		public function __construct( $list, $row ) {
315		parent::__construct( $list, $row );
316		$this->revision = new Revision( $row );
317		$this->context = $list->getContext();
318		}
319
320		public function getIdField() {
321		return 'rev_id';
322		}
323
324		public function getTimestampField() {
325		return 'rev_timestamp';
326		}
327
328		public function getAuthorIdField() {
329		return 'rev_user';
330		}
331
332		public function getAuthorNameField() {
333		return 'rev_user_text';
334		}
335
336		public function canView() {
337		return $this->revision->userCan( Revision::DELETED_RESTRICTED, $this->context->getUser() );
338		}
339
340		public function canViewContent() {
341		return $this->revision->userCan( Revision::DELETED_TEXT, $this->context->getUser() );
342		}
343
344		public function isDeleted() {
345		return $this->revision->isDeleted( Revision::DELETED_TEXT );
346		}
347
348		/**
349		* Get the HTML link to the revision text.
350		* @todo Essentially a copy of RevDelRevisionItem::getRevisionLink. That class
351		* should inherit from this one, and implement an appropriate interface instead
352		* of extending RevDelItem
353		* @return string
354		*/
355	View Code Duplication	protected function getRevisionLink() {
356		$date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
357		$this->revision->getTimestamp(), $this->list->getUser() ) );
358
359		if ( $this->isDeleted() && !$this->canViewContent() ) {
360		return $date;
361		}
362		return Linker::linkKnown(
363		$this->list->title,
364		$date,
365		[],
366		[
367		'oldid' => $this->revision->getId(),
368		'unhide' => 1
369		]
370		);
371		}
372
373		/**
374		* Get the HTML link to the diff.
375		* @todo Essentially a copy of RevDelRevisionItem::getDiffLink. That class
376		* should inherit from this one, and implement an appropriate interface instead
377		* of extending RevDelItem
378		* @return string
379		*/
380	View Code Duplication	protected function getDiffLink() {
381		if ( $this->isDeleted() && !$this->canViewContent() ) {
382		return $this->context->msg( 'diff' )->escaped();
383		} else {
384		return Linker::linkKnown(
385		$this->list->title,
386		$this->list->msg( 'diff' )->escaped(),
387		[],
388		[
389		'diff' => $this->revision->getId(),
390		'oldid' => 'prev',
391		'unhide' => 1
392		]
393		);
394		}
395		}
396
397		/**
398		* @todo Essentially a copy of RevDelRevisionItem::getHTML. That class
399		* should inherit from this one, and implement an appropriate interface instead
400		* of extending RevDelItem
401		* @return string
402		*/
403		public function getHTML() {
404		$difflink = $this->context->msg( 'parentheses' )
405		->rawParams( $this->getDiffLink() )->escaped();
406		$revlink = $this->getRevisionLink();
407		$userlink = Linker::revUserLink( $this->revision );
408		$comment = Linker::revComment( $this->revision );
409		if ( $this->isDeleted() ) {
410		$revlink = "<span class=\"history-deleted\">$revlink</span>";
411		}
412		return "<li>$difflink $revlink $userlink $comment</li>";
413		}
414		}
415

wikimedia / mediawiki

RevisionItemBase::formatDate() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RevisionItemBase::formatDate() A
last analyzed 2016-11-13 17:42 UTC