BaseInput - Code Metrics - Inspection of "7.0.0" - yikesinc/yikes-inc-easy-mailchimp-extender - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — staging (#840)

unknown

created 2019-12-11 15:51 UTC

BaseInput A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	149
Duplicated Lines	10.07 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	15
loc	149
rs	10
c	0
b	0
f	0
wmc	17
lcom	1
cbo	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	get_type()	0	3	1
A	get_placeholder()	0	3	1
A	field_classes()	0	3	1
A	label_classes()	0	3	1
A	get_name()	0	3	1
A	get_id()	0	3	1
A	get_value()	0	3	1
A	set_description()	0	5	1
B	render()	15	45	8

How to fix Duplicated Code

<?php
/**
 * YIKES Inc. Easy Mailchimp Forms Plugin.
 *
 * @package YIKES\EasyForms
 * @author  Freddie Mixell
 * @license GPL2
 */

namespace YIKES\EasyForms\Field;

use YIKES\EasyForms\Exception\MustExtend;

/**
 * Class BaseInput
 *
 * @since   %VERSION%
 * @package YIKES\EasyForms
 */
class BaseInput extends BaseField {

	/**
	 * Field ID.
	 *
	 * @var string
	 */
	private $field_id;

	/**
	 * Field's classes
	 *
	 * @var array
	 */
	private $classes = [];

	/**
	 * Field placeholder.
	 *
	 * @var string
	 */
	private $placeholder;

	/**
	 * Field name.
	 *
	 * @var string
	 */
	private $name;

	/**
	 * Field value.
	 *
	 * @var string
	 */
	private $value;

	/**
	 * Construct Field
	 *
	 * @param string $id          Fields ID.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param array  $classes     Field and label classes.
	 * @param string $placeholder Fields placeholder.
	 * @param string $name        Field name.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 */
	public function __construct( $classes, $placeholder, $label, $value, $description, $merge, $form_id, $hidden ) {
		$this->classes     = $classes;
		$this->placeholder = $placeholder;
		$this->label       = $label;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->value       = $value;
		$this->description = $this->set_description( $description );
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->merge       = $merge;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->form_id     = $form_id;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->hidden      = $hidden;
class MyClass { }

$x = new MyClass();
$x->foo = true;
	}

	const TYPE     = 'text';
	const REQUIRED = false;

	/**
	 * Get Field Type
	 *
	 * @return string $field['type']
	 */
	public function get_type() {
		return static::TYPE;
	}

	public function get_placeholder() {
		return $this->placeholder;
	}

	public function field_classes() {
		return $this->classes['field_classes'];
	}

	public function label_classes() {
		return $this->classes['label_classes'];
	}

	public function get_name() {
		return $this->merge;
	}

	public function get_id() {
        return 'yikes-easy-mc-form-' . $this->form_id . '-' . $this->merge;
    }

	public function get_value() {
		return $this->value;
	}

	public function set_description( $description ) {
		$this->show_desc   = $description['show_description'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->desc_above  = $description['description_above'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->description = $description['description'];
	}

	/**
	 * Render the field.
	 *
	 * @since %VERSION%
	 */
	public function render() {
		?>
		<label for="<?= esc_attr( $this->get_id() ); ?>" class="<?= esc_html( implode( ' ' , $this->label_classes() ) ); ?>" <?= esc_html( implode( ' ' , $this->label['props'] ) ); ?> >

		<!-- dictate label visibility -->
		<?php if ( ! isset( $this->label['hide-label'] ) ) { ?>
			<span class="<?= esc_attr( $this->merge ) . '-label'; ?>">
				<?= esc_html( apply_filters( 'yikes-mailchimp-'. $this->merge .'-label' , esc_attr( $this->label['value'] ), $this->form_id ) ); ?>
			</span>
		<?php }

		if ( $this->show_desc === true && $this->desc_above === true ) :

		?>

        <p class="form-field-description" id="form-field-description-<?= esc_attr( $this->merge ); ?>">
			<?= esc_html( apply_filters( 'yikes-mailchimp-' . $this->merge . '-description', $this->description, $this->form_id ) ); ?>
		</p>

        <?php
        endif;
		?>
		<input type="<?= esc_attr( $this->get_type() ); ?>"
			class="<?= esc_attr( implode( ' ' , $this->field_classes() ) ); ?>"
			name="<?= esc_attr( $this->get_name() ); ?>"
			placeholder="<?= esc_attr( $this->get_placeholder() ); ?>"
			id="<?= esc_attr( $this->get_id() ); ?>"
			value="<?= esc_attr( $this->get_value() ); ?>"
			<?php if ( true === static::REQUIRED ) : ?>
			required="required"
			<?php endif; ?>
			<?php if ( true === $this->hidden ) : ?>
			style="display:none;"
			<?php endif; ?>
		/>
		<?php
		if ( $this->show_desc === true && $this->desc_above === false ) {

			$desc_value = apply_filters( 'yikes-mailchimp-' . $this->merge . '-description', $this->description, $this->form_id );
		?>
            <p class="form-field-description" id="form-field-description-<?= esc_attr( $this->merge ); ?>"><?=  esc_html( $desc_value ); ?></p>
        <?php
		}
		?>
		</label>
		<?php
	}
}


1		<?php
2		/**
3		* YIKES Inc. Easy Mailchimp Forms Plugin.
4		*
5		* @package YIKES\EasyForms
6		* @author Freddie Mixell
7		* @license GPL2
8		*/
9
10		namespace YIKES\EasyForms\Field;
11
12		use YIKES\EasyForms\Exception\MustExtend;
13
14		/**
15		* Class BaseInput
16		*
17		* @since %VERSION%
18		* @package YIKES\EasyForms
19		*/
20		class BaseInput extends BaseField {
21
22		/**
23		* Field ID.
24		*
25		* @var string
26		*/
27		private $field_id;
28
29		/**
30		* Field's classes
31		*
32		* @var array
33		*/
34		private $classes = [];
35
36		/**
37		* Field placeholder.
38		*
39		* @var string
40		*/
41		private $placeholder;
42
43		/**
44		* Field name.
45		*
46		* @var string
47		*/
48		private $name;
49
50		/**
51		* Field value.
52		*
53		* @var string
54		*/
55		private $value;
56
57		/**
58		* Construct Field
59		*
60		* @param string $id Fields ID.
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report There is no parameter named `$id`. 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...
61		* @param array $classes Field and label classes.
62		* @param string $placeholder Fields placeholder.
63		* @param string $name Field name.
		0 ignored issues – show Bug introduced 2019-12-11 16:07 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. 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...
64		*/
65		public function __construct( $classes, $placeholder, $label, $value, $description, $merge, $form_id, $hidden ) {
66		$this->classes = $classes;
67		$this->placeholder = $placeholder;
68		$this->label = $label;
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The property `label` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
69		$this->value = $value;
70		$this->description = $this->set_description( $description );
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The property `description` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$this->description` is correct as `$this->set_description($description)` (which targets `YIKES\EasyForms\Field\BaseInput::set_description()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
71		$this->merge = $merge;
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The property `merge` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
72		$this->form_id = $form_id;
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The property `form_id` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
73		$this->hidden = $hidden;
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The property `hidden` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
74		}
75
76		const TYPE = 'text';
77		const REQUIRED = false;
78
79		/**
80		* Get Field Type
81		*
82		* @return string $field['type']
83		*/
84		public function get_type() {
85		return static::TYPE;
86		}
87
88		public function get_placeholder() {
89		return $this->placeholder;
90		}
91
92		public function field_classes() {
93		return $this->classes['field_classes'];
94		}
95
96		public function label_classes() {
97		return $this->classes['label_classes'];
98		}
99
100		public function get_name() {
101		return $this->merge;
102		}
103
104		public function get_id() {
105		return 'yikes-easy-mc-form-' . $this->form_id . '-' . $this->merge;
106		}
107
108		public function get_value() {
109		return $this->value;
110		}
111
112		public function set_description( $description ) {
113		$this->show_desc = $description['show_description'];
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The property `show_desc` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
114		$this->desc_above = $description['description_above'];
		0 ignored issues – show Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The property `desc_above` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
115		$this->description = $description['description'];
116		}
117
118		/**
119		* Render the field.
120		*
121		* @since %VERSION%
122		*/
123		public function render() {
124		?>
125		<label for="<?= esc_attr( $this->get_id() ); ?>" class="<?= esc_html( implode( ' ' , $this->label_classes() ) ); ?>" <?= esc_html( implode( ' ' , $this->label['props'] ) ); ?> >
126
127		<!-- dictate label visibility -->
128		<?php if ( ! isset( $this->label['hide-label'] ) ) { ?>
129		<span class="<?= esc_attr( $this->merge ) . '-label'; ?>">
130		<?= esc_html( apply_filters( 'yikes-mailchimp-'. $this->merge .'-label' , esc_attr( $this->label['value'] ), $this->form_id ) ); ?>
131		</span>
132		<?php }
133
134	View Code Duplication	if ( $this->show_desc === true && $this->desc_above === true ) :
		0 ignored issues – show Duplication introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
135		?>
136
137		<p class="form-field-description" id="form-field-description-<?= esc_attr( $this->merge ); ?>">
138		<?= esc_html( apply_filters( 'yikes-mailchimp-' . $this->merge . '-description', $this->description, $this->form_id ) ); ?>
139		</p>
140
141		<?php
142		endif;
143		?>
144		<input type="<?= esc_attr( $this->get_type() ); ?>"
145		class="<?= esc_attr( implode( ' ' , $this->field_classes() ) ); ?>"
146		name="<?= esc_attr( $this->get_name() ); ?>"
147		placeholder="<?= esc_attr( $this->get_placeholder() ); ?>"
148		id="<?= esc_attr( $this->get_id() ); ?>"
149		value="<?= esc_attr( $this->get_value() ); ?>"
150		<?php if ( true === static::REQUIRED ) : ?>
151		required="required"
152		<?php endif; ?>
153		<?php if ( true === $this->hidden ) : ?>
154		style="display:none;"
155		<?php endif; ?>
156		/>
157		<?php
158	View Code Duplication	if ( $this->show_desc === true && $this->desc_above === false ) {
		0 ignored issues – show Duplication introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
159		$desc_value = apply_filters( 'yikes-mailchimp-' . $this->merge . '-description', $this->description, $this->form_id );
160		?>
161		<p class="form-field-description" id="form-field-description-<?= esc_attr( $this->merge ); ?>"><?= esc_html( $desc_value ); ?></p>
162		<?php
163		}
164		?>
165		</label>
166		<?php
167		}
168		}
169

yikesinc / yikes-inc-easy-mailchimp-extender

Pull Request — staging (#840)

BaseInput A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like