GetPaid_Notification_Email

Complexity

Total Complexity

17

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	is_admin_email()	0	3	1
A	get_heading()	0	3	1
A	get_subject()	0	3	1
A	get_body()	0	3	1
A	get_option()	0	16	5
A	get_content()	0	19	1
A	include_admin_bcc()	0	3	1
A	is_active()	0	3	1
A	get_attachments()	0	2	1
A	get_merge_tags()	0	8	1
A	add_merge_tags()	0	7	2

<?php
/**
 * Contains the notification email class.
 *
 */

defined( 'ABSPATH' ) || exit;

/**
 * Represents a single email type.
 *
 */
class GetPaid_Notification_Email {

    /**
	 * Contains the type of this notification email.
	 *
	 * @var string
	 */
    public $id;

    /**
	 * Contains any object to use in filters.
	 *
	 * @var false|WPInv_Invoice|WPInv_Item|WPInv_Subscription
	 */
    public $object;

    /**
	 * Class constructor.
	 *
     * @param string $id Email Type.
     * @param mixed $object Optional. Associated object.
	 */
	public function __construct( $id, $object = false ) {
        $this->id     = $id;
        $this->object = $object;
    }

    /**
	 * Retrieves an option
	 *
     * @return mixed
	 */
	public function get_option( $key ) {

        $key   = "email_{$this->id}_$key";
        $value = wpinv_get_option( $key, null );

        if ( is_null( $value ) ) {

The condition is_null($value) is always false.

            $options = wpinv_get_emails();

            if ( ! isset( $options[ $this->id ] ) || ! isset( $options[ $this->id ][ $key ] ) ) {
                return '';
            }

            $value = isset( $options[ $this->id ][ $key ]['std'] ) ? $options[ $this->id ][ $key ]['std'] : '';
        }

        return $value;
    }

    /**
	 * Retrieves the email body.
	 *
     * @return string
	 */
	public function get_body() {
        $body = $this->get_option( 'body' );
        return apply_filters( 'getpaid_get_email_body', $body, $this->id, $this->object );

The expression return apply_filters('getpaid_get_email_body', $body, $this->id, $this->object) also could return the type array which is incompatible with the documented return type string.

    }

    /**
	 * Retrieves the email subject.
	 *
     * @return string
	 */
	public function get_subject() {
        $subject = $this->get_option( 'subject' );
        return apply_filters( 'getpaid_get_email_subject', $subject, $this->id, $this->object );

The expression return apply_filters('getpaid_get_email_subject', $subject, $this->id, $this->object) also could return the type array which is incompatible with the documented return type string.

    }

    /**
	 * Retrieves the email heading.
	 *
     * @return string
	 */
	public function get_heading() {
        $heading = $this->get_option( 'heading' );
        return apply_filters( 'getpaid_get_email_heading', $heading, $this->id, $this->object );

The expression return apply_filters('getpaid_get_email_heading', $heading, $this->id, $this->object) also could return the type array which is incompatible with the documented return type string.

    }

    /**
	 * Checks if an email is active.
	 *
     * @return bool
	 */
	public function is_active() {
        $is_active = ! empty( $this->get_option( 'is_active' ) );
        return apply_filters( 'getpaid_email_type_is_active', $is_active, $this->id, $this->object );
    }

    /**
	 * Checks if the site's admin should receive email notifications.
	 *
     * @return bool
	 */
	public function include_admin_bcc() {
        $include_admin_bcc = ! empty( $this->get_option( 'admin_bcc' ) );
        return apply_filters( 'getpaid_email_type_include_admin_bcc', $include_admin_bcc, $this->id, $this->object );
    }

    /**
	 * Checks whether this email should be sent to the customer or admin.
	 *
     * @return bool
	 */
	public function is_admin_email() {
        $is_admin_email = in_array( $this->id, array( 'new_invoice', 'cancelled_invoice', 'failed_invoice' ) );
        return apply_filters( 'getpaid_email_type_is_admin_email', $is_admin_email, $this->id, $this->object );
    }

    /**
	 * Returns email attachments.
	 *
     * @return array
	 */
	public function get_attachments() {
        return apply_filters( 'getpaid_get_email_attachments', array(), $this->id, $this->object );
    }

    /**
	 * Returns an array of merge tags.
	 *
     * @return array
	 */
	public function get_merge_tags() {

        $merge_tags = array(
            '{site_title}' => wpinv_get_blogname(),
            '{date}'       => date_i18n( get_option( 'date_format' ), current_time( 'timestamp' ) ),

It seems like get_option('date_format') can also be of type false; however, parameter $format of date_i18n() does only seem to accept string, maybe add an additional type check?

        );

        return apply_filters( 'getpaid_get_email_merge_tags', $merge_tags, $this->id, $this->object );
    }

    /**
	 * Adds merge tags to a text.
	 *
     * @param string string $text
     * @param array $merge_tags
     * @return string
	 */
	public function add_merge_tags( $text, $merge_tags = array() ) {

        foreach ( $merge_tags as $key => $value ) {
            $text = str_replace( $key, $value, $text );
        }

        return wptexturize( $text );
    }

    /**
	 * Returns the email content
	 *
     * @param array $merge_tags
     * @param array $extra_args Extra template args
     * @return string
	 */
	public function get_content( $merge_tags = array(), $extra_args = array() ) {

        $content = wpinv_get_template_html(
            "emails/wpinv-email-{$this->id}.php",
            array_merge(
                $extra_args,
                array(
                    'invoice'       => $this->object, // Backwards compat.
                    'object'        => $this->object,
                    'email_type'    => $this->id,
                    'email_heading' => $this->add_merge_tags( $this->get_heading(), $merge_tags ),
                    'sent_to_admin' => $this->is_admin_email(),
                    'plain_text'    => false,
                    'message_body'  => wpautop( $this->add_merge_tags( $this->get_body(), $merge_tags ) ),
                )
            )
        );

        return wpinv_email_style_body( $content );
    }

}