EED_Events_Archive_Caff - Code Metrics - Inspection of "Daily Inspection: Merge remote-tracking branch 'gi..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-9019-ticket-selector-submi... (c1f9d8)

unknown

created 2015-11-26 21:40 UTC

EED_Events_Archive_Caff B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	164
Duplicated Lines	3.05 %

Coupling/Cohesion

Components	0
Dependencies	8

Metric	Value
wmc	42
lcom	0
cbo	8
dl	5
loc	164
rs	8.2951

7 Methods

Rating	Name	Duplication	Size	Complexity
A	instance()	0	3	1
A	set_hooks()	0	2	1
A	set_hooks_admin()	0	9	1
A	run()	0	2	1
F	template_settings_form()	0	30	15
C	update_template_settings()	0	20	18
B	update_event_archive_order()	5	28	5

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 EED_Events_Archive_Caff 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 EED_Events_Archive_Caff, and based on these observations, apply Extract Interface, too.

<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
/**
 * Event Espresso
 *
 * Event Registration and Management Plugin for WordPress
 *
 * @ package			Event Espresso
 * @ author			Seth Shoultes
 * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
 * @ license			http://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
 * @ link					http://www.eventespresso.com
 * @ version		 	4.0
 *
 * ------------------------------------------------------------------------
 *
 * EED_Events_Archive_Caff
 *
 * @package		Event Espresso
 * @subpackage	/modules/events_archive_caff/
 * @author		Brent Christensen
 *
 * ------------------------------------------------------------------------
 */
class EED_Events_Archive_Caff  extends EED_Events_Archive {


	/**
	 * @return EED_Events_Archive_Caff
	 */
	public static function instance() {
		return parent::get_instance( __CLASS__ );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
	}



	/**
	 * 	set_hooks - for hooking into EE Core, other modules, etc
	 *
	 *  @access 	public
	 *  @return 	void
	 */
	public static function set_hooks() {
	}

