Setup - Code Metrics - Inspection of "Avoid killing site if plugin is active on PHP 52" - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#990)

by Paul

created 2016-02-11 10:46 UTC

Setup A

↳ Parent: HMBKP_Setup

Complexity

Total Complexity

Size/Duplication

Total Lines	173
Duplicated Lines	2.89 %

Coupling/Cohesion

Components	1
Dependencies	0

Metric	Value
wmc	19
lcom	1
cbo	0
dl	5
loc	173
rs	10

11 Methods

Rating	Name	Size	Complexity
A	HMBKP_Setup::activate()	19	3
A	HMBKP_Setup::deactivate()	11	2
A	HMBKP_Setup::delete_schedules()	13	2
A	HMBKP_Setup::trim_prefix()	3	1
A	HMBKP_Setup::delete_transients()	13	1
A	HMBKP_Setup::self_deactivate()	17	4
A	HMBKP_Setup::meets_requirements()	12	3
A	HMBKP_Setup::is_supported_php_version()	4	1
A	HMBKP_Setup::is_supported_wp_version()	4	1
A	HMBKP_Setup::display_admin_notices()	5	1
A	HMBKP_Setup::get_notice_message()	12	1

How to fix Duplicated Code

<?php
/**
 * Class BackUpWordPress_Setup
 */
class HMBKP_Setup {
namespace YourVendor;

class YourClass { }

	/**
	 * Defines the minimum version of WordPress required by BWP.
	 */
	const MIN_WP_VERSION = '3.9';

	/**
	 * Defines the minimum version of PHP required by BWP.
	 */
	const MIN_PHP_VERSION = '5.3.2';

	/**
	 * Setup the plugin defaults on activation
	 */
	public static function activate() {

		if ( ! current_user_can( 'activate_plugins' ) ) {
			return;
		}

		// loads the translation files for the Error message in the wp_die call.
		load_plugin_textdomain( 'backupwordpress', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );

		if ( ! self::meets_requirements() ) {

			wp_die( self::get_notice_message(), __( 'BackUpWordPress', 'backupwordpress' ), array( 'back_link' => true ) );

		}

		// Run deactivate on activation in-case it was deactivated manually
		self::deactivate();

	}

	/**
	 * Cleanup on plugin deactivation
	 *
	 * Removes options and clears all cron schedules
	 */
	public static function deactivate() {

		if ( ! current_user_can( 'activate_plugins' ) ) {
			return;
		}

		self::delete_schedules();

		self::delete_transients();

	}

	/**
	 * Deletes the backup schedule database entries and WP Cron entries.
	 */
	public static function delete_schedules() {

		// Delete Cron schedules.
		global $wpdb;
function myFunction($a, $b) {
    // Do something
}

		$schedules = $wpdb->get_col( $wpdb->prepare( "SELECT option_name FROM $wpdb->options WHERE option_name LIKE %s", 'hmbkp_schedule_%' ) );

		foreach ( array_map( array( 'self', 'trim_prefix' ), $schedules ) as $item ) {
			wp_clear_scheduled_hook( 'hmbkp_schedule_hook', array( 'id' => $item ) );
		}


	}

	public static function trim_prefix( $item ) {
		return ltrim( $item, 'hmbkp_schedule_' );
	}

	/**
	 * Deletes the plugin's transients from the database.
	 */
	public static function delete_transients() {

		// Delete all transients
		$transients = array(
			'hmbkp_plugin_data',
			'hmbkp_directory_filesizes',
			'hmbkp_directory_filesizes_running',
			'hmbkp_wp_cron_test_beacon',
			'hm_backdrop',
		);

		array_map( 'delete_transient', $transients );
	}

	/**
	 * Deactivate BackUpWordPress.
	 */
	public static function self_deactivate() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}

		if ( ! current_user_can( 'activate_plugins' ) ) {
			return;
		}

		if ( ! function_exists( 'deactivate_plugins' ) ) {
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
		}

		deactivate_plugins( dirname( dirname(__FILE__ ) ) . '/backupwordpress.php' );

		if ( isset( $_GET['activate'] ) ) {
			unset( $_GET['activate'] );
		}

	}

	/**
	 * Determine if this WordPress install meets the minimum requirements for BWP to run.
	 *
	 * @return bool
	 */
	public static function meets_requirements() {

		if ( false === self::is_supported_php_version() ) {
			return false;
		}

		if ( false === self::is_supported_wp_version() ) {

			return false;
		}

		return true;
	}

	/**
	 * Checks the current PHP version against the required version.
	 *
	 * @return bool 'Operator' parameter specified, returns a boolean.
	 */
	protected static function is_supported_php_version() {

		return version_compare( phpversion(), self::MIN_PHP_VERSION, '>=' );
	}

	/**
	 * Checks the current WordPress version against the required version.
	 *
	 * @return bool 'Operator' parameter specified, returns a boolean.
	 */
	protected static function is_supported_wp_version() {

		return version_compare( get_bloginfo( 'version' ), self::MIN_WP_VERSION, '>=' );
	}

	/**
	 * Displays a user friendly message in the WordPress admin.
	 */
	public static function display_admin_notices() {

		echo '<div class="error"><p>' . self::get_notice_message() . '</p></div>';

	}

	/**
	 * Returns a localized user friendly error message.
	 *
	 * @return string
	 */
	public static function get_notice_message() {

		return sprintf(
			__( 'BackUpWordPress requires PHP version %1$s or later and WordPress version %2$s or later to run. It has not been activated. %3$s%4$s%5$sLearn more%6$s', 'backupwordpress' ),
			self::MIN_PHP_VERSION,
			self::MIN_WP_VERSION,
			'<a href="',
			'https://bwp.hmn.md/unsupported-php-version-error/',
			'">',
			'</a>'
		);
	}

}


