Theme_Options_Container - Code Metrics - Inspection of "improve theme options filename sanitization" - htmlburger/carbon-fields - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( aa54dc...7fd09f )

unknown

created 2017-05-22 07:12 UTC

Theme_Options_Container B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	276
Duplicated Lines	2.54 %

Coupling/Cohesion

Components	4
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	7
loc	276
rs	8.295
wmc	42
lcom	4
cbo	3

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	save()	0	13	3
A	title_to_filename()	0	15	1
B	init()	0	15	5
A	is_valid_save()	7	7	3
B	attach()	0	27	2
A	is_active()	0	7	3
A	detach()	0	8	1
A	render()	0	7	3
B	verify_unique_page()	0	23	5
C	drop_unique_page()	0	22	7
A	add_fields()	0	9	2
A	set_page_parent()	0	8	2
A	set_icon()	0	4	1
A	set_page_file()	0	4	1
A	set_page_permissions()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Theme_Options_Container often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Theme_Options_Container, and based on these observations, apply Extract Interface, too.

<?php

namespace Carbon_Fields\Container;

use Carbon_Fields\Datastore\Theme_Options_Datastore;
use Carbon_Fields\Exception\Incorrect_Syntax_Exception;

/**
 * Theme options container class.
 */
class Theme_Options_Container extends Container {
	static protected $registered_pages = array();

	public $settings = array(
		'parent' => 'self',
		'file' => '',
		'permissions' => 'manage_options',
	);

	public $icon = '';

	/**
	 * Create a new theme options fields container
	 *
	 * @param string $title Unique title of the container
	 **/
	public function __construct( $title ) {
		parent::__construct( $title );

		if ( ! $this->get_datastore() ) {
			$this->set_datastore( new Theme_Options_Datastore(), $this->has_default_datastore() );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		}
	}

	/**
	 * Perform save operation after successful is_valid_save() check.
	 * The call is propagated to all fields in the container.
	 *
	 * @param mixed $user_data
	 **/
	public function save( $user_data = null ) {
		try {
			parent::save( $user_data );
		} catch ( Incorrect_Syntax_Exception $e ) {
			$this->errors[] = $e->getMessage();
		}

		do_action( 'carbon_after_save_theme_options', $user_data );

		if ( ! headers_sent() ) {
			wp_redirect( add_query_arg( array( 'settings-updated' => 'true' ) ) );
		}
	}
	

	/**
	 * Sanitize a title to a filename
	 *
	 * @param string $title
	 * @return string
	 */
	protected function title_to_filename( $title, $extension ) {
		$title = sanitize_file_name( $title );
		$title = strtolower( $title );
		$title = remove_accents( $title );
		$title = preg_replace( array(
			'~\s+~',
			'~[^\w\d-]+~u',
			'~-+~'

		), array(

			'-',
			'-',
			'-'

		), $title );
		return $title . $extension;
	}

	/**
	 * Attach container as a theme options page/subpage.
	 **/
	public function init() {
		if ( ! $this->settings['parent'] || $this->settings['parent'] == 'self' ) {
			$this->settings['parent'] = '';
		} else if ( strpos( $this->settings['parent'], '.php' ) === false ) {
			$this->settings['parent'] = $this->title_to_filename( 'crbn-' . $this->settings['parent'], '.php' );
		}

		if ( ! $this->settings['file'] ) {
			$this->settings['file'] = $this->title_to_filename( 'crbn-' . $this->title, '.php' );
		}

		$this->verify_unique_page();

		add_action( 'admin_menu', array( $this, '_attach' ) );
	}

	/**
	 * Perform checks whether the current save() request is valid.
	 *
	 * @return bool
	 **/
	public function is_valid_save() {

		if ( ! isset( $_POST[ $this->get_nonce_name() ] ) || ! wp_verify_nonce( $_POST[ $this->get_nonce_name() ], $this->get_nonce_name() ) ) { // Input var okay.

			return false;
		}

		return true;
	}

	/**
	 * Add theme options container pages.
	 * Hook the container saving action.
	 **/
	public function attach() {

		// Add menu page
		if ( ! $this->settings['parent'] ) {
			add_menu_page(
				$this->title,
				$this->title,
				$this->settings['permissions'],
				$this->settings['file'],
				array( $this, 'render' ),
				$this->icon
			);
		}

		add_submenu_page(
			$this->settings['parent'],
			$this->title,
			$this->title,
			$this->settings['permissions'],
			$this->settings['file'],
			array( $this, 'render' ),
			$this->icon
		);

		$page_hook = get_plugin_page_hookname( $this->settings['file'], '' );
		add_action( 'load-' . $page_hook, array( $this, '_save' ) );
	}

