Toolbar_Theme_Switcher::setup_theme() - Code Metrics - Inspection of "Moved reset check to a dedicated method." - Rarst/toolbar-theme-switcher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aef7d3...2a820e )

by Andrey

created 2016-11-27 21:25 UTC

Toolbar_Theme_Switcher::setup_theme() B

↳ Parent: Toolbar_Theme_Switcher

Complexity

Conditions	6
Paths	3

Size

Total Lines	22
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.6737
c	0
b	0
f	0
cc	6
eloc	14
nc	3
nop	0

<?php

/**
 * Main plugin class.
 */
class Toolbar_Theme_Switcher {
namespace YourVendor;

class YourClass { }

	/** @var WP_Theme $theme */
	public static $theme = false;

	/**
	 * Hooks that need to be set up early.
	 */
	public static function on_load() {

		add_action( 'setup_theme', array( __CLASS__, 'setup_theme' ) );
		add_action( 'init', array( __CLASS__, 'init' ) );
	}

	/**
	 * Loads cookie and sets up theme filters.
	 */
	public static function setup_theme() {

		global $pagenow;
function myFunction($a, $b) {
    // Do something
}

		if ( ( is_admin() && 'themes.php' == $pagenow ) || ! self::can_switch_themes() ) {
			return;
		}

		self::check_reset();
		self::load_cookie();

		if ( empty( self::$theme ) ) {
			return;
		}

		add_filter( 'pre_option_template', array( self::$theme, 'get_template' ) );
		add_filter( 'pre_option_stylesheet', array( self::$theme, 'get_stylesheet' ) );
		add_filter( 'pre_option_stylesheet_root', array( self::$theme, 'get_theme_root' ) );
		$parent = self::$theme->parent();
		add_filter( 'pre_option_template_root', array( empty( $parent ) ? self::$theme : $parent, 'get_theme_root' ) );
		add_filter( 'pre_option_current_theme', '__return_false' );
	}

	/**
	 * Clear theme choice if reset variable is present in request.
	 */
	public static function check_reset() {

		if ( ! empty( filter_input( INPUT_GET, 'tts_reset' ) ) ) {
			setcookie( self::get_cookie_name(), '', 1 );
			nocache_headers();
			wp_safe_redirect( home_url() );
			die;

		}
	}

	/**
	 * If allowed to switch theme.
	 *
	 * @return boolean
	 */
	public static function can_switch_themes() {

		$capability = apply_filters( 'tts_capability', 'switch_themes' );

		return apply_filters( 'tts_can_switch_themes', current_user_can( $capability ) );
	}

	/**
	 * Sets if cookie is defined to non-default theme.
	 */
	public static function load_cookie() {

		$theme_name  = filter_input( INPUT_COOKIE, self::get_cookie_name() );

		if ( ! $theme_name ) {
			return;
		}

		$theme = wp_get_theme( $theme_name );

		if (
			$theme->exists()
			&& $theme->get( 'Name' ) !== get_option( 'current_theme' )
			&& $theme->is_allowed()
		) {
			self::$theme = $theme;
		}
	}

	/**
	 * Returns cookie name, based on home URL so it differs for sites in multisite.
	 *
	 * @return string
	 */
	public static function get_cookie_name() {

		static $hash;

		if ( empty( $hash ) ) {
			$hash = 'wordpress_tts_theme_' . md5( home_url( '', 'http' ) );
		}

		return $hash;
	}

	/**
	 * Retrieves allowed themes.
	 *
	 * @return WP_Theme[]
	 */
	public static function get_allowed_themes() {

		static $themes;

		if ( isset( $themes ) ) {
			return $themes;
		}

		$wp_themes = wp_get_themes( array( 'allowed' => true ) );

		/** @var WP_Theme $theme */
		foreach ( $wp_themes as $theme ) {

			// Make keys names (rather than slugs) for backwards compat.
			$themes[ $theme->get( 'Name' ) ] = $theme;
		}

		$themes = apply_filters( 'tts_allowed_themes', $themes );

		return $themes;
	}

	/**
	 * Sets up hooks that doesn't need to happen early.
	 */
	public static function init() {

		if ( self::can_switch_themes() ) {
			add_action( 'admin_bar_menu', array( __CLASS__, 'admin_bar_menu' ), 90 );
			add_action( 'wp_ajax_tts_set_theme', array( __CLASS__, 'set_theme' ) );
		}

		load_plugin_textdomain( 'toolbar-theme-switcher', false, dirname( plugin_basename( __FILE__ ) ) . '/lang' );
	}

