SMWOrderedListPage::view() - Code Metrics - Inspection of "Avoid error on ConceptPage::getTopIndicators (#232..." - SemanticMediaWiki/SemanticMediaWiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0a23e6...45ce5f )

by mw

created 2017-03-11 03:11 UTC

SMWOrderedListPage::view() D

↳ Parent: SMWOrderedListPage

Complexity

Conditions	9
Paths	13

Size

Total Lines	36
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	90

Importance

Changes

Metric	Value
cc	9
eloc	19
nc	13
nop	0
dl	0
loc	36
ccs	0
cts	20
cp	0
crap	90
rs	4.909
c	0
b	0
f	0

<?php

use SMW\ApplicationFactory;
use SMW\DIProperty;
use SMW\PropertyRegistry;

/**
 * Abstract subclass of MediaWiki's Article that handles the common tasks of
 * article pages for Concept and Property pages. This is mainly parameter
 * handling and some very basic output control.
 *
 * @ingroup SMW
 *
 * @author Nikolas Iwan
 * @author Markus Krötzsch
 * @author Jeroen De Dauw
 */
abstract class SMWOrderedListPage extends Article {
namespace YourVendor;

class YourClass { }

	/**
	 * Limit for results per page.
	 *
	 * @var integer
	 */
	protected $limit;

	/**
	 * Start string: print $limit results from here.
	 *
	 * @var string
	 */
	protected $from;

	/**
	 * End string: print $limit results strictly before this article.
	 *
	 * @var string
	 */
	protected $until;

	/**
	 * Cache for the current skin, obtained from $wgUser.
	 *
	 * @var Skin
	 */
	protected $skin;

	/**
	 * Property that the displayed values are for, if any.
	 *
	 * @since 1.6
	 *
	 * @var SMWDIProperty
	 */
	protected $mProperty = null;

	/**
	 * Overwrite view() from Article.php to add additional HTML to the
	 * output.
	 */
	public function view() {
		global $wgRequest, $wgUser;
function myFunction($a, $b) {
    // Do something
}

		$outputPage = $this->getContext()->getOutput();

		if ( !ApplicationFactory::getInstance()->getSettings()->get( 'smwgSemanticsEnabled' ) ) {
			$outputPage->setPageTitle( $this->getTitle()->getPrefixedText() );
			$outputPage->addHTML( wfMessage( 'smw-semantics-not-enabled' )->text() );
			return;
		}

		if ( $this->getTitle()->getNamespace() === SMW_NS_PROPERTY ) {
			$this->findBasePropertyToRedirectFor( $this->getTitle()->getText() );
		}

		$this->initParameters();

		if ( !isset( $diff ) || !$diffOnly ) {
function someFunction() {
    $x = 5;
    echo $x;
}

			// MW 1.25+
			if ( method_exists( $outputPage, 'setIndicators' ) && ( $indicators = $this->getTopIndicators() ) !== '' ) {
				$outputPage->setIndicators( $indicators );
			}

			$outputPage->addHTML( $this->getIntroductoryText() );
		}

		parent::view();

		// Copied from CategoryPage
		$diff = $wgRequest->getVal( 'diff' );
		$diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
		if ( !isset( $diff ) || !$diffOnly ) {
			$this->showList();
		}
	}

	private function findBasePropertyToRedirectFor( $label ) {

		$property = new DIProperty(
			PropertyRegistry::getInstance()->findPropertyIdByLabel( $label )
		);

		// Ensure to redirect to `Property:Modification date` and not using
		// a possible user contextualized version such as `Property:Date de modification`
		$canonicalLabel = $property->getCanonicalLabel();

		if ( $canonicalLabel !== '' && $label !== $canonicalLabel ) {
			$outputPage = $this->getContext()->getOutput();
			$outputPage->redirect( $property->getCanonicalDiWikiPage()->getTitle()->getFullURL() );
		}
	}

	/**
	 * @since 2.4
	 *
	 * @return string
	 */
	protected function getTopIndicators() {
		return '';
	}

	/**
	 * @since 2.4
	 *
	 * @return string
	 */
	protected function getIntroductoryText() {
		return '';
	}

