OOUIHTMLForm::wrapForm() - Code Metrics - Inspection of "Daily Inspection: Merge "SessionManager: Add provi..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (7440f2)

unknown

created 2016-05-03 17:22 UTC

OOUIHTMLForm::wrapForm() A

↳ Parent: OOUIHTMLForm

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	17
rs	9.4285
cc	1
eloc	11
nc	1
nop	1

<?php

/**
 * HTML form generation and submission handling, OOUI style.
 *
 * 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
 */

/**
 * Compact stacked vertical format for forms, implemented using OOUI widgets.
 */
class OOUIHTMLForm extends HTMLForm {
	private $oouiErrors;

	public function __construct( $descriptor, $context = null, $messagePrefix = '' ) {
		parent::__construct( $descriptor, $context, $messagePrefix );
		$this->getOutput()->enableOOUI();
		$this->getOutput()->addModuleStyles( 'mediawiki.htmlform.ooui.styles' );
	}

	/**
	 * Symbolic display format name.
	 * @var string
	 */
	protected $displayFormat = 'ooui';

	public static function loadInputFromParameters( $fieldname, $descriptor,
		HTMLForm $parent = null
	) {
		$field = parent::loadInputFromParameters( $fieldname, $descriptor, $parent );
		$field->setShowEmptyLabel( false );
		return $field;
	}

	function getButtons() {
		$buttons = '';

		// IE<8 has bugs with <button>, so we'll need to avoid them.
		$isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );

		if ( $this->mShowSubmit ) {
			$attribs = [ 'infusable' => true ];

			if ( isset( $this->mSubmitID ) ) {
				$attribs['id'] = $this->mSubmitID;
			}

			if ( isset( $this->mSubmitName ) ) {
				$attribs['name'] = $this->mSubmitName;
			}

			if ( isset( $this->mSubmitTooltip ) ) {
				$attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
			}

			$attribs['classes'] = [ 'mw-htmlform-submit' ];
			$attribs['type'] = 'submit';
			$attribs['label'] = $this->getSubmitText();
			$attribs['value'] = $this->getSubmitText();
			$attribs['flags'] = $this->mSubmitFlags;
			$attribs['useInputTag'] = $isBadIE;

			$buttons .= new OOUI\ButtonInputWidget( $attribs );
		}

		if ( $this->mShowReset ) {
			$buttons .= new OOUI\ButtonInputWidget( [
				'type' => 'reset',
				'label' => $this->msg( 'htmlform-reset' )->text(),
				'useInputTag' => $isBadIE,
			] );
		}

		foreach ( $this->mButtons as $button ) {
			$attrs = [];

			if ( $button['attribs'] ) {
				$attrs += $button['attribs'];
			}

			if ( isset( $button['id'] ) ) {
				$attrs['id'] = $button['id'];
			}

			if ( $isBadIE ) {
				$label = $button['value'];
			} elseif ( isset( $button['label-message'] ) ) {
				$label = new OOUI\HtmlSnippet( $this->getMessage( $button['label-message'] )->parse() );
			} elseif ( isset( $button['label'] ) ) {
				$label = $button['label'];
			} elseif ( isset( $button['label-raw'] ) ) {
				$label = new OOUI\HtmlSnippet( $button['label-raw'] );
			} else {
				$label = $button['value'];
			}

			$attrs['classes'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];

			$buttons .= new OOUI\ButtonInputWidget( [
				'type' => 'submit',
				'name' => $button['name'],
				'value' => $button['value'],
				'label' => $label,
				'flags' => $button['flags'],
				'useInputTag' => $isBadIE,
			] + $attrs );
		}

		if ( !$buttons ) {
			return '';
		}

