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

SpecialPagesWithProp::isCacheable() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: SpecialPagesWithProp

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Implements Special:PagesWithProp
 *
 * 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
 *
 * @since 1.21
 * @file
 * @ingroup SpecialPage
 * @author Brad Jorsch
 */

/**
 * Special:PagesWithProp to search the page_props table
 * @ingroup SpecialPage
 * @since 1.21
 */
class SpecialPagesWithProp extends QueryPage {
	private $propName = null;
	private $existingPropNames = null;

	function __construct( $name = 'PagesWithProp' ) {
		parent::__construct( $name );
	}

	function isCacheable() {
		return false;
	}

	public function execute( $par ) {
		$this->setHeaders();
		$this->outputHeader();
		$this->getOutput()->addModuleStyles( 'mediawiki.special.pagesWithProp' );

		$request = $this->getRequest();
		$propname = $request->getVal( 'propname', $par );

		$propnames = $this->getExistingPropNames();

		$form = HTMLForm::factory( 'ooui', [
			'propname' => [
				'type' => 'combobox',
				'name' => 'propname',
				'options' => $propnames,
				'default' => $propname,
				'label-message' => 'pageswithprop-prop',
				'required' => true,
			],
		], $this->getContext() );
		$form->setMethod( 'get' );
		$form->setSubmitCallback( [ $this, 'onSubmit' ] );
		$form->setWrapperLegendMsg( 'pageswithprop-legend' );
		$form->addHeaderText( $this->msg( 'pageswithprop-text' )->parseAsBlock() );
		$form->setSubmitTextMsg( 'pageswithprop-submit' );

		$form->prepareForm();
		$form->displayForm( false );
		if ( $propname !== '' && $propname !== null ) {
			$form->trySubmit();
		}
	}

	public function onSubmit( $data, $form ) {
		$this->propName = $data['propname'];
		parent::execute( $data['propname'] );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
	}

	/**
	 * Return an array of subpages beginning with $search that this special page will accept.
	 *
	 * @param string $search Prefix to search for
	 * @param int $limit Maximum number of results to return
	 * @param int $offset Number of pages to skip
	 * @return string[] Matching subpages
	 */
	public function prefixSearchSubpages( $search, $limit, $offset ) {
		$subpages = array_keys( $this->queryExistingProps( $limit, $offset ) );
		// We've already limited and offsetted, set to N and 0 respectively.
		return self::prefixSearchArray( $search, count( $subpages ), $subpages, 0 );
	}

	/**
	 * Disable RSS/Atom feeds
	 * @return bool
	 */
	function isSyndicated() {
		return false;
	}

	public function getQueryInfo() {
		return [
			'tables' => [ 'page_props', 'page' ],
			'fields' => [
				'page_id' => 'pp_page',
				'page_namespace',
				'page_title',
				'page_len',
				'page_is_redirect',
				'page_latest',
				'pp_value',
			],
			'conds' => [
				'pp_propname' => $this->propName,
			],
			'join_conds' => [
				'page' => [ 'INNER JOIN', 'page_id = pp_page' ]
			],
			'options' => []
		];
	}

	function getOrderFields() {
		return [ 'page_id' ];
	}

	/**
	 * @param Skin $skin
	 * @param object $result Result row
	 * @return string
	 */
	function formatResult( $skin, $result ) {
		$title = Title::newFromRow( $result );
		$ret = Linker::link( $title, null, [], [], [ 'known' ] );
		if ( $result->pp_value !== '' ) {
			// Do not show very long or binary values on the special page
			$valueLength = strlen( $result->pp_value );
			$isBinary = strpos( $result->pp_value, "\0" ) !== false;
			$isTooLong = $valueLength > 1024;

			if ( $isBinary || $isTooLong ) {
				$message = $this
					->msg( $isBinary ? 'pageswithprop-prophidden-binary' : 'pageswithprop-prophidden-long' )
					->params( $this->getLanguage()->formatSize( $valueLength ) );

				$propValue = Html::element( 'span', [ 'class' => 'prop-value-hidden' ], $message->text() );
			} else {
				$propValue = Html::element( 'span', [ 'class' => 'prop-value' ], $result->pp_value );
			}

			$ret .= $this->msg( 'colon-separator' )->escaped() . $propValue;
		}

		return $ret;
	}

	public function getExistingPropNames() {
		if ( $this->existingPropNames === null ) {
			$this->existingPropNames = $this->queryExistingProps();
		}
		return $this->existingPropNames;
	}