	/**
	 * Whether this container is currently viewed.
	 **/
	public function is_active() {
		if ( isset( $_GET['page'] ) && $_GET['page'] === $this->settings['file'] ) {

			return true;
		}

		return false;
	}

	/**
	 * Revert the result of attach()
	 **/
	public function detach() {
		parent::detach();

		$this->drop_unique_page();

		$page_hook = get_plugin_page_hookname( $this->settings['file'], '' );
		remove_action( 'load-' . $page_hook, array( $this, '_save' ) );
	}

	/**
	 * Output the container markup
	 **/
	public function render() {
		if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] == 'true' ) {
			$this->notifications[] = __( 'Settings saved.', 'carbon-fields' );
		}

		include \Carbon_Fields\DIR . '/templates/Container/theme_options.php';
	}

	/**
	 * Make sure that there are no duplicate containers with the same name.
	 **/
	public function verify_unique_page() {
		$file = $this->settings['file'];
		$parent = $this->settings['parent'];

		// Register top level page
		if ( ! $parent ) {
			if ( isset( self::$registered_pages[ $file ] ) ) {
				Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" already registered' );
			}

			self::$registered_pages[ $file ] = array();
			return;
		}

		// Register sub-page
		if ( ! isset( self::$registered_pages[ $parent ] ) ) {
			self::$registered_pages[ $parent ] = array( $file );
		} elseif ( in_array( $file, self::$registered_pages[ $parent ] ) ) {
			Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" with parent "' . $parent . '" is already registered. Please set a different file name using setup()' );
		} else {
			self::$registered_pages[ $parent ][] = $file;
		}
	}

	/**
	 * Unregister the container parent and child pages.
	 **/
	public function drop_unique_page() {
		$file = $this->settings['file'];
		$parent = $this->settings['parent'];

		// Register top level page
		if ( ! $parent ) {
			if ( isset( self::$registered_pages[ $file ] ) && empty( self::$registered_pages[ $file ] ) ) {
				unset( self::$registered_pages[ $file ] );
			}

			return;
		}

		// Register sub-page
		if ( isset( self::$registered_pages[ $parent ] ) && in_array( $file, self::$registered_pages[ $parent ] ) ) {

			$index = array_search( $file, self::$registered_pages[ $parent ] );
			if ( $index !== false ) {
				unset( self::$registered_pages[ $parent ][ $index ] );
			}
		}
	}

	/**
	 * Append array of fields to the current fields set. All items of the array
	 * must be instances of Field and their names should be unique for all
	 * Carbon containers.
	 * If a field does not have DataStore already, the container datastore is
	 * assigned to them instead.
	 *
	 * @param array $fields
	 **/
	public function add_fields( $fields ) {
		parent::add_fields( $fields );

		foreach ( $this->fields as $field ) {
			$field->set_prefix( '' );
		}

		return $this;
	}

	/**
	 * Change the parent theme options page of this container
	 **/
	public function set_page_parent( $parent ) {
		if ( is_a( $parent, 'Carbon_Container' ) ) {
			$parent = $parent->title;
		}

		$this->settings['parent'] = $parent;
		return $this;
	}

	/**
	 * Set the icon of this theme options page.
	 * Applicable only for parent theme option pages.
	 **/
	public function set_icon( $icon ) {
		$this->icon = $icon;
		return $this;
	}

	/**
	 * Set the theme options file name of this container.
	 **/
	public function set_page_file( $file ) {
		$this->settings['file'] = $file;
		return $this;
	}

	/**
	 * Set the permissions necessary to view
	 * the corresponding theme options page
	 **/
	public function set_page_permissions( $permissions ) {
		$this->settings['permissions'] = $permissions;
		return $this;
	}

}