		return Html::rawElement( 'div',
			[ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
	}

	protected function wrapFieldSetSection( $legend, $section, $attributes ) {
		// to get a user visible effect, wrap the fieldset into a framed panel layout
		$layout = new OOUI\PanelLayout( [
			'expanded' => false,
			'padded' => true,
			'framed' => true,
			'infusable' => false,
		] );

		$layout->appendContent(
			new OOUI\FieldsetLayout( [
				'label' => $legend,
				'infusable' => false,
				'items' => [
					new OOUI\Widget( [
						'content' => new OOUI\HtmlSnippet( $section )
					] ),
				],
			] + $attributes )
		);
		return $layout;
	}

	/**
	 * Put a form section together from the individual fields' HTML, merging it and wrapping.
	 * @param OOUI\FieldLayout[] $fieldsHtml
	 * @param string $sectionName
	 * @param bool $anyFieldHasLabel Unused
	 * @return string HTML
	 */
	protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
		$config = [
			'items' => $fieldsHtml,
		];
		if ( $sectionName ) {
			$config['id'] = Sanitizer::escapeId( $sectionName );
		}
		if ( is_string( $this->mWrapperLegend ) ) {
			$config['label'] = $this->mWrapperLegend;
		}
		return new OOUI\FieldsetLayout( $config );
	}

	/**
	 * @param string|array|Status $err
	 * @return string
	 */
	function getErrors( $err ) {
		if ( !$err ) {
			$errors = [];
		} elseif ( $err instanceof Status ) {
			if ( $err->isOK() ) {
				$errors = [];
			} else {
				$errors = $err->getErrorsByType( 'error' );
				foreach ( $errors as &$error ) {
					// Input:  array( 'message' => 'foo', 'errors' => array( 'a', 'b', 'c' ) )
					// Output: array( 'foo', 'a', 'b', 'c' )
					$error = array_merge( [ $error['message'] ], $error['params'] );
				}
			}
		} else {
			$errors = $err;
			if ( !is_array( $errors ) ) {
				$errors = [ $errors ];
			}
		}

		foreach ( $errors as &$error ) {
			$error = $this->getMessage( $error )->parse();
			$error = new OOUI\HtmlSnippet( $error );
		}

		// Used in getBody()
		$this->oouiErrors = $errors;
		return '';
	}

	function getHeaderText( $section = null ) {
		if ( is_null( $section ) ) {
			// We handle $this->mHeader elsewhere, in getBody()
			return '';
		} else {
			return parent::getHeaderText( $section );
		}
	}

	function getBody() {
		$fieldset = parent::getBody();
		// FIXME This only works for forms with no subsections
		if ( $fieldset instanceof OOUI\FieldsetLayout ) {
			$classes = [ 'mw-htmlform-ooui-header' ];
			if ( !$this->mHeader ) {
				$classes[] = 'mw-htmlform-ooui-header-empty';
			}
			if ( $this->oouiErrors ) {
				$classes[] = 'mw-htmlform-ooui-header-errors';
			}
			$fieldset->addItems( [
				new OOUI\FieldLayout(
					new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet( $this->mHeader ) ] ),
					[
						'align' => 'top',
						'errors' => $this->oouiErrors,
						'classes' => $classes,
					]
				)
			], 0 );
		}
		return $fieldset;
	}

	function wrapForm( $html ) {
		$form = new OOUI\FormLayout( $this->getFormAttributes() + [
			'classes' => [ 'mw-htmlform-ooui' ],
			'content' => new OOUI\HtmlSnippet( $html ),
		] );

		// Include a wrapper for style, if requested.
		$form = new OOUI\PanelLayout( [
			'classes' => [ 'mw-htmlform-ooui-wrapper' ],
			'expanded' => false,
			'padded' => $this->mWrapperLegend !== false,
			'framed' => $this->mWrapperLegend !== false,
			'content' => $form,
		] );

		return $form;
	}
}