	/**
	 * @since 2.4
	 */
	protected function getNavigationLinks( $msgKey, array $diWikiPages, $default = 50 ) {
		global $wgRequest;
function myFunction($a, $b) {
    // Do something
}

		$mwCollaboratorFactory = ApplicationFactory::getInstance()->newMwCollaboratorFactory();

		$messageBuilder = $mwCollaboratorFactory->newMessageBuilder(
			$this->getContext()->getLanguage()
		);

		$title = $this->mTitle;
		$title->setFragment( '#SMWResults' ); // Make navigation point to the result list.

		$resultCount = count( $diWikiPages );
		$navigation = '';

		if ( $resultCount > 0 ) {
			$navigation = $messageBuilder->prevNextToText(
				$title,
				$wgRequest->getVal( 'limit', $default ),
				$wgRequest->getVal( 'offset', '0' ),
				array(
					'value'  => $wgRequest->getVal( 'value', '' ),
					'from'   => $wgRequest->getVal( 'from', '' ),
					'until'  => $wgRequest->getVal( 'until', '' )
				),
				$resultCount < $wgRequest->getVal( 'limit', $default )
			);

			$navigation = Html::rawElement('div', array(), $navigation );
		}

		return Html::rawElement(
			'p',
			array(),
			Html::element( 'span', array(), wfMessage( $msgKey, $resultCount )->parse() ) . '<br>' .
			$navigation
		);
	}

	/**
	 * Main method for adding all additional HTML to the output stream.
	 */
	protected function showList() {
		global $wgOut, $wgRequest;
function myFunction($a, $b) {
    // Do something
}


		$this->from = $wgRequest->getVal( 'from', '' );
		$this->until = $wgRequest->getVal( 'until', '' );

		if ( $this->initParameters() ) {
			$wgOut->addHTML( $this->getHtml() );
			SMWOutputs::commitToOutputPage( $wgOut );
		}

	}

	/**
	 * Initialise some parameters that might be changed by subclasses
	 * (e.g. $limit). Method can be overwritten in this case.
	 * If the method returns false, nothing will be printed besides
	 * the original article.
	 *
	 * @return true
	 */
	protected function initParameters() {
		$this->limit = 20;
		return true;
	}

	/**
	 * Returns the HTML which is added to $wgOut after the article text.
	 *
	 * @return string
	 */
	protected abstract function getHtml();


	/**
	 * Like Article's getTitle(), but returning a suitable SMWDIWikiPage.
	 *
	 * @since 1.6
	 *
	 * @return SMWDIWikiPage
	 */
	protected function getDataItem() {
		return SMWDIWikiPage::newFromTitle( $this->getTitle() );
	}

}


Push — master ( 0a23e6...45ce5f )

