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

FormSpecialPage::getForm() B
last analyzed 2016-11-13 17:42 UTC

↳ Parent: FormSpecialPage

Complexity

Conditions	4
Paths	8

Size

Total Lines	34
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	21
nc	8
nop	0
dl	0
loc	34
rs	8.5806
c	0
b	0
f	0

<?php
/**
 * Special page which uses an HTMLForm to handle processing.
 *
 * 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
 */

/**
 * Special page which uses an HTMLForm to handle processing.  This is mostly a
 * clone of FormAction.  More special pages should be built this way; maybe this could be
 * a new structure for SpecialPages.
 *
 * @ingroup SpecialPage
 */
abstract class FormSpecialPage extends SpecialPage {
	/**
	 * The sub-page of the special page.
	 * @var string
	 */
	protected $par = null;

	/**
	 * Get an HTMLForm descriptor array
	 * @return array
	 */
	abstract protected function getFormFields();

	/**
	 * Add pre-text to the form
	 * @return string HTML which will be sent to $form->addPreText()
	 */
	protected function preText() {
		return '';
	}

	/**
	 * Add post-text to the form
	 * @return string HTML which will be sent to $form->addPostText()
	 */
	protected function postText() {
		return '';
	}

	/**
	 * Play with the HTMLForm if you need to more substantially
	 * @param HTMLForm $form
	 */
	protected function alterForm( HTMLForm $form ) {
	}

	/**
	 * Get message prefix for HTMLForm
	 *
	 * @since 1.21
	 * @return string
	 */
	protected function getMessagePrefix() {
		return strtolower( $this->getName() );
	}

	/**
	 * Get display format for the form. See HTMLForm documentation for available values.
	 *
	 * @since 1.25
	 * @return string
	 */
	protected function getDisplayFormat() {
		return 'table';
	}

	/**
	 * Get the HTMLForm to control behavior
	 * @return HTMLForm|null
	 */
	protected function getForm() {
		$form = HTMLForm::factory(
			$this->getDisplayFormat(),
			$this->getFormFields(),
			$this->getContext(),
			$this->getMessagePrefix()
		);
		$form->setSubmitCallback( [ $this, 'onSubmit' ] );
		if ( $this->getDisplayFormat() !== 'ooui' ) {
			// No legend and wrapper by default in OOUI forms, but can be set manually
			// from alterForm()
			$form->setWrapperLegendMsg( $this->getMessagePrefix() . '-legend' );
		}

		$headerMsg = $this->msg( $this->getMessagePrefix() . '-text' );
		if ( !$headerMsg->isDisabled() ) {
			$form->addHeaderText( $headerMsg->parseAsBlock() );
		}

		$form->addPreText( $this->preText() );
		$form->addPostText( $this->postText() );
		$this->alterForm( $form );
		if ( $form->getMethod() == 'post' ) {
			// Retain query parameters (uselang etc) on POST requests
			$params = array_diff_key(
				$this->getRequest()->getQueryValues(), [ 'title' => null ] );
			$form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
		}

		// Give hooks a chance to alter the form, adding extra fields or text etc
		Hooks::run( 'SpecialPageBeforeFormDisplay', [ $this->getName(), &$form ] );

		return $form;
	}

	/**
	 * Process the form on POST submission.
	 * @param array $data
	 * @param HTMLForm $form
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return bool|string|array|Status As documented for HTMLForm::trySubmit.
	 */
	abstract public function onSubmit( array $data /* $form = null */ );

	/**
	 * Do something exciting on successful processing of the form, most likely to show a
	 * confirmation message
	 * @since 1.22 Default is to do nothing
	 */
	public function onSuccess() {
	}

	/**
	 * Basic SpecialPage workflow: get a form, send it to the user; get some data back,
	 *
	 * @param string $par Subpage string if one was specified
	 */
	public function execute( $par ) {
		$this->setParameter( $par );
		$this->setHeaders();

		// This will throw exceptions if there's a problem
		$this->checkExecutePermissions( $this->getUser() );

		$form = $this->getForm();
		if ( $form->show() ) {
			$this->onSuccess();
		}
	}

	/**
	 * Maybe do something interesting with the subpage parameter
	 * @param string $par
	 */
	protected function setParameter( $par ) {
		$this->par = $par;
	}