1		<?php
2
3		/**
4		* HTML form generation and submission handling, OOUI style.
5		*
6		* This program is free software; you can redistribute it and/or modify
7		* it under the terms of the GNU General Public License as published by
8		* the Free Software Foundation; either version 2 of the License, or
9		* (at your option) any later version.
10		*
11		* This program is distributed in the hope that it will be useful,
12		* but WITHOUT ANY WARRANTY; without even the implied warranty of
13		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14		* GNU General Public License for more details.
15		*
16		* You should have received a copy of the GNU General Public License along
17		* with this program; if not, write to the Free Software Foundation, Inc.,
18		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19		* http://www.gnu.org/copyleft/gpl.html
20		*
21		* @file
22		*/
23
24		/**
25		* Compact stacked vertical format for forms, implemented using OOUI widgets.
26		*/
27		class OOUIHTMLForm extends HTMLForm {
28		private $oouiErrors;
29
30		public function __construct( $descriptor, $context = null, $messagePrefix = '' ) {
31		parent::__construct( $descriptor, $context, $messagePrefix );
32		$this->getOutput()->enableOOUI();
33		$this->getOutput()->addModuleStyles( 'mediawiki.htmlform.ooui.styles' );
34		}
35
36		/**
37		* Symbolic display format name.
38		* @var string
39		*/
40		protected $displayFormat = 'ooui';
41
42	View Code Duplication	public static function loadInputFromParameters( $fieldname, $descriptor,
43		HTMLForm $parent = null
44		) {
45		$field = parent::loadInputFromParameters( $fieldname, $descriptor, $parent );
46		$field->setShowEmptyLabel( false );
47		return $field;
48		}
49
50		function getButtons() {
51		$buttons = '';
52
53		// IE<8 has bugs with <button>, so we'll need to avoid them.
54		$isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
55
56		if ( $this->mShowSubmit ) {
57		$attribs = [ 'infusable' => true ];
58
59		if ( isset( $this->mSubmitID ) ) {
60		$attribs['id'] = $this->mSubmitID;
61		}
62
63		if ( isset( $this->mSubmitName ) ) {
64		$attribs['name'] = $this->mSubmitName;
65		}
66
67		if ( isset( $this->mSubmitTooltip ) ) {
68		$attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
69		}
70
71		$attribs['classes'] = [ 'mw-htmlform-submit' ];
72		$attribs['type'] = 'submit';
73		$attribs['label'] = $this->getSubmitText();
74		$attribs['value'] = $this->getSubmitText();
75		$attribs['flags'] = $this->mSubmitFlags;
76		$attribs['useInputTag'] = $isBadIE;
77
78		$buttons .= new OOUI\ButtonInputWidget( $attribs );
79		}
80
81		if ( $this->mShowReset ) {
82		$buttons .= new OOUI\ButtonInputWidget( [
83		'type' => 'reset',
84		'label' => $this->msg( 'htmlform-reset' )->text(),
85		'useInputTag' => $isBadIE,
86		] );
87		}
88
89		foreach ( $this->mButtons as $button ) {
90		$attrs = [];
91
92		if ( $button['attribs'] ) {
93		$attrs += $button['attribs'];
94		}
95
96		if ( isset( $button['id'] ) ) {
97		$attrs['id'] = $button['id'];
98		}
99
100		if ( $isBadIE ) {
101		$label = $button['value'];
102		} elseif ( isset( $button['label-message'] ) ) {
103		$label = new OOUI\HtmlSnippet( $this->getMessage( $button['label-message'] )->parse() );
104		} elseif ( isset( $button['label'] ) ) {
105		$label = $button['label'];
106		} elseif ( isset( $button['label-raw'] ) ) {
107		$label = new OOUI\HtmlSnippet( $button['label-raw'] );
108		} else {
109		$label = $button['value'];
110		}
111
112		$attrs['classes'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
113
114		$buttons .= new OOUI\ButtonInputWidget( [
115		'type' => 'submit',
116		'name' => $button['name'],
117		'value' => $button['value'],
118		'label' => $label,
119		'flags' => $button['flags'],
120		'useInputTag' => $isBadIE,
121		] + $attrs );
122		}
123
124		if ( !$buttons ) {
125		return '';
126		}
127
128		return Html::rawElement( 'div',
129		[ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
130		}
131
132		protected function wrapFieldSetSection( $legend, $section, $attributes ) {
133		// to get a user visible effect, wrap the fieldset into a framed panel layout
134		$layout = new OOUI\PanelLayout( [
135		'expanded' => false,
136		'padded' => true,
137		'framed' => true,
138		'infusable' => false,
139		] );
140
141		$layout->appendContent(
142		new OOUI\FieldsetLayout( [
143		'label' => $legend,
144		'infusable' => false,
145		'items' => [
146		new OOUI\Widget( [
147		'content' => new OOUI\HtmlSnippet( $section )
148		] ),
149		],
150		] + $attributes )
151		);
152		return $layout;
153		}
154
155		/**
156		* Put a form section together from the individual fields' HTML, merging it and wrapping.
157		* @param OOUI\FieldLayout[] $fieldsHtml
158		* @param string $sectionName
159		* @param bool $anyFieldHasLabel Unused
160		* @return string HTML
161		*/
162		protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
163		$config = [
164		'items' => $fieldsHtml,
165		];
166		if ( $sectionName ) {
167		$config['id'] = Sanitizer::escapeId( $sectionName );
168		}
169		if ( is_string( $this->mWrapperLegend ) ) {
170		$config['label'] = $this->mWrapperLegend;
171		}
172		return new OOUI\FieldsetLayout( $config );
173		}
174
175		/**
176		* @param string\|array\|Status $err
177		* @return string
178		*/
179		function getErrors( $err ) {
180		if ( !$err ) {
181		$errors = [];
182		} elseif ( $err instanceof Status ) {
183		if ( $err->isOK() ) {
184		$errors = [];
185		} else {
186		$errors = $err->getErrorsByType( 'error' );
187		foreach ( $errors as &$error ) {
188		// Input: array( 'message' => 'foo', 'errors' => array( 'a', 'b', 'c' ) )
189		// Output: array( 'foo', 'a', 'b', 'c' )
190		$error = array_merge( [ $error['message'] ], $error['params'] );
191		}
192		}
193		} else {
194		$errors = $err;
195		if ( !is_array( $errors ) ) {
196		$errors = [ $errors ];
197		}
198		}
199
200		foreach ( $errors as &$error ) {
201		$error = $this->getMessage( $error )->parse();
202		$error = new OOUI\HtmlSnippet( $error );
203		}
204
205		// Used in getBody()
206		$this->oouiErrors = $errors;
207		return '';
208		}
209
210		function getHeaderText( $section = null ) {
211		if ( is_null( $section ) ) {
212		// We handle $this->mHeader elsewhere, in getBody()
213		return '';
214		} else {
215		return parent::getHeaderText( $section );
216		}
217		}
218
219		function getBody() {
220		$fieldset = parent::getBody();
221		// FIXME This only works for forms with no subsections
222		if ( $fieldset instanceof OOUI\FieldsetLayout ) {
223		$classes = [ 'mw-htmlform-ooui-header' ];
224		if ( !$this->mHeader ) {
225		$classes[] = 'mw-htmlform-ooui-header-empty';
226		}
227		if ( $this->oouiErrors ) {
228		$classes[] = 'mw-htmlform-ooui-header-errors';
229		}
230		$fieldset->addItems( [
231		new OOUI\FieldLayout(
232		new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet( $this->mHeader ) ] ),
233		[
234		'align' => 'top',
235		'errors' => $this->oouiErrors,
236		'classes' => $classes,
237		]
238		)
239		], 0 );
240		}
241		return $fieldset;
242		}
243
244		function wrapForm( $html ) {
245		$form = new OOUI\FormLayout( $this->getFormAttributes() + [
246		'classes' => [ 'mw-htmlform-ooui' ],
247		'content' => new OOUI\HtmlSnippet( $html ),
248		] );
249
250		// Include a wrapper for style, if requested.
251		$form = new OOUI\PanelLayout( [
252		'classes' => [ 'mw-htmlform-ooui-wrapper' ],
253		'expanded' => false,
254		'padded' => $this->mWrapperLegend !== false,
255		'framed' => $this->mWrapperLegend !== false,
256		'content' => $form,
257		] );
258
259		return $form;
260		}
261		}
262

wikimedia / mediawiki

Branch — master (7440f2)

OOUIHTMLForm::wrapForm() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like