1			<?php
2			/**
3			* Class BackUpWordPress_Setup
4			*/
5			class HMBKP_Setup {
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-11 10:48 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...
6
7			/**
8			* Defines the minimum version of WordPress required by BWP.
9			*/
10			const MIN_WP_VERSION = '3.9';
11
12			/**
13			* Defines the minimum version of PHP required by BWP.
14			*/
15			const MIN_PHP_VERSION = '5.3.2';
16
17			/**
18			* Setup the plugin defaults on activation
19			*/
20			public static function activate() {
21
22			if ( ! current_user_can( 'activate_plugins' ) ) {
23			return;
24			}
25
26			// loads the translation files for the Error message in the wp_die call.
27			load_plugin_textdomain( 'backupwordpress', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
28
29			if ( ! self::meets_requirements() ) {
30
31			wp_die( self::get_notice_message(), __( 'BackUpWordPress', 'backupwordpress' ), array( 'back_link' => true ) );
32
33			}
34
35			// Run deactivate on activation in-case it was deactivated manually
36			self::deactivate();
37
38			}
39
40			/**
41			* Cleanup on plugin deactivation
42			*
43			* Removes options and clears all cron schedules
44			*/
45			public static function deactivate() {
46
47			if ( ! current_user_can( 'activate_plugins' ) ) {
48			return;
49			}
50
51			self::delete_schedules();
52
53			self::delete_transients();
54
55			}
56
57			/**
58			* Deletes the backup schedule database entries and WP Cron entries.
59			*/
60			public static function delete_schedules() {
61
62			// Delete Cron schedules.
63			global $wpdb;
			0 ignored issues – show Compatibility Best Practice introduced 2015-11-21 01:52 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...
64
65			$schedules = $wpdb->get_col( $wpdb->prepare( "SELECT option_name FROM $wpdb->options WHERE option_name LIKE %s", 'hmbkp_schedule_%' ) );
66
67			foreach ( array_map( array( 'self', 'trim_prefix' ), $schedules ) as $item ) {
68			wp_clear_scheduled_hook( 'hmbkp_schedule_hook', array( 'id' => $item ) );
69			}
70
71
72			}
73
74			public static function trim_prefix( $item ) {
75			return ltrim( $item, 'hmbkp_schedule_' );
76			}
77
78			/**
79			* Deletes the plugin's transients from the database.
80			*/
81			public static function delete_transients() {
82
83			// Delete all transients
84			$transients = array(
85			'hmbkp_plugin_data',
86			'hmbkp_directory_filesizes',
87			'hmbkp_directory_filesizes_running',
88			'hmbkp_wp_cron_test_beacon',
89			'hm_backdrop',
90			);
91
92			array_map( 'delete_transient', $transients );
93			}
94
95			/**
96			* Deactivate BackUpWordPress.
97			*/
98			public static function self_deactivate() {
			1 ignored issue – show Coding Style introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report `self_deactivate` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
99
100			if ( ! current_user_can( 'activate_plugins' ) ) {
101			return;
102			}
103
104			if ( ! function_exists( 'deactivate_plugins' ) ) {
105			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
106			}
107
108			deactivate_plugins( dirname( dirname(__FILE__ ) ) . '/backupwordpress.php' );
109
110			if ( isset( $_GET['activate'] ) ) {
111			unset( $_GET['activate'] );
112			}
113
114			}
115
116			/**
117			* Determine if this WordPress install meets the minimum requirements for BWP to run.
118			*
119			* @return bool
120			*/
121			public static function meets_requirements() {
122
123			if ( false === self::is_supported_php_version() ) {
124			return false;
125			}
126
127			if ( false === self::is_supported_wp_version() ) {
			1 ignored issue – show Unused Code introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return !(false === self:...upported_wp_version());`. Loading history...
128			return false;
129			}
130
131			return true;
132			}
133
134			/**
135			* Checks the current PHP version against the required version.
136			*
137			* @return bool 'Operator' parameter specified, returns a boolean.
138			*/
139			protected static function is_supported_php_version() {
140
141			return version_compare( phpversion(), self::MIN_PHP_VERSION, '>=' );
142			}
143
144			/**
145			* Checks the current WordPress version against the required version.
146			*
147			* @return bool 'Operator' parameter specified, returns a boolean.
148			*/
149			protected static function is_supported_wp_version() {
150
151			return version_compare( get_bloginfo( 'version' ), self::MIN_WP_VERSION, '>=' );
152			}
153
154			/**
155			* Displays a user friendly message in the WordPress admin.
156			*/
157			public static function display_admin_notices() {
158
159			echo '<div class="error"><p>' . self::get_notice_message() . '</p></div>';
160
161			}
162
163			/**
164			* Returns a localized user friendly error message.
165			*
166			* @return string
167			*/
168			public static function get_notice_message() {
169
170			return sprintf(
171			__( 'BackUpWordPress requires PHP version %1$s or later and WordPress version %2$s or later to run. It has not been activated. %3$s%4$s%5$sLearn more%6$s', 'backupwordpress' ),
172			self::MIN_PHP_VERSION,
173			self::MIN_WP_VERSION,
174			'<a href="',
175			'https://bwp.hmn.md/unsupported-php-version-error/',
176			'">',
177			'</a>'
178			);
179			}
180
181			}
182

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#990)

Setup A

Complexity

Size/Duplication

Coupling/Cohesion

11 Methods

How to fix Duplicated Code

Duplicated Code

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like