1		<?php
2
3		namespace Carbon_Fields\Container;
4
5		use Carbon_Fields\Datastore\Theme_Options_Datastore;
6		use Carbon_Fields\Exception\Incorrect_Syntax_Exception;
7
8		/**
9		* Theme options container class.
10		*/
11		class Theme_Options_Container extends Container {
12		static protected $registered_pages = array();
13
14		public $settings = array(
15		'parent' => 'self',
16		'file' => '',
17		'permissions' => 'manage_options',
18		);
19
20		public $icon = '';
21
22		/**
23		* Create a new theme options fields container
24		*
25		* @param string $title Unique title of the container
26		**/
27		public function __construct( $title ) {
28		parent::__construct( $title );
29
30		if ( ! $this->get_datastore() ) {
31		$this->set_datastore( new Theme_Options_Datastore(), $this->has_default_datastore() );
		0 ignored issues – show Documentation introduced 2017-01-19 11:00 UTC by Report Bug Copy Issue Report `$this->has_default_datastore()` is of type `object<Carbon_Fields\Dat...re\Datastore_Interface>`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
32		}
33		}
34
35		/**
36		* Perform save operation after successful is_valid_save() check.
37		* The call is propagated to all fields in the container.
38		*
39		* @param mixed $user_data
40		**/
41		public function save( $user_data = null ) {
42		try {
43		parent::save( $user_data );
44		} catch ( Incorrect_Syntax_Exception $e ) {
45		$this->errors[] = $e->getMessage();
46		}
47
48		do_action( 'carbon_after_save_theme_options', $user_data );
49
50		if ( ! headers_sent() ) {
51		wp_redirect( add_query_arg( array( 'settings-updated' => 'true' ) ) );
52		}
53		}
54
55
56		/**
57		* Sanitize a title to a filename
58		*
59		* @param string $title
60		* @return string
61		*/
62		protected function title_to_filename( $title, $extension ) {
63		$title = sanitize_file_name( $title );
64		$title = strtolower( $title );
65		$title = remove_accents( $title );
66		$title = preg_replace( array(
67		'~\s+~',
68		'~[^\w\d-]+~u',
69		'~-+~'
		0 ignored issues – show introduced 2017-05-22 07:27 UTC by Report Bug Copy Issue Report Comma required after last value in array declaration Loading history...
70		), array(
		1 ignored issue – show Coding Style introduced 2017-05-22 07:27 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `12` spaces, but found `8`. Loading history...
71		'-',
72		'-',
73		'-'
		0 ignored issues – show introduced 2017-05-22 07:27 UTC by Report Bug Copy Issue Report Comma required after last value in array declaration Loading history...
74		), $title );
75		return $title . $extension;
76		}
77
78		/**
79		* Attach container as a theme options page/subpage.
80		**/
81		public function init() {
82		if ( ! $this->settings['parent'] \|\| $this->settings['parent'] == 'self' ) {
83		$this->settings['parent'] = '';
84		} else if ( strpos( $this->settings['parent'], '.php' ) === false ) {
85		$this->settings['parent'] = $this->title_to_filename( 'crbn-' . $this->settings['parent'], '.php' );
86		}
87
88		if ( ! $this->settings['file'] ) {
89		$this->settings['file'] = $this->title_to_filename( 'crbn-' . $this->title, '.php' );
90		}
91
92		$this->verify_unique_page();
93
94		add_action( 'admin_menu', array( $this, '_attach' ) );
95		}
96
97		/**
98		* Perform checks whether the current save() request is valid.
99		*
100		* @return bool
101		**/
102	View Code Duplication	public function is_valid_save() {
		0 ignored issues – show Duplication introduced 2016-03-02 09:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
103		if ( ! isset( $_POST[ $this->get_nonce_name() ] ) \|\| ! wp_verify_nonce( $_POST[ $this->get_nonce_name() ], $this->get_nonce_name() ) ) { // Input var okay.
		0 ignored issues – show introduced 2016-03-02 09:23 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_POST Loading history...
104		return false;
105		}
106
107		return true;
108		}
109
110		/**
111		* Add theme options container pages.
112		* Hook the container saving action.
113		**/
114		public function attach() {
115
116		// Add menu page
117		if ( ! $this->settings['parent'] ) {
118		add_menu_page(
119		$this->title,
120		$this->title,
121		$this->settings['permissions'],
122		$this->settings['file'],
123		array( $this, 'render' ),
124		$this->icon
125		);
126		}
127
128		add_submenu_page(
129		$this->settings['parent'],
130		$this->title,
131		$this->title,
132		$this->settings['permissions'],
133		$this->settings['file'],
134		array( $this, 'render' ),
135		$this->icon
136		);
137
138		$page_hook = get_plugin_page_hookname( $this->settings['file'], '' );
139		add_action( 'load-' . $page_hook, array( $this, '_save' ) );
140		}
141
142		/**
143		* Whether this container is currently viewed.
144		**/
145		public function is_active() {
146		if ( isset( $_GET['page'] ) && $_GET['page'] === $this->settings['file'] ) {
		0 ignored issues – show introduced 2016-01-07 13:39 UTC by Report Bug Copy Issue Report Detected access of super global var $_GET, probably need manual inspection. Loading history... introduced 2016-01-07 13:39 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_GET Loading history...
147		return true;
148		}
149
150		return false;
151		}
152
153		/**
154		* Revert the result of attach()
155		**/
156		public function detach() {
157		parent::detach();
158
159		$this->drop_unique_page();
160
161		$page_hook = get_plugin_page_hookname( $this->settings['file'], '' );
162		remove_action( 'load-' . $page_hook, array( $this, '_save' ) );
163		}
164
165		/**
166		* Output the container markup
167		**/
168		public function render() {
169		if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] == 'true' ) {
170		$this->notifications[] = __( 'Settings saved.', 'carbon-fields' );
171		}
172
173		include \Carbon_Fields\DIR . '/templates/Container/theme_options.php';
174		}
175
176		/**
177		* Make sure that there are no duplicate containers with the same name.
178		**/
179		public function verify_unique_page() {
180		$file = $this->settings['file'];
181		$parent = $this->settings['parent'];
182
183		// Register top level page
184		if ( ! $parent ) {
185		if ( isset( self::$registered_pages[ $file ] ) ) {
186		Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" already registered' );
187		}
188
189		self::$registered_pages[ $file ] = array();
190		return;
191		}
192
193		// Register sub-page
194		if ( ! isset( self::$registered_pages[ $parent ] ) ) {
195		self::$registered_pages[ $parent ] = array( $file );
196		} elseif ( in_array( $file, self::$registered_pages[ $parent ] ) ) {
197		Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" with parent "' . $parent . '" is already registered. Please set a different file name using setup()' );
198		} else {
199		self::$registered_pages[ $parent ][] = $file;
200		}
201		}
202
203		/**
204		* Unregister the container parent and child pages.
205		**/
206		public function drop_unique_page() {
207		$file = $this->settings['file'];
208		$parent = $this->settings['parent'];
209
210		// Register top level page
211		if ( ! $parent ) {
212		if ( isset( self::$registered_pages[ $file ] ) && empty( self::$registered_pages[ $file ] ) ) {
213		unset( self::$registered_pages[ $file ] );
214		}
215
216		return;
217		}
218
219		// Register sub-page
220		if ( isset( self::$registered_pages[ $parent ] ) && in_array( $file, self::$registered_pages[ $parent ] ) ) {
221
222		$index = array_search( $file, self::$registered_pages[ $parent ] );
223		if ( $index !== false ) {
224		unset( self::$registered_pages[ $parent ][ $index ] );
225		}
226		}
227		}
228
229		/**
230		* Append array of fields to the current fields set. All items of the array
231		* must be instances of Field and their names should be unique for all
232		* Carbon containers.
233		* If a field does not have DataStore already, the container datastore is
234		* assigned to them instead.
235		*
236		* @param array $fields
237		**/
238		public function add_fields( $fields ) {
239		parent::add_fields( $fields );
240
241		foreach ( $this->fields as $field ) {
242		$field->set_prefix( '' );
243		}
244
245		return $this;
246		}
247
248		/**
249		* Change the parent theme options page of this container
250		**/
251		public function set_page_parent( $parent ) {
252		if ( is_a( $parent, 'Carbon_Container' ) ) {
253		$parent = $parent->title;
254		}
255
256		$this->settings['parent'] = $parent;
257		return $this;
258		}
259
260		/**
261		* Set the icon of this theme options page.
262		* Applicable only for parent theme option pages.
263		**/
264		public function set_icon( $icon ) {
265		$this->icon = $icon;
266		return $this;
267		}
268
269		/**
270		* Set the theme options file name of this container.
271		**/
272		public function set_page_file( $file ) {
273		$this->settings['file'] = $file;
274		return $this;
275		}
276
277		/**
278		* Set the permissions necessary to view
279		* the corresponding theme options page
280		**/
281		public function set_page_permissions( $permissions ) {
282		$this->settings['permissions'] = $permissions;
283		return $this;
284		}
285
286		}
287

htmlburger / carbon-fields