	/**
	 * Creates menu in toolbar.
	 *
	 * @param WP_Admin_Bar $wp_admin_bar Admin bar instance.
	 */
	public static function admin_bar_menu( $wp_admin_bar ) {
		$themes  = self::get_allowed_themes();
		$current = empty( self::$theme ) ? wp_get_theme() : self::$theme;
		unset( $themes[ $current->get( 'Name' ) ] );
		uksort( $themes, array( __CLASS__, 'sort_core_themes' ) );

		$title = apply_filters( 'tts_root_title', sprintf( __( 'Theme: %s', 'toolbar-theme-switcher' ), $current->display( 'Name' ) ) );

		$wp_admin_bar->add_menu( array(
			'id'    => 'toolbar_theme_switcher',
			'title' => $title,
			'href'  => admin_url( 'themes.php' ),
		) );

		$ajax_url = admin_url( 'admin-ajax.php' );

		foreach ( $themes as $theme ) {

			$href = add_query_arg( array(
				'action' => 'tts_set_theme',
				'theme'  => urlencode( $theme->get_stylesheet() ),
			), $ajax_url );

			$wp_admin_bar->add_menu( array(
				'id'     => $theme['Stylesheet'],
				'title'  => $theme->display( 'Name' ),
				'href'   => $href,
				'parent' => 'toolbar_theme_switcher',
			) );
		}
	}

	/**
	 * Callback to sort theme array with core themes in numerical order by year.
	 *
	 * @param string $theme_a First theme name.
	 * @param string $theme_b Second theme name.
	 *
	 * @return int
	 */
	public static function sort_core_themes( $theme_a, $theme_b ) {

		static $twenties = array(
			'Twenty Ten',
			'Twenty Eleven',
			'Twenty Twelve',
			'Twenty Thirteen',
			'Twenty Fourteen',
			'Twenty Fifteen',
			'Twenty Sixteen',
			'Twenty Seventeen',
			'Twenty Eighteen',
			'Twenty Nineteen',
			'Twenty Twenty',
		);

		if ( 0 === strpos( $theme_a, 'Twenty' ) && 0 === strpos( $theme_b, 'Twenty' ) ) {

			$index_a = array_search( $theme_a, $twenties, true );
			$index_b = array_search( $theme_b, $twenties, true );

			if ( false !== $index_a && false !== $index_b ) {
				return ( $index_a < $index_b ) ? - 1 : 1;
			}
		}

		return strcasecmp( $theme_a, $theme_b );
	}

	/**
	 * Saves selected theme in cookie if valid.
	 */
	public static function set_theme() {

		$stylesheet = filter_input( INPUT_GET, 'theme' );
		$theme      = wp_get_theme( $stylesheet );

		if ( $theme->exists() && $theme->is_allowed() ) {
			setcookie( self::get_cookie_name(), $theme->get_stylesheet(), strtotime( '+1 year' ), COOKIEPATH );
		}

		wp_safe_redirect( wp_get_referer() );
		die;

	}

	// <editor-fold desc="Deprecated">
	/**
	 * If theme is in list of allowed to be switched to.
	 *
	 * @deprecated :2.0
	 *
	 * @param WP_Theme $theme
	 *
	 * @return bool
	 */
	public static function is_allowed( $theme ) {

		return array_key_exists( $theme->get( 'Name' ), self::get_allowed_themes() );
	}

	/**
	 * Template slug filter.
	 *
	 * @param string $template
	 *
	 * @deprecated :2.0
	 *
	 * @return string
	 */
	public static function template( $template ) {

		return self::get_theme_field( 'Template', $template );

	}

	/**
	 * Stylesheet slug filter.
	 *
	 * @param string $stylesheet
	 *
	 * @deprecated :2.0
	 *
	 * @return string
	 */
	public static function stylesheet( $stylesheet ) {

		return self::get_theme_field( 'Stylesheet', $stylesheet );

	}

	/**
	 * Returns field from theme data if cookie is set to valid theme.
	 *
	 * @param string $field_name
	 * @param mixed  $default
	 *
	 * @deprecated :2.0
	 *
	 * @return mixed
	 */
	public static function get_theme_field( $field_name, $default = false ) {

		if ( ! empty( self::$theme ) ) {
			return self::$theme->get( $field_name );
		}

		return $default;
	}
	// </editor-fold>
}


Push — master ( aef7d3...2a820e )