	/**
	 * Called from execute() to check if the given user can perform this action.
	 * Failures here must throw subclasses of ErrorPageError.
	 * @param User $user
	 * @throws UserBlockedError
	 */
	protected function checkExecutePermissions( User $user ) {
		$this->checkPermissions();

		if ( $this->requiresUnblock() && $user->isBlocked() ) {
			$block = $user->getBlock();
			throw new UserBlockedError( $block );
/** @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);
    }
}
		}

		if ( $this->requiresWrite() ) {
			$this->checkReadOnly();
		}
	}

	/**
	 * Whether this action requires the wiki not to be locked
	 * @return bool
	 */
	public function requiresWrite() {
		return true;
	}

	/**
	 * Whether this action cannot be executed by a blocked user
	 * @return bool
	 */
	public function requiresUnblock() {
		return true;
	}
}


1			<?php
2			/**
3			* Special page which uses an HTMLForm to handle processing.
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			* @ingroup SpecialPage
22			*/
23
24			/**
25			* Special page which uses an HTMLForm to handle processing. This is mostly a
26			* clone of FormAction. More special pages should be built this way; maybe this could be
27			* a new structure for SpecialPages.
28			*
29			* @ingroup SpecialPage
30			*/
31			abstract class FormSpecialPage extends SpecialPage {
32			/**
33			* The sub-page of the special page.
34			* @var string
35			*/
36			protected $par = null;
37
38			/**
39			* Get an HTMLForm descriptor array
40			* @return array
41			*/
42			abstract protected function getFormFields();
43
44			/**
45			* Add pre-text to the form
46			* @return string HTML which will be sent to $form->addPreText()
47			*/
48			protected function preText() {
49			return '';
50			}
51
52			/**
53			* Add post-text to the form
54			* @return string HTML which will be sent to $form->addPostText()
55			*/
56			protected function postText() {
57			return '';
58			}
59
60			/**
61			* Play with the HTMLForm if you need to more substantially
62			* @param HTMLForm $form
63			*/
64			protected function alterForm( HTMLForm $form ) {
65			}
66
67			/**
68			* Get message prefix for HTMLForm
69			*
70			* @since 1.21
71			* @return string
72			*/
73			protected function getMessagePrefix() {
74			return strtolower( $this->getName() );
75			}
76
77			/**
78			* Get display format for the form. See HTMLForm documentation for available values.
79			*
80			* @since 1.25
81			* @return string
82			*/
83			protected function getDisplayFormat() {
84			return 'table';
85			}
86
87			/**
88			* Get the HTMLForm to control behavior
89			* @return HTMLForm\|null
90			*/
91			protected function getForm() {
92			$form = HTMLForm::factory(
93			$this->getDisplayFormat(),
94			$this->getFormFields(),
95			$this->getContext(),
96			$this->getMessagePrefix()
97			);
98			$form->setSubmitCallback( [ $this, 'onSubmit' ] );
99			if ( $this->getDisplayFormat() !== 'ooui' ) {
100			// No legend and wrapper by default in OOUI forms, but can be set manually
101			// from alterForm()
102			$form->setWrapperLegendMsg( $this->getMessagePrefix() . '-legend' );
103			}
104
105			$headerMsg = $this->msg( $this->getMessagePrefix() . '-text' );
106			if ( !$headerMsg->isDisabled() ) {
107			$form->addHeaderText( $headerMsg->parseAsBlock() );
108			}
109
110			$form->addPreText( $this->preText() );
111			$form->addPostText( $this->postText() );
112			$this->alterForm( $form );
113			if ( $form->getMethod() == 'post' ) {
114			// Retain query parameters (uselang etc) on POST requests
115			$params = array_diff_key(
116			$this->getRequest()->getQueryValues(), [ 'title' => null ] );
117			$form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
118			}
119
120			// Give hooks a chance to alter the form, adding extra fields or text etc
121			Hooks::run( 'SpecialPageBeforeFormDisplay', [ $this->getName(), &$form ] );
122
123			return $form;
124			}
125
126			/**
127			* Process the form on POST submission.
128			* @param array $data
129			* @param HTMLForm $form
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report There is no parameter named `$form`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
130			* @return bool\|string\|array\|Status As documented for HTMLForm::trySubmit.
131			*/
132			abstract public function onSubmit( array $data /* $form = null */ );
133
134			/**
135			* Do something exciting on successful processing of the form, most likely to show a
136			* confirmation message
137			* @since 1.22 Default is to do nothing
138			*/
139			public function onSuccess() {
140			}
141
142			/**
143			* Basic SpecialPage workflow: get a form, send it to the user; get some data back,
144			*
145			* @param string $par Subpage string if one was specified
146			*/
147			public function execute( $par ) {
148			$this->setParameter( $par );
149			$this->setHeaders();
150
151			// This will throw exceptions if there's a problem
152			$this->checkExecutePermissions( $this->getUser() );
153
154			$form = $this->getForm();
155			if ( $form->show() ) {
156			$this->onSuccess();
157			}
158			}
159
160			/**
161			* Maybe do something interesting with the subpage parameter
162			* @param string $par
163			*/
164			protected function setParameter( $par ) {
165			$this->par = $par;
166			}
167
168			/**
169			* Called from execute() to check if the given user can perform this action.
170			* Failures here must throw subclasses of ErrorPageError.
171			* @param User $user
172			* @throws UserBlockedError
173			*/
174			protected function checkExecutePermissions( User $user ) {
175			$this->checkPermissions();
176
177			if ( $this->requiresUnblock() && $user->isBlocked() ) {
178			$block = $user->getBlock();
179			throw new UserBlockedError( $block );
			0 ignored issues – show Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report It seems like `$block` defined by `$user->getBlock()` on line `178` can be `null`; however, `UserBlockedError::__construct()` 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...
180			}
181
182			if ( $this->requiresWrite() ) {
183			$this->checkReadOnly();
184			}
185			}
186
187			/**
188			* Whether this action requires the wiki not to be locked
189			* @return bool
190			*/
191			public function requiresWrite() {
192			return true;
193			}
194
195			/**
196			* Whether this action cannot be executed by a blocked user
197			* @return bool
198			*/
199			public function requiresUnblock() {
200			return true;
201			}
202			}
203

wikimedia / mediawiki

FormSpecialPage::getForm() B last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FormSpecialPage::getForm() B
last analyzed 2016-11-13 17:42 UTC