	/**
	 * 	set_hooks_admin - for hooking into EE Admin Core, other modules, etc
	 *
	 *  @access 	public
	 *  @return 	void
	 */
	public static function set_hooks_admin() {
		define( 'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH', str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS );
		define( 'EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
		add_action( 'AHEE__template_settings__template__before_settings_form', array( 'EED_Events_Archive_Caff', 'template_settings_form' ), 10 );
		add_filter( 'FHEE__General_Settings_Admin_Page__update_template_settings__data', array( 'EED_Events_Archive_Caff', 'update_template_settings' ), 10, 2 );
		// AJAX
		add_action( 'wp_ajax_espresso_update_event_archive_order', array( 'EED_Events_Archive_Caff', 'update_event_archive_order' ) );
		add_action( 'wp_ajax_nopriv_espresso_update_event_archive_order', array( 'EED_Events_Archive_Caff', 'update_event_archive_order' ) );
	}




	/**
	 *    run - initial module setup
	 *
	 * @access    public
	 * @param    WP $WP
	 * @return    void
	 */
	public function run( $WP ) {
	}




	/**
	 * 	template_settings_form
	 *
	 *  @access 	public
	 *  @static
	 *  @return 	void
	 */
	public static function template_settings_form() {
		// grab general settings admin page and remove the existing hook callback
		$gen_set_admin = EE_Registry::instance()->LIB->EE_Admin_Page_Loader->get_admin_page_object( 'general_settings' );
		if ( $gen_set_admin instanceof General_Settings_Admin_Page ) {
			remove_action( 'AHEE__template_settings__template__before_settings_form', array( $gen_set_admin, 'template_settings_caff_features' ), 100 );
		}
		// first just grab the template settings
		$config = EE_Registry::instance()->CFG->template_settings;
		// then if the Event Archive config is valid, use that, else create a new one
		$config = isset( $config->EED_Events_Archive ) && $config->EED_Events_Archive instanceof EE_Events_Archive_Config ? $config->EED_Events_Archive : new EE_Events_Archive_Config();
		$config = apply_filters( 'FHEE__EED_Events_Archive__template_settings_form__event_list_config', $config );
		$config->display_status_banner = isset( $config->display_status_banner ) ? $config->display_status_banner : 0;
		$config->display_description = isset( $config->display_description ) ? $config->display_description : 1;
		$config->display_ticket_selector = isset( $config->display_ticket_selector ) ? $config->display_ticket_selector : 0;
		$config->display_datetimes = isset( $config->display_datetimes ) ? $config->display_datetimes : 1;
		$config->display_venue = isset( $config->display_venue ) ? $config->display_venue : 0;
		$config->display_expired_events = isset( $config->display_expired_events ) ? $config->display_expired_events : 0;
		// display order options
		$config->use_sortable_display_order = isset( $config->use_sortable_display_order  )? $config->use_sortable_display_order : false;
		$config->display_order_tickets = isset( $config->display_order_tickets  )? $config->display_order_tickets : 100;
		$config->display_order_datetimes = isset( $config->display_order_datetimes  )? $config->display_order_datetimes : 110;
		$config->display_order_event = isset( $config->display_order_event  )? $config->display_order_event : 120;
		$config->display_order_venue = isset( $config->display_order_venue  )? $config->display_order_venue : 130;
		// get template parts
		$template_parts = EED_Events_Archive::instance()->initialize_template_parts( $config );
		// convert to array so that we can add more properties
		$config = get_object_vars( $config );
		$config[ 'event_archive_display_order' ] = $template_parts->generate_sortable_list_of_template_parts( 'event-archive-sortable-js', '', 'archive-sortable-li archive-sortable-js' );
		EEH_Template::display_template( EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php', $config );
	}






	/**
	 * 	update_template_settings
	 *
	 *  @access 	public
	 *  @param    EE_Template_Config $CFG
	 *  @param 	array $REQ
	 *  @return    EE_Events_Archive_Config
	 */
	public static function update_template_settings( $CFG, $REQ ) {
		$config = new EE_Events_Archive_Config();
		// unless we are resetting the config...
		if ( ! isset( $REQ['EED_Events_Archive_reset_event_list_settings'] ) || absint( $REQ['EED_Events_Archive_reset_event_list_settings'] ) !== 1 ) {
			$config->display_status_banner = isset( $REQ['EED_Events_Archive_display_status_banner'] ) ? absint( $REQ['EED_Events_Archive_display_status_banner'] ) : 0;
			$config->display_description = isset( $REQ['EED_Events_Archive_display_description'] ) ? absint( $REQ['EED_Events_Archive_display_description'] ) : 1;
			$config->display_ticket_selector = isset( $REQ['EED_Events_Archive_display_ticket_selector'] ) ? absint( $REQ['EED_Events_Archive_display_ticket_selector'] ) : 0;
			$config->display_datetimes = isset( $REQ['EED_Events_Archive_display_datetimes'] ) ? absint( $REQ['EED_Events_Archive_display_datetimes'] ) : 1;
			$config->display_venue = isset( $REQ['EED_Events_Archive_display_venue'] ) ? absint( $REQ['EED_Events_Archive_display_venue'] ) : 0;
			$config->display_expired_events = isset( $REQ['EED_Events_Archive_display_expired_events'] ) ? absint( $REQ['EED_Events_Archive_display_expired_events'] ) : 0;
			$config->use_sortable_display_order = isset( $REQ['EED_Events_Archive_use_sortable_display_order'] ) ? absint( $REQ['EED_Events_Archive_use_sortable_display_order'] ) : 0;
			$config->display_order_tickets = isset( $CFG->EED_Events_Archive->display_order_tickets ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_tickets : 100;
			$config->display_order_datetimes = isset( $CFG->EED_Events_Archive->display_order_datetimes ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_datetimes : 110;
			$config->display_order_event = isset( $CFG->EED_Events_Archive->display_order_event ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_event : 120;
			$config->display_order_venue = isset( $CFG->EED_Events_Archive->display_order_venue ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_venue : 130;
		}
		$CFG->EED_Events_Archive = $config;
		do_action( 'AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ );
		return $CFG;
	}



	/**
	 * update_event_single_order
	 *
	 * @access    public
	 * @return    void
	 */
	public static function update_event_archive_order() {
		$config_saved = false;
		$template_parts = sanitize_text_field( $_POST[ 'elements' ] );
		if ( ! empty( $template_parts ) ) {
			$template_parts = explode( ',', trim( $template_parts, ',' ) );
			foreach ( $template_parts as $key => $template_part ) {
				$template_part = "display_order_$template_part";
				$priority = ( $key * 10 ) + 100;
				if (
					property_exists(
						EE_Registry::instance()->CFG->template_settings->EED_Events_Archive,
						$template_part
					)
				) {
					EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->$template_part = $priority;
				}
				do_action( "AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority );
			}
			$config_saved = EE_Registry::instance()->CFG->update_espresso_config( false, false );
		}
		if ( $config_saved ) {

			EE_Error::add_success( __( 'Display Order has been successfully updated.', 'event_espresso' ) );
		} else {
			EE_Error::add_error( __( 'Display Order was not updated.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
		}
		echo wp_json_encode( EE_Error::get_notices( false ) );
		exit();
	}


}





// End of file EED_Events_Archive.module.php
// Location: /modules/events_archive_caff/EED_Events_Archive.module.php

1		<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
2		/**
3		* Event Espresso
4		*
5		* Event Registration and Management Plugin for WordPress
6		*
7		* @ package Event Espresso
8		* @ author Seth Shoultes
9		* @ copyright (c) 2008-2011 Event Espresso All Rights Reserved.
10		* @ license http://eventespresso.com/support/terms-conditions/ * see Plugin Licensing *
11		* @ link http://www.eventespresso.com
12		* @ version 4.0
13		*
14		* ------------------------------------------------------------------------
15		*
16		* EED_Events_Archive_Caff
17		*
18		* @package Event Espresso
19		* @subpackage /modules/events_archive_caff/
20		* @author Brent Christensen
21		*
22		* ------------------------------------------------------------------------
23		*/
24		class EED_Events_Archive_Caff extends EED_Events_Archive {
25
26
27		/**
28		* @return EED_Events_Archive_Caff
29		*/
30		public static function instance() {
31		return parent::get_instance( __CLASS__ );
		0 ignored issues – show Comprehensibility Bug introduced 2015-11-23 01:20 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`get_instance()` instead of `instance()`). Are you sure this is correct? If so, you might want to change this to `$this->get_instance()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
32		}
33
34
35
36		/**
37		* set_hooks - for hooking into EE Core, other modules, etc
38		*
39		* @access public
40		* @return void
41		*/
42		public static function set_hooks() {
43		}
44
45		/**
46		* set_hooks_admin - for hooking into EE Admin Core, other modules, etc
47		*
48		* @access public
49		* @return void
50		*/
51		public static function set_hooks_admin() {
52		define( 'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH', str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS );
53		define( 'EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
54		add_action( 'AHEE__template_settings__template__before_settings_form', array( 'EED_Events_Archive_Caff', 'template_settings_form' ), 10 );
55		add_filter( 'FHEE__General_Settings_Admin_Page__update_template_settings__data', array( 'EED_Events_Archive_Caff', 'update_template_settings' ), 10, 2 );
56		// AJAX
57		add_action( 'wp_ajax_espresso_update_event_archive_order', array( 'EED_Events_Archive_Caff', 'update_event_archive_order' ) );
58		add_action( 'wp_ajax_nopriv_espresso_update_event_archive_order', array( 'EED_Events_Archive_Caff', 'update_event_archive_order' ) );
59		}
60
61
62
63
64		/**
65		* run - initial module setup
66		*
67		* @access public
68		* @param WP $WP
69		* @return void
70		*/
71		public function run( $WP ) {
72		}
73
74
75
76
77		/**
78		* template_settings_form
79		*
80		* @access public
81		* @static
82		* @return void
83		*/
84		public static function template_settings_form() {
85		// grab general settings admin page and remove the existing hook callback
86		$gen_set_admin = EE_Registry::instance()->LIB->EE_Admin_Page_Loader->get_admin_page_object( 'general_settings' );
87		if ( $gen_set_admin instanceof General_Settings_Admin_Page ) {
88		remove_action( 'AHEE__template_settings__template__before_settings_form', array( $gen_set_admin, 'template_settings_caff_features' ), 100 );
89		}
90		// first just grab the template settings
91		$config = EE_Registry::instance()->CFG->template_settings;
92		// then if the Event Archive config is valid, use that, else create a new one
93		$config = isset( $config->EED_Events_Archive ) && $config->EED_Events_Archive instanceof EE_Events_Archive_Config ? $config->EED_Events_Archive : new EE_Events_Archive_Config();
94		$config = apply_filters( 'FHEE__EED_Events_Archive__template_settings_form__event_list_config', $config );
95		$config->display_status_banner = isset( $config->display_status_banner ) ? $config->display_status_banner : 0;
96		$config->display_description = isset( $config->display_description ) ? $config->display_description : 1;
97		$config->display_ticket_selector = isset( $config->display_ticket_selector ) ? $config->display_ticket_selector : 0;
98		$config->display_datetimes = isset( $config->display_datetimes ) ? $config->display_datetimes : 1;
99		$config->display_venue = isset( $config->display_venue ) ? $config->display_venue : 0;
100		$config->display_expired_events = isset( $config->display_expired_events ) ? $config->display_expired_events : 0;
101		// display order options
102		$config->use_sortable_display_order = isset( $config->use_sortable_display_order )? $config->use_sortable_display_order : false;
103		$config->display_order_tickets = isset( $config->display_order_tickets )? $config->display_order_tickets : 100;
104		$config->display_order_datetimes = isset( $config->display_order_datetimes )? $config->display_order_datetimes : 110;
105		$config->display_order_event = isset( $config->display_order_event )? $config->display_order_event : 120;
106		$config->display_order_venue = isset( $config->display_order_venue )? $config->display_order_venue : 130;
107		// get template parts
108		$template_parts = EED_Events_Archive::instance()->initialize_template_parts( $config );
109		// convert to array so that we can add more properties
110		$config = get_object_vars( $config );
111		$config[ 'event_archive_display_order' ] = $template_parts->generate_sortable_list_of_template_parts( 'event-archive-sortable-js', '', 'archive-sortable-li archive-sortable-js' );
112		EEH_Template::display_template( EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php', $config );
113		}
114
115
116
117
118
119
120		/**
121		* update_template_settings
122		*
123		* @access public
124		* @param EE_Template_Config $CFG
125		* @param array $REQ
126		* @return EE_Events_Archive_Config
127		*/
128		public static function update_template_settings( $CFG, $REQ ) {
129		$config = new EE_Events_Archive_Config();
130		// unless we are resetting the config...
131		if ( ! isset( $REQ['EED_Events_Archive_reset_event_list_settings'] ) \|\| absint( $REQ['EED_Events_Archive_reset_event_list_settings'] ) !== 1 ) {
132		$config->display_status_banner = isset( $REQ['EED_Events_Archive_display_status_banner'] ) ? absint( $REQ['EED_Events_Archive_display_status_banner'] ) : 0;
133		$config->display_description = isset( $REQ['EED_Events_Archive_display_description'] ) ? absint( $REQ['EED_Events_Archive_display_description'] ) : 1;
134		$config->display_ticket_selector = isset( $REQ['EED_Events_Archive_display_ticket_selector'] ) ? absint( $REQ['EED_Events_Archive_display_ticket_selector'] ) : 0;
135		$config->display_datetimes = isset( $REQ['EED_Events_Archive_display_datetimes'] ) ? absint( $REQ['EED_Events_Archive_display_datetimes'] ) : 1;
136		$config->display_venue = isset( $REQ['EED_Events_Archive_display_venue'] ) ? absint( $REQ['EED_Events_Archive_display_venue'] ) : 0;
137		$config->display_expired_events = isset( $REQ['EED_Events_Archive_display_expired_events'] ) ? absint( $REQ['EED_Events_Archive_display_expired_events'] ) : 0;
138		$config->use_sortable_display_order = isset( $REQ['EED_Events_Archive_use_sortable_display_order'] ) ? absint( $REQ['EED_Events_Archive_use_sortable_display_order'] ) : 0;
139		$config->display_order_tickets = isset( $CFG->EED_Events_Archive->display_order_tickets ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_tickets : 100;
140		$config->display_order_datetimes = isset( $CFG->EED_Events_Archive->display_order_datetimes ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_datetimes : 110;
141		$config->display_order_event = isset( $CFG->EED_Events_Archive->display_order_event ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_event : 120;
142		$config->display_order_venue = isset( $CFG->EED_Events_Archive->display_order_venue ) && $config->use_sortable_display_order ? $CFG->EED_Events_Archive->display_order_venue : 130;
143		}
144		$CFG->EED_Events_Archive = $config;
145		do_action( 'AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ );
146		return $CFG;
147		}
148
149
150
151		/**
152		* update_event_single_order
153		*
154		* @access public
155		* @return void
156		*/
157		public static function update_event_archive_order() {
158		$config_saved = false;
159		$template_parts = sanitize_text_field( $_POST[ 'elements' ] );
160		if ( ! empty( $template_parts ) ) {
161		$template_parts = explode( ',', trim( $template_parts, ',' ) );
162		foreach ( $template_parts as $key => $template_part ) {
163		$template_part = "display_order_$template_part";
164		$priority = ( $key * 10 ) + 100;
165		if (
166		property_exists(
167		EE_Registry::instance()->CFG->template_settings->EED_Events_Archive,
168		$template_part
169		)
170		) {
171		EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->$template_part = $priority;
172		}
173		do_action( "AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority );
174		}
175		$config_saved = EE_Registry::instance()->CFG->update_espresso_config( false, false );
176		}
177	View Code Duplication	if ( $config_saved ) {
		0 ignored issues – show Duplication introduced 2015-11-27 04:50 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...
178		EE_Error::add_success( __( 'Display Order has been successfully updated.', 'event_espresso' ) );
179		} else {
180		EE_Error::add_error( __( 'Display Order was not updated.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
181		}
182		echo wp_json_encode( EE_Error::get_notices( false ) );
183		exit();
184		}
185
186
187		}
188
189
190
191
192
193		// End of file EED_Events_Archive.module.php
194		// Location: /modules/events_archive_caff/EED_Events_Archive.module.php

eventespresso / event-espresso-core