SpecialActiveUsers::buildForm() - Code Metrics - Inspection of "Daily Inspection: Add hooks for WatchedItemQuerySe..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (715cbe)

unknown

created 2016-11-03 17:18 UTC

SpecialActiveUsers::buildForm() B

↳ Parent: SpecialActiveUsers

Complexity

Conditions	2
Paths	2

Size

Total Lines	37
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	26
nc	2
nop	0
dl	0
loc	37
rs	8.8571
c	0
b	0
f	0

<?php
/**
 * Implements Special:Activeusers
 *
 * Copyright © 2008 Aaron Schulz
 *
 * 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
 * @ingroup SpecialPage
 */

/**
 * Implements Special:Activeusers
 *
 * @ingroup SpecialPage
 */
class SpecialActiveUsers extends SpecialPage {

	/**
	 * Constructor
	 */
	public function __construct() {
		parent::__construct( 'Activeusers' );
	}

	/**
	 * Show the special page
	 *
	 * @param string $par Parameter passed to the page or null
	 */
	public function execute( $par ) {
		$out = $this->getOutput();

		$this->setHeaders();
		$this->outputHeader();

		$opts = new FormOptions();

		$opts->add( 'username', '' );
		$opts->add( 'groups', [] );

		$opts->fetchValuesFromRequest( $this->getRequest() );

		if ( $par !== null ) {
			$opts->setValue( 'username', $par );
		}

		$pager = new ActiveUsersPager( $this->getContext(), $opts );
		$usersBody = $pager->getBody();

		$this->buildForm();

		if ( $usersBody ) {
			$out->addHTML(
				$pager->getNavigationBar() .
				Html::rawElement( 'ul', [], $usersBody ) .
				$pager->getNavigationBar()
			);
		} else {
			$out->addWikiMsg( 'activeusers-noresult' );
		}
	}

	/**
	 * Generate and output the form
	 */
	protected function buildForm() {
		$groups = User::getAllGroups();

		foreach ( $groups as $group ) {
			$msg = User::getGroupName( $group );
			$options[$msg] = $group;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		}

		$formDescriptor = [
			'username' => [
				'type' => 'user',
				'name' => 'username',
				'label-message' => 'activeusers-from',
			],

			'groups' => [
				'type' => 'multiselect',
				'dropdown' => true,
				'flatlist' => true,
				'name' => 'groups',
				'label-message' => 'activeusers-groups',
				'options' => $options,
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
			],
		];

		HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
			// For the 'multiselect' field values to be preserved on submit
			->setFormIdentifier( 'specialactiveusers' )
			->setIntro( $this->getIntroText() )
			->setWrapperLegendMsg( 'activeusers' )
			->setSubmitTextMsg( 'activeusers-submit' )
			// prevent setting subpage and 'username' parameter at the same time
			->setAction( $this->getPageTitle()->getLocalURL() )
			->setMethod( 'get' )
			->prepareForm()
			->displayForm( false );
	}

	/**
	 * Return introductory message.
	 * @return string
	 */
	protected function getIntroText() {
		$days = $this->getConfig()->get( 'ActiveUserDays' );

		$intro = $this->msg( 'activeusers-intro' )->numParams( $days )->parse();

		// Mention the level of cache staleness...
		$dbr = wfGetDB( DB_REPLICA, 'recentchanges' );
		$rcMax = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', '', __METHOD__ );
		if ( $rcMax ) {
			$cTime = $dbr->selectField( 'querycache_info',
				'qci_timestamp',
				[ 'qci_type' => 'activeusers' ],
				__METHOD__
			);
			if ( $cTime ) {
				$secondsOld = wfTimestamp( TS_UNIX, $rcMax ) - wfTimestamp( TS_UNIX, $cTime );
			} else {
				$rcMin = $dbr->selectField( 'recentchanges', 'MIN(rc_timestamp)' );
				$secondsOld = time() - wfTimestamp( TS_UNIX, $rcMin );
			}
			if ( $secondsOld > 0 ) {
				$intro .= $this->msg( 'cachedspecial-viewing-cached-ttl' )
					->durationParams( $secondsOld )->parseAsBlock();
			}
		}

		return $intro;
	}

	protected function getGroupName() {
		return 'users';
	}
}