	protected function queryExistingProps( $limit = null, $offset = 0 ) {
		$opts = [
			'DISTINCT', 'ORDER BY' => 'pp_propname'
		];
		if ( $limit ) {
			$opts['LIMIT'] = $limit;
		}
		if ( $offset ) {
			$opts['OFFSET'] = $offset;
		}

		$res = wfGetDB( DB_REPLICA )->select(
			'page_props',
			'pp_propname',
			'',
			__METHOD__,
			$opts
		);

		$propnames = [];
		foreach ( $res as $row ) {
			$propnames[$row->pp_propname] = $row->pp_propname;
		}

		return $propnames;
	}

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


1			<?php
2			/**
3			* Implements Special:PagesWithProp
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			* @since 1.21
21			* @file
22			* @ingroup SpecialPage
23			* @author Brad Jorsch
24			*/
25
26			/**
27			* Special:PagesWithProp to search the page_props table
28			* @ingroup SpecialPage
29			* @since 1.21
30			*/
31			class SpecialPagesWithProp extends QueryPage {
32			private $propName = null;
33			private $existingPropNames = null;
34
35			function __construct( $name = 'PagesWithProp' ) {
36			parent::__construct( $name );
37			}
38
39			function isCacheable() {
40			return false;
41			}
42
43			public function execute( $par ) {
44			$this->setHeaders();
45			$this->outputHeader();
46			$this->getOutput()->addModuleStyles( 'mediawiki.special.pagesWithProp' );
47
48			$request = $this->getRequest();
49			$propname = $request->getVal( 'propname', $par );
50
51			$propnames = $this->getExistingPropNames();
52
53			$form = HTMLForm::factory( 'ooui', [
54			'propname' => [
55			'type' => 'combobox',
56			'name' => 'propname',
57			'options' => $propnames,
58			'default' => $propname,
59			'label-message' => 'pageswithprop-prop',
60			'required' => true,
61			],
62			], $this->getContext() );
63			$form->setMethod( 'get' );
64			$form->setSubmitCallback( [ $this, 'onSubmit' ] );
65			$form->setWrapperLegendMsg( 'pageswithprop-legend' );
66			$form->addHeaderText( $this->msg( 'pageswithprop-text' )->parseAsBlock() );
67			$form->setSubmitTextMsg( 'pageswithprop-submit' );
68
69			$form->prepareForm();
70			$form->displayForm( false );
71			if ( $propname !== '' && $propname !== null ) {
72			$form->trySubmit();
73			}
74			}
75
76			public function onSubmit( $data, $form ) {
77			$this->propName = $data['propname'];
78			parent::execute( $data['propname'] );
			0 ignored issues – show Comprehensibility Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`execute()` instead of `onSubmit()`). Are you sure this is correct? If so, you might want to change this to `$this->execute()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
79			}
80
81			/**
82			* Return an array of subpages beginning with $search that this special page will accept.
83			*
84			* @param string $search Prefix to search for
85			* @param int $limit Maximum number of results to return
86			* @param int $offset Number of pages to skip
87			* @return string[] Matching subpages
88			*/
89			public function prefixSearchSubpages( $search, $limit, $offset ) {
90			$subpages = array_keys( $this->queryExistingProps( $limit, $offset ) );
91			// We've already limited and offsetted, set to N and 0 respectively.
92			return self::prefixSearchArray( $search, count( $subpages ), $subpages, 0 );
93			}
94
95			/**
96			* Disable RSS/Atom feeds
97			* @return bool
98			*/
99			function isSyndicated() {
100			return false;
101			}
102
103			public function getQueryInfo() {
104			return [
105			'tables' => [ 'page_props', 'page' ],
106			'fields' => [
107			'page_id' => 'pp_page',
108			'page_namespace',
109			'page_title',
110			'page_len',
111			'page_is_redirect',
112			'page_latest',
113			'pp_value',
114			],
115			'conds' => [
116			'pp_propname' => $this->propName,
117			],
118			'join_conds' => [
119			'page' => [ 'INNER JOIN', 'page_id = pp_page' ]
120			],
121			'options' => []
122			];
123			}
124
125			function getOrderFields() {
126			return [ 'page_id' ];
127			}
128
129			/**
130			* @param Skin $skin
131			* @param object $result Result row
132			* @return string
133			*/
134			function formatResult( $skin, $result ) {
135			$title = Title::newFromRow( $result );
136			$ret = Linker::link( $title, null, [], [], [ 'known' ] );
137			if ( $result->pp_value !== '' ) {
138			// Do not show very long or binary values on the special page
139			$valueLength = strlen( $result->pp_value );
140			$isBinary = strpos( $result->pp_value, "\0" ) !== false;
141			$isTooLong = $valueLength > 1024;
142
143			if ( $isBinary \|\| $isTooLong ) {
144			$message = $this
145			->msg( $isBinary ? 'pageswithprop-prophidden-binary' : 'pageswithprop-prophidden-long' )
146			->params( $this->getLanguage()->formatSize( $valueLength ) );
147
148			$propValue = Html::element( 'span', [ 'class' => 'prop-value-hidden' ], $message->text() );
149			} else {
150			$propValue = Html::element( 'span', [ 'class' => 'prop-value' ], $result->pp_value );
151			}
152
153			$ret .= $this->msg( 'colon-separator' )->escaped() . $propValue;
154			}
155
156			return $ret;
157			}
158
159			public function getExistingPropNames() {
160			if ( $this->existingPropNames === null ) {
161			$this->existingPropNames = $this->queryExistingProps();
162			}
163			return $this->existingPropNames;
164			}
165
166			protected function queryExistingProps( $limit = null, $offset = 0 ) {
167			$opts = [
168			'DISTINCT', 'ORDER BY' => 'pp_propname'
169			];
170			if ( $limit ) {
171			$opts['LIMIT'] = $limit;
172			}
173			if ( $offset ) {
174			$opts['OFFSET'] = $offset;
175			}
176
177			$res = wfGetDB( DB_REPLICA )->select(
178			'page_props',
179			'pp_propname',
180			'',
181			__METHOD__,
182			$opts
183			);
184
185			$propnames = [];
186			foreach ( $res as $row ) {
187			$propnames[$row->pp_propname] = $row->pp_propname;
188			}
189
190			return $propnames;
191			}
192
193			protected function getGroupName() {
194			return 'pages';
195			}
196			}
197

wikimedia / mediawiki

SpecialPagesWithProp::isCacheable() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SpecialPagesWithProp::isCacheable() A
last analyzed 2016-11-13 17:42 UTC