EE_Message - Code Metrics - Inspection of "Daily Inspection: remove all resource validation l..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — FET-9046-messages-queue (ac2959)

unknown

created 2016-01-14 21:40 UTC

EE_Message F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	749
Duplicated Lines	8.28 %

Coupling/Cohesion

Components	2
Dependencies	10

Metric	Value
wmc	76
lcom	2
cbo	10
dl	62
loc	749
rs	3.7142

54 Methods

Rating	Name	Duplication	Size	Complexity
A	new_instance_from_db()	0	3	1
A	MSG_token()	0	3	1
A	set_MSG_token()	0	3	1
A	GRP_ID()	0	3	1
A	set_GRP_ID()	0	3	1
A	TXN_ID()	0	3	1
A	set_TXN_ID()	0	3	1
A	messenger()	0	3	1
A	set_messenger()	0	3	1
A	set_messenger_object()	0	3	1
A	new_instance()	0	9	3
A	messenger_object()	0	5	1
A	valid_messenger()	0	17	3
A	messenger_label()	0	5	3
A	message_type()	0	3	1
A	set_message_type()	0	3	1
A	message_type_object()	0	5	1
A	set_message_type_object()	0	3	1
A	valid_message_type()	0	17	3
A	message_type_label()	0	5	3
A	context()	0	3	1
A	context_label()	0	6	2
A	set_context()	0	3	1
A	recipient_ID()	0	3	1
A	set_recipient_ID()	0	3	1
A	recipient_type()	0	3	1
A	recipient_object()	0	7	3
A	set_recipient_type()	0	3	1
A	content()	0	3	1
A	set_content()	0	3	1
A	subject()	0	3	1
A	set_subject()	0	3	1
A	to()	0	4	2
A	set_to()	0	3	1
A	from()	0	3	1
A	set_from()	0	3	1
A	priority()	0	3	1
A	set_priority()	0	3	1
A	STS_ID()	0	3	1
A	set_STS_ID()	0	3	1
A	created()	0	3	1
A	set_created()	0	3	1
A	modified()	0	3	1
A	set_modified()	0	3	1
A	set_generation_data()	0	3	1
A	get_generation_data()	0	3	1
A	error_message()	0	3	1
A	set_error_message()	0	3	1
A	get_template_pack()	20	20	4
B	get_template_pack_variation()	22	22	4
A	get_admin_details_link()	0	16	3
A	get_admin_edit_link()	0	3	1
A	get_admin_settings_link()	10	10	1
A	get_admin_overview_link()	10	10	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 EE_Message 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 EE_Message, and based on these observations, apply Extract Interface, too.

<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}
/**
 * EE_Message class
 *
 * @package 	Event Espresso
 * @subpackage 	db classes
 * @author 		Darren Ethier
 */
class EE_Message extends EE_Base_Class implements EEI_Admin_Links {

	/**
	 * @deprecated 4.9.0  Added for backward compat with add-on's
	 * @type null
	 */
	public $template_pack;

	/**
	 * @deprecated 4.9.0 Added for backward compat with add-on's
	 * @type null
	 */
	public $template_variation;

	/**
	 * @deprecated 4.9.0 Added for backward compat with add-on's
	 * @type string
	 */
	public $content = '';


	/**
	 * @type EE_Messenger $_messenger
	 */
	protected $_messenger = null;

	/**
	 * @type EE_Message_Type $_message_type
	 */
	protected $_message_type = null;