1			<?php
2			/**
3			* Implements Special:Activeusers
4			*
5			* Copyright © 2008 Aaron Schulz
6			*
7			* This program is free software; you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 2 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License along
18			* with this program; if not, write to the Free Software Foundation, Inc.,
19			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20			* http://www.gnu.org/copyleft/gpl.html
21			*
22			* @file
23			* @ingroup SpecialPage
24			*/
25
26			/**
27			* Implements Special:Activeusers
28			*
29			* @ingroup SpecialPage
30			*/
31			class SpecialActiveUsers extends SpecialPage {
32
33			/**
34			* Constructor
35			*/
36			public function __construct() {
37			parent::__construct( 'Activeusers' );
38			}
39
40			/**
41			* Show the special page
42			*
43			* @param string $par Parameter passed to the page or null
44			*/
45			public function execute( $par ) {
46			$out = $this->getOutput();
47
48			$this->setHeaders();
49			$this->outputHeader();
50
51			$opts = new FormOptions();
52
53			$opts->add( 'username', '' );
54			$opts->add( 'groups', [] );
55
56			$opts->fetchValuesFromRequest( $this->getRequest() );
57
58			if ( $par !== null ) {
59			$opts->setValue( 'username', $par );
60			}
61
62			$pager = new ActiveUsersPager( $this->getContext(), $opts );
63			$usersBody = $pager->getBody();
64
65			$this->buildForm();
66
67			if ( $usersBody ) {
68			$out->addHTML(
69			$pager->getNavigationBar() .
70			Html::rawElement( 'ul', [], $usersBody ) .
71			$pager->getNavigationBar()
72			);
73			} else {
74			$out->addWikiMsg( 'activeusers-noresult' );
75			}
76			}
77
78			/**
79			* Generate and output the form
80			*/
81			protected function buildForm() {
82			$groups = User::getAllGroups();
83
84			foreach ( $groups as $group ) {
85			$msg = User::getGroupName( $group );
86			$options[$msg] = $group;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-02 17:56 UTC by Report Bug Copy Issue Report `$options` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$options = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
87			}
88
89			$formDescriptor = [
90			'username' => [
91			'type' => 'user',
92			'name' => 'username',
93			'label-message' => 'activeusers-from',
94			],
95
96			'groups' => [
97			'type' => 'multiselect',
98			'dropdown' => true,
99			'flatlist' => true,
100			'name' => 'groups',
101			'label-message' => 'activeusers-groups',
102			'options' => $options,
			0 ignored issues – show Bug introduced 2016-11-02 17:56 UTC by Report Bug Copy Issue Report The variable `$options` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
103			],
104			];
105
106			HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
107			// For the 'multiselect' field values to be preserved on submit
108			->setFormIdentifier( 'specialactiveusers' )
109			->setIntro( $this->getIntroText() )
110			->setWrapperLegendMsg( 'activeusers' )
111			->setSubmitTextMsg( 'activeusers-submit' )
112			// prevent setting subpage and 'username' parameter at the same time
113			->setAction( $this->getPageTitle()->getLocalURL() )
114			->setMethod( 'get' )
115			->prepareForm()
116			->displayForm( false );
117			}
118
119			/**
120			* Return introductory message.
121			* @return string
122			*/
123			protected function getIntroText() {
124			$days = $this->getConfig()->get( 'ActiveUserDays' );
125
126			$intro = $this->msg( 'activeusers-intro' )->numParams( $days )->parse();
127
128			// Mention the level of cache staleness...
129			$dbr = wfGetDB( DB_REPLICA, 'recentchanges' );
130			$rcMax = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', '', __METHOD__ );
131			if ( $rcMax ) {
132			$cTime = $dbr->selectField( 'querycache_info',
133			'qci_timestamp',
134			[ 'qci_type' => 'activeusers' ],
135			__METHOD__
136			);
137			if ( $cTime ) {
138			$secondsOld = wfTimestamp( TS_UNIX, $rcMax ) - wfTimestamp( TS_UNIX, $cTime );
139			} else {
140			$rcMin = $dbr->selectField( 'recentchanges', 'MIN(rc_timestamp)' );
141			$secondsOld = time() - wfTimestamp( TS_UNIX, $rcMin );
142			}
143			if ( $secondsOld > 0 ) {
144			$intro .= $this->msg( 'cachedspecial-viewing-cached-ttl' )
145			->durationParams( $secondsOld )->parseAsBlock();
146			}
147			}
148
149			return $intro;
150			}
151
152			protected function getGroupName() {
153			return 'users';
154			}
155			}
156

wikimedia / mediawiki

Branch — master (715cbe)

SpecialActiveUsers::buildForm() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like