Widget_Cache - Code Metrics - Rarst/fragment-cache - Measure and Improve Code Quality continuously with Scrutinizer

Widget_Cache A
last analyzed 2017-10-12 14:06 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	121
Duplicated Lines	14.88 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	15
c	1
b	0
f	0
lcom	0
cbo	1
dl	18
loc	121
rs	10

6 Methods

Rating	Name	Duplication	Size	Complexity
A	enable()	9	9	2
A	disable()	9	9	2
A	widget_update_callback()	0	8	2
B	update_widget()	0	32	6
A	widget_display_callback()	0	15	2
A	callback()	0	7	1

How to fix Duplicated Code

<?php

namespace Rarst\Fragment_Cache;

/**
 * Cache widgets.
 */
class Widget_Cache extends Fragment_Cache {

	/**
	 * @inheritDoc
	 */
	public function enable() {


		if ( is_admin() ) {
			add_filter( 'widget_update_callback', array( $this, 'widget_update_callback' ) );
			add_action( 'wp_ajax_update-widget', array( $this, 'update_widget' ), 0 );
		} else {
			add_filter( 'widget_display_callback', array( $this, 'widget_display_callback' ), 10, 3 );
		}
	}

	/**
	 * @inheritDoc
	 */
	public function disable() {


		if ( is_admin() ) {
			remove_filter( 'widget_update_callback', array( $this, 'widget_update_callback' ) );
			remove_action( 'wp_ajax_update-widget', array( $this, 'update_widget' ), 0 );
		} else {
			remove_filter( 'widget_display_callback', array( $this, 'widget_display_callback' ), 10 );
		}
	}

	/**
	 * Adds timestamp to widget instance to use as salt.
	 *
	 * @param array $instance Widget instance to modify.
	 *
	 * @return array
	 */
	public function widget_update_callback( $instance ) {

		if ( is_array( $instance ) ) {
			$instance['fc_widget_edited'] = time();
		}

		return $instance;
	}

	/**
	 * Invalidate widget instance cache on Customizer save.
	 */
	public function update_widget() {
// 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);
    }
}

		$customized = filter_input( INPUT_POST, 'customized' );

		if ( empty( $customized ) ) {
			return;
		}

		$customized = json_decode( $customized, true );
		$changed    = false;

		foreach ( $customized as $key => $data ) {

			if ( ! isset( $data['encoded_serialized_instance'] ) || 0 !== stripos( $key, 'widget' ) ) {
				continue;
			}

			$instance                     = unserialize( base64_decode( $data['encoded_serialized_instance'] ) );
			$instance['fc_widget_edited'] = time();
			$instance                     = base64_encode( serialize( $instance ) );

			$data['encoded_serialized_instance'] = $instance;
			$data['instance_hash_key']           = wp_hash( $instance );
			$customized[ $key ]                  = $data;

			$changed = true;
		}

		if ( $changed ) {
			$_POST['customized'] = wp_json_encode( $customized );
		}
	}

	/**
	 * Set up and echo widget cache
	 *
	 * @param array  $instance Widget instance data.
	 * @param object $widget   Widget object instance.
	 * @param array  $args     Arguments.
	 *
	 * @return bool false
	 */
	public function widget_display_callback( $instance, $widget, $args ) {

		$edited = isset( $instance['fc_widget_edited'] ) ? $instance['fc_widget_edited'] : '';

		echo $this->fetch(
			$widget->id,
			array(
				'callback' => array( $widget, 'widget' ),
				'args'     => array( $args, $instance ),
			),
			$edited
		);

		return false;
	}

	/**
	 * Generate widget output, capture with buffer and timestamp.
	 *
	 * @param string $name Fragment name.
	 * @param array  $args Arguments.
	 *
	 * @return string
	 */
	protected function callback( $name, $args ) {

		ob_start();
		call_user_func_array( $args['callback'], $args['args'] );

		return ob_get_clean() . $this->get_comment( $name );
	}
}


