eventespresso / event-espresso-core

modules/gateways/Invoice/lib/Invoice.class.php

Indentation +427 added lines, -427 removed lines

@@ -13,431 +13,431 @@
  */
 class Invoice
 {
-    /**
-     *
-     * @var EE_Registration
-     */
-    private $registration;
-
-    /**
-     *
-     * @var EE_Transaction
-     */
-    private $transaction;
-
-    /**
-     *
-     * @var EE_Payment_Method
-     */
-    private $invoice_payment_method;
-
-
-    /**
-     * Invoice constructor.
-     *
-     * @param int $url_link
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.9.13
-     */
-    public function __construct($url_link = 0)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__,
-            esc_html__(
-                'This class has been deprecated and replaced by the new Messages library.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        /** @var EEM_Registration $reg_model */
-        $reg_model = EE_Registry::instance()->load_model('Registration');
-        if ($this->registration = $reg_model->get_registration_for_reg_url_link($url_link)) {
-            $this->transaction = $this->registration->transaction();
-            EE_Config::instance()->gateway->payment_settings;
-            $this->invoice_payment_method = EEM_Payment_Method::instance()->get_one_of_type('Invoice');
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Your request appears to be missing some required data, and no information for your transaction could be retrieved.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param false $download
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function send_invoice($download = false)
-    {
-        $template_args = [];
-        $EE            = EE_Registry::instance();
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $theme   = $request->getRequestParam('theme', 0, 'int');
-        // allow the request to override the default theme defined in the invoice settings
-        $theme_requested = $theme > 0 && $theme < 8
-                ? $theme
-                : null;
-        $themes          = [
-            1 => "simple.css",
-            2 => "bauhaus.css",
-            3 => "ejs.css",
-            4 => "horizon.css",
-            5 => "lola.css",
-            6 => "tranquility.css",
-            7 => "union.css",
-        ];
-        // Get the CSS file
-        if (isset($themes[ $theme_requested ])) {
-            $template_args['invoice_css'] = $themes[ $theme_requested ];
-        } else {
-            $template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
-                'legacy_invoice_css',
-                true,
-                'simple.css'
-            );
-        }
-
-        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
-            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
-        } else {
-            $template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
-        }
-        $primary_attendee = $this->transaction->primary_registration()->attendee();
-
-        $template_args['organization'] = $EE->CFG->organization->get_pretty('name');
-        $template_args['street']       = empty($EE->CFG->organization->address_2)
-                ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1')
-                  . '<br>'
-                  . $EE->CFG->organization->get_pretty('address_2');
-        $template_args['city']         = $EE->CFG->organization->get_pretty('city');
-        $template_args['state']        = EE_Registry::instance()->load_model('State')->get_one_by_ID(
-            $EE->CFG->organization->STA_ID
-        );
-        $template_args['country']      = EE_Registry::instance()->load_model('Country')->get_one_by_ID(
-            $EE->CFG->organization->CNT_ISO
-        );
-        $template_args['zip']          = $EE->CFG->organization->get_pretty('zip');
-        $template_args['email']        = $EE->CFG->organization->get_pretty('email');
-
-        $template_args['registration_code'] = $this->registration->reg_code();
-        $template_args['registration_date'] = $this->registration->date();
-        $template_args['name']              = $primary_attendee->full_name();
-        $template_args['attendee_address']  = $primary_attendee->address();
-        $template_args['attendee_address2'] = $primary_attendee->address2();
-        $template_args['attendee_city']     = $primary_attendee->city();
-        $attendee_state                     = $primary_attendee->state_obj();
-        if ($attendee_state) {
-            $attendee_state_name = $attendee_state->name();
-        } else {
-            $attendee_state_name = '';
-        }
-        $template_args['attendee_state'] = $attendee_state_name;
-        $template_args['attendee_zip']   = $primary_attendee->zip();
-
-        $template_args['ship_name']    = $template_args['name'];
-        $template_args['ship_address'] = $template_args['attendee_address'];
-        $template_args['ship_city']    = $template_args['attendee_city'];
-        $template_args['ship_state']   = $template_args['attendee_state'];
-        $template_args['ship_zip']     = $template_args['attendee_zip'];
-
-        $template_args['total_cost']                 = number_format($this->transaction->total(), 2, '.', '');
-        $template_args['transaction']                = $this->transaction;
-        $template_args['amount_pd']                  = $this->transaction->paid();
-        $template_args['amount_owed']                = $this->transaction->total() - $this->transaction->paid();
-        $template_args['payments']                   = $this->transaction->approved_payments();
-        $template_args['net_total']                  = '';
-        $template_args['edit_reg_info_url']          = $this->registration->edit_attendee_information_url();
-        $template_args['retry_payment_url']          = $this->registration->payment_overview_url();
-        $template_args['show_line_item_description'] = $this->check_if_any_line_items_have_a_description(
-            $this->transaction->total_line_item()
-        );
-        if ($template_args['amount_pd'] != $template_args['total_cost']) {
-            // $template_args['net_total'] = $this->espressoInvoiceTotals(
-            //      esc_html__('SubTotal', 'event_espresso'),
-            //      $this->transaction->total());
-            //      $this->session_data['cart']['REG']['sub_total']
-            // );
-            $tax_items = $this->transaction->tax_items();
-            if (! empty($tax_items)) {
-                foreach ($tax_items as $tax) {
-                    $template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
-                }
-            }
-
-            $difference = $template_args['amount_pd'] - $template_args['total_cost'];
-            if ($difference < 0) {
-                $text = esc_html__('Discount', 'event_espresso');
-            } else {
-                $text = esc_html__('Extra', 'event_espresso');
-            }
-            $template_args['discount'] = $this->espressoInvoiceTotals($text, $difference);
-        }
-
-        $template_args['currency_symbol']               = $EE->CFG->currency->sign;
-        $template_args['template_payment_instructions'] = wpautop(
-            stripslashes_deep(
-                html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
-            )
-        );
-        $template_args['shameless_plug']                = apply_filters(
-            'FHEE_Invoice__send_invoice__shameless_plug',
-            true
-        );
-        $receipt = $request->getRequestParam('receipt');
-        if ($receipt) {
-            // receipt-specific stuff
-            $events_for_txn              = EEM_Event::instance()->get_all(
-                [['Registration.TXN_ID' => $this->transaction->ID()]]
-            );
-            $ticket_line_items_per_event = [];
-            $registrations_per_line_item = [];
-            $venues_for_events           = [];
-            foreach ($events_for_txn as $event_id => $event) {
-                $line_items_for_this_event                = EEM_Line_Item::instance()->get_all(
-                    [['Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()]]
-                );
-                $ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
-                foreach ($line_items_for_this_event as $line_item_id => $line_item) {
-                    if (! $line_item instanceof EE_Line_Item) {
-                        continue;
-                    }
-                    $ticket                                       = $line_item->ticket();
-                    $registrations_for_this_ticket                = EEM_Registration::instance()->get_all(
-                        [['TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()]]
-                    );
-                    $registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
-                }
-                if ($event instanceof EE_Event) {
-                    $venues_for_events += $event->venues();
-                }
-            }
-            $tax_total_line_item = EEM_Line_Item::instance()->get_one(
-                [['TXN_ID' => $this->transaction->ID(), 'LIN_type' => EEM_Line_Item::type_tax_sub_total]]
-            );
-            $questions_to_skip   = [
-                EEM_Attendee::system_question_fname,
-                EEM_Attendee::system_question_lname,
-                EEM_Attendee::system_question_email,
-            ];
-
-
-            $template_args['events_for_txn']              = $events_for_txn;
-            $template_args['ticket_line_items_per_event'] = $ticket_line_items_per_event;
-            $template_args['registrations_per_line_item'] = $registrations_per_line_item;
-            $template_args['venues_for_events']           = $venues_for_events;
-            $template_args['tax_total_line_item']         = $tax_total_line_item;
-            $template_args['questions_to_skip']           = $questions_to_skip;
-            // d($template_args);
-            $template_args['download_link'] = $this->registration->receipt_url('download');
-        } else {
-            // it's just an invoice we're accessing
-            $template_args['download_link'] = $this->registration->invoice_url('download');
-        }
-
-        // Get the HTML as an object
-        $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $template_header         = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_header.template.php',
-            $template_args
-        );
-        if ($receipt) {
-            $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'receipt_body.template.php',
-                $template_args
-            );
-        } else {
-            $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'invoice_body.template.php',
-                $template_args
-            );
-        }
-
-
-        $template_footer = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_footer.template.php',
-            $template_args
-        );
-
-        $copies = $request->getRequestParam('copies', 1, 'int');
-
-        $content = $this->espresso_replace_invoice_shortcodes($template_header);
-        for ($x = 1; $x <= $copies; $x++) {
-            $content .= $this->espresso_replace_invoice_shortcodes($template_body);
-        }
-        $content .= $this->espresso_replace_invoice_shortcodes($template_footer);
-
-        // Check if debugging or mobile is set
-        if ($request->getRequestParam('html')) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-            exit(0);
-        }
-        $invoice_name = $template_args['organization'] . ' ';
-        $invoice_name .= esc_html__('Invoice #', 'event_espresso');
-        $invoice_name .= $template_args['registration_code'];
-        $invoice_name .= esc_html__(' for ', 'event_espresso') . $template_args['name'];
-        $invoice_name = str_replace(' ', '_', $invoice_name);
-        // Create the PDF
-        if ($request->requestParamIsSet('html')) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-            exit(0);
-        }
-        $pdf_adapter = new PdfAdapter();
-        // dompdf options
-        $options = $pdf_adapter->getOptions();
-        if ($options instanceof Dompdf\Options) {
-            $pdf_adapter
-                ->setOptions($options)
-                ->setContent($content)
-                ->generate($invoice_name . ".pdf", (bool) $download);
-            exit(0);
-        }
-        wp_die(esc_html__(
-            'DomPDF package appears to be missing, so cannot generate the PDF file.',
-            'event_espresso'
-        ));
-        exit(0);
-    }
-
-
-    /**
-     * Checks if this line item, or any of its children, actually has a description.
-     * If none do, then the template can decide to not show any description column
-     *
-     * @param EE_Line_Item $line_item
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function check_if_any_line_items_have_a_description(EE_Line_Item $line_item)
-    {
-        if ($line_item->desc()) {
-            return true;
-        } else {
-            foreach ($line_item->children() as $child_line_item) {
-                if ($this->check_if_any_line_items_have_a_description($child_line_item)) {
-                    return true;
-                }
-            }
-            // well, if I and my children don't have descriptions, I guess not
-            return false;
-        }
-    }
-
-
-    /**
-     * Perform the shortcode replacement
-     *
-     * @param $content
-     * @return array|string|string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function espresso_replace_invoice_shortcodes($content)
-    {
-
-        $EE = EE_Registry::instance();
-        // Create the logo
-        $invoice_logo_url = $this->invoice_payment_method->get_extra_meta(
-            'pdf_logo_image',
-            true,
-            $EE->CFG->organization->logo_url
-        );
-        if (! empty($invoice_logo_url)) {
-            $image_size         = getimagesize($invoice_logo_url);
-            $invoice_logo_image =
-                '<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
-        } else {
-            $invoice_logo_image = '';
-        }
-        $SearchValues     = [
-            "[organization]",
-            "[registration_code]",
-            "[transaction_id]",
-            "[name]",
-            "[base_url]",
-            "[download_link]",
-            "[invoice_logo_image]",
-            "[street]",
-            "[city]",
-            "[state]",
-            "[zip]",
-            "[email]",
-            "[vat]",
-            "[registration_date]",
-            "[instructions]",
-        ];
-        $primary_attendee = $this->transaction->primary_registration()->attendee();
-        $org_state        = EE_Registry::instance()->load_model('State')->get_one_by_ID($EE->CFG->organization->STA_ID);
-        if ($org_state) {
-            $org_state_name = $org_state->name();
-        } else {
-            $org_state_name = '';
-        }
-        $ReplaceValues = [
-            $EE->CFG->organization->get_pretty('name'),
-            $this->registration->reg_code(),
-            $this->transaction->ID(),
-            $primary_attendee->full_name(),
-            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice'))
-                ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
-                : EE_GATEWAYS_URL . 'Invoice/lib/templates/',
-            $this->registration->invoice_url(),
-            // home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
-            $invoice_logo_image,
-            empty($EE->CFG->organization->address_2)
-                ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
-                    'address_2'
-                ),
-            $EE->CFG->organization->get_pretty('city'),
-            $org_state_name,
-            $EE->CFG->organization->get_pretty('zip'),
-            $EE->CFG->organization->get_pretty('email'),
-            $EE->CFG->organization->vat,
-            $this->registration->get_i18n_datetime('REG_date', get_option('date_format')),
-            $this->invoice_payment_method->get_extra_meta('pdf_instructions', true),
-        ];
-
-        return str_replace($SearchValues, $ReplaceValues, $content);
-    }
-
-
-    public function espressoLoadData($items)
-    {
-        $lines = $items;
-        $data  = [];
-        foreach ($lines as $line) {
-            $data[] = explode(';', chop($line));
-        }
-
-        return $data;
-    }
-
-
-    public function espressoInvoiceTotals($text, $total_cost)
-    {
-        $html = '';
-        if ($total_cost < 0) {
-            $total_cost = (-1) * $total_cost;
-        }
-        $find    = [' '];
-        $replace = ['-'];
-        $row_id  = strtolower(str_replace($find, $replace, $text));
-        $html    .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
-        $html    .= '<td class="item_r">' . $text . '</td>';
-        $html    .= '<td class="item_r">' . $total_cost . '</td>';
-        $html    .= '</tr>';
-        return $html;
-    }
+	/**
+	 *
+	 * @var EE_Registration
+	 */
+	private $registration;
+
+	/**
+	 *
+	 * @var EE_Transaction
+	 */
+	private $transaction;
+
+	/**
+	 *
+	 * @var EE_Payment_Method
+	 */
+	private $invoice_payment_method;
+
+
+	/**
+	 * Invoice constructor.
+	 *
+	 * @param int $url_link
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.9.13
+	 */
+	public function __construct($url_link = 0)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__,
+			esc_html__(
+				'This class has been deprecated and replaced by the new Messages library.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		/** @var EEM_Registration $reg_model */
+		$reg_model = EE_Registry::instance()->load_model('Registration');
+		if ($this->registration = $reg_model->get_registration_for_reg_url_link($url_link)) {
+			$this->transaction = $this->registration->transaction();
+			EE_Config::instance()->gateway->payment_settings;
+			$this->invoice_payment_method = EEM_Payment_Method::instance()->get_one_of_type('Invoice');
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Your request appears to be missing some required data, and no information for your transaction could be retrieved.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param false $download
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function send_invoice($download = false)
+	{
+		$template_args = [];
+		$EE            = EE_Registry::instance();
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$theme   = $request->getRequestParam('theme', 0, 'int');
+		// allow the request to override the default theme defined in the invoice settings
+		$theme_requested = $theme > 0 && $theme < 8
+				? $theme
+				: null;
+		$themes          = [
+			1 => "simple.css",
+			2 => "bauhaus.css",
+			3 => "ejs.css",
+			4 => "horizon.css",
+			5 => "lola.css",
+			6 => "tranquility.css",
+			7 => "union.css",
+		];
+		// Get the CSS file
+		if (isset($themes[ $theme_requested ])) {
+			$template_args['invoice_css'] = $themes[ $theme_requested ];
+		} else {
+			$template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
+				'legacy_invoice_css',
+				true,
+				'simple.css'
+			);
+		}
+
+		if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
+			$template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
+		} else {
+			$template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
+		}
+		$primary_attendee = $this->transaction->primary_registration()->attendee();
+
+		$template_args['organization'] = $EE->CFG->organization->get_pretty('name');
+		$template_args['street']       = empty($EE->CFG->organization->address_2)
+				? $EE->CFG->organization->get_pretty('address_1')
+				: $EE->CFG->organization->get_pretty('address_1')
+				  . '<br>'
+				  . $EE->CFG->organization->get_pretty('address_2');
+		$template_args['city']         = $EE->CFG->organization->get_pretty('city');
+		$template_args['state']        = EE_Registry::instance()->load_model('State')->get_one_by_ID(
+			$EE->CFG->organization->STA_ID
+		);
+		$template_args['country']      = EE_Registry::instance()->load_model('Country')->get_one_by_ID(
+			$EE->CFG->organization->CNT_ISO
+		);
+		$template_args['zip']          = $EE->CFG->organization->get_pretty('zip');
+		$template_args['email']        = $EE->CFG->organization->get_pretty('email');
+
+		$template_args['registration_code'] = $this->registration->reg_code();
+		$template_args['registration_date'] = $this->registration->date();
+		$template_args['name']              = $primary_attendee->full_name();
+		$template_args['attendee_address']  = $primary_attendee->address();
+		$template_args['attendee_address2'] = $primary_attendee->address2();
+		$template_args['attendee_city']     = $primary_attendee->city();
+		$attendee_state                     = $primary_attendee->state_obj();
+		if ($attendee_state) {
+			$attendee_state_name = $attendee_state->name();
+		} else {
+			$attendee_state_name = '';
+		}
+		$template_args['attendee_state'] = $attendee_state_name;
+		$template_args['attendee_zip']   = $primary_attendee->zip();
+
+		$template_args['ship_name']    = $template_args['name'];
+		$template_args['ship_address'] = $template_args['attendee_address'];
+		$template_args['ship_city']    = $template_args['attendee_city'];
+		$template_args['ship_state']   = $template_args['attendee_state'];
+		$template_args['ship_zip']     = $template_args['attendee_zip'];
+
+		$template_args['total_cost']                 = number_format($this->transaction->total(), 2, '.', '');
+		$template_args['transaction']                = $this->transaction;
+		$template_args['amount_pd']                  = $this->transaction->paid();
+		$template_args['amount_owed']                = $this->transaction->total() - $this->transaction->paid();
+		$template_args['payments']                   = $this->transaction->approved_payments();
+		$template_args['net_total']                  = '';
+		$template_args['edit_reg_info_url']          = $this->registration->edit_attendee_information_url();
+		$template_args['retry_payment_url']          = $this->registration->payment_overview_url();
+		$template_args['show_line_item_description'] = $this->check_if_any_line_items_have_a_description(
+			$this->transaction->total_line_item()
+		);
+		if ($template_args['amount_pd'] != $template_args['total_cost']) {
+			// $template_args['net_total'] = $this->espressoInvoiceTotals(
+			//      esc_html__('SubTotal', 'event_espresso'),
+			//      $this->transaction->total());
+			//      $this->session_data['cart']['REG']['sub_total']
+			// );
+			$tax_items = $this->transaction->tax_items();
+			if (! empty($tax_items)) {
+				foreach ($tax_items as $tax) {
+					$template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
+				}
+			}
+
+			$difference = $template_args['amount_pd'] - $template_args['total_cost'];
+			if ($difference < 0) {
+				$text = esc_html__('Discount', 'event_espresso');
+			} else {
+				$text = esc_html__('Extra', 'event_espresso');
+			}
+			$template_args['discount'] = $this->espressoInvoiceTotals($text, $difference);
+		}
+
+		$template_args['currency_symbol']               = $EE->CFG->currency->sign;
+		$template_args['template_payment_instructions'] = wpautop(
+			stripslashes_deep(
+				html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
+			)
+		);
+		$template_args['shameless_plug']                = apply_filters(
+			'FHEE_Invoice__send_invoice__shameless_plug',
+			true
+		);
+		$receipt = $request->getRequestParam('receipt');
+		if ($receipt) {
+			// receipt-specific stuff
+			$events_for_txn              = EEM_Event::instance()->get_all(
+				[['Registration.TXN_ID' => $this->transaction->ID()]]
+			);
+			$ticket_line_items_per_event = [];
+			$registrations_per_line_item = [];
+			$venues_for_events           = [];
+			foreach ($events_for_txn as $event_id => $event) {
+				$line_items_for_this_event                = EEM_Line_Item::instance()->get_all(
+					[['Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()]]
+				);
+				$ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
+				foreach ($line_items_for_this_event as $line_item_id => $line_item) {
+					if (! $line_item instanceof EE_Line_Item) {
+						continue;
+					}
+					$ticket                                       = $line_item->ticket();
+					$registrations_for_this_ticket                = EEM_Registration::instance()->get_all(
+						[['TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()]]
+					);
+					$registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
+				}
+				if ($event instanceof EE_Event) {
+					$venues_for_events += $event->venues();
+				}
+			}
+			$tax_total_line_item = EEM_Line_Item::instance()->get_one(
+				[['TXN_ID' => $this->transaction->ID(), 'LIN_type' => EEM_Line_Item::type_tax_sub_total]]
+			);
+			$questions_to_skip   = [
+				EEM_Attendee::system_question_fname,
+				EEM_Attendee::system_question_lname,
+				EEM_Attendee::system_question_email,
+			];
+
+
+			$template_args['events_for_txn']              = $events_for_txn;
+			$template_args['ticket_line_items_per_event'] = $ticket_line_items_per_event;
+			$template_args['registrations_per_line_item'] = $registrations_per_line_item;
+			$template_args['venues_for_events']           = $venues_for_events;
+			$template_args['tax_total_line_item']         = $tax_total_line_item;
+			$template_args['questions_to_skip']           = $questions_to_skip;
+			// d($template_args);
+			$template_args['download_link'] = $this->registration->receipt_url('download');
+		} else {
+			// it's just an invoice we're accessing
+			$template_args['download_link'] = $this->registration->invoice_url('download');
+		}
+
+		// Get the HTML as an object
+		$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+		$template_header         = EEH_Template::locate_template(
+			$templates_relative_path . 'invoice_header.template.php',
+			$template_args
+		);
+		if ($receipt) {
+			$template_body = EEH_Template::locate_template(
+				$templates_relative_path . 'receipt_body.template.php',
+				$template_args
+			);
+		} else {
+			$template_body = EEH_Template::locate_template(
+				$templates_relative_path . 'invoice_body.template.php',
+				$template_args
+			);
+		}
+
+
+		$template_footer = EEH_Template::locate_template(
+			$templates_relative_path . 'invoice_footer.template.php',
+			$template_args
+		);
+
+		$copies = $request->getRequestParam('copies', 1, 'int');
+
+		$content = $this->espresso_replace_invoice_shortcodes($template_header);
+		for ($x = 1; $x <= $copies; $x++) {
+			$content .= $this->espresso_replace_invoice_shortcodes($template_body);
+		}
+		$content .= $this->espresso_replace_invoice_shortcodes($template_footer);
+
+		// Check if debugging or mobile is set
+		if ($request->getRequestParam('html')) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+			exit(0);
+		}
+		$invoice_name = $template_args['organization'] . ' ';
+		$invoice_name .= esc_html__('Invoice #', 'event_espresso');
+		$invoice_name .= $template_args['registration_code'];
+		$invoice_name .= esc_html__(' for ', 'event_espresso') . $template_args['name'];
+		$invoice_name = str_replace(' ', '_', $invoice_name);
+		// Create the PDF
+		if ($request->requestParamIsSet('html')) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+			exit(0);
+		}
+		$pdf_adapter = new PdfAdapter();
+		// dompdf options
+		$options = $pdf_adapter->getOptions();
+		if ($options instanceof Dompdf\Options) {
+			$pdf_adapter
+				->setOptions($options)
+				->setContent($content)
+				->generate($invoice_name . ".pdf", (bool) $download);
+			exit(0);
+		}
+		wp_die(esc_html__(
+			'DomPDF package appears to be missing, so cannot generate the PDF file.',
+			'event_espresso'
+		));
+		exit(0);
+	}
+
+
+	/**
+	 * Checks if this line item, or any of its children, actually has a description.
+	 * If none do, then the template can decide to not show any description column
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function check_if_any_line_items_have_a_description(EE_Line_Item $line_item)
+	{
+		if ($line_item->desc()) {
+			return true;
+		} else {
+			foreach ($line_item->children() as $child_line_item) {
+				if ($this->check_if_any_line_items_have_a_description($child_line_item)) {
+					return true;
+				}
+			}
+			// well, if I and my children don't have descriptions, I guess not
+			return false;
+		}
+	}
+
+
+	/**
+	 * Perform the shortcode replacement
+	 *
+	 * @param $content
+	 * @return array|string|string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function espresso_replace_invoice_shortcodes($content)
+	{
+
+		$EE = EE_Registry::instance();
+		// Create the logo
+		$invoice_logo_url = $this->invoice_payment_method->get_extra_meta(
+			'pdf_logo_image',
+			true,
+			$EE->CFG->organization->logo_url
+		);
+		if (! empty($invoice_logo_url)) {
+			$image_size         = getimagesize($invoice_logo_url);
+			$invoice_logo_image =
+				'<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
+		} else {
+			$invoice_logo_image = '';
+		}
+		$SearchValues     = [
+			"[organization]",
+			"[registration_code]",
+			"[transaction_id]",
+			"[name]",
+			"[base_url]",
+			"[download_link]",
+			"[invoice_logo_image]",
+			"[street]",
+			"[city]",
+			"[state]",
+			"[zip]",
+			"[email]",
+			"[vat]",
+			"[registration_date]",
+			"[instructions]",
+		];
+		$primary_attendee = $this->transaction->primary_registration()->attendee();
+		$org_state        = EE_Registry::instance()->load_model('State')->get_one_by_ID($EE->CFG->organization->STA_ID);
+		if ($org_state) {
+			$org_state_name = $org_state->name();
+		} else {
+			$org_state_name = '';
+		}
+		$ReplaceValues = [
+			$EE->CFG->organization->get_pretty('name'),
+			$this->registration->reg_code(),
+			$this->transaction->ID(),
+			$primary_attendee->full_name(),
+			(is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice'))
+				? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
+				: EE_GATEWAYS_URL . 'Invoice/lib/templates/',
+			$this->registration->invoice_url(),
+			// home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
+			$invoice_logo_image,
+			empty($EE->CFG->organization->address_2)
+				? $EE->CFG->organization->get_pretty('address_1')
+				: $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
+					'address_2'
+				),
+			$EE->CFG->organization->get_pretty('city'),
+			$org_state_name,
+			$EE->CFG->organization->get_pretty('zip'),
+			$EE->CFG->organization->get_pretty('email'),
+			$EE->CFG->organization->vat,
+			$this->registration->get_i18n_datetime('REG_date', get_option('date_format')),
+			$this->invoice_payment_method->get_extra_meta('pdf_instructions', true),
+		];
+
+		return str_replace($SearchValues, $ReplaceValues, $content);
+	}
+
+
+	public function espressoLoadData($items)
+	{
+		$lines = $items;
+		$data  = [];
+		foreach ($lines as $line) {
+			$data[] = explode(';', chop($line));
+		}
+
+		return $data;
+	}
+
+
+	public function espressoInvoiceTotals($text, $total_cost)
+	{
+		$html = '';
+		if ($total_cost < 0) {
+			$total_cost = (-1) * $total_cost;
+		}
+		$find    = [' '];
+		$replace = ['-'];
+		$row_id  = strtolower(str_replace($find, $replace, $text));
+		$html    .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
+		$html    .= '<td class="item_r">' . $text . '</td>';
+		$html    .= '<td class="item_r">' . $total_cost . '</td>';
+		$html    .= '</tr>';
+		return $html;
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -97,8 +97,8 @@ 
             7 => "union.css",
         ];
         // Get the CSS file
-        if (isset($themes[ $theme_requested ])) {
-            $template_args['invoice_css'] = $themes[ $theme_requested ];
+        if (isset($themes[$theme_requested])) {
+            $template_args['invoice_css'] = $themes[$theme_requested];
         } else {
             $template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
                 'legacy_invoice_css',
@@ -107,10 +107,10 @@ 
             );
         }
 
-        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
-            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
+        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR.'/invoice')) {
+            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL.'Invoice/lib/templates/';
         } else {
-            $template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
+            $template_args['base_url'] = EE_GATEWAYS.'/Invoice/lib/templates/';
         }
         $primary_attendee = $this->transaction->primary_registration()->attendee();
 
@@ -169,7 +169,7 @@ 
             //      $this->session_data['cart']['REG']['sub_total']
             // );
             $tax_items = $this->transaction->tax_items();
-            if (! empty($tax_items)) {
+            if ( ! empty($tax_items)) {
                 foreach ($tax_items as $tax) {
                     $template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
                 }
@@ -190,7 +190,7 @@ 
                 html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
             )
         );
-        $template_args['shameless_plug']                = apply_filters(
+        $template_args['shameless_plug'] = apply_filters(
             'FHEE_Invoice__send_invoice__shameless_plug',
             true
         );
@@ -207,16 +207,16 @@ 
                 $line_items_for_this_event                = EEM_Line_Item::instance()->get_all(
                     [['Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()]]
                 );
-                $ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
+                $ticket_line_items_per_event[$event_id] = $line_items_for_this_event;
                 foreach ($line_items_for_this_event as $line_item_id => $line_item) {
-                    if (! $line_item instanceof EE_Line_Item) {
+                    if ( ! $line_item instanceof EE_Line_Item) {
                         continue;
                     }
                     $ticket                                       = $line_item->ticket();
                     $registrations_for_this_ticket                = EEM_Registration::instance()->get_all(
                         [['TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()]]
                     );
-                    $registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
+                    $registrations_per_line_item[$line_item_id] = $registrations_for_this_ticket;
                 }
                 if ($event instanceof EE_Event) {
                     $venues_for_events += $event->venues();
@@ -248,24 +248,24 @@ 
         // Get the HTML as an object
         $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
         $template_header         = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_header.template.php',
+            $templates_relative_path.'invoice_header.template.php',
             $template_args
         );
         if ($receipt) {
             $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'receipt_body.template.php',
+                $templates_relative_path.'receipt_body.template.php',
                 $template_args
             );
         } else {
             $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'invoice_body.template.php',
+                $templates_relative_path.'invoice_body.template.php',
                 $template_args
             );
         }
 
 
         $template_footer = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_footer.template.php',
+            $templates_relative_path.'invoice_footer.template.php',
             $template_args
         );
 
@@ -282,10 +282,10 @@ 
             echo wp_kses($content, AllowedTags::getWithFormTags());
             exit(0);
         }
-        $invoice_name = $template_args['organization'] . ' ';
+        $invoice_name = $template_args['organization'].' ';
         $invoice_name .= esc_html__('Invoice #', 'event_espresso');
         $invoice_name .= $template_args['registration_code'];
-        $invoice_name .= esc_html__(' for ', 'event_espresso') . $template_args['name'];
+        $invoice_name .= esc_html__(' for ', 'event_espresso').$template_args['name'];
         $invoice_name = str_replace(' ', '_', $invoice_name);
         // Create the PDF
         if ($request->requestParamIsSet('html')) {
@@ -299,7 +299,7 @@ 
             $pdf_adapter
                 ->setOptions($options)
                 ->setContent($content)
-                ->generate($invoice_name . ".pdf", (bool) $download);
+                ->generate($invoice_name.".pdf", (bool) $download);
             exit(0);
         }
         wp_die(esc_html__(
@@ -353,14 +353,14 @@ 
             true,
             $EE->CFG->organization->logo_url
         );
-        if (! empty($invoice_logo_url)) {
+        if ( ! empty($invoice_logo_url)) {
             $image_size         = getimagesize($invoice_logo_url);
             $invoice_logo_image =
-                '<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
+                '<img class="logo screen" src="'.$invoice_logo_url.'" '.$image_size[3].' alt="logo" /> ';
         } else {
             $invoice_logo_image = '';
         }
-        $SearchValues     = [
+        $SearchValues = [
             "[organization]",
             "[registration_code]",
             "[transaction_id]",
@@ -389,15 +389,15 @@ 
             $this->registration->reg_code(),
             $this->transaction->ID(),
             $primary_attendee->full_name(),
-            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice'))
+            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR.'/invoice'))
                 ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
-                : EE_GATEWAYS_URL . 'Invoice/lib/templates/',
+                : EE_GATEWAYS_URL.'Invoice/lib/templates/',
             $this->registration->invoice_url(),
             // home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
             $invoice_logo_image,
             empty($EE->CFG->organization->address_2)
                 ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
+                : $EE->CFG->organization->get_pretty('address_1').'<br>'.$EE->CFG->organization->get_pretty(
                     'address_2'
                 ),
             $EE->CFG->organization->get_pretty('city'),
@@ -434,9 +434,9 @@ 
         $find    = [' '];
         $replace = ['-'];
         $row_id  = strtolower(str_replace($find, $replace, $text));
-        $html    .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
-        $html    .= '<td class="item_r">' . $text . '</td>';
-        $html    .= '<td class="item_r">' . $total_cost . '</td>';
+        $html    .= '<tr id="'.$row_id.'-tr"><td colspan="4">&nbsp;</td>';
+        $html    .= '<td class="item_r">'.$text.'</td>';
+        $html    .= '<td class="item_r">'.$total_cost.'</td>';
         $html    .= '</tr>';
         return $html;
     }

core/services/adapters/PdfAdapter.php

Indentation +74 added lines, -74 removed lines

@@ -13,89 +13,89 @@
  */
 class PdfAdapter
 {
-    /**
-     * @var Options|null
-     */
-    private $options;
+	/**
+	 * @var Options|null
+	 */
+	private $options;
 
-    /**
-     * @var string
-     */
-    private $content;
+	/**
+	 * @var string
+	 */
+	private $content;
 
 
-    /**
-     * PdfAdapter constructor.
-     */
-    public function __construct()
-    {
-        $this->options = null;
-        $this->content = '';
-    }
+	/**
+	 * PdfAdapter constructor.
+	 */
+	public function __construct()
+	{
+		$this->options = null;
+		$this->content = '';
+	}
 
 
-    /**
-     * @return Options|null
-     */
-    public function getOptions()
-    {
-        // only load dompdf if nobody else has yet...
-        if (! class_exists('Dompdf\Autoloader') and is_readable(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php')) {
-            require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
-            Autoloader::register();
-        }
-        if (! class_exists('Dompdf\Options')) {
-            return null;
-        }
-        $options = new Options();
-        $options->set('isRemoteEnabled', true);
-        $options->set('isJavascriptEnabled', false);
-        if (defined('DOMPDF_FONT_DIR')) {
-            $options->setFontDir(DOMPDF_FONT_DIR);
-            $options->setFontCache(DOMPDF_FONT_DIR);
-        }
-        // Allow changing the paper size.
-        if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
-            $options->set('defaultPaperSize', DOMPDF_DEFAULT_PAPER_SIZE);
-        }
-        return $options;
-    }
+	/**
+	 * @return Options|null
+	 */
+	public function getOptions()
+	{
+		// only load dompdf if nobody else has yet...
+		if (! class_exists('Dompdf\Autoloader') and is_readable(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php')) {
+			require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
+			Autoloader::register();
+		}
+		if (! class_exists('Dompdf\Options')) {
+			return null;
+		}
+		$options = new Options();
+		$options->set('isRemoteEnabled', true);
+		$options->set('isJavascriptEnabled', false);
+		if (defined('DOMPDF_FONT_DIR')) {
+			$options->setFontDir(DOMPDF_FONT_DIR);
+			$options->setFontCache(DOMPDF_FONT_DIR);
+		}
+		// Allow changing the paper size.
+		if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
+			$options->set('defaultPaperSize', DOMPDF_DEFAULT_PAPER_SIZE);
+		}
+		return $options;
+	}
 
 
-    /**
-     * @param Options $options
-     * @return $this
-     */
-    public function setOptions(Options $options): self
-    {
-        $this->options = $options;
-        return $this;
-    }
+	/**
+	 * @param Options $options
+	 * @return $this
+	 */
+	public function setOptions(Options $options): self
+	{
+		$this->options = $options;
+		return $this;
+	}
 
 
-    /**
-     * @param string $content
-     * @return $this
-     */
-    public function setContent(string $content): self
-    {
-        $this->content = $content;
-        return $this;
-    }
+	/**
+	 * @param string $content
+	 * @return $this
+	 */
+	public function setContent(string $content): self
+	{
+		$this->content = $content;
+		return $this;
+	}
 
 
-    /**
-     * @param string $filename
-     * @param bool $download
-     * @return void
-     */
-    public function generate(string $filename, bool $download): void
-    {
-        if ($this->options instanceof Options && ! empty($this->content)) {
-            $dompdf = new Dompdf($this->options);
-            $dompdf->loadHtml($this->content);
-            $dompdf->render();
-            $dompdf->stream($filename, ['Attachment' => $download]);
-        }
-    }
+	/**
+	 * @param string $filename
+	 * @param bool $download
+	 * @return void
+	 */
+	public function generate(string $filename, bool $download): void
+	{
+		if ($this->options instanceof Options && ! empty($this->content)) {
+			$dompdf = new Dompdf($this->options);
+			$dompdf->loadHtml($this->content);
+			$dompdf->render();
+			$dompdf->stream($filename, ['Attachment' => $download]);
+		}
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -40,11 +40,11 @@
     public function getOptions()
     {
         // only load dompdf if nobody else has yet...
-        if (! class_exists('Dompdf\Autoloader') and is_readable(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php')) {
-            require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
+        if ( ! class_exists('Dompdf\Autoloader') and is_readable(EE_THIRD_PARTY.'dompdf/src/Autoloader.php')) {
+            require_once(EE_THIRD_PARTY.'dompdf/src/Autoloader.php');
             Autoloader::register();
         }
-        if (! class_exists('Dompdf\Options')) {
+        if ( ! class_exists('Dompdf\Options')) {
             return null;
         }
         $options = new Options();

core/libraries/messages/messenger/EE_Pdf_messenger.class.php

Indentation +345 added lines, -345 removed lines

@@ -16,350 +16,350 @@
  */
 class EE_Pdf_messenger extends EE_messenger
 {
-    /**
-     * The following are the properties that this messenger requires for generating pdf
-     */
-
-    /**
-     * This is the pdf body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content;
-
-
-    /**
-     * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
-     *
-     * @var string
-     */
-    protected $_subject;
-
-    /**
-     * @var PdfAdapter
-     */
-    protected $pdf_adapter;
-
-
-    /**
-     * EE_Pdf_messenger constructor.
-     */
-    public function __construct()
-    {
-        // set properties
-        $this->name = 'pdf';
-        $this->description = esc_html__('This messenger is used for generating a pdf version of the message.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('PDF', 'event_espresso'),
-            'plural' => esc_html__('PDFs', 'event_espresso')
-        );
-        $this->activate_on_install = true;
-        $this->pdf_adapter = new PdfAdapter();
-
-        parent::__construct();
-    }
-
-
-    /**
-     * PDF Messenger desires execution immediately.
-     * @see  parent::send_now() for documentation.
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     * @see parent::allow_empty_to_field() for documentation
-     * @since  4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array('events_edit' => false);
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = array();
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = array(
-            'subject' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'content' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required' => array('[ATTENDEE_LIST]')
-            ),
-            'event_list' => array(
-                'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
-                'required' => array('[EVENT_LIST]')
-            ),
-            'ticket_list' => array(
-                'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
-                'required' => array('[TICKET_LIST]')
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required' => array('[DATETIME_LIST]')
-            ),
-        );
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'subject' => array(
-                'input' => 'text',
-                'label' => esc_html__('Page Title', 'event_espresso'),
-                'type' => 'string',
-                'required' => true,
-                'validation' => true,
-                'css_class' => 'large-text',
-                'format' => '%s'
-            ),
-            'content' => '', // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra' => array(
-                'content' => array(
-                    'main' => array(
-                        'input' => 'wp_editor',
-                        'label' => esc_html__('Main Content', 'event_espresso'),
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15'
-                    ),
-                    'event_list' => array(
-                        'input' => 'wp_editor',
-                        'label' => '[EVENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]')
-                    ),
-                    'attendee_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ATTENDEE_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]')
-                    ),
-                    'ticket_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]')
-                    ),
-                    'datetime_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[DATETIME_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]')
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     *
-     */
-    protected function _set_default_message_types()
-    {
-        // note currently PDF is only a secondary messenger so it never has any associated message types.
-        $this->_default_message_types = array();
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array();
-    }
-
-
-    /**
-     * Generates html version of the message content and then sends it to the pdf generator.
-     *
-     *
-     * @since 4.5.0
-     *
-     * @return string.
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = array(
-            'page_title' => $this->_subject,
-            'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'base', $this->_variation),
-            'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'print', $this->_variation),
-            'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
-            'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content)
-        );
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        $content = $this->_get_main_template();
+	/**
+	 * The following are the properties that this messenger requires for generating pdf
+	 */
+
+	/**
+	 * This is the pdf body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content;
+
+
+	/**
+	 * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
+	 *
+	 * @var string
+	 */
+	protected $_subject;
+
+	/**
+	 * @var PdfAdapter
+	 */
+	protected $pdf_adapter;
+
+
+	/**
+	 * EE_Pdf_messenger constructor.
+	 */
+	public function __construct()
+	{
+		// set properties
+		$this->name = 'pdf';
+		$this->description = esc_html__('This messenger is used for generating a pdf version of the message.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('PDF', 'event_espresso'),
+			'plural' => esc_html__('PDFs', 'event_espresso')
+		);
+		$this->activate_on_install = true;
+		$this->pdf_adapter = new PdfAdapter();
+
+		parent::__construct();
+	}
+
+
+	/**
+	 * PDF Messenger desires execution immediately.
+	 * @see  parent::send_now() for documentation.
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 * @see parent::allow_empty_to_field() for documentation
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array('events_edit' => false);
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = array();
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = array(
+			'subject' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'content' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required' => array('[ATTENDEE_LIST]')
+			),
+			'event_list' => array(
+				'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
+				'required' => array('[EVENT_LIST]')
+			),
+			'ticket_list' => array(
+				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
+				'required' => array('[TICKET_LIST]')
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required' => array('[DATETIME_LIST]')
+			),
+		);
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'subject' => array(
+				'input' => 'text',
+				'label' => esc_html__('Page Title', 'event_espresso'),
+				'type' => 'string',
+				'required' => true,
+				'validation' => true,
+				'css_class' => 'large-text',
+				'format' => '%s'
+			),
+			'content' => '', // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra' => array(
+				'content' => array(
+					'main' => array(
+						'input' => 'wp_editor',
+						'label' => esc_html__('Main Content', 'event_espresso'),
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15'
+					),
+					'event_list' => array(
+						'input' => 'wp_editor',
+						'label' => '[EVENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+						'shortcodes_required' => array('[EVENT_LIST]')
+					),
+					'attendee_list' => array(
+						'input' => 'textarea',
+						'label' => '[ATTENDEE_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]')
+					),
+					'ticket_list' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[TICKET_LIST]')
+					),
+					'datetime_list' => array(
+						'input' => 'textarea',
+						'label' => '[DATETIME_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]')
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 *
+	 */
+	protected function _set_default_message_types()
+	{
+		// note currently PDF is only a secondary messenger so it never has any associated message types.
+		$this->_default_message_types = array();
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array();
+	}
+
+
+	/**
+	 * Generates html version of the message content and then sends it to the pdf generator.
+	 *
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string.
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = array(
+			'page_title' => $this->_subject,
+			'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'base', $this->_variation),
+			'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'print', $this->_variation),
+			'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'main', $this->_variation),
+			'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+			'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content)
+		);
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		$content = $this->_get_main_template();
 //      die( $content );
-        $this->_do_pdf($content);
-        exit(0);
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = array();
-
-        // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_head', 'wp_enqueue_scripts');
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for pdf purposes.
-     *
-     * @since  4.5.0
-     *
-     * @param bool $preview
-     * @return string
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
-        // add message type to template_args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * This takes care of loading the dompdf library and generating the actual pdf
-     *
-     * @param string $content This is the generated html content being converted into a pdf.
-     *
-     * @return void
-     */
-    protected function _do_pdf($content = '')
-    {
-        // dompdf options
-        $options = $this->pdf_adapter->getOptions();
-        if ($options instanceof Options) {
-            // Remove all spaces between HTML tags
-            $content = preg_replace('/>\s+</', '><', $content);
-            if ($content) {
-                $this->pdf_adapter
-                    ->setOptions($options)
-                    ->setContent($content)
-                    // forcing the browser to open a download dialog.
-                    ->generate($this->_subject . ".pdf", true);
-                exit;
-            }
-        }
-        // display error if dompdf is not available
-        wp_die(esc_html__(
-            'DomPDF package appears to be missing, so cannot generate the PDF file.',
-            'event_espresso'
-        ));
-        exit;
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _preview()
-    {
-        return $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
+		$this->_do_pdf($content);
+		exit(0);
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = array();
+
+		// just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_head', 'wp_enqueue_scripts');
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for pdf purposes.
+	 *
+	 * @since  4.5.0
+	 *
+	 * @param bool $preview
+	 * @return string
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
+		// add message type to template_args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * This takes care of loading the dompdf library and generating the actual pdf
+	 *
+	 * @param string $content This is the generated html content being converted into a pdf.
+	 *
+	 * @return void
+	 */
+	protected function _do_pdf($content = '')
+	{
+		// dompdf options
+		$options = $this->pdf_adapter->getOptions();
+		if ($options instanceof Options) {
+			// Remove all spaces between HTML tags
+			$content = preg_replace('/>\s+</', '><', $content);
+			if ($content) {
+				$this->pdf_adapter
+					->setOptions($options)
+					->setContent($content)
+					// forcing the browser to open a download dialog.
+					->generate($this->_subject . ".pdf", true);
+				exit;
+			}
+		}
+		// display error if dompdf is not available
+		wp_die(esc_html__(
+			'DomPDF package appears to be missing, so cannot generate the PDF file.',
+			'event_espresso'
+		));
+		exit;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _preview()
+	{
+		return $this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -266,7 +266,7 @@ 
             'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'base', $this->_variation),
             'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'print', $this->_variation),
             'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+            'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css',
             'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content)
         );
         $this->_deregister_wp_hooks();
@@ -337,7 +337,7 @@ 
                     ->setOptions($options)
                     ->setContent($content)
                     // forcing the browser to open a download dialog.
-                    ->generate($this->_subject . ".pdf", true);
+                    ->generate($this->_subject.".pdf", true);
                 exit;
             }
         }