Toolbar_Theme_Switcher::setup_theme() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2
3			/**
4			* Main plugin class.
5			*/
6			class Toolbar_Theme_Switcher {
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-27 21:00 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
7
8			/** @var WP_Theme $theme */
9			public static $theme = false;
10
11			/**
12			* Hooks that need to be set up early.
13			*/
14			public static function on_load() {
15
16			add_action( 'setup_theme', array( __CLASS__, 'setup_theme' ) );
17			add_action( 'init', array( __CLASS__, 'init' ) );
18			}
19
20			/**
21			* Loads cookie and sets up theme filters.
22			*/
23			public static function setup_theme() {
24
25			global $pagenow;
			0 ignored issues – show Compatibility Best Practice introduced 2016-11-27 19:34 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
26
27			if ( ( is_admin() && 'themes.php' == $pagenow ) \|\| ! self::can_switch_themes() ) {
28			return;
29			}
30
31			self::check_reset();
32			self::load_cookie();
33
34			if ( empty( self::$theme ) ) {
35			return;
36			}
37
38			add_filter( 'pre_option_template', array( self::$theme, 'get_template' ) );
39			add_filter( 'pre_option_stylesheet', array( self::$theme, 'get_stylesheet' ) );
40			add_filter( 'pre_option_stylesheet_root', array( self::$theme, 'get_theme_root' ) );
41			$parent = self::$theme->parent();
42			add_filter( 'pre_option_template_root', array( empty( $parent ) ? self::$theme : $parent, 'get_theme_root' ) );
43			add_filter( 'pre_option_current_theme', '__return_false' );
44			}
45
46			/**
47			* Clear theme choice if reset variable is present in request.
48			*/
49			public static function check_reset() {
50
51			if ( ! empty( filter_input( INPUT_GET, 'tts_reset' ) ) ) {
52			setcookie( self::get_cookie_name(), '', 1 );
53			nocache_headers();
54			wp_safe_redirect( home_url() );
55			die;
			1 ignored issue – show Coding Style Compatibility introduced 2016-11-27 21:26 UTC by Report Bug Copy Issue Report The method `check_reset()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
56			}
57			}
58
59			/**
60			* If allowed to switch theme.
61			*
62			* @return boolean
63			*/
64			public static function can_switch_themes() {
65
66			$capability = apply_filters( 'tts_capability', 'switch_themes' );
67
68			return apply_filters( 'tts_can_switch_themes', current_user_can( $capability ) );
69			}
70
71			/**
72			* Sets if cookie is defined to non-default theme.
73			*/
74			public static function load_cookie() {
75
76			$theme_name = filter_input( INPUT_COOKIE, self::get_cookie_name() );
77
78			if ( ! $theme_name ) {
79			return;
80			}
81
82			$theme = wp_get_theme( $theme_name );
83
84			if (
85			$theme->exists()
86			&& $theme->get( 'Name' ) !== get_option( 'current_theme' )
87			&& $theme->is_allowed()
88			) {
89			self::$theme = $theme;
90			}
91			}
92
93			/**
94			* Returns cookie name, based on home URL so it differs for sites in multisite.
95			*
96			* @return string
97			*/
98			public static function get_cookie_name() {
99
100			static $hash;
101
102			if ( empty( $hash ) ) {
103			$hash = 'wordpress_tts_theme_' . md5( home_url( '', 'http' ) );
104			}
105
106			return $hash;
107			}
108
109			/**
110			* Retrieves allowed themes.
111			*
112			* @return WP_Theme[]
113			*/
114			public static function get_allowed_themes() {
115
116			static $themes;
117
118			if ( isset( $themes ) ) {
119			return $themes;
120			}
121
122			$wp_themes = wp_get_themes( array( 'allowed' => true ) );
123
124			/** @var WP_Theme $theme */
125			foreach ( $wp_themes as $theme ) {
126
127			// Make keys names (rather than slugs) for backwards compat.
128			$themes[ $theme->get( 'Name' ) ] = $theme;
129			}
130
131			$themes = apply_filters( 'tts_allowed_themes', $themes );
132
133			return $themes;
134			}
135
136			/**
137			* Sets up hooks that doesn't need to happen early.
138			*/
139			public static function init() {
140
141			if ( self::can_switch_themes() ) {
142			add_action( 'admin_bar_menu', array( __CLASS__, 'admin_bar_menu' ), 90 );
143			add_action( 'wp_ajax_tts_set_theme', array( __CLASS__, 'set_theme' ) );
144			}
145
146			load_plugin_textdomain( 'toolbar-theme-switcher', false, dirname( plugin_basename( __FILE__ ) ) . '/lang' );
147			}
148
149			/**
150			* Creates menu in toolbar.
151			*
152			* @param WP_Admin_Bar $wp_admin_bar Admin bar instance.
153			*/
154			public static function admin_bar_menu( $wp_admin_bar ) {
155			$themes = self::get_allowed_themes();
156			$current = empty( self::$theme ) ? wp_get_theme() : self::$theme;
157			unset( $themes[ $current->get( 'Name' ) ] );
158			uksort( $themes, array( __CLASS__, 'sort_core_themes' ) );
159
160			$title = apply_filters( 'tts_root_title', sprintf( __( 'Theme: %s', 'toolbar-theme-switcher' ), $current->display( 'Name' ) ) );
161
162			$wp_admin_bar->add_menu( array(
163			'id' => 'toolbar_theme_switcher',
164			'title' => $title,
165			'href' => admin_url( 'themes.php' ),
166			) );
167
168			$ajax_url = admin_url( 'admin-ajax.php' );
169
170			foreach ( $themes as $theme ) {
171
172			$href = add_query_arg( array(
173			'action' => 'tts_set_theme',
174			'theme' => urlencode( $theme->get_stylesheet() ),
175			), $ajax_url );
176
177			$wp_admin_bar->add_menu( array(
178			'id' => $theme['Stylesheet'],
179			'title' => $theme->display( 'Name' ),
180			'href' => $href,
181			'parent' => 'toolbar_theme_switcher',
182			) );
183			}
184			}
185
186			/**
187			* Callback to sort theme array with core themes in numerical order by year.
188			*
189			* @param string $theme_a First theme name.
190			* @param string $theme_b Second theme name.
191			*
192			* @return int
193			*/
194			public static function sort_core_themes( $theme_a, $theme_b ) {
195
196			static $twenties = array(
197			'Twenty Ten',
198			'Twenty Eleven',
199			'Twenty Twelve',
200			'Twenty Thirteen',
201			'Twenty Fourteen',
202			'Twenty Fifteen',
203			'Twenty Sixteen',
204			'Twenty Seventeen',
205			'Twenty Eighteen',
206			'Twenty Nineteen',
207			'Twenty Twenty',
208			);
209
210			if ( 0 === strpos( $theme_a, 'Twenty' ) && 0 === strpos( $theme_b, 'Twenty' ) ) {
211
212			$index_a = array_search( $theme_a, $twenties, true );
213			$index_b = array_search( $theme_b, $twenties, true );
214
215			if ( false !== $index_a && false !== $index_b ) {
216			return ( $index_a < $index_b ) ? - 1 : 1;
217			}
218			}
219
220			return strcasecmp( $theme_a, $theme_b );
221			}
222
223			/**
224			* Saves selected theme in cookie if valid.
225			*/
226			public static function set_theme() {
227
228			$stylesheet = filter_input( INPUT_GET, 'theme' );
229			$theme = wp_get_theme( $stylesheet );
230
231			if ( $theme->exists() && $theme->is_allowed() ) {
232			setcookie( self::get_cookie_name(), $theme->get_stylesheet(), strtotime( '+1 year' ), COOKIEPATH );
233			}
234
235			wp_safe_redirect( wp_get_referer() );
236			die;
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-27 21:00 UTC by Report Bug Copy Issue Report The method `set_theme()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
237			}
238
239			// <editor-fold desc="Deprecated">
240			/**
241			* If theme is in list of allowed to be switched to.
242			*
243			* @deprecated :2.0
244			*
245			* @param WP_Theme $theme
246			*
247			* @return bool
248			*/
249			public static function is_allowed( $theme ) {
250
251			return array_key_exists( $theme->get( 'Name' ), self::get_allowed_themes() );
252			}
253
254			/**
255			* Template slug filter.
256			*
257			* @param string $template
258			*
259			* @deprecated :2.0
260			*
261			* @return string
262			*/
263			public static function template( $template ) {
264
265			return self::get_theme_field( 'Template', $template );
			0 ignored issues – show Deprecated Code introduced 2016-11-27 21:00 UTC by Report Bug Copy Issue Report The method `Toolbar_Theme_Switcher::get_theme_field()` has been deprecated with message: :2.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
266			}
267
268			/**
269			* Stylesheet slug filter.
270			*
271			* @param string $stylesheet
272			*
273			* @deprecated :2.0
274			*
275			* @return string
276			*/
277			public static function stylesheet( $stylesheet ) {
278
279			return self::get_theme_field( 'Stylesheet', $stylesheet );
			0 ignored issues – show Deprecated Code introduced 2016-11-27 21:00 UTC by Report Bug Copy Issue Report The method `Toolbar_Theme_Switcher::get_theme_field()` has been deprecated with message: :2.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
280			}
281
282			/**
283			* Returns field from theme data if cookie is set to valid theme.
284			*
285			* @param string $field_name
286			* @param mixed $default
287			*
288			* @deprecated :2.0
289			*
290			* @return mixed
291			*/
292			public static function get_theme_field( $field_name, $default = false ) {
293
294			if ( ! empty( self::$theme ) ) {
295			return self::$theme->get( $field_name );
296			}
297
298			return $default;
299			}
300			// </editor-fold>
301			}
302

Rarst / toolbar-theme-switcher

Push — master ( aef7d3...2a820e )

Toolbar_Theme_Switcher::setup_theme() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like