1		<?php
2
3		namespace Rarst\Fragment_Cache;
4
5		/**
6		* Cache widgets.
7		*/
8		class Widget_Cache extends Fragment_Cache {
9
10		/**
11		* @inheritDoc
12		*/
13	View Code Duplication	public function enable() {
		0 ignored issues – show Duplication introduced 2017-10-11 13:10 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...
14
15		if ( is_admin() ) {
16		add_filter( 'widget_update_callback', array( $this, 'widget_update_callback' ) );
17		add_action( 'wp_ajax_update-widget', array( $this, 'update_widget' ), 0 );
18		} else {
19		add_filter( 'widget_display_callback', array( $this, 'widget_display_callback' ), 10, 3 );
20		}
21		}
22
23		/**
24		* @inheritDoc
25		*/
26	View Code Duplication	public function disable() {
		0 ignored issues – show Duplication introduced 2017-10-11 13:10 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...
27
28		if ( is_admin() ) {
29		remove_filter( 'widget_update_callback', array( $this, 'widget_update_callback' ) );
30		remove_action( 'wp_ajax_update-widget', array( $this, 'update_widget' ), 0 );
31		} else {
32		remove_filter( 'widget_display_callback', array( $this, 'widget_display_callback' ), 10 );
33		}
34		}
35
36		/**
37		* Adds timestamp to widget instance to use as salt.
38		*
39		* @param array $instance Widget instance to modify.
40		*
41		* @return array
42		*/
43		public function widget_update_callback( $instance ) {
44
45		if ( is_array( $instance ) ) {
46		$instance['fc_widget_edited'] = time();
47		}
48
49		return $instance;
50		}
51
52		/**
53		* Invalidate widget instance cache on Customizer save.
54		*/
55		public function update_widget() {
		0 ignored issues – show Coding Style introduced 2017-10-11 13:10 UTC by Report Bug Copy Issue Report `update_widget` uses the super-global variable `$_POST` 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...
56
57		$customized = filter_input( INPUT_POST, 'customized' );
58
59		if ( empty( $customized ) ) {
60		return;
61		}
62
63		$customized = json_decode( $customized, true );
64		$changed = false;
65
66		foreach ( $customized as $key => $data ) {
67
68		if ( ! isset( $data['encoded_serialized_instance'] ) \|\| 0 !== stripos( $key, 'widget' ) ) {
69		continue;
70		}
71
72		$instance = unserialize( base64_decode( $data['encoded_serialized_instance'] ) );
73		$instance['fc_widget_edited'] = time();
74		$instance = base64_encode( serialize( $instance ) );
75
76		$data['encoded_serialized_instance'] = $instance;
77		$data['instance_hash_key'] = wp_hash( $instance );
78		$customized[ $key ] = $data;
79
80		$changed = true;
81		}
82
83		if ( $changed ) {
84		$_POST['customized'] = wp_json_encode( $customized );
85		}
86		}
87
88		/**
89		* Set up and echo widget cache
90		*
91		* @param array $instance Widget instance data.
92		* @param object $widget Widget object instance.
93		* @param array $args Arguments.
94		*
95		* @return bool false
96		*/
97		public function widget_display_callback( $instance, $widget, $args ) {
98
99		$edited = isset( $instance['fc_widget_edited'] ) ? $instance['fc_widget_edited'] : '';
100
101		echo $this->fetch(
102		$widget->id,
103		array(
104		'callback' => array( $widget, 'widget' ),
105		'args' => array( $args, $instance ),
106		),
107		$edited
108		);
109
110		return false;
111		}
112
113		/**
114		* Generate widget output, capture with buffer and timestamp.
115		*
116		* @param string $name Fragment name.
117		* @param array $args Arguments.
118		*
119		* @return string
120		*/
121		protected function callback( $name, $args ) {
122
123		ob_start();
124		call_user_func_array( $args['callback'], $args['args'] );
125
126		return ob_get_clean() . $this->get_comment( $name );
127		}
128		}
129

Rarst / fragment-cache

Widget_Cache A last analyzed 2017-10-12 14:06 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

Widget_Cache A
last analyzed 2017-10-12 14:06 UTC