HTMLFormElement::initializeHTMLFormElement() - Code Metrics - Inspection of "Daily Inspection: Merge "Tell users that js/css su..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (d7c4e6)

unknown

created 2016-08-23 17:31 UTC

HTMLFormElement::initializeHTMLFormElement() B

↳ Parent: HTMLFormElement

Complexity

Conditions	6
Paths	16

Size

Total Lines	21
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	6
eloc	10
c	2
b	0
f	0
nc	16
nop	1
dl	0
loc	21
rs	8.7624

<?php

/**
 * Allows custom data specific to HTMLFormField to be set for OOjs UI forms. A matching JS widget
 * (defined in htmlform.Element.js) picks up the extra config when constructed using OO.ui.infuse().
 *
 * Currently only supports passing 'hide-if' data.
 */
trait HTMLFormElement {

	protected $hideIf = null;
	protected $modules = null;

	public function initializeHTMLFormElement( array $config = [] ) {
		// Properties
		$this->hideIf = isset( $config['hideIf'] ) ? $config['hideIf'] : null;
		$this->modules = isset( $config['modules'] ) ? $config['modules'] : [];

		// Initialization
		if ( $this->hideIf ) {
			$this->addClasses( [ 'mw-htmlform-hide-if' ] );
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
		}
		if ( $this->modules ) {
			// JS code must be able to read this before infusing (before OOjs UI is even loaded),
			// so we put this in a separate attribute (not with the rest of the config).
			// And it's not needed anymore after infusing, so we don't put it in JS config at all.
			$this->setAttributes( [ 'data-mw-modules' => implode( ',', $this->modules ) ] );
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
		}
		$this->registerConfigCallback( function( &$config ) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
			if ( $this->hideIf !== null ) {
				$config['hideIf'] = $this->hideIf;
			}
		} );
	}
}

class HTMLFormFieldLayout extends OOUI\FieldLayout {
	use HTMLFormElement;

	public function __construct( $fieldWidget, array $config = [] ) {
		// Parent constructor
		parent::__construct( $fieldWidget, $config );
		// Traits
		$this->initializeHTMLFormElement( $config );
	}

	protected function getJavaScriptClassName() {
		return 'mw.htmlform.FieldLayout';
	}
}

class HTMLFormActionFieldLayout extends OOUI\ActionFieldLayout {
	use HTMLFormElement;

	public function __construct( $fieldWidget, $buttonWidget = false, array $config = [] ) {
		// Parent constructor
		parent::__construct( $fieldWidget, $buttonWidget, $config );
		// Traits
		$this->initializeHTMLFormElement( $config );
	}

	protected function getJavaScriptClassName() {
		return 'mw.htmlform.ActionFieldLayout';
	}
}


1			<?php
2
3			/**
4			* Allows custom data specific to HTMLFormField to be set for OOjs UI forms. A matching JS widget
5			* (defined in htmlform.Element.js) picks up the extra config when constructed using OO.ui.infuse().
6			*
7			* Currently only supports passing 'hide-if' data.
8			*/
9			trait HTMLFormElement {
10
11			protected $hideIf = null;
12			protected $modules = null;
13
14			public function initializeHTMLFormElement( array $config = [] ) {
15			// Properties
16			$this->hideIf = isset( $config['hideIf'] ) ? $config['hideIf'] : null;
17			$this->modules = isset( $config['modules'] ) ? $config['modules'] : [];
18
19			// Initialization
20			if ( $this->hideIf ) {
21			$this->addClasses( [ 'mw-htmlform-hide-if' ] );
			0 ignored issues – show Bug introduced 2016-08-22 18:00 UTC by Report Bug Copy Issue Report It seems like `addClasses()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
22			}
23			if ( $this->modules ) {
24			// JS code must be able to read this before infusing (before OOjs UI is even loaded),
25			// so we put this in a separate attribute (not with the rest of the config).
26			// And it's not needed anymore after infusing, so we don't put it in JS config at all.
27			$this->setAttributes( [ 'data-mw-modules' => implode( ',', $this->modules ) ] );
			0 ignored issues – show Bug introduced 2016-08-23 18:00 UTC by Report Bug Copy Issue Report It seems like `setAttributes()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
28			}
29			$this->registerConfigCallback( function( &$config ) {
			0 ignored issues – show Bug introduced 2016-08-22 18:00 UTC by Report Bug Copy Issue Report It seems like `registerConfigCallback()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
30			if ( $this->hideIf !== null ) {
31			$config['hideIf'] = $this->hideIf;
32			}
33			} );
34			}
35			}
36
37			class HTMLFormFieldLayout extends OOUI\FieldLayout {
38			use HTMLFormElement;
39
40			public function __construct( $fieldWidget, array $config = [] ) {
41			// Parent constructor
42			parent::__construct( $fieldWidget, $config );
43			// Traits
44			$this->initializeHTMLFormElement( $config );
45			}
46
47			protected function getJavaScriptClassName() {
48			return 'mw.htmlform.FieldLayout';
49			}
50			}
51
52			class HTMLFormActionFieldLayout extends OOUI\ActionFieldLayout {
53			use HTMLFormElement;
54
55			public function __construct( $fieldWidget, $buttonWidget = false, array $config = [] ) {
56			// Parent constructor
57			parent::__construct( $fieldWidget, $buttonWidget, $config );
58			// Traits
59			$this->initializeHTMLFormElement( $config );
60			}
61
62			protected function getJavaScriptClassName() {
63			return 'mw.htmlform.ActionFieldLayout';
64			}
65			}
66

wikimedia / mediawiki

Branch — master (d7c4e6)

HTMLFormElement::initializeHTMLFormElement() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like