SMWOrderedListPage::view() D

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2
3			use SMW\ApplicationFactory;
4			use SMW\DIProperty;
5			use SMW\PropertyRegistry;
6
7			/**
8			* Abstract subclass of MediaWiki's Article that handles the common tasks of
9			* article pages for Concept and Property pages. This is mainly parameter
10			* handling and some very basic output control.
11			*
12			* @ingroup SMW
13			*
14			* @author Nikolas Iwan
15			* @author Markus Krötzsch
16			* @author Jeroen De Dauw
17			*/
18			abstract class SMWOrderedListPage extends Article {
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-23 10:29 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
19
20			/**
21			* Limit for results per page.
22			*
23			* @var integer
24			*/
25			protected $limit;
26
27			/**
28			* Start string: print $limit results from here.
29			*
30			* @var string
31			*/
32			protected $from;
33
34			/**
35			* End string: print $limit results strictly before this article.
36			*
37			* @var string
38			*/
39			protected $until;
40
41			/**
42			* Cache for the current skin, obtained from $wgUser.
43			*
44			* @var Skin
45			*/
46			protected $skin;
47
48			/**
49			* Property that the displayed values are for, if any.
50			*
51			* @since 1.6
52			*
53			* @var SMWDIProperty
54			*/
55			protected $mProperty = null;
56
57			/**
58			* Overwrite view() from Article.php to add additional HTML to the
59			* output.
60			*/
61			public function view() {
62			global $wgRequest, $wgUser;
			0 ignored issues – show Compatibility Best Practice introduced 2015-11-23 10:29 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
63
64			$outputPage = $this->getContext()->getOutput();
65
66			if ( !ApplicationFactory::getInstance()->getSettings()->get( 'smwgSemanticsEnabled' ) ) {
67			$outputPage->setPageTitle( $this->getTitle()->getPrefixedText() );
68			$outputPage->addHTML( wfMessage( 'smw-semantics-not-enabled' )->text() );
69			return;
70			}
71
72			if ( $this->getTitle()->getNamespace() === SMW_NS_PROPERTY ) {
73			$this->findBasePropertyToRedirectFor( $this->getTitle()->getText() );
74			}
75
76			$this->initParameters();
77
78			if ( !isset( $diff ) \|\| !$diffOnly ) {
			0 ignored issues – show Bug introduced 2015-12-24 05:15 UTC by Report Bug Copy Issue Report The variable `$diff` seems only to be defined at a later point. As such the call to `isset()` seems to always evaluate to `false`. This check marks calls to `isset(...)` or `empty(...)` that are found before the variable itself is defined. These will always have the same result. This is likely the result of code being shifted around. Consider removing these calls. Loading history... Bug introduced 2015-12-24 05:15 UTC by Report Bug Copy Issue Report The variable `$diffOnly` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
79
80			// MW 1.25+
81			if ( method_exists( $outputPage, 'setIndicators' ) && ( $indicators = $this->getTopIndicators() ) !== '' ) {
82			$outputPage->setIndicators( $indicators );
83			}
84
85			$outputPage->addHTML( $this->getIntroductoryText() );
86			}
87
88			parent::view();
89
90			// Copied from CategoryPage
91			$diff = $wgRequest->getVal( 'diff' );
92			$diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
93			if ( !isset( $diff ) \|\| !$diffOnly ) {
94			$this->showList();
95			}
96			}
97
98			private function findBasePropertyToRedirectFor( $label ) {
99
100			$property = new DIProperty(
101			PropertyRegistry::getInstance()->findPropertyIdByLabel( $label )
102			);
103
104			// Ensure to redirect to `Property:Modification date` and not using
105			// a possible user contextualized version such as `Property:Date de modification`
106			$canonicalLabel = $property->getCanonicalLabel();
107
108			if ( $canonicalLabel !== '' && $label !== $canonicalLabel ) {
109			$outputPage = $this->getContext()->getOutput();
110			$outputPage->redirect( $property->getCanonicalDiWikiPage()->getTitle()->getFullURL() );
111			}
112			}
113
114			/**
115			* @since 2.4
116			*
117			* @return string
118			*/
119			protected function getTopIndicators() {
120			return '';
121			}
122
123			/**
124			* @since 2.4
125			*
126			* @return string
127			*/
128			protected function getIntroductoryText() {
129			return '';
130			}
131
132			/**
133			* @since 2.4
134			*/
135			protected function getNavigationLinks( $msgKey, array $diWikiPages, $default = 50 ) {
136			global $wgRequest;
			0 ignored issues – show Compatibility Best Practice introduced 2016-04-29 09:48 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
137
138			$mwCollaboratorFactory = ApplicationFactory::getInstance()->newMwCollaboratorFactory();
139
140			$messageBuilder = $mwCollaboratorFactory->newMessageBuilder(
141			$this->getContext()->getLanguage()
142			);
143
144			$title = $this->mTitle;
145			$title->setFragment( '#SMWResults' ); // Make navigation point to the result list.
146
147			$resultCount = count( $diWikiPages );
148			$navigation = '';
149
150			if ( $resultCount > 0 ) {
151			$navigation = $messageBuilder->prevNextToText(
152			$title,
153			$wgRequest->getVal( 'limit', $default ),
154			$wgRequest->getVal( 'offset', '0' ),
155			array(
156			'value' => $wgRequest->getVal( 'value', '' ),
157			'from' => $wgRequest->getVal( 'from', '' ),
158			'until' => $wgRequest->getVal( 'until', '' )
159			),
160			$resultCount < $wgRequest->getVal( 'limit', $default )
161			);
162
163			$navigation = Html::rawElement('div', array(), $navigation );
164			}
165
166			return Html::rawElement(
167			'p',
168			array(),
169			Html::element( 'span', array(), wfMessage( $msgKey, $resultCount )->parse() ) . '<br>' .
170			$navigation
171			);
172			}
173
174			/**
175			* Main method for adding all additional HTML to the output stream.
176			*/
177			protected function showList() {
178			global $wgOut, $wgRequest;
			0 ignored issues – show Compatibility Best Practice introduced 2015-11-23 10:29 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
179
180
181			$this->from = $wgRequest->getVal( 'from', '' );
182			$this->until = $wgRequest->getVal( 'until', '' );
183
184			if ( $this->initParameters() ) {
185			$wgOut->addHTML( $this->getHtml() );
186			SMWOutputs::commitToOutputPage( $wgOut );
187			}
188
189			}
190
191			/**
192			* Initialise some parameters that might be changed by subclasses
193			* (e.g. $limit). Method can be overwritten in this case.
194			* If the method returns false, nothing will be printed besides
195			* the original article.
196			*
197			* @return true
198			*/
199			protected function initParameters() {
200			$this->limit = 20;
201			return true;
202			}
203
204			/**
205			* Returns the HTML which is added to $wgOut after the article text.
206			*
207			* @return string
208			*/
209			protected abstract function getHtml();
			0 ignored issues – show Coding Style introduced 2015-11-23 10:29 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
210
211			/**
212			* Like Article's getTitle(), but returning a suitable SMWDIWikiPage.
213			*
214			* @since 1.6
215			*
216			* @return SMWDIWikiPage
217			*/
218			protected function getDataItem() {
219			return SMWDIWikiPage::newFromTitle( $this->getTitle() );
220			}
221
222			}
223

SemanticMediaWiki / SemanticMediaWiki

Push — master ( 0a23e6...45ce5f )

SMWOrderedListPage::view() D

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like