	/**
	 *
	 * @param array  $props_n_values
	 * @param string $timezone
	 * @param array $date_formats incoming date formats in an array.  First value is the date_format, second is time format.
	 * @return EE_Message
	 */
	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
		$has_object = parent::_check_for_object( $props_n_values, __CLASS__ );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
		//if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
		if ( ! $has_object ) {
			EE_Registry::instance()->load_helper( 'URL' );
			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
		}
		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
	}



	/**
	 *
	 * @param array  $props_n_values
	 * @param string $timezone
	 * @return EE_Message
	 */
	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
		return new self( $props_n_values, true, $timezone );
	}



	/**
	 * Gets MSG_token
	 *
	 * @return int
	 */
	public function MSG_token() {
		return $this->get( 'MSG_token' );
	}



	/**
	 * Sets MSG_token
	 *
	 * @param int $MSG_token
	 */
	public function set_MSG_token( $MSG_token) {
		$this->set( 'MSG_token', $MSG_token );
	}




	/**
	 * Gets GRP_ID
	 *
	 * @return int
	 */
	public function GRP_ID() {
		return $this->get( 'GRP_ID' );
	}



	/**
	 * Sets GRP_ID
	 *
	 * @param int $GRP_ID
	 */
	public function set_GRP_ID( $GRP_ID ) {
		$this->set( 'GRP_ID', $GRP_ID );
	}




	/**
	 * Gets TXN_ID
	 *
	 * @return int
	 */
	public function TXN_ID() {
		return $this->get( 'TXN_ID' );
	}



	/**
	 * Sets TXN_ID
	 *
	 * @param int $TXN_ID
	 */
	public function set_TXN_ID( $TXN_ID) {
		$this->set( 'TXN_ID', $TXN_ID );
	}




	/**
	 * Gets messenger
	 *
	 * @return string
	 */
	public function messenger() {
		return $this->get( 'MSG_messenger' );
	}



	/**
	 * Sets messenger
	 *
	 * @param string $messenger
	 */
	public function set_messenger( $messenger ) {
		$this->set( 'MSG_messenger', $messenger );
	}



	/**
	 * Returns corresponding messenger object for the set messenger on this message
	 *
	 * @return EE_Messenger | null
	 */
	public function messenger_object() {
		return $this->_messenger;
		//EE_Registry::instance()->load_helper( 'MSG_Template' );
		//return EEH_MSG_Template::messenger_obj( $this->messenger() );
	}



	/**
	 * Sets messenger
	 *
	 * @param EE_Messenger $messenger
	 */
	public function set_messenger_object( EE_Messenger $messenger ) {
		$this->_messenger = $messenger;
	}



	/**
	 * validates messenger
	 *
	 * @param bool $throw_exceptions
	 * @return bool
	 * @throws \EE_Error
	 */
	public function valid_messenger( $throw_exceptions = false ) {
		if ( $this->_messenger instanceof EE_Messenger ) {
			return true;
		}
		if ( $throw_exceptions ) {
			throw new EE_Error(
				sprintf(
					__(
						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
						'event_espresso'
					),
					$this->messenger()
				)
			);
		}
		return false;
	}



	/**
	 * This returns the set localized label for the messenger on this message.
	 * Note, if unable to retrieve the EE_Messenger object then will just return the messenger slug saved
	 * with this message.
	 *
	 * @param   bool    $plural whether to return the plural label or not.
	 * @return string
	 */
	public function messenger_label( $plural = false ) {
		$label_type = $plural ? 'plural' : 'singular';
		$messenger = $this->messenger_object();
		return $messenger instanceof EE_Messenger ? $messenger->label[ $label_type ] : $this->messenger();
	}



	/**
	 * Gets message_type
	 *
	 * @return string
	 */
	public function message_type() {
		return $this->get( 'MSG_message_type' );
	}



	/**
	 * Sets message_type
	 *
	 * @param string $message_type
	 */
	public function set_message_type( $message_type ) {
		$this->set( 'MSG_message_type', $message_type );
	}



	/**
	 * Returns the message type object for the set message type on this message
	 *
	 * @return EE_message_type | null
	 */
	public function message_type_object() {
		return $this->_message_type;
		//EE_Registry::instance()->load_helper( 'MSG_Template' );
		//return EEH_MSG_Template::message_type_obj( $this->message_type() );
	}



	/**
	 * Sets message_type
	 *
	 * @param EE_Message_Type $message_type
	 */
	public function set_message_type_object( EE_Message_Type $message_type ) {
		$this->_message_type = $message_type;
	}



	/**
	 * validates message_type
	 *
	 * @param bool $throw_exceptions
	 * @return bool
	 * @throws \EE_Error
	 */
	public function valid_message_type( $throw_exceptions = false ) {
		if ( $this->_message_type instanceof EE_Message_Type ) {
			return true;
		}
		if ( $throw_exceptions ) {
			throw new EE_Error(
				sprintf(
					__(
						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
						'event_espresso'
					),
					$this->message_type()
				)
			);
		}
		return false;
	}



	/**
	 * This returns the set localized label for the message type on this message.
	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
	 * with this message.
	 *
	 * @param   bool    $plural whether to return the plural label or not.
	 * @return string
	 */
	public function message_type_label( $plural = false ) {
		$label_type = $plural ? 'plural' : 'singular';
		$message_type = $this->message_type_object();
		return $message_type instanceof EE_message_type ? $message_type->label[ $label_type ] : $this->message_type();
	}



	/**
	 * Gets context
	 *
	 * @return string
	 */
	public function context() {
		return $this->get( 'MSG_context' );
	}




	/**
	 * This returns the corresponding localized label for the given context slug, if possible from installed message types.
	 * Otherwise, this will just return the set context slug on this object.
	 *
	 * @return string
	 */
	public function context_label() {
		/** @type EE_Messages $messages_controller */
		$messages_controller = EE_Registry::instance()->load_lib( 'messages' );
		$contexts = $messages_controller->get_all_contexts();
		return isset( $contexts[ $this->context() ] ) ? $contexts[ $this->context() ] : $this->context();
	}



	/**
	 * Sets context
	 *
	 * @param string $context
	 */
	public function set_context( $context ) {
		$this->set( 'MSG_context', $context );
	}



	/**
	 * Gets recipient_ID
	 *
	 * @return int
	 */
	public function recipient_ID() {
		return $this->get( 'MSG_recipient_ID' );
	}



	/**
	 * Sets recipient_ID
	 *
	 * @param string $recipient_ID
	 */
	public function set_recipient_ID( $recipient_ID ) {
		$this->set( 'MSG_recipient_ID', $recipient_ID );
	}



	/**
	 * Gets recipient_type
	 *
	 * @return string
	 */
	public function recipient_type() {
		return $this->get( 'MSG_recipient_type' );
	}




	/**
	 * Return the related object matching the recipient type and ID.
	 *
	 * @return EE_Base_Class | null
	 */
	public function recipient_object() {
		if ( ! $this->recipient_type() || ! $this->recipient_ID() ) {
			return null;
		}

		return $this->get_first_related( $this->recipient_type() );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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



	/**
	 * Sets recipient_type
	 *
	 * @param string $recipient_type
	 */
	public function set_recipient_type( $recipient_type ) {
		$this->set( 'MSG_recipient_type', $recipient_type );
	}



	/**
	 * Gets content
	 *
	 * @return string
	 */
	public function content() {
		return $this->get( 'MSG_content' );
	}



	/**
	 * Sets content
	 *
	 * @param string $content
	 */
	public function set_content( $content ) {
		$this->set( 'MSG_content', $content );
	}



	/**
	 * Gets subject
	 *
	 * @return string
	 */
	public function subject() {
		return $this->get( 'MSG_subject' );
	}



	/**
	 * Sets subject
	 *
	 * @param string $subject
	 */
	public function set_subject( $subject ) {
		$this->set( 'MSG_subject', $subject );
	}



	/**
	 * Gets to
	 *
	 * @return string
	 */
	public function to() {
		$to = $this->get( 'MSG_to' );
		return empty( $to ) ? __( 'No recipient', 'event_espresso' ) : $to;
	}



	/**
	 * Sets to
	 *
	 * @param string $to
	 */
	public function set_to( $to ) {
		$this->set( 'MSG_to', $to );
	}



	/**
	 * Gets from
	 *
	 * @return string
	 */
	public function from() {
		return $this->get( 'MSG_from' );
	}



	/**
	 * Sets from
	 *
	 * @param string $from
	 */
	public function set_from( $from ) {
		$this->set( 'MSG_from', $from );
	}





	/**
	 * Gets priority
	 *
	 * @return int
	 */
	public function priority() {
		return $this->get( 'MSG_priority' );
	}



	/**
	 * Sets priority
	 *
	 * @param int $priority
	 */
	public function set_priority( $priority ) {
		$this->set( 'MSG_priority', $priority );
	}



	/**
	 * Gets STS_ID
	 *
	 * @return string
	 */
	public function STS_ID() {
		return $this->get( 'STS_ID' );
	}



	/**
	 * Sets STS_ID
	 *
	 * @param string $STS_ID
	 */
	public function set_STS_ID( $STS_ID ) {
		$this->set( 'STS_ID', $STS_ID );
	}



	/**
	 * Gets created
	 *
	 * @return string
	 */
	public function created() {
		return $this->get( 'MSG_created' );
	}



	/**
	 * Sets created
	 *
	 * @param string $created
	 */
	public function set_created( $created ) {
		$this->set( 'MSG_created', $created );
	}



	/**
	 * Gets modified
	 *
	 * @return string
	 */
	public function modified() {
		return $this->get( 'MSG_modified' );
	}



	/**
	 * Sets modified
	 *
	 * @param string $modified
	 */
	public function set_modified( $modified ) {
		$this->set( 'MSG_modified', $modified );
	}




	/**
	 * Sets generation data for this message.
	 * @param mixed $data
	 */
	public function set_generation_data( $data ) {
		$this->set_field_or_extra_meta( 'MSG_generation_data', $data );
	}





	/**
	 * Returns any set generation data for this message.
	 * @return mixed|null
	 */
	public function get_generation_data() {
		return $this->get_field_or_extra_meta( 'MSG_generation_data' );
	}




	/**
	 * Gets any error message.
	 * @return mixed|null
	 */
	public function error_message() {
		return $this->get_field_or_extra_meta( 'MSG_error' );
	}


	/**
	 * Sets an error message.
	 * @param $message
	 * @return bool|int
	 */
	public function set_error_message( $message ) {
		return $this->set_field_or_extra_meta( 'MSG_error', $message );
	}




	/**
	 * This retrieves the associated template pack with this message.
	 * @return EE_Messages_Template_Pack | null
	 */
	public function get_template_pack() {

		/**
		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
		 */
		if ( ! empty( $this->template_pack ) ) {

			return $this->template_pack;

		}
		/** @type EE_Message_Template_Group $grp */
		$grp = $this->get_first_related( 'Message_Template_Group' );
		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
		if ( ! $grp instanceof EE_Message_Template_Group ) {
			$grp = EEM_Message_Template_Group::instance()->get_one( array( array(
				'MTP_messenger' => $this->messenger(),
				'MTP_message_type' => $this->message_type(),
				'MTP_is_global' => true
			) ) );
		}

		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
	}




	/**
	 * Retrieves the variation used for generating this message.
	 * @return string
	 */
	public function get_template_pack_variation() {

		/**
		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
		 */
		if ( ! empty( $this->template_variation ) ) {

			return $this->template_variation;

		}

		/** @type EE_Message_Template_Group $grp */
		$grp = $this->get_first_related( 'Message_Template_Group' );

		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
		if ( ! $grp instanceof EE_Message_Template_Group ) {
			$grp = EEM_Message_Template_Group::instance()->get_one( array( array(
				'MTP_messenger' => $this->messenger(),
				'MTP_message_type' => $this->message_type(),
				'MTP_is_global' => true
			) ) );
		}

		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
	}

	/**
	 * Return the link to the admin details for the object.
	 * @return string
	 */
	public function get_admin_details_link() {
		EE_Registry::instance()->load_helper( 'URL' );
		EE_Registry::instance()->load_helper( 'MSG_Template' );
		switch ( $this->STS_ID() ) {
			case EEM_Message::status_failed :
				return EEH_MSG_Template::generate_error_display_trigger( $this );
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

			case EEM_Message::status_sent :
				return EEH_MSG_Template::generate_browser_trigger( $this );
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

			default :
				return '';
		}
	}

	/**
	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
	 * @return string
	 */
	public function get_admin_edit_link() {
		return $this->get_admin_details_link();
	}

	/**
	 * Returns the link to a settings page for the object.
	 * @return string
	 */
	public function get_admin_settings_link() {

		EE_Registry::instance()->load_helper( 'URL' );
		return EEH_URL::add_query_args_and_nonce(
			array(
				'page' => 'espresso_messages',
				'action' => 'settings',
			),
			admin_url( 'admin.php' )
		);
	}

	/**
	 * Returns the link to the "overview" for the object (typically the "list table" view).
	 * @return string
	 */
	public function get_admin_overview_link() {

		EE_Registry::instance()->load_helper( 'URL' );
		return EEH_URL::add_query_args_and_nonce(
			array(
				'page' => 'espresso_messages',
				'action' => 'default',
			),
			admin_url( 'admin.php' )
		);
	}


}
/* End of file EE_Message.class.php */
/* Location: /core/db_classes/EE_Message.class.php */

eventespresso / event-espresso-core