EE_Message::set_messenger() - Code Metrics - Inspection of "Daily Inspection: fix wonky merge; [touch:9623]" - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Branch — BUG-9623-config-log (c144cd)

unknown
created 2016-05-29 21:34 UTC
EE_Message::set_messenger() A

↳ Parent: EE_Message
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?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;
	}



	/**
	 * 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;
	}



	/**
	 * Sets message_type
	 *
	 * @param EE_message_type $message_type
	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
	 *                                        the message type or not.
	 */
	public function set_message_type_object( EE_message_type $message_type, $set_priority = false ) {
		$this->_message_type = $message_type;
		if ( $set_priority ) {
			$this->set_priority( $this->_message_type->get_priority() );
		}
	}



	/**
	 * 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;
	}



	/**
	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
	 *
	 * @param bool $throw_exceptions
	 * @return bool
	 * @throws \EE_Error
	 */
	public function is_valid( $throw_exceptions = false ) {
		if ( $this->valid_messenger( $throw_exceptions ) && $this->valid_message_type( $throw_exceptions ) ) {
			return true;
		}
		return false;
	}


	/**
	 * This validates whether the internal messenger and message type objects are valid for sending.
	 *
	 * Three checks are done:
	 *
	 * 1. There is a valid messenger object.
	 * 2. There is a valid message type object.
	 * 3. The message type object is active for the messenger.
	 *
	 * @throws EE_Error  But only if $throw_exceptions is set to true.
	 *
	 * @param bool $throw_exceptions
	 * @return bool
	 */
	public function is_valid_for_sending_or_generation( $throw_exceptions = false ) {
		$valid = false;
		if ( $this->is_valid( $throw_exceptions ) ) {
			/** @var EE_Message_Resource_Manager $message_resource_manager */
			$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
			$valid = $message_resource_manager->is_message_type_active_for_messenger( $this->messenger(), $this->message_type() );
			if ( ! $valid && $throw_exceptions ) {
				throw new EE_Error(
					sprintf(
						__( 'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.', 'event_espresso' ),
						$this->message_type(),
						$this->messenger()
					)
				);
			}
		}
		return $valid;
	}



	/**
	 * 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_Message_Resource_Manager $message_resource_manager */
		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
		$contexts = $message_resource_manager->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() );
	}



	/**
	 * 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
	 *
	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
	 * this method calls the send_now method to verify that.
	 *
	 * @param int $priority
	 */
	public function set_priority( $priority ) {
		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
		parent::set( 'MSG_priority', $priority );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

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


	/**
	 * Overrides parent::set method so we can capture any sets for priority.
	 * @see parent::set() for phpdocs
	 * @param string $field_name
	 * @param mixed  $field_value
	 * @param bool   $use_default
	 * @throws EE_Error
	 */
	public function set( $field_name, $field_value, $use_default = false ) {
		if ( $field_name === 'MSG_priority' ) {
			$this->set_priority( $field_value );
		}
		parent::set( $field_name, $field_value, $use_default );
	}



	/**
	 * @return bool
	 * @throws \EE_Error
	 */
	public function send_now() {
		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high : $this->priority();
		return $send_now === EEM_Message::priority_high ? true : false;
	}



	/**
	 * 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 :
			case EEM_Message::status_debug_only :
				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

Branch — BUG-9623-config-log (c144cd)

EE_Message::set_messenger() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
