eventespresso / event-espresso-core

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_invoice_settings.dmsstage.php

Spacing +2 added lines, -2 removed lines

@@ -66,8 +66,8 @@
     {
 
         $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-        $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+        $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path.'invoice_body.template.php', null, false, false, true);
+        $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path.'receipt_body.template.php', null, false, false, true);
         if ($overridden_invoice_body || $overridden_receipt_body) {
             new PersistentAdminNotice(
                 'invoice_overriding_templates',

Indentation +47 added lines, -47 removed lines

@@ -27,59 +27,59 @@
  */
 class EE_DMS_4_6_0_invoice_settings extends EE_Data_Migration_Script_Stage
 {
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = esc_html__('Update Invoice Settings', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = esc_html__('Update Invoice Settings', 'event_espresso');
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _count_records_to_migrate
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @access protected
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * _count_records_to_migrate
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @access protected
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
 
 
-    /**
-     *    _migration_step
-     *
-     * @access protected
-     * @param int $num_items
-     * @throws EE_Error
-     * @return int number of items ACTUALLY migrated
-     * @throws InvalidDataTypeException
-     */
-    protected function _migration_step($num_items = 1)
-    {
+	/**
+	 *    _migration_step
+	 *
+	 * @access protected
+	 * @param int $num_items
+	 * @throws EE_Error
+	 * @return int number of items ACTUALLY migrated
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _migration_step($num_items = 1)
+	{
 
-        $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-        $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
-        if ($overridden_invoice_body || $overridden_receipt_body) {
-            new PersistentAdminNotice(
-                'invoice_overriding_templates',
-                esc_html__(
-                    'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents (but this will be removed in an upcoming version). We recommend deleting your old Invoice/Receipt templates and using the new messages system. Then modify the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
-                    'event_espresso'
-                ),
-                true
-            );
-        }
+		$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+		$overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
+		$overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+		if ($overridden_invoice_body || $overridden_receipt_body) {
+			new PersistentAdminNotice(
+				'invoice_overriding_templates',
+				esc_html__(
+					'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents (but this will be removed in an upcoming version). We recommend deleting your old Invoice/Receipt templates and using the new messages system. Then modify the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
+					'event_espresso'
+				),
+				true
+			);
+		}
 
-        // regardless of whether it worked or not, we ought to continue the migration
-        $this->set_completed();
-        return 1;
-    }
+		// regardless of whether it worked or not, we ought to continue the migration
+		$this->set_completed();
+		return 1;
+	}
 }

core/EE_Load_Textdomain.core.php

Spacing +9 added lines, -9 removed lines

@@ -36,19 +36,19 @@ 
     {
         EE_Load_Textdomain::loadTranslationsForLocale();
         // now load the textdomain
-        if (!empty(EE_Load_Textdomain::$locale)) {
-            $github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
+        if ( ! empty(EE_Load_Textdomain::$locale)) {
+            $github_mo_path = EE_LANGUAGES_SAFE_DIR.'event_espresso-'.EE_Load_Textdomain::$locale.'.mo';
             if (is_readable($github_mo_path)) {
                 load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
                 return;
             }
-            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
+            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR.'event-espresso-4-'.EE_Load_Textdomain::$locale.'.mo';
             if (is_readable($glotpress_mo_path)) {
                 load_textdomain('event_espresso', $glotpress_mo_path);
                 return;
             }
         }
-        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
+        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME).'/languages/');
     }
 
 
@@ -71,7 +71,7 @@ 
         if (empty(EE_Load_Textdomain::$locale)) {
             return;
         }
-        $language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
+        $language_check_option_name = 'ee_lang_check_'.EE_Load_Textdomain::$locale.'_'.EVENT_ESPRESSO_VERSION;
         // check if language files has already been sideloaded
         if (get_option($language_check_option_name)) {
             return;
@@ -81,8 +81,8 @@ 
 
         // load sideloader and sideload the .POT file as this should always be included.
         $sideloader_args = array(
-            '_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
-            '_download_from'   => $repo_base_URL . '.pot?raw=true',
+            '_upload_to'     => EE_PLUGIN_DIR_PATH.'languages/',
+            '_download_from'   => $repo_base_URL.'.pot?raw=true',
             '_new_file_name' => 'event_espresso.pot',
         );
         /** @var EEH_Sideloader $sideloader */
@@ -98,8 +98,8 @@ 
             update_option($language_check_option_name, 1);
             return;
         }
-        $repo_locale_URL = $repo_base_URL . '-' . EE_Load_Textdomain::$locale;
-        $file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
+        $repo_locale_URL = $repo_base_URL.'-'.EE_Load_Textdomain::$locale;
+        $file_name_base = 'event_espresso-'.EE_Load_Textdomain::$locale;
 
         // made it here so let's get the language files from the github repo, first the .mo file
         $sideloader->set_download_from("{$repo_locale_URL}.mo?raw=true");

Indentation +91 added lines, -91 removed lines

@@ -12,105 +12,105 @@
  */
 class EE_Load_Textdomain extends EE_Base
 {
-    /**
-     * holds the current lang in WP
-     *
-     * @var string
-     */
-    private static $locale;
+	/**
+	 * holds the current lang in WP
+	 *
+	 * @var string
+	 */
+	private static $locale;
 
 
-    /**
-     * this takes care of retrieving a matching textdomain for event espresso for the current WPLANG from EE GitHub
-     * repo (if necessary) and then loading it for translations. should only be called in wp plugins_loaded callback
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_textdomain()
-    {
-        EE_Load_Textdomain::loadTranslationsForLocale();
-        // now load the textdomain
-        if (!empty(EE_Load_Textdomain::$locale)) {
-            $github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
-            if (is_readable($github_mo_path)) {
-                load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
-                return;
-            }
-            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
-            if (is_readable($glotpress_mo_path)) {
-                load_textdomain('event_espresso', $glotpress_mo_path);
-                return;
-            }
-        }
-        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
-    }
+	/**
+	 * this takes care of retrieving a matching textdomain for event espresso for the current WPLANG from EE GitHub
+	 * repo (if necessary) and then loading it for translations. should only be called in wp plugins_loaded callback
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_textdomain()
+	{
+		EE_Load_Textdomain::loadTranslationsForLocale();
+		// now load the textdomain
+		if (!empty(EE_Load_Textdomain::$locale)) {
+			$github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
+			if (is_readable($github_mo_path)) {
+				load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
+				return;
+			}
+			$glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
+			if (is_readable($glotpress_mo_path)) {
+				load_textdomain('event_espresso', $glotpress_mo_path);
+				return;
+			}
+		}
+		load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
+	}
 
 
-    /**
-     * The purpose of this method is to sideload all of the lang files for EE, this includes the POT file and also the PO/MO files for the given WPLANG locale (if necessary).
-     *
-     * @access private
-     * @static
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function loadTranslationsForLocale()
-    {
-        EE_Load_Textdomain::$locale = get_locale();
-        // can't download a language file if a language isn't set <taps temple>
-        if (empty(EE_Load_Textdomain::$locale)) {
-            return;
-        }
-        $language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
-        // check if language files has already been sideloaded
-        if (get_option($language_check_option_name)) {
-            return;
-        }
+	/**
+	 * The purpose of this method is to sideload all of the lang files for EE, this includes the POT file and also the PO/MO files for the given WPLANG locale (if necessary).
+	 *
+	 * @access private
+	 * @static
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function loadTranslationsForLocale()
+	{
+		EE_Load_Textdomain::$locale = get_locale();
+		// can't download a language file if a language isn't set <taps temple>
+		if (empty(EE_Load_Textdomain::$locale)) {
+			return;
+		}
+		$language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
+		// check if language files has already been sideloaded
+		if (get_option($language_check_option_name)) {
+			return;
+		}
 
-        $repo_base_URL = 'https://github.com/eventespresso/languages-ee4/blob/master/event_espresso';
+		$repo_base_URL = 'https://github.com/eventespresso/languages-ee4/blob/master/event_espresso';
 
-        // load sideloader and sideload the .POT file as this should always be included.
-        $sideloader_args = array(
-            '_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
-            '_download_from'   => $repo_base_URL . '.pot?raw=true',
-            '_new_file_name' => 'event_espresso.pot',
-        );
-        /** @var EEH_Sideloader $sideloader */
-        $sideloader = EE_Registry::instance()->load_helper('Sideloader', $sideloader_args, false);
-        // sideload the .POT file only for main site of the network, or if not running Multisite.
-        if (is_main_site()) {
-            $sideloader->sideload();
-        }
+		// load sideloader and sideload the .POT file as this should always be included.
+		$sideloader_args = array(
+			'_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
+			'_download_from'   => $repo_base_URL . '.pot?raw=true',
+			'_new_file_name' => 'event_espresso.pot',
+		);
+		/** @var EEH_Sideloader $sideloader */
+		$sideloader = EE_Registry::instance()->load_helper('Sideloader', $sideloader_args, false);
+		// sideload the .POT file only for main site of the network, or if not running Multisite.
+		if (is_main_site()) {
+			$sideloader->sideload();
+		}
 
-        // if locale is "en_US" then lets just get out, since Event Espresso core is already "en_US"
-        if (EE_Load_Textdomain::$locale === 'en_US') {
-            // but set option first else we'll forever be downloading the pot file
-            update_option($language_check_option_name, 1);
-            return;
-        }
-        $repo_locale_URL = $repo_base_URL . '-' . EE_Load_Textdomain::$locale;
-        $file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
+		// if locale is "en_US" then lets just get out, since Event Espresso core is already "en_US"
+		if (EE_Load_Textdomain::$locale === 'en_US') {
+			// but set option first else we'll forever be downloading the pot file
+			update_option($language_check_option_name, 1);
+			return;
+		}
+		$repo_locale_URL = $repo_base_URL . '-' . EE_Load_Textdomain::$locale;
+		$file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
 
-        // made it here so let's get the language files from the github repo, first the .mo file
-        $sideloader->set_download_from("{$repo_locale_URL}.mo?raw=true");
-        $sideloader->set_new_file_name("{$file_name_base}.mo");
-        $sideloader->sideload();
+		// made it here so let's get the language files from the github repo, first the .mo file
+		$sideloader->set_download_from("{$repo_locale_URL}.mo?raw=true");
+		$sideloader->set_new_file_name("{$file_name_base}.mo");
+		$sideloader->sideload();
 
-        // now the .po file:
-        $sideloader->set_download_from("{$repo_locale_URL}.po?raw=true");
-        $sideloader->set_new_file_name("{$file_name_base}.po");
-        $sideloader->sideload();
+		// now the .po file:
+		$sideloader->set_download_from("{$repo_locale_URL}.po?raw=true");
+		$sideloader->set_new_file_name("{$file_name_base}.po");
+		$sideloader->sideload();
 
-        // set option so the above only runs when EE updates.
-        update_option($language_check_option_name, 1);
-    }
+		// set option so the above only runs when EE updates.
+		update_option($language_check_option_name, 1);
+	}
 }

admin_pages/events/Events_Admin_List_Table.class.php

Spacing +29 added lines, -29 removed lines

@@ -114,7 +114,7 @@ 
         $class = parent::_get_row_class($item);
         // add status class
         $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
+            ? ' ee-status-strip event-status-'.$item->get_active_status()
             : '';
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
@@ -143,7 +143,7 @@ 
      */
     public function column_cb($item)
     {
-        if (! $item instanceof EE_Event) {
+        if ( ! $item instanceof EE_Event) {
             return '';
         }
         $this->_dtt = $item->primary_datetime(); // set this for use in other columns
@@ -166,7 +166,7 @@ 
     public function column_id(EE_Event $item)
     {
         $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$item->name().'</span>';
         return $content;
     }
 
@@ -189,7 +189,7 @@ 
         $actions = $this->_column_name_action_setup($item);
         $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
         $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
+                   . $edit_link.'">'
                    . $item->name()
                    . '</a></strong>'
                    . $status;
@@ -218,7 +218,7 @@ 
     protected function _column_name_action_setup(EE_Event $item)
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $actions = array();
@@ -237,8 +237,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $actions['edit'] = '<a href="'.$edit_link.'"'
+                               . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                                . esc_html__('Edit', 'event_espresso')
                                . '</a>';
         }
@@ -258,8 +258,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+            $actions['attendees'] = '<a href="'.$attendees_link.'"'
+                                    . ' title="'.esc_attr__('View Registrations', 'event_espresso').'">'
                                     . esc_html__('Registrations', 'event_espresso')
                                     . '</a>';
         }
@@ -312,8 +312,8 @@ 
             );
         }
         $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+        $actions['view'] = '<a href="'.$view_link.'"'
+                           . ' title="'.esc_attr__('View Event', 'event_espresso').'">'
                            . esc_html__('View', 'event_espresso')
                            . '</a>';
         if ($item->get('status') === 'trash') {
@@ -324,8 +324,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+                $actions['restore_from_trash'] = '<a href="'.$restore_event_link.'"'
+                                                 . ' title="'.esc_attr__('Restore from Trash', 'event_espresso')
                                                  . '">'
                                                  . esc_html__('Restore from Trash', 'event_espresso')
                                                  . '</a>';
@@ -338,8 +338,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+                $actions['delete'] = '<a href="'.$delete_event_link.'"'
+                                     . ' title="'.esc_attr__('Delete Permanently', 'event_espresso').'">'
                                      . esc_html__('Delete Permanently', 'event_espresso')
                                      . '</a>';
             }
@@ -351,8 +351,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+                $actions['move to trash'] = '<a href="'.$trash_event_link.'"'
+                                            . ' title="'.esc_attr__('Trash Event', 'event_espresso').'">'
                                             . esc_html__('Trash', 'event_espresso')
                                             . '</a>';
             }
@@ -377,8 +377,8 @@ 
             'EVT_wp_user' => $item->wp_user(),
         );
         $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+        return $gravatar.'  <a href="'.$filter_url.'"'
+               . ' title="'.esc_attr__('Click to filter events by this author.', 'event_espresso').'">'
                . $event_author->display_name
                . '</a>';
     }
@@ -395,7 +395,7 @@ 
         return implode(
             ', ',
             array_map(
-                function (EE_Term $category) {
+                function(EE_Term $category) {
                     return $category->name();
                 },
                 $event_categories
@@ -470,7 +470,7 @@ 
                    'ee_read_registrations',
                    'espresso_registrations_view_registration'
                )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+            ? '<a href="'.$attendees_link.'">'.$registered_attendees.'</a>'
             : $registered_attendees;
     }
 
@@ -500,13 +500,13 @@ 
     public function column_actions(EE_Event $item)
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $action_links = array();
         $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                          . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+        $action_links[] = '<a href="'.$view_link.'"'
+                          . ' title="'.esc_attr__('View Event', 'event_espresso').'" target="_blank">';
         $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
         if (
             EE_Registry::instance()->CAP->current_user_can(
@@ -520,8 +520,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                              . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$edit_link.'"'
+                              . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                               . '<div class="ee-icon ee-icon-calendar-edit"></div>'
                               . '</a>';
         }
@@ -540,8 +540,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                              . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$attendees_link.'"'
+                              . ' title="'.esc_attr__('View Registrants', 'event_espresso').'">'
                               . '<div class="dashicons dashicons-groups"></div>'
                               . '</a>';
         }
@@ -576,7 +576,7 @@ 
         }
         $column_array = [];
         foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
+            $column_array[$column] = $column_label;
             if ($column === 'venue') {
                 $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
             }

Indentation +563 added lines, -563 removed lines

@@ -14,567 +14,567 @@
  */
 class Events_Admin_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * @var EE_Datetime
-     */
-    private $_dtt;
-
-
-    /**
-     * Initial setup of data properties for the list table.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
-        $this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
-    }
-
-
-    /**
-     * Set up of additional properties for the list table.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('event', 'event_espresso'),
-            'plural'   => esc_html__('events', 'event_espresso'),
-            'ajax'     => true, // for now
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $this->_columns = array(
-            'cb'              => '<input type="checkbox" />',
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'name'            => esc_html__('Name', 'event_espresso'),
-            'author'          => esc_html__('Author', 'event_espresso'),
-            'venue'           => esc_html__('Venue', 'event_espresso'),
-            'start_date_time' => esc_html__('Event Start', 'event_espresso'),
-            'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
-            'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
-                                 . '<span class="screen-reader-text">'
-                                 . esc_html__('Approved Registrations', 'event_espresso')
-                                 . '</span>'
-                                 . '</span>',
-            // 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
-            'actions'         => esc_html__('Actions', 'event_espresso'),
-        );
-        $this->addConditionalColumns();
-        $this->_sortable_columns = array(
-            'id'              => array('EVT_ID' => true),
-            'name'            => array('EVT_name' => false),
-            'author'          => array('EVT_wp_user' => false),
-            'venue'           => array('Venue.VNU_name' => false),
-            'start_date_time' => array('Datetime.DTT_EVT_start' => false),
-            'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
-        );
-
-        $this->_primary_column = 'id';
-        $this->_hidden_columns = array('author', 'event_category');
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array(); // no filters with decaf
-    }
-
-
-    /**
-     * Setup of views properties.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_admin_page->total_events();
-        $this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_events',
-                'espresso_events_trash_events'
-            )
-        ) {
-            $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
-        }
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        // add status class
-        $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
-            : '';
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_status(EE_Event $item)
-    {
-        return '<span class="ee-status-strip ee-status-strip-td event-status-'
-               . $item->get_active_status()
-               . '"></span>';
-    }
-
-
-    /**
-     * @param  EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($item)
-    {
-        if (! $item instanceof EE_Event) {
-            return '';
-        }
-        $this->_dtt = $item->primary_datetime(); // set this for use in other columns
-        return sprintf(
-            '<input type="checkbox" name="EVT_IDs[]" value="%s" />',
-            $item->ID()
-        );
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    public function column_id(EE_Event $item)
-    {
-        $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_name(EE_Event $item)
-    {
-        $edit_query_args = array(
-            'action' => 'edit',
-            'post'   => $item->ID(),
-        );
-        $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-        $actions = $this->_column_name_action_setup($item);
-        $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
-        $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
-                   . $item->name()
-                   . '</a></strong>'
-                   . $status;
-        $content .= '<br><span class="ee-status-text-small">'
-                    . EEH_Template::pretty_status(
-                        $item->get_active_status(),
-                        false,
-                        'sentence'
-                    )
-                    . '</span>';
-        $content .= $this->row_actions($actions);
-        return $content;
-    }
-
-
-    /**
-     * Just a method for setting up the actions for the name column
-     *
-     * @param EE_Event $item
-     * @return array array of actions
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _column_name_action_setup(EE_Event $item)
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $actions = array();
-        $restore_event_link = '';
-        $delete_event_link = '';
-        $trash_event_link = '';
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_event',
-                'espresso_events_edit',
-                $item->ID()
-            )
-        ) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso')
-                               . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
-                                    . esc_html__('Registrations', 'event_espresso')
-                                    . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_trash_event',
-                $item->ID()
-            )
-        ) {
-            $trash_event_query_args = array(
-                'action' => 'trash_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $trash_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_restore_event',
-                $item->ID()
-            )
-        ) {
-            $restore_event_query_args = array(
-                'action' => 'restore_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $restore_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_delete_event',
-                $item->ID()
-            )
-        ) {
-            $delete_event_query_args = array(
-                'action' => 'delete_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $delete_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
-                           . esc_html__('View', 'event_espresso')
-                           . '</a>';
-        if ($item->get('status') === 'trash') {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_restore_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
-                                                 . '">'
-                                                 . esc_html__('Restore from Trash', 'event_espresso')
-                                                 . '</a>';
-            }
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_delete_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_trash_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
-                                            . esc_html__('Trash', 'event_espresso')
-                                            . '</a>';
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_author(EE_Event $item)
-    {
-        // user author info
-        $event_author = get_userdata($item->wp_user());
-        $gravatar = get_avatar($item->wp_user(), '15');
-        // filter link
-        $query_args = array(
-            'action'      => 'default',
-            'EVT_wp_user' => $item->wp_user(),
-        );
-        $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
-               . $event_author->display_name
-               . '</a>';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_event_category(EE_Event $event)
-    {
-        $event_categories = $event->get_all_event_categories();
-        return implode(
-            ', ',
-            array_map(
-                function (EE_Term $category) {
-                    return $category->name();
-                },
-                $event_categories
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_venue(EE_Event $item)
-    {
-        $venue = $item->get_first_related('Venue');
-        return ! empty($venue)
-            ? $venue->name()
-            : '';
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_start_date_time(EE_Event $item)
-    {
-        return $this->_dtt instanceof EE_Datetime
-            ? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
-            : esc_html__('No Date was saved for this Event', 'event_espresso');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_reg_begins(EE_Event $item)
-    {
-        $reg_start = $item->get_ticket_with_earliest_start_time();
-        return $reg_start instanceof EE_Ticket
-            ? $reg_start->get_i18n_datetime('TKT_start_date')
-            : esc_html__('No Tickets have been setup for this Event', 'event_espresso');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_attendees(EE_Event $item)
-    {
-        $attendees_query_args = array(
-            'action'   => 'default',
-            'event_id' => $item->ID(),
-        );
-        $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-        $registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_event',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        )
-               && EE_Registry::instance()->CAP->current_user_can(
-                   'ee_read_registrations',
-                   'espresso_registrations_view_registration'
-               )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
-            : $registered_attendees;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_tkts_sold(EE_Event $item)
-    {
-        return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_actions(EE_Event $item)
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $action_links = array();
-        $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                          . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
-        $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_event',
-                'espresso_events_edit',
-                $item->ID()
-            )
-        ) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                              . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                              . '<div class="ee-icon ee-icon-calendar-edit"></div>'
-                              . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            ) && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                              . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
-                              . '<div class="dashicons dashicons-groups"></div>'
-                              . '</a>';
-        }
-        $action_links = apply_filters(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            $action_links,
-            $item
-        );
-        return $this->_action_string(
-            implode("\n\t", $action_links),
-            $item,
-            'div'
-        );
-    }
-
-
-    /**
-     * Helper for adding columns conditionally
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function addConditionalColumns()
-    {
-        $event_category_count = EEM_Term::instance()->count(
-            [['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
-        );
-        if ($event_category_count === 0) {
-            return;
-        }
-        $column_array = [];
-        foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
-            if ($column === 'venue') {
-                $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
-            }
-        }
-        $this->_columns = $column_array;
-    }
+	/**
+	 * @var EE_Datetime
+	 */
+	private $_dtt;
+
+
+	/**
+	 * Initial setup of data properties for the list table.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
+		$this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
+	}
+
+
+	/**
+	 * Set up of additional properties for the list table.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('event', 'event_espresso'),
+			'plural'   => esc_html__('events', 'event_espresso'),
+			'ajax'     => true, // for now
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$this->_columns = array(
+			'cb'              => '<input type="checkbox" />',
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'name'            => esc_html__('Name', 'event_espresso'),
+			'author'          => esc_html__('Author', 'event_espresso'),
+			'venue'           => esc_html__('Venue', 'event_espresso'),
+			'start_date_time' => esc_html__('Event Start', 'event_espresso'),
+			'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
+			'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
+								 . '<span class="screen-reader-text">'
+								 . esc_html__('Approved Registrations', 'event_espresso')
+								 . '</span>'
+								 . '</span>',
+			// 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
+			'actions'         => esc_html__('Actions', 'event_espresso'),
+		);
+		$this->addConditionalColumns();
+		$this->_sortable_columns = array(
+			'id'              => array('EVT_ID' => true),
+			'name'            => array('EVT_name' => false),
+			'author'          => array('EVT_wp_user' => false),
+			'venue'           => array('Venue.VNU_name' => false),
+			'start_date_time' => array('Datetime.DTT_EVT_start' => false),
+			'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
+		);
+
+		$this->_primary_column = 'id';
+		$this->_hidden_columns = array('author', 'event_category');
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array(); // no filters with decaf
+	}
+
+
+	/**
+	 * Setup of views properties.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_admin_page->total_events();
+		$this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_events',
+				'espresso_events_trash_events'
+			)
+		) {
+			$this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
+		}
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		// add status class
+		$class .= $item instanceof EE_Event
+			? ' ee-status-strip event-status-' . $item->get_active_status()
+			: '';
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_status(EE_Event $item)
+	{
+		return '<span class="ee-status-strip ee-status-strip-td event-status-'
+			   . $item->get_active_status()
+			   . '"></span>';
+	}
+
+
+	/**
+	 * @param  EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($item)
+	{
+		if (! $item instanceof EE_Event) {
+			return '';
+		}
+		$this->_dtt = $item->primary_datetime(); // set this for use in other columns
+		return sprintf(
+			'<input type="checkbox" name="EVT_IDs[]" value="%s" />',
+			$item->ID()
+		);
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	public function column_id(EE_Event $item)
+	{
+		$content = $item->ID();
+		$content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_name(EE_Event $item)
+	{
+		$edit_query_args = array(
+			'action' => 'edit',
+			'post'   => $item->ID(),
+		);
+		$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+		$actions = $this->_column_name_action_setup($item);
+		$status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
+		$content = '<strong><a class="row-title" href="'
+				   . $edit_link . '">'
+				   . $item->name()
+				   . '</a></strong>'
+				   . $status;
+		$content .= '<br><span class="ee-status-text-small">'
+					. EEH_Template::pretty_status(
+						$item->get_active_status(),
+						false,
+						'sentence'
+					)
+					. '</span>';
+		$content .= $this->row_actions($actions);
+		return $content;
+	}
+
+
+	/**
+	 * Just a method for setting up the actions for the name column
+	 *
+	 * @param EE_Event $item
+	 * @return array array of actions
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _column_name_action_setup(EE_Event $item)
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$actions = array();
+		$restore_event_link = '';
+		$delete_event_link = '';
+		$trash_event_link = '';
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_event',
+				'espresso_events_edit',
+				$item->ID()
+			)
+		) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_link . '"'
+							   . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso')
+							   . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$actions['attendees'] = '<a href="' . $attendees_link . '"'
+									. ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+									. esc_html__('Registrations', 'event_espresso')
+									. '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_trash_event',
+				$item->ID()
+			)
+		) {
+			$trash_event_query_args = array(
+				'action' => 'trash_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$trash_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_restore_event',
+				$item->ID()
+			)
+		) {
+			$restore_event_query_args = array(
+				'action' => 'restore_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$restore_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_delete_event',
+				$item->ID()
+			)
+		) {
+			$delete_event_query_args = array(
+				'action' => 'delete_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$delete_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		$view_link = get_permalink($item->ID());
+		$actions['view'] = '<a href="' . $view_link . '"'
+						   . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+						   . esc_html__('View', 'event_espresso')
+						   . '</a>';
+		if ($item->get('status') === 'trash') {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_restore_event',
+					$item->ID()
+				)
+			) {
+				$actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
+												 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+												 . '">'
+												 . esc_html__('Restore from Trash', 'event_espresso')
+												 . '</a>';
+			}
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_delete_event',
+					$item->ID()
+				)
+			) {
+				$actions['delete'] = '<a href="' . $delete_event_link . '"'
+									 . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_trash_event',
+					$item->ID()
+				)
+			) {
+				$actions['move to trash'] = '<a href="' . $trash_event_link . '"'
+											. ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+											. esc_html__('Trash', 'event_espresso')
+											. '</a>';
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_author(EE_Event $item)
+	{
+		// user author info
+		$event_author = get_userdata($item->wp_user());
+		$gravatar = get_avatar($item->wp_user(), '15');
+		// filter link
+		$query_args = array(
+			'action'      => 'default',
+			'EVT_wp_user' => $item->wp_user(),
+		);
+		$filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
+		return $gravatar . '  <a href="' . $filter_url . '"'
+			   . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+			   . $event_author->display_name
+			   . '</a>';
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_event_category(EE_Event $event)
+	{
+		$event_categories = $event->get_all_event_categories();
+		return implode(
+			', ',
+			array_map(
+				function (EE_Term $category) {
+					return $category->name();
+				},
+				$event_categories
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_venue(EE_Event $item)
+	{
+		$venue = $item->get_first_related('Venue');
+		return ! empty($venue)
+			? $venue->name()
+			: '';
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_start_date_time(EE_Event $item)
+	{
+		return $this->_dtt instanceof EE_Datetime
+			? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
+			: esc_html__('No Date was saved for this Event', 'event_espresso');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_reg_begins(EE_Event $item)
+	{
+		$reg_start = $item->get_ticket_with_earliest_start_time();
+		return $reg_start instanceof EE_Ticket
+			? $reg_start->get_i18n_datetime('TKT_start_date')
+			: esc_html__('No Tickets have been setup for this Event', 'event_espresso');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_attendees(EE_Event $item)
+	{
+		$attendees_query_args = array(
+			'action'   => 'default',
+			'event_id' => $item->ID(),
+		);
+		$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+		$registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_event',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		)
+			   && EE_Registry::instance()->CAP->current_user_can(
+				   'ee_read_registrations',
+				   'espresso_registrations_view_registration'
+			   )
+			? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+			: $registered_attendees;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_tkts_sold(EE_Event $item)
+	{
+		return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_actions(EE_Event $item)
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$action_links = array();
+		$view_link = get_permalink($item->ID());
+		$action_links[] = '<a href="' . $view_link . '"'
+						  . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+		$action_links[] = '<div class="dashicons dashicons-search"></div></a>';
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_event',
+				'espresso_events_edit',
+				$item->ID()
+			)
+		) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$action_links[] = '<a href="' . $edit_link . '"'
+							  . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							  . '<div class="ee-icon ee-icon-calendar-edit"></div>'
+							  . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			) && EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="' . $attendees_link . '"'
+							  . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+							  . '<div class="dashicons dashicons-groups"></div>'
+							  . '</a>';
+		}
+		$action_links = apply_filters(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			$action_links,
+			$item
+		);
+		return $this->_action_string(
+			implode("\n\t", $action_links),
+			$item,
+			'div'
+		);
+	}
+
+
+	/**
+	 * Helper for adding columns conditionally
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function addConditionalColumns()
+	{
+		$event_category_count = EEM_Term::instance()->count(
+			[['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
+		);
+		if ($event_category_count === 0) {
+			return;
+		}
+		$column_array = [];
+		foreach ($this->_columns as $column => $column_label) {
+			$column_array[ $column ] = $column_label;
+			if ($column === 'venue') {
+				$column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
+			}
+		}
+		$this->_columns = $column_array;
+	}
 }

admin_pages/registrations/EE_Attendee_Contact_List_Table.class.php

Indentation +378 added lines, -378 removed lines

@@ -12,382 +12,382 @@
  */
 class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * Initial setup of data (called by parent).
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_view !== 'trash'
-            ? $this->_admin_page->get_attendees($this->_per_page)
-            : $this->_admin_page->get_attendees($this->_per_page, false, true);
-        $this->_all_data_count = $this->_view !== 'trash'
-            ? $this->_admin_page->get_attendees($this->_per_page, true)
-            : $this->_admin_page->get_attendees($this->_per_page, true, true);
-    }
-
-
-    /**
-     * Initial setup of properties.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('attendee', 'event_espresso'),
-            'plural'   => esc_html__('attendees', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'                 => '<input type="checkbox" />', // Render a checkbox instead of text
-            'ATT_ID'             => esc_html__('ID', 'event_espresso'),
-            'ATT_fname'          => esc_html__('First Name', 'event_espresso'),
-            'ATT_lname'          => esc_html__('Last Name', 'event_espresso'),
-            'ATT_email'          => esc_html__('Email Address', 'event_espresso'),
-            'Registration_Count' => esc_html__('# Registrations', 'event_espresso'),
-            'ATT_phone'          => esc_html__('Phone', 'event_espresso'),
-            'ATT_address'        => esc_html__('Address', 'event_espresso'),
-            'ATT_city'           => esc_html__('City', 'event_espresso'),
-            'STA_ID'             => esc_html__('State/Province', 'event_espresso'),
-            'CNT_ISO'            => esc_html__('Country', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'ATT_ID'             => array('ATT_ID' => false),
-            'ATT_lname'          => array('ATT_lname' => true), // true means its already sorted
-            'ATT_fname'          => array('ATT_fname' => false),
-            'ATT_email'          => array('ATT_email' => false),
-            'Registration_Count' => array('Registration_Count' => false),
-            'ATT_city'           => array('ATT_city' => false),
-            'STA_ID'             => array('STA_ID' => false),
-            'CNT_ISO'            => array('CNT_ISO' => false),
-        );
-
-        $this->_hidden_columns = array(
-            'ATT_phone',
-            'ATT_address',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-        );
-    }
-
-
-    /**
-     * Initial setup of filters
-     *
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array();
-    }
-
-
-    /**
-     * Initial setup of counts for views
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true);
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_contacts',
-                'espresso_registrations_delete_registration'
-            )
-        ) {
-            $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true);
-        }
-    }
-
-
-    /**
-     * Get count of attendees.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_attendees_count()
-    {
-        return EEM_Attendee::instance()->count();
-    }
-
-
-    /**
-     * Checkbox column
-     *
-     * @param EE_Attendee $attendee Unable to typehint this method because overrides parent.
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($attendee)
-    {
-        if (! $attendee instanceof EE_Attendee) {
-            return '';
-        }
-        return sprintf(
-            '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-            $attendee->ID()
-        );
-    }
-
-
-    /**
-     * ATT_ID column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_ATT_ID(EE_Attendee $attendee)
-    {
-        $content = $attendee->ID();
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * ATT_lname column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     */
-    public function column_ATT_lname(EE_Attendee $attendee)
-    {
-        // edit attendee link
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">'
-              . $attendee->lname() . '</a>'
-            : $attendee->lname();
-        return $name_link;
-    }
-
-
-    /**
-     * ATT_fname column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     */
-    public function column_ATT_fname(EE_Attendee $attendee)
-    {
-        // Build row actions
-        $actions = array();
-        // edit attendee link
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_contacts',
-                'espresso_registrations_edit_attendee'
-            )
-        ) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'edit_attendee',
-                    'post'   => $attendee->ID(),
-                ),
-                REG_ADMIN_URL
-            );
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Contact', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso') . '</a>';
-        }
-
-        if ($this->_view === 'in_use') {
-            // trash attendee link
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_contacts',
-                    'espresso_registrations_trash_attendees'
-                )
-            ) {
-                $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'trash_attendee',
-                        'ATT_ID' => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                    . esc_attr__('Move Contact to Trash', 'event_espresso')
-                                    . '">' . esc_html__('Trash', 'event_espresso') . '</a>';
-            }
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_contacts',
-                    'espresso_registrations_restore_attendees'
-                )
-            ) {
-                // restore attendee link
-                $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'restore_attendees',
-                        'ATT_ID' => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                      . esc_attr__('Restore Contact', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-            }
-        }
-
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
-            : $attendee->fname();
-
-        // Return the name contents
-        return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions));
-    }
-
-
-    /**
-     * Email Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_ATT_email(EE_Attendee $attendee)
-    {
-        return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
-    }
-
-
-    /**
-     * Column displaying count of registrations attached to Attendee.
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_Registration_Count(EE_Attendee $attendee)
-    {
-        $link = EEH_URL::add_query_args_and_nonce(
-            array(
-                'action' => 'default',
-                'ATT_ID' => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
-    }
-
-
-    /**
-     * ATT_address column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_address(EE_Attendee $attendee)
-    {
-        return $attendee->address();
-    }
-
-
-    /**
-     * ATT_city column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_city(EE_Attendee $attendee)
-    {
-        return $attendee->city();
-    }
-
-
-    /**
-     * State Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_STA_ID(EE_Attendee $attendee)
-    {
-        $states = EEM_State::instance()->get_all_states();
-        $state = isset($states[ $attendee->state_ID() ])
-            ? $states[ $attendee->state_ID() ]->get('STA_name')
-            : $attendee->state_ID();
-        return ! is_numeric($state) ? $state : '';
-    }
-
-
-    /**
-     * Country Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_CNT_ISO(EE_Attendee $attendee)
-    {
-        $countries = EEM_Country::instance()->get_all_countries();
-        $country = isset($countries[ $attendee->country_ID() ])
-            ? $countries[ $attendee->country_ID() ]->get('CNT_name')
-            : $attendee->country_ID();
-        return ! is_numeric($country) ? $country : '';
-    }
-
-
-    /**
-     * Phone Number column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_phone(EE_Attendee $attendee)
-    {
-        return $attendee->phone();
-    }
+	/**
+	 * Initial setup of data (called by parent).
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_view !== 'trash'
+			? $this->_admin_page->get_attendees($this->_per_page)
+			: $this->_admin_page->get_attendees($this->_per_page, false, true);
+		$this->_all_data_count = $this->_view !== 'trash'
+			? $this->_admin_page->get_attendees($this->_per_page, true)
+			: $this->_admin_page->get_attendees($this->_per_page, true, true);
+	}
+
+
+	/**
+	 * Initial setup of properties.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('attendee', 'event_espresso'),
+			'plural'   => esc_html__('attendees', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'                 => '<input type="checkbox" />', // Render a checkbox instead of text
+			'ATT_ID'             => esc_html__('ID', 'event_espresso'),
+			'ATT_fname'          => esc_html__('First Name', 'event_espresso'),
+			'ATT_lname'          => esc_html__('Last Name', 'event_espresso'),
+			'ATT_email'          => esc_html__('Email Address', 'event_espresso'),
+			'Registration_Count' => esc_html__('# Registrations', 'event_espresso'),
+			'ATT_phone'          => esc_html__('Phone', 'event_espresso'),
+			'ATT_address'        => esc_html__('Address', 'event_espresso'),
+			'ATT_city'           => esc_html__('City', 'event_espresso'),
+			'STA_ID'             => esc_html__('State/Province', 'event_espresso'),
+			'CNT_ISO'            => esc_html__('Country', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'ATT_ID'             => array('ATT_ID' => false),
+			'ATT_lname'          => array('ATT_lname' => true), // true means its already sorted
+			'ATT_fname'          => array('ATT_fname' => false),
+			'ATT_email'          => array('ATT_email' => false),
+			'Registration_Count' => array('Registration_Count' => false),
+			'ATT_city'           => array('ATT_city' => false),
+			'STA_ID'             => array('STA_ID' => false),
+			'CNT_ISO'            => array('CNT_ISO' => false),
+		);
+
+		$this->_hidden_columns = array(
+			'ATT_phone',
+			'ATT_address',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+		);
+	}
+
+
+	/**
+	 * Initial setup of filters
+	 *
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array();
+	}
+
+
+	/**
+	 * Initial setup of counts for views
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true);
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_contacts',
+				'espresso_registrations_delete_registration'
+			)
+		) {
+			$this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true);
+		}
+	}
+
+
+	/**
+	 * Get count of attendees.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_attendees_count()
+	{
+		return EEM_Attendee::instance()->count();
+	}
+
+
+	/**
+	 * Checkbox column
+	 *
+	 * @param EE_Attendee $attendee Unable to typehint this method because overrides parent.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($attendee)
+	{
+		if (! $attendee instanceof EE_Attendee) {
+			return '';
+		}
+		return sprintf(
+			'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+			$attendee->ID()
+		);
+	}
+
+
+	/**
+	 * ATT_ID column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_ATT_ID(EE_Attendee $attendee)
+	{
+		$content = $attendee->ID();
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+		$content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * ATT_lname column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 */
+	public function column_ATT_lname(EE_Attendee $attendee)
+	{
+		// edit attendee link
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Contact', 'event_espresso') . '">'
+			  . $attendee->lname() . '</a>'
+			: $attendee->lname();
+		return $name_link;
+	}
+
+
+	/**
+	 * ATT_fname column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 */
+	public function column_ATT_fname(EE_Attendee $attendee)
+	{
+		// Build row actions
+		$actions = array();
+		// edit attendee link
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_contacts',
+				'espresso_registrations_edit_attendee'
+			)
+		) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'edit_attendee',
+					'post'   => $attendee->ID(),
+				),
+				REG_ADMIN_URL
+			);
+			$actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
+							   . esc_attr__('Edit Contact', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso') . '</a>';
+		}
+
+		if ($this->_view === 'in_use') {
+			// trash attendee link
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_contacts',
+					'espresso_registrations_trash_attendees'
+				)
+			) {
+				$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'trash_attendee',
+						'ATT_ID' => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+									. esc_attr__('Move Contact to Trash', 'event_espresso')
+									. '">' . esc_html__('Trash', 'event_espresso') . '</a>';
+			}
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_contacts',
+					'espresso_registrations_restore_attendees'
+				)
+			) {
+				// restore attendee link
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'restore_attendees',
+						'ATT_ID' => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
+									  . esc_attr__('Restore Contact', 'event_espresso') . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+			}
+		}
+
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
+			: $attendee->fname();
+
+		// Return the name contents
+		return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions));
+	}
+
+
+	/**
+	 * Email Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_ATT_email(EE_Attendee $attendee)
+	{
+		return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
+	}
+
+
+	/**
+	 * Column displaying count of registrations attached to Attendee.
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_Registration_Count(EE_Attendee $attendee)
+	{
+		$link = EEH_URL::add_query_args_and_nonce(
+			array(
+				'action' => 'default',
+				'ATT_ID' => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
+	}
+
+
+	/**
+	 * ATT_address column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_address(EE_Attendee $attendee)
+	{
+		return $attendee->address();
+	}
+
+
+	/**
+	 * ATT_city column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_city(EE_Attendee $attendee)
+	{
+		return $attendee->city();
+	}
+
+
+	/**
+	 * State Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_STA_ID(EE_Attendee $attendee)
+	{
+		$states = EEM_State::instance()->get_all_states();
+		$state = isset($states[ $attendee->state_ID() ])
+			? $states[ $attendee->state_ID() ]->get('STA_name')
+			: $attendee->state_ID();
+		return ! is_numeric($state) ? $state : '';
+	}
+
+
+	/**
+	 * Country Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_CNT_ISO(EE_Attendee $attendee)
+	{
+		$countries = EEM_Country::instance()->get_all_countries();
+		$country = isset($countries[ $attendee->country_ID() ])
+			? $countries[ $attendee->country_ID() ]->get('CNT_name')
+			: $attendee->country_ID();
+		return ! is_numeric($country) ? $country : '';
+	}
+
+
+	/**
+	 * Phone Number column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_phone(EE_Attendee $attendee)
+	{
+		return $attendee->phone();
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -129,7 +129,7 @@ 
      */
     public function column_cb($attendee)
     {
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             return '';
         }
         return sprintf(
@@ -150,7 +150,7 @@ 
     {
         $content = $attendee->ID();
         $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$attendee_name.'</span>';
         return $content;
     }
 
@@ -179,9 +179,9 @@ 
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">'
-              . $attendee->lname() . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Contact', 'event_espresso').'">'
+              . $attendee->lname().'</a>'
             : $attendee->lname();
         return $name_link;
     }
@@ -215,9 +215,9 @@ 
                 ),
                 REG_ADMIN_URL
             );
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Contact', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso') . '</a>';
+            $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'
+                               . esc_attr__('Edit Contact', 'event_espresso').'">'
+                               . esc_html__('Edit', 'event_espresso').'</a>';
         }
 
         if ($this->_view === 'in_use') {
@@ -235,9 +235,9 @@ 
                     ),
                     REG_ADMIN_URL
                 );
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+                $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'
                                     . esc_attr__('Move Contact to Trash', 'event_espresso')
-                                    . '">' . esc_html__('Trash', 'event_espresso') . '</a>';
+                                    . '">'.esc_html__('Trash', 'event_espresso').'</a>';
             }
         } else {
             if (
@@ -254,9 +254,9 @@ 
                     ),
                     REG_ADMIN_URL
                 );
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                      . esc_attr__('Restore Contact', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'
+                                      . esc_attr__('Restore Contact', 'event_espresso').'">'
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
             }
         }
 
@@ -271,8 +271,8 @@ 
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Contact', 'event_espresso').'">'.$attendee->fname().'</a>'
             : $attendee->fname();
 
         // Return the name contents
@@ -289,7 +289,7 @@ 
      */
     public function column_ATT_email(EE_Attendee $attendee)
     {
-        return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
+        return '<a href="mailto:'.$attendee->email().'">'.$attendee->email().'</a>';
     }
 
 
@@ -309,7 +309,7 @@ 
             ),
             REG_ADMIN_URL
         );
-        return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
+        return '<a href="'.$link.'">'.$attendee->getCustomSelect('Registration_Count').'</a>';
     }
 
 
@@ -352,8 +352,8 @@ 
     public function column_STA_ID(EE_Attendee $attendee)
     {
         $states = EEM_State::instance()->get_all_states();
-        $state = isset($states[ $attendee->state_ID() ])
-            ? $states[ $attendee->state_ID() ]->get('STA_name')
+        $state = isset($states[$attendee->state_ID()])
+            ? $states[$attendee->state_ID()]->get('STA_name')
             : $attendee->state_ID();
         return ! is_numeric($state) ? $state : '';
     }
@@ -372,8 +372,8 @@ 
     public function column_CNT_ISO(EE_Attendee $attendee)
     {
         $countries = EEM_Country::instance()->get_all_countries();
-        $country = isset($countries[ $attendee->country_ID() ])
-            ? $countries[ $attendee->country_ID() ]->get('CNT_name')
+        $country = isset($countries[$attendee->country_ID()])
+            ? $countries[$attendee->country_ID()]->get('CNT_name')
             : $attendee->country_ID();
         return ! is_numeric($country) ? $country : '';
     }

core/db_classes/EE_Price.class.php

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
     public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
     {
         $price = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        if (! $price instanceof EE_Price) {
+        if ( ! $price instanceof EE_Price) {
             $price = new EE_Price($props_n_values, false, $timezone, $date_formats);
         }
         return $price;

Indentation +342 added lines, -342 removed lines

@@ -9,346 +9,346 @@
  */
 class EE_Price extends EE_Soft_Delete_Base_Class
 {
-    /**
-     * @param array  $props_n_values    incoming values
-     * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats      incoming date_formats in an array where the first value is the
-     *                                  date_format and the second value is the time format
-     * @return EE_Price
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
-    {
-        $price = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        if (! $price instanceof EE_Price) {
-            $price = new EE_Price($props_n_values, false, $timezone, $date_formats);
-        }
-        return $price;
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Price
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Adds some defaults if they're not specified
-     *
-     * @param array  $props_n_values
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats  incoming date_formats in an array where the first value is the
-     *                              date_format and the second value is the time format
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct($props_n_values = [], $bydb = false, $timezone = '', $date_formats = [])
-    {
-        parent::__construct($props_n_values, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * Set Price type ID
-     *
-     * @param int $PRT_ID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_type($PRT_ID = 0)
-    {
-        $this->set('PRT_ID', $PRT_ID);
-    }
-
-
-    /**
-     * Set Price Amount
-     *
-     * @param float $amount
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_amount($amount = 0.00)
-    {
-        $this->set('PRC_amount', $amount);
-    }
-
-
-    /**
-     * Set Price Name
-     *
-     * @param string $PRC_name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_name($PRC_name = '')
-    {
-        $this->set('PRC_name', $PRC_name);
-    }
-
-
-    /**
-     * Set Price Description
-     *
-     * @param string $PRC_desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_description($PRC_desc = '')
-    {
-        $this->Set('PRC_desc', $PRC_desc);
-    }
-
-
-    /**
-     * set is_default
-     *
-     * @param bool $PRC_is_default
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_is_default($PRC_is_default = false)
-    {
-        $this->set('PRC_is_default', $PRC_is_default);
-    }
-
-
-    /**
-     * set deleted
-     *
-     * @param bool $PRC_deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_deleted($PRC_deleted = null)
-    {
-        $this->set('PRC_deleted', $PRC_deleted);
-    }
-
-
-    /**
-     * get Price type
-     *
-     * @return        int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type()
-    {
-        return $this->get('PRT_ID');
-    }
-
-
-    /**
-     * get Price Amount
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function amount()
-    {
-        return $this->get('PRC_amount');
-    }
-
-
-    /**
-     * get Price Name
-     *
-     * @return        string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        return $this->get('PRC_name');
-    }
-
-
-    /**
-     * get Price description
-     *
-     * @return        string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function desc()
-    {
-        return $this->get('PRC_desc');
-    }
-
-
-    /**
-     * get overrides
-     *
-     * @return        int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function overrides()
-    {
-        return $this->get('PRC_overrides');
-    }
-
-
-    /**
-     * get order
-     *
-     * @return        int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('PRC_order');
-    }
-
-
-    /**
-     * get the author of the price
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     *
-     */
-    public function wp_user()
-    {
-        return $this->get('PRC_wp_user');
-    }
-
-
-    /**
-     * get is_default
-     *
-     * @return        bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_default()
-    {
-        return $this->get('PRC_is_default');
-    }
-
-
-    /**
-     * get deleted
-     *
-     * @return        bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deleted()
-    {
-        return $this->get('PRC_deleted');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function parent()
-    {
-        return $this->get('PRC_parent');
-    }
-
-
-    // some helper methods for getting info on the price_type for this price
-
-
-    /**
-     * return whether the price is a base price or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_base_price()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->base_type() === 1;
-    }
-
-
-    /**
-     *
-     * @return EE_Base_Class|EE_Price_Type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type_obj()
-    {
-        return $this->get_first_related('Price_Type');
-    }
-
-
-    /**
-     * Simply indicates whether this price increases or decreases the total
-     *
-     * @return boolean true = discount, otherwise adds to the total
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_discount()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->is_discount();
-    }
-
-
-    /**
-     * whether the price is a percentage or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_percent()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->get('PRT_is_percent');
-    }
-
-
-    /**
-     * return pretty price dependant on whether its a dollar or percent.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.4.0
-     *
-     */
-    public function pretty_price()
-    {
-        return $this->is_percent()
-            ? apply_filters(
-                'FHEE__format_percentage_value',
-                $this->get_pretty('PRC_amount', 'localized_float')
-            )
-            : $this->get_pretty('PRC_amount', 'localized_currency');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_price_without_currency_symbol()
-    {
-        return $this->get_pretty('PRC_amount', 'localized_float');
-    }
+	/**
+	 * @param array  $props_n_values    incoming values
+	 * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats      incoming date_formats in an array where the first value is the
+	 *                                  date_format and the second value is the time format
+	 * @return EE_Price
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
+	{
+		$price = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		if (! $price instanceof EE_Price) {
+			$price = new EE_Price($props_n_values, false, $timezone, $date_formats);
+		}
+		return $price;
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Price
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Adds some defaults if they're not specified
+	 *
+	 * @param array  $props_n_values
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats  incoming date_formats in an array where the first value is the
+	 *                              date_format and the second value is the time format
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct($props_n_values = [], $bydb = false, $timezone = '', $date_formats = [])
+	{
+		parent::__construct($props_n_values, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * Set Price type ID
+	 *
+	 * @param int $PRT_ID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_type($PRT_ID = 0)
+	{
+		$this->set('PRT_ID', $PRT_ID);
+	}
+
+
+	/**
+	 * Set Price Amount
+	 *
+	 * @param float $amount
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_amount($amount = 0.00)
+	{
+		$this->set('PRC_amount', $amount);
+	}
+
+
+	/**
+	 * Set Price Name
+	 *
+	 * @param string $PRC_name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_name($PRC_name = '')
+	{
+		$this->set('PRC_name', $PRC_name);
+	}
+
+
+	/**
+	 * Set Price Description
+	 *
+	 * @param string $PRC_desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_description($PRC_desc = '')
+	{
+		$this->Set('PRC_desc', $PRC_desc);
+	}
+
+
+	/**
+	 * set is_default
+	 *
+	 * @param bool $PRC_is_default
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_is_default($PRC_is_default = false)
+	{
+		$this->set('PRC_is_default', $PRC_is_default);
+	}
+
+
+	/**
+	 * set deleted
+	 *
+	 * @param bool $PRC_deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_deleted($PRC_deleted = null)
+	{
+		$this->set('PRC_deleted', $PRC_deleted);
+	}
+
+
+	/**
+	 * get Price type
+	 *
+	 * @return        int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type()
+	{
+		return $this->get('PRT_ID');
+	}
+
+
+	/**
+	 * get Price Amount
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function amount()
+	{
+		return $this->get('PRC_amount');
+	}
+
+
+	/**
+	 * get Price Name
+	 *
+	 * @return        string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		return $this->get('PRC_name');
+	}
+
+
+	/**
+	 * get Price description
+	 *
+	 * @return        string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function desc()
+	{
+		return $this->get('PRC_desc');
+	}
+
+
+	/**
+	 * get overrides
+	 *
+	 * @return        int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function overrides()
+	{
+		return $this->get('PRC_overrides');
+	}
+
+
+	/**
+	 * get order
+	 *
+	 * @return        int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('PRC_order');
+	}
+
+
+	/**
+	 * get the author of the price
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 *
+	 */
+	public function wp_user()
+	{
+		return $this->get('PRC_wp_user');
+	}
+
+
+	/**
+	 * get is_default
+	 *
+	 * @return        bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_default()
+	{
+		return $this->get('PRC_is_default');
+	}
+
+
+	/**
+	 * get deleted
+	 *
+	 * @return        bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deleted()
+	{
+		return $this->get('PRC_deleted');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function parent()
+	{
+		return $this->get('PRC_parent');
+	}
+
+
+	// some helper methods for getting info on the price_type for this price
+
+
+	/**
+	 * return whether the price is a base price or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_base_price()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->base_type() === 1;
+	}
+
+
+	/**
+	 *
+	 * @return EE_Base_Class|EE_Price_Type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type_obj()
+	{
+		return $this->get_first_related('Price_Type');
+	}
+
+
+	/**
+	 * Simply indicates whether this price increases or decreases the total
+	 *
+	 * @return boolean true = discount, otherwise adds to the total
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_discount()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->is_discount();
+	}
+
+
+	/**
+	 * whether the price is a percentage or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_percent()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->get('PRT_is_percent');
+	}
+
+
+	/**
+	 * return pretty price dependant on whether its a dollar or percent.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.4.0
+	 *
+	 */
+	public function pretty_price()
+	{
+		return $this->is_percent()
+			? apply_filters(
+				'FHEE__format_percentage_value',
+				$this->get_pretty('PRC_amount', 'localized_float')
+			)
+			: $this->get_pretty('PRC_amount', 'localized_currency');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_price_without_currency_symbol()
+	{
+		return $this->get_pretty('PRC_amount', 'localized_float');
+	}
 }

core/db_classes/EE_Registration_Payment.class.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
     {
         $reg_payment = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        if (! $reg_payment instanceof EE_Registration_Payment) {
+        if ( ! $reg_payment instanceof EE_Registration_Payment) {
             $reg_payment = new EE_Registration_Payment($props_n_values, false, $timezone, $date_formats);
         }
         return $reg_payment;

Indentation +138 added lines, -138 removed lines

@@ -11,142 +11,142 @@
  */
 class EE_Registration_Payment extends EE_Base_Class
 {
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Registration_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
-    {
-        $reg_payment = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        if (! $reg_payment instanceof EE_Registration_Payment) {
-            $reg_payment = new EE_Registration_Payment($props_n_values, false, $timezone, $date_formats);
-        }
-        return $reg_payment;
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Registration_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Adds some defaults if they're not specified
-     *
-     * @param array  $props_n_values
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats  incoming date_formats in an array where the first value is the
-     *                              date_format and the second value is the time format
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct($props_n_values = [], $bydb = false, $timezone = '', $date_formats = [])
-    {
-        parent::__construct($props_n_values, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * registration_ID
-     *
-     * @return    int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration_ID()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    /**
-     * payment_ID
-     *
-     * @return    int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function payment_ID()
-    {
-        return $this->get('PAY_ID');
-    }
-
-
-    /**
-     * amount
-     *
-     * @return    float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function amount()
-    {
-        return $this->get('RPY_amount');
-    }
-
-
-    /**
-     * formatted amount
-     *
-     * @param string|null $schema
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function prettyAmount($schema = 'localized_currency')
-    {
-        return $this->get_pretty('RPY_amount', $schema);
-    }
-
-
-    /**
-     * amount
-     *
-     * @param float $amount
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_amount($amount = 0)
-    {
-        $this->set('RPY_amount', $amount);
-    }
-
-
-    /**
-     * registration
-     *
-     * @return EE_Base_Class|EE_Registration
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration()
-    {
-        return $this->get_first_related('Registration');
-    }
-
-
-    /**
-     * payment
-     *
-     * @return EE_Base_Class|EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function payment()
-    {
-        return $this->get_first_related('Payment');
-    }
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Registration_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
+	{
+		$reg_payment = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		if (! $reg_payment instanceof EE_Registration_Payment) {
+			$reg_payment = new EE_Registration_Payment($props_n_values, false, $timezone, $date_formats);
+		}
+		return $reg_payment;
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Registration_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Adds some defaults if they're not specified
+	 *
+	 * @param array  $props_n_values
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats  incoming date_formats in an array where the first value is the
+	 *                              date_format and the second value is the time format
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct($props_n_values = [], $bydb = false, $timezone = '', $date_formats = [])
+	{
+		parent::__construct($props_n_values, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * registration_ID
+	 *
+	 * @return    int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration_ID()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	/**
+	 * payment_ID
+	 *
+	 * @return    int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function payment_ID()
+	{
+		return $this->get('PAY_ID');
+	}
+
+
+	/**
+	 * amount
+	 *
+	 * @return    float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function amount()
+	{
+		return $this->get('RPY_amount');
+	}
+
+
+	/**
+	 * formatted amount
+	 *
+	 * @param string|null $schema
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function prettyAmount($schema = 'localized_currency')
+	{
+		return $this->get_pretty('RPY_amount', $schema);
+	}
+
+
+	/**
+	 * amount
+	 *
+	 * @param float $amount
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_amount($amount = 0)
+	{
+		$this->set('RPY_amount', $amount);
+	}
+
+
+	/**
+	 * registration
+	 *
+	 * @return EE_Base_Class|EE_Registration
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration()
+	{
+		return $this->get_first_related('Registration');
+	}
+
+
+	/**
+	 * payment
+	 *
+	 * @return EE_Base_Class|EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function payment()
+	{
+		return $this->get_first_related('Payment');
+	}
 }

core/db_classes/EE_Line_Item.class.php

Spacing +15 added lines, -15 removed lines

@@ -116,15 +116,15 @@ 
      */
     protected function __construct($fieldValues = [], $bydb = false, $timezone = '', $date_formats = [])
     {
-        if (! $this->calculator instanceof LineItemCalculator) {
+        if ( ! $this->calculator instanceof LineItemCalculator) {
             $this->calculator = LoaderFactory::getLoader()->getShared(LineItemCalculator::class);
         }
         parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-        if (! $this->get('LIN_code')) {
+        if ( ! $this->get('LIN_code')) {
             $this->set_code($this->generate_code());
         }
         // in a better world this would have been injected upon construction
-        if (! $this->currency_formatter instanceof CurrencyFormatter) {
+        if ( ! $this->currency_formatter instanceof CurrencyFormatter) {
             $this->currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
         }
     }
@@ -200,7 +200,7 @@ 
     public function name()
     {
         $name = $this->get('LIN_name');
-        if (! $name) {
+        if ( ! $name) {
             $name = ucwords(str_replace('-', ' ', $this->type()));
         }
         return $name;
@@ -710,7 +710,7 @@ 
                 ]
             );
         }
-        if (! is_array($this->_children)) {
+        if ( ! is_array($this->_children)) {
             $this->_children = [];
         }
         return $this->_children;
@@ -951,7 +951,7 @@ 
             }
             return $line_item->save();
         }
-        $this->_children[ $line_item->code() ] = $line_item;
+        $this->_children[$line_item->code()] = $line_item;
         if ($line_item->parent() !== $this) {
             $line_item->set_parent($this);
         }
@@ -975,7 +975,7 @@ 
     public function set_parent($line_item)
     {
         if ($this->ID()) {
-            if (! $line_item->ID()) {
+            if ( ! $line_item->ID()) {
                 $line_item->save();
             }
             $this->set_parent_ID($line_item->ID());
@@ -1007,8 +1007,8 @@ 
                 [['LIN_parent' => $this->ID(), 'LIN_code' => $code]]
             );
         }
-        return isset($this->_children[ $code ])
-            ? $this->_children[ $code ]
+        return isset($this->_children[$code])
+            ? $this->_children[$code]
             : null;
     }
 
@@ -1068,8 +1068,8 @@ 
             }
             return $items_deleted;
         }
-        if (isset($this->_children[ $code ])) {
-            unset($this->_children[ $code ]);
+        if (isset($this->_children[$code])) {
+            unset($this->_children[$code]);
             return 1;
         }
         return 0;
@@ -1111,7 +1111,7 @@ 
     {
         // each line item in the cart requires a unique identifier
         // return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
-        return $this->get('OBJ_type') . '-' . $this->get('OBJ_ID') . '-' . microtime();
+        return $this->get('OBJ_type').'-'.$this->get('OBJ_ID').'-'.microtime();
     }
 
 
@@ -1424,12 +1424,12 @@ 
     public function save_this_and_descendants_to_txn($txn_id = null)
     {
         $count = 0;
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             $txn_id = $this->TXN_ID();
         }
         $this->set_TXN_ID($txn_id);
         $children = $this->children();
-        $count    += $this->save()
+        $count += $this->save()
             ? 1
             : 0;
         foreach ($children as $child_line_item) {
@@ -1456,7 +1456,7 @@ 
     {
         $count    = 0;
         $children = $this->children();
-        $count    += $this->save()
+        $count += $this->save()
             ? 1
             : 0;
         foreach ($children as $child_line_item) {

Indentation +1564 added lines, -1564 removed lines

@@ -16,1568 +16,1568 @@
  */
 class EE_Line_Item extends EE_Base_Class implements EEI_Line_Item
 {
-    /**
-     * @var CurrencyFormatter
-     * @since $VID:$
-     */
-    protected $currency_formatter;
-
-    /**
-     * for children line items (currently not a normal relation)
-     *
-     * @type EE_Line_Item[]
-     */
-    protected $_children = [];
-
-    /**
-     * for the parent line item
-     *
-     * @var EE_Line_Item
-     */
-    protected $_parent;
-
-    /**
-     * number of decimal places to round numbers to when performing calculations
-     *
-     * @var integer $decimal_precision
-     */
-    protected $decimal_precision = 6;
-
-    /**
-     * @var LineItemCalculator
-     */
-    private $calculator;
-
-    /**
-     * @var bool
-     */
-    private $is_percent;
-
-
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
-    {
-        $has_object = parent::_check_for_object(
-            $props_n_values,
-            EE_Line_Item::class,
-            $timezone,
-            $date_formats
-        );
-        return $has_object
-            ? $has_object
-            : new EE_Line_Item($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = null)
-    {
-        return new EE_Line_Item($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Adds some defaults if they're not specified
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function __construct($fieldValues = [], $bydb = false, $timezone = '', $date_formats = [])
-    {
-        if (! $this->calculator instanceof LineItemCalculator) {
-            $this->calculator = LoaderFactory::getLoader()->getShared(LineItemCalculator::class);
-        }
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-        if (! $this->get('LIN_code')) {
-            $this->set_code($this->generate_code());
-        }
-        // in a better world this would have been injected upon construction
-        if (! $this->currency_formatter instanceof CurrencyFormatter) {
-            $this->currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
-        }
-    }
-
-
-    /**
-     * @param int $decimal_precision
-     */
-    public function setDecimalPrecision($decimal_precision = 6)
-    {
-        $this->decimal_precision = absint($decimal_precision);
-    }
-
-
-    /**
-     * Gets ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ID()
-    {
-        return $this->get('LIN_ID');
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        $name = $this->get('LIN_name');
-        if (! $name) {
-            $name = ucwords(str_replace('-', ' ', $this->type()));
-        }
-        return $name;
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('LIN_name', $name);
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function desc()
-    {
-        return $this->get('LIN_desc');
-    }
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_desc($desc)
-    {
-        $this->set('LIN_desc', $desc);
-    }
-
-
-    /**
-     * Gets quantity
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function quantity()
-    {
-        return $this->get('LIN_quantity');
-    }
-
-
-    /**
-     * Sets quantity
-     *
-     * @param int $quantity
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_quantity($quantity)
-    {
-        $this->set('LIN_quantity', max($quantity, 0));
-    }
-
-
-    /**
-     * Gets item_id
-     *
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_ID()
-    {
-        return $this->get('OBJ_ID');
-    }
-
-
-    /**
-     * Sets item_id
-     *
-     * @param int|string $item_id
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_OBJ_ID($item_id)
-    {
-        $this->set('OBJ_ID', $item_id);
-    }
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_type()
-    {
-        return $this->get('OBJ_type');
-    }
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_type_i18n()
-    {
-        $obj_type = $this->OBJ_type();
-        switch ($obj_type) {
-            case EEM_Line_Item::OBJ_TYPE_EVENT:
-                $obj_type = esc_html__('Event', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_PRICE:
-                $obj_type = esc_html__('Price', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_PROMOTION:
-                $obj_type = esc_html__('Promotion', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_TICKET:
-                $obj_type = esc_html__('Ticket', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_TRANSACTION:
-                $obj_type = esc_html__('Transaction', 'event_espresso');
-                break;
-        }
-        return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
-    }
-
-
-    /**
-     * Sets item_type
-     *
-     * @param string $OBJ_type
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_OBJ_type($OBJ_type)
-    {
-        $this->set('OBJ_type', $OBJ_type);
-    }
-
-
-    /**
-     * Gets unit_price for flat rate items. Percent items should set this to 0.
-     * You may alternatively want to use prettyUnitPrice(), which works for flat and percent items.
-     *
-     * @param string $schema
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function unit_price($schema = 'localized_float')
-    {
-        return $this->get('LIN_unit_price', $schema);
-    }
-
-
-    /**
-     * @param string $schema
-     * @return mixed|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public function prettyUnitPrice($schema = 'localized_currency')
-    {
-        if ($this->is_percent()) {
-            $quantity = $this->parent() instanceof EE_Line_Item
-                        && $this->parent()->type() === EEM_Line_Item::type_line_item
-                ? $this->parent()->quantity()
-                : $this->quantity();
-            if ($quantity !== 0) {
-                $percent = $this->total() / $quantity;
-                $percent = $this->currency_formatter->roundForLocale($percent);
-                return apply_filters('FHEE__format_percentage_value', $percent);
-            }
-        }
-        return $this->get_pretty('LIN_unit_price', $schema);
-    }
-
-
-    /**
-     * Sets unit_price
-     *
-     * @param float $unit_price
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_unit_price($unit_price)
-    {
-        $this->set('LIN_unit_price', $unit_price);
-    }
-
-
-    /**
-     * Checks if this item is a percentage modifier or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_percent()
-    {
-        if ($this->is_percent !== null) {
-            return $this->is_percent;
-        }
-        if ($this->is_tax_sub_total()) {
-            // tax subtotals HAVE a percent on them, that percentage only applies
-            // to taxable items, so its' an exception. Treat it like a flat line item
-            $this->is_percent = false;
-            return $this->is_percent;
-        }
-        $unit_price = abs($this->get('LIN_unit_price'));
-        $percent    = abs($this->get('LIN_percent'));
-        if ($unit_price < .001 && $percent) {
-            $this->is_percent = true;
-            return $this->is_percent;
-        }
-        if ($unit_price >= .001 && ! $percent) {
-            $this->is_percent = false;
-            return $this->is_percent;
-        }
-        if ($unit_price >= .001 && $percent) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'A Line Item can not have a unit price of (%s) AND a percent (%s)!',
-                        'event_espresso'
-                    ),
-                    $unit_price,
-                    $percent
-                )
-            );
-        }
-        // if they're both 0, assume its not a percent item
-        $this->is_percent = false;
-        return $this->is_percent;
-    }
-
-
-    /**
-     * Gets percent (between 100-.001)
-     *
-     * @param bool $as_decimal if true will divide value by 100
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function percent($as_decimal = false)
-    {
-        $percent = $this->get('LIN_percent');
-        $percent = $as_decimal ? $percent / 100 : $percent;
-        return $this->currency_formatter->precisionRound($percent);
-    }
-
-
-    /**
-     * Gets percent (between 100-.001)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function prettyPercent()
-    {
-        return apply_filters('FHEE__format_percentage_value', $this->get_pretty('LIN_percent'));
-    }
-
-
-    /**
-     * Sets percent (between 100-0.01)
-     *
-     * @param float $percent
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_percent($percent)
-    {
-        $this->set('LIN_percent', $percent);
-    }
-
-
-    /**
-     * Gets total
-     *
-     * @param string $schema
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function total($schema = 'localized_float')
-    {
-        return $this->get('LIN_total', $schema);
-    }
-
-
-    /**
-     * @param string $schema
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function prettyTotal($schema = 'localized_currency')
-    {
-        return $this->get_pretty('LIN_total', $schema);
-    }
-
-
-    /**
-     * Sets total
-     *
-     * @param float $total
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_total($total)
-    {
-        $this->set('LIN_total', $total);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('LIN_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('LIN_order', $order);
-    }
-
-
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function parent_ID()
-    {
-        return $this->get('LIN_parent');
-    }
-
-
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_parent_ID($parent)
-    {
-        $this->set('LIN_parent', $parent);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function type()
-    {
-        return $this->get('LIN_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_type($type)
-    {
-        $this->set('LIN_type', $type);
-    }
-
-
-    /**
-     * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
-     * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
-     * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
-     * or indirectly by `EE_Line_item::add_child_line_item()`)
-     *
-     * @return EE_Base_Class|EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function parent()
-    {
-        return $this->ID()
-            ? $this->get_model()->get_one_by_ID($this->parent_ID())
-            : $this->_parent;
-    }
-
-
-    /**
-     * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
-     *
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function children()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_all(
-                [
-                    ['LIN_parent' => $this->ID()],
-                    'order_by' => ['LIN_order' => 'ASC'],
-                ]
-            );
-        }
-        if (! is_array($this->_children)) {
-            $this->_children = [];
-        }
-        return $this->_children;
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function code()
-    {
-        return $this->get('LIN_code');
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_code($code)
-    {
-        $this->set('LIN_code', $code);
-    }
-
-
-    /**
-     * Gets is_taxable
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_taxable()
-    {
-        return $this->get('LIN_is_taxable');
-    }
-
-
-    /**
-     * Sets is_taxable
-     *
-     * @param boolean $is_taxable
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_is_taxable($is_taxable)
-    {
-        $this->set('LIN_is_taxable', $is_taxable);
-    }
-
-
-    /**
-     * Gets the object that this model-joins-to.
-     * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
-     * EEM_Promotion_Object
-     *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
-     *
-     * @return EE_Base_Class | NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_object()
-    {
-        $model_name_of_related_obj = $this->OBJ_type();
-        return $this->get_model()->has_relation($model_name_of_related_obj)
-            ? $this->get_first_related($model_name_of_related_obj)
-            : null;
-    }
-
-
-    /**
-     * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
-     * (IE, if this line item is for a price or something else, will return NULL)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class|EE_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket($query_params = [])
-    {
-        // we're going to assume that when this method is called
-        // we always want to receive the attached ticket EVEN if that ticket is archived.
-        // This can be overridden via the incoming $query_params argument
-        $remove_defaults = ['default_where_conditions' => 'none'];
-        $query_params    = array_merge($remove_defaults, $query_params);
-        return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params);
-    }
-
-
-    /**
-     * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
-     *
-     * @return EE_Datetime | NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_ticket_datetime()
-    {
-        if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
-            $ticket = $this->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                $datetime = $ticket->first_datetime();
-                if ($datetime instanceof EE_Datetime) {
-                    return $datetime;
-                }
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the event's name that's related to the ticket, if this is for
-     * a ticket
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_event_name()
-    {
-        $event_name = esc_html__('Unknown', 'event_espresso');
-        $event      = $this->ticket_event();
-        if ($event instanceof EE_Event) {
-            $event_name = $event->name();
-        }
-        return $event_name;
-    }
-
-
-    /**
-     * Gets the event that's related to the ticket, if this line item represents a ticket.
-     *
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_event()
-    {
-        $event  = null;
-        $ticket = $this->ticket();
-        if ($ticket instanceof EE_Ticket) {
-            $datetime = $ticket->first_datetime();
-            if ($datetime instanceof EE_Datetime) {
-                $event = $datetime->event();
-            }
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the first datetime for this lien item, assuming it's for a ticket
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_datetime_start($date_format = '', $time_format = '')
-    {
-        $first_datetime_string = esc_html__('Unknown', 'event_espresso');
-        $datetime              = $this->get_ticket_datetime();
-        if ($datetime) {
-            $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
-        }
-        return $first_datetime_string;
-    }
-
-
-    /**
-     * Adds the line item as a child to this line item. If there is another child line
-     * item with the same LIN_code, it is overwritten by this new one
-     *
-     * @param EEI_Line_Item|EE_Line_Item $line_item
-     * @param bool                       $set_order
-     * @return bool success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
-    {
-        // should we calculate the LIN_order for this line item ?
-        if ($set_order || $line_item->order() === null) {
-            $line_item->set_order(count($this->children()));
-        }
-        if ($this->ID()) {
-            // check for any duplicate line items (with the same code), if so, this replaces it
-            $line_item_with_same_code = $this->get_child_line_item($line_item->code());
-            if (($line_item_with_same_code instanceof EE_Line_Item) && $line_item_with_same_code !== $line_item) {
-                $this->delete_child_line_item($line_item_with_same_code->code());
-            }
-            $line_item->set_parent_ID($this->ID());
-            if ($this->TXN_ID()) {
-                $line_item->set_TXN_ID($this->TXN_ID());
-            }
-            return $line_item->save();
-        }
-        $this->_children[ $line_item->code() ] = $line_item;
-        if ($line_item->parent() !== $this) {
-            $line_item->set_parent($this);
-        }
-        return true;
-    }
-
-
-    /**
-     * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
-     * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
-     * However, if this line item is NOT saved to the DB, this just caches the parent on
-     * the EE_Line_Item::_parent property.
-     *
-     * @param EE_Line_Item $line_item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_parent($line_item)
-    {
-        if ($this->ID()) {
-            if (! $line_item->ID()) {
-                $line_item->save();
-            }
-            $this->set_parent_ID($line_item->ID());
-            $this->save();
-        } else {
-            $this->_parent = $line_item;
-            $this->set_parent_ID($line_item->ID());
-        }
-    }
-
-
-    /**
-     * Gets the child line item as specified by its code. Because this returns an object (by reference)
-     * you can modify this child line item and the parent (this object) can know about them
-     * because it also has a reference to that line item
-     *
-     * @param string $code
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_child_line_item($code)
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_one(
-                [['LIN_parent' => $this->ID(), 'LIN_code' => $code]]
-            );
-        }
-        return isset($this->_children[ $code ])
-            ? $this->_children[ $code ]
-            : null;
-    }
-
-
-    /**
-     * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
-     * cached on it)
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_children_line_items()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->delete([['LIN_parent' => $this->ID()]]);
-        }
-        $count           = count($this->_children);
-        $this->_children = [];
-        return $count;
-    }
-
-
-    /**
-     * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
-     * HAS NOT been saved to the DB, removes the child line item with index $code.
-     * Also searches through the child's children for a matching line item. However, once a line item has been found
-     * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
-     * deleted)
-     *
-     * @param string $code
-     * @param bool   $stop_search_once_found
-     * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
-     *             the DB yet)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_child_line_item($code, $stop_search_once_found = true)
-    {
-        if ($this->ID()) {
-            $items_deleted = 0;
-            if ($this->code() === $code) {
-                $items_deleted += EEH_Line_Item::delete_all_child_items($this);
-                $items_deleted += (int) $this->delete();
-                if ($stop_search_once_found) {
-                    return $items_deleted;
-                }
-            }
-            foreach ($this->children() as $child_line_item) {
-                $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
-            }
-            return $items_deleted;
-        }
-        if (isset($this->_children[ $code ])) {
-            unset($this->_children[ $code ]);
-            return 1;
-        }
-        return 0;
-    }
-
-
-    /**
-     * If this line item is in the database, is of the type subtotal, and
-     * has no children, why do we have it? It should be deleted so this function
-     * does that
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_if_childless_subtotal()
-    {
-        if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
-            return $this->delete();
-        }
-        return false;
-    }
-
-
-    /**
-     * Creates a code and returns a string. doesn't assign the code to this model object
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function generate_code()
-    {
-        // each line item in the cart requires a unique identifier
-        // return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
-        return $this->get('OBJ_type') . '-' . $this->get('OBJ_ID') . '-' . microtime();
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_tax()
-    {
-        return $this->type() === EEM_Line_Item::type_tax;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_tax_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_tax_sub_total;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_line_item;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_sub_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_line_item;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_total;
-    }
-
-
-    /**
-     * Whether or not this line item is a cancellation line item
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancellation()
-    {
-        return EEM_Line_Item::type_cancellation === $this->type();
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_total()
-    {
-        return $this->type() === EEM_Line_Item::type_total;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancelled()
-    {
-        return $this->type() === EEM_Line_Item::type_cancellation;
-    }
-
-
-    /**
-     * @param string $schema
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function unit_price_no_code($schema = 'localized_float')
-    {
-        return $this->get_pretty('LIN_unit_price', $schema);
-    }
-
-
-    /**
-     * @param string $schema
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function total_no_code($schema = 'localized_float')
-    {
-        return $this->get_pretty('LIN_total', $schema);
-    }
-
-
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total (provided this line item is allowed to persist, otherwise we don't
-     * want to change a persistable transaction with info from a non-persistent line item)
-     *
-     * @param bool $update_txn_status
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function recalculate_total_including_taxes($update_txn_status = false)
-    {
-        return $this->calculator->recalculateTotalIncludingTaxes($this, $update_txn_status);
-    }
-
-
-    /**
-     * Recursively goes through all the children and recalculates sub-totals EXCEPT for
-     * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
-     * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
-     * when this is called on the grand total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function recalculate_pre_tax_total()
-    {
-        return $this->calculator->recalculatePreTaxTotal($this);
-    }
-
-
-    /**
-     * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
-     * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
-     * and tax sub-total if already in the DB
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function recalculate_taxes_and_tax_total()
-    {
-        return $this->calculator->recalculateTaxesAndTaxTotal($this);
-    }
-
-
-    /**
-     * Gets the total tax on this line item. Assumes taxes have already been calculated using
-     * recalculate_taxes_and_total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_total_tax()
-    {
-        return $this->calculator->getTotalTax($this);
-    }
-
-
-    /**
-     * Gets the total for all the items purchased only
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_items_total()
-    {
-        return $this->calculator->getItemsTotal($this);
-    }
-
-
-    /**
-     * Returns the amount taxable among this line item's children (or if it has no children,
-     * how much of it is taxable). Does not recalculate totals or subtotals.
-     * If the taxable total is negative, (eg, if none of the tickets were taxable,
-     * but there is a "Taxable" discount), returns 0.
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function taxable_total()
-    {
-        return $this->calculator->amountTaxable($this);
-    }
-
-
-    /**
-     * Gets all the descendants (ie, children or children of children etc) that
-     * are of the type 'tax'
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function tax_descendants()
-    {
-        return EEH_Line_Item::get_tax_descendants($this);
-    }
-
-
-    /**
-     * Gets all the real items purchased which are children of this item
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_items()
-    {
-        return EEH_Line_Item::get_line_item_descendants($this);
-    }
-
-
-    /**
-     * Gets the transaction for this line item
-     *
-     * @return EE_Base_Class|EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function transaction()
-    {
-        return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION);
-    }
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     * Because there currently is no proper parent-child relation on the model,
-     * save_this_and_cached() will NOT save the descendants.
-     * Also sets the transaction on this line item and all its descendants before saving
-     *
-     * @param int $txn_id if none is provided, assumes $this->TXN_ID()
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function save_this_and_descendants_to_txn($txn_id = null)
-    {
-        $count = 0;
-        if (! $txn_id) {
-            $txn_id = $this->TXN_ID();
-        }
-        $this->set_TXN_ID($txn_id);
-        $children = $this->children();
-        $count    += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function save_this_and_descendants()
-    {
-        $count    = 0;
-        $children = $this->children();
-        $count    += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants();
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * returns the cancellation line item if this item was cancelled
-     *
-     * @return EE_Line_Item[]
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function get_cancellations()
-    {
-        EE_Registry::instance()->load_helper('Line_Item');
-        return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
-    }
-
-
-    /**
-     * If this item has an ID, then this saves it again to update the db
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function maybe_save()
-    {
-        if ($this->ID()) {
-            return $this->save();
-        }
-        return false;
-    }
-
-
-    /**
-     * clears the cached children and parent from the line item
-     *
-     * @return void
-     */
-    public function clear_related_line_item_cache()
-    {
-        $this->_children = [];
-        $this->_parent   = null;
-    }
-
-
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function timestamp($raw = false)
-    {
-        return $raw
-            ? $this->get_raw('LIN_timestamp')
-            : $this->get('LIN_timestamp');
-    }
-
-
-
-
-    /************************* DEPRECATED *************************/
-    /**
-     * @param string $type one of the constants on EEM_Line_Item
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.6.0
-     */
-    protected function _get_descendants_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::_get_descendants_of_type()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_descendants_of_type()'
-            ),
-            '4.6.0'
-        );
-        return EEH_Line_Item::get_descendants_of_type($this, $type);
-    }
-
-
-    /**
-     * @param string $type like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.6.0
-     */
-    public function get_nearest_descendant_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::get_nearest_descendant_of_type()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_nearest_descendant_of_type()'
-            ),
-            '4.6.0'
-        );
-        return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
-    }
+	/**
+	 * @var CurrencyFormatter
+	 * @since $VID:$
+	 */
+	protected $currency_formatter;
+
+	/**
+	 * for children line items (currently not a normal relation)
+	 *
+	 * @type EE_Line_Item[]
+	 */
+	protected $_children = [];
+
+	/**
+	 * for the parent line item
+	 *
+	 * @var EE_Line_Item
+	 */
+	protected $_parent;
+
+	/**
+	 * number of decimal places to round numbers to when performing calculations
+	 *
+	 * @var integer $decimal_precision
+	 */
+	protected $decimal_precision = 6;
+
+	/**
+	 * @var LineItemCalculator
+	 */
+	private $calculator;
+
+	/**
+	 * @var bool
+	 */
+	private $is_percent;
+
+
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = null, $date_formats = [])
+	{
+		$has_object = parent::_check_for_object(
+			$props_n_values,
+			EE_Line_Item::class,
+			$timezone,
+			$date_formats
+		);
+		return $has_object
+			? $has_object
+			: new EE_Line_Item($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = null)
+	{
+		return new EE_Line_Item($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Adds some defaults if they're not specified
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function __construct($fieldValues = [], $bydb = false, $timezone = '', $date_formats = [])
+	{
+		if (! $this->calculator instanceof LineItemCalculator) {
+			$this->calculator = LoaderFactory::getLoader()->getShared(LineItemCalculator::class);
+		}
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+		if (! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
+		}
+		// in a better world this would have been injected upon construction
+		if (! $this->currency_formatter instanceof CurrencyFormatter) {
+			$this->currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
+		}
+	}
+
+
+	/**
+	 * @param int $decimal_precision
+	 */
+	public function setDecimalPrecision($decimal_precision = 6)
+	{
+		$this->decimal_precision = absint($decimal_precision);
+	}
+
+
+	/**
+	 * Gets ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ID()
+	{
+		return $this->get('LIN_ID');
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		$name = $this->get('LIN_name');
+		if (! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
+		}
+		return $name;
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('LIN_name', $name);
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function desc()
+	{
+		return $this->get('LIN_desc');
+	}
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('LIN_desc', $desc);
+	}
+
+
+	/**
+	 * Gets quantity
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function quantity()
+	{
+		return $this->get('LIN_quantity');
+	}
+
+
+	/**
+	 * Sets quantity
+	 *
+	 * @param int $quantity
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_quantity($quantity)
+	{
+		$this->set('LIN_quantity', max($quantity, 0));
+	}
+
+
+	/**
+	 * Gets item_id
+	 *
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_ID()
+	{
+		return $this->get('OBJ_ID');
+	}
+
+
+	/**
+	 * Sets item_id
+	 *
+	 * @param int|string $item_id
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_ID($item_id)
+	{
+		$this->set('OBJ_ID', $item_id);
+	}
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_type()
+	{
+		return $this->get('OBJ_type');
+	}
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_type_i18n()
+	{
+		$obj_type = $this->OBJ_type();
+		switch ($obj_type) {
+			case EEM_Line_Item::OBJ_TYPE_EVENT:
+				$obj_type = esc_html__('Event', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_PRICE:
+				$obj_type = esc_html__('Price', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_PROMOTION:
+				$obj_type = esc_html__('Promotion', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_TICKET:
+				$obj_type = esc_html__('Ticket', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_TRANSACTION:
+				$obj_type = esc_html__('Transaction', 'event_espresso');
+				break;
+		}
+		return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
+	}
+
+
+	/**
+	 * Sets item_type
+	 *
+	 * @param string $OBJ_type
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_type($OBJ_type)
+	{
+		$this->set('OBJ_type', $OBJ_type);
+	}
+
+
+	/**
+	 * Gets unit_price for flat rate items. Percent items should set this to 0.
+	 * You may alternatively want to use prettyUnitPrice(), which works for flat and percent items.
+	 *
+	 * @param string $schema
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function unit_price($schema = 'localized_float')
+	{
+		return $this->get('LIN_unit_price', $schema);
+	}
+
+
+	/**
+	 * @param string $schema
+	 * @return mixed|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public function prettyUnitPrice($schema = 'localized_currency')
+	{
+		if ($this->is_percent()) {
+			$quantity = $this->parent() instanceof EE_Line_Item
+						&& $this->parent()->type() === EEM_Line_Item::type_line_item
+				? $this->parent()->quantity()
+				: $this->quantity();
+			if ($quantity !== 0) {
+				$percent = $this->total() / $quantity;
+				$percent = $this->currency_formatter->roundForLocale($percent);
+				return apply_filters('FHEE__format_percentage_value', $percent);
+			}
+		}
+		return $this->get_pretty('LIN_unit_price', $schema);
+	}
+
+
+	/**
+	 * Sets unit_price
+	 *
+	 * @param float $unit_price
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_unit_price($unit_price)
+	{
+		$this->set('LIN_unit_price', $unit_price);
+	}
+
+
+	/**
+	 * Checks if this item is a percentage modifier or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_percent()
+	{
+		if ($this->is_percent !== null) {
+			return $this->is_percent;
+		}
+		if ($this->is_tax_sub_total()) {
+			// tax subtotals HAVE a percent on them, that percentage only applies
+			// to taxable items, so its' an exception. Treat it like a flat line item
+			$this->is_percent = false;
+			return $this->is_percent;
+		}
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent    = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
+			$this->is_percent = true;
+			return $this->is_percent;
+		}
+		if ($unit_price >= .001 && ! $percent) {
+			$this->is_percent = false;
+			return $this->is_percent;
+		}
+		if ($unit_price >= .001 && $percent) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'A Line Item can not have a unit price of (%s) AND a percent (%s)!',
+						'event_espresso'
+					),
+					$unit_price,
+					$percent
+				)
+			);
+		}
+		// if they're both 0, assume its not a percent item
+		$this->is_percent = false;
+		return $this->is_percent;
+	}
+
+
+	/**
+	 * Gets percent (between 100-.001)
+	 *
+	 * @param bool $as_decimal if true will divide value by 100
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function percent($as_decimal = false)
+	{
+		$percent = $this->get('LIN_percent');
+		$percent = $as_decimal ? $percent / 100 : $percent;
+		return $this->currency_formatter->precisionRound($percent);
+	}
+
+
+	/**
+	 * Gets percent (between 100-.001)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function prettyPercent()
+	{
+		return apply_filters('FHEE__format_percentage_value', $this->get_pretty('LIN_percent'));
+	}
+
+
+	/**
+	 * Sets percent (between 100-0.01)
+	 *
+	 * @param float $percent
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_percent($percent)
+	{
+		$this->set('LIN_percent', $percent);
+	}
+
+
+	/**
+	 * Gets total
+	 *
+	 * @param string $schema
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function total($schema = 'localized_float')
+	{
+		return $this->get('LIN_total', $schema);
+	}
+
+
+	/**
+	 * @param string $schema
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function prettyTotal($schema = 'localized_currency')
+	{
+		return $this->get_pretty('LIN_total', $schema);
+	}
+
+
+	/**
+	 * Sets total
+	 *
+	 * @param float $total
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_total($total)
+	{
+		$this->set('LIN_total', $total);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('LIN_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('LIN_order', $order);
+	}
+
+
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function parent_ID()
+	{
+		return $this->get('LIN_parent');
+	}
+
+
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_parent_ID($parent)
+	{
+		$this->set('LIN_parent', $parent);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function type()
+	{
+		return $this->get('LIN_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_type($type)
+	{
+		$this->set('LIN_type', $type);
+	}
+
+
+	/**
+	 * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
+	 * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
+	 * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
+	 * or indirectly by `EE_Line_item::add_child_line_item()`)
+	 *
+	 * @return EE_Base_Class|EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function parent()
+	{
+		return $this->ID()
+			? $this->get_model()->get_one_by_ID($this->parent_ID())
+			: $this->_parent;
+	}
+
+
+	/**
+	 * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
+	 *
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function children()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_all(
+				[
+					['LIN_parent' => $this->ID()],
+					'order_by' => ['LIN_order' => 'ASC'],
+				]
+			);
+		}
+		if (! is_array($this->_children)) {
+			$this->_children = [];
+		}
+		return $this->_children;
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function code()
+	{
+		return $this->get('LIN_code');
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_code($code)
+	{
+		$this->set('LIN_code', $code);
+	}
+
+
+	/**
+	 * Gets is_taxable
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_taxable()
+	{
+		return $this->get('LIN_is_taxable');
+	}
+
+
+	/**
+	 * Sets is_taxable
+	 *
+	 * @param boolean $is_taxable
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_is_taxable($is_taxable)
+	{
+		$this->set('LIN_is_taxable', $is_taxable);
+	}
+
+
+	/**
+	 * Gets the object that this model-joins-to.
+	 * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
+	 * EEM_Promotion_Object
+	 *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
+	 *
+	 * @return EE_Base_Class | NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_object()
+	{
+		$model_name_of_related_obj = $this->OBJ_type();
+		return $this->get_model()->has_relation($model_name_of_related_obj)
+			? $this->get_first_related($model_name_of_related_obj)
+			: null;
+	}
+
+
+	/**
+	 * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
+	 * (IE, if this line item is for a price or something else, will return NULL)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class|EE_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket($query_params = [])
+	{
+		// we're going to assume that when this method is called
+		// we always want to receive the attached ticket EVEN if that ticket is archived.
+		// This can be overridden via the incoming $query_params argument
+		$remove_defaults = ['default_where_conditions' => 'none'];
+		$query_params    = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params);
+	}
+
+
+	/**
+	 * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
+	 *
+	 * @return EE_Datetime | NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_datetime()
+	{
+		if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
+			$ticket = $this->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				$datetime = $ticket->first_datetime();
+				if ($datetime instanceof EE_Datetime) {
+					return $datetime;
+				}
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the event's name that's related to the ticket, if this is for
+	 * a ticket
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_event_name()
+	{
+		$event_name = esc_html__('Unknown', 'event_espresso');
+		$event      = $this->ticket_event();
+		if ($event instanceof EE_Event) {
+			$event_name = $event->name();
+		}
+		return $event_name;
+	}
+
+
+	/**
+	 * Gets the event that's related to the ticket, if this line item represents a ticket.
+	 *
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_event()
+	{
+		$event  = null;
+		$ticket = $this->ticket();
+		if ($ticket instanceof EE_Ticket) {
+			$datetime = $ticket->first_datetime();
+			if ($datetime instanceof EE_Datetime) {
+				$event = $datetime->event();
+			}
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the first datetime for this lien item, assuming it's for a ticket
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_datetime_start($date_format = '', $time_format = '')
+	{
+		$first_datetime_string = esc_html__('Unknown', 'event_espresso');
+		$datetime              = $this->get_ticket_datetime();
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
+		}
+		return $first_datetime_string;
+	}
+
+
+	/**
+	 * Adds the line item as a child to this line item. If there is another child line
+	 * item with the same LIN_code, it is overwritten by this new one
+	 *
+	 * @param EEI_Line_Item|EE_Line_Item $line_item
+	 * @param bool                       $set_order
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
+	{
+		// should we calculate the LIN_order for this line item ?
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
+		}
+		if ($this->ID()) {
+			// check for any duplicate line items (with the same code), if so, this replaces it
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if (($line_item_with_same_code instanceof EE_Line_Item) && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
+			}
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
+			}
+			return $line_item->save();
+		}
+		$this->_children[ $line_item->code() ] = $line_item;
+		if ($line_item->parent() !== $this) {
+			$line_item->set_parent($this);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
+	 * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
+	 * However, if this line item is NOT saved to the DB, this just caches the parent on
+	 * the EE_Line_Item::_parent property.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_parent($line_item)
+	{
+		if ($this->ID()) {
+			if (! $line_item->ID()) {
+				$line_item->save();
+			}
+			$this->set_parent_ID($line_item->ID());
+			$this->save();
+		} else {
+			$this->_parent = $line_item;
+			$this->set_parent_ID($line_item->ID());
+		}
+	}
+
+
+	/**
+	 * Gets the child line item as specified by its code. Because this returns an object (by reference)
+	 * you can modify this child line item and the parent (this object) can know about them
+	 * because it also has a reference to that line item
+	 *
+	 * @param string $code
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_child_line_item($code)
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_one(
+				[['LIN_parent' => $this->ID(), 'LIN_code' => $code]]
+			);
+		}
+		return isset($this->_children[ $code ])
+			? $this->_children[ $code ]
+			: null;
+	}
+
+
+	/**
+	 * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
+	 * cached on it)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_children_line_items()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->delete([['LIN_parent' => $this->ID()]]);
+		}
+		$count           = count($this->_children);
+		$this->_children = [];
+		return $count;
+	}
+
+
+	/**
+	 * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
+	 * HAS NOT been saved to the DB, removes the child line item with index $code.
+	 * Also searches through the child's children for a matching line item. However, once a line item has been found
+	 * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
+	 * deleted)
+	 *
+	 * @param string $code
+	 * @param bool   $stop_search_once_found
+	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
+	 *             the DB yet)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_child_line_item($code, $stop_search_once_found = true)
+	{
+		if ($this->ID()) {
+			$items_deleted = 0;
+			if ($this->code() === $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
+				$items_deleted += (int) $this->delete();
+				if ($stop_search_once_found) {
+					return $items_deleted;
+				}
+			}
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
+			}
+			return $items_deleted;
+		}
+		if (isset($this->_children[ $code ])) {
+			unset($this->_children[ $code ]);
+			return 1;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * If this line item is in the database, is of the type subtotal, and
+	 * has no children, why do we have it? It should be deleted so this function
+	 * does that
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_if_childless_subtotal()
+	{
+		if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
+			return $this->delete();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Creates a code and returns a string. doesn't assign the code to this model object
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function generate_code()
+	{
+		// each line item in the cart requires a unique identifier
+		// return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
+		return $this->get('OBJ_type') . '-' . $this->get('OBJ_ID') . '-' . microtime();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_tax()
+	{
+		return $this->type() === EEM_Line_Item::type_tax;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_tax_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_tax_sub_total;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_line_item;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_sub_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_line_item;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_total;
+	}
+
+
+	/**
+	 * Whether or not this line item is a cancellation line item
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancellation()
+	{
+		return EEM_Line_Item::type_cancellation === $this->type();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_total()
+	{
+		return $this->type() === EEM_Line_Item::type_total;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancelled()
+	{
+		return $this->type() === EEM_Line_Item::type_cancellation;
+	}
+
+
+	/**
+	 * @param string $schema
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function unit_price_no_code($schema = 'localized_float')
+	{
+		return $this->get_pretty('LIN_unit_price', $schema);
+	}
+
+
+	/**
+	 * @param string $schema
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function total_no_code($schema = 'localized_float')
+	{
+		return $this->get_pretty('LIN_total', $schema);
+	}
+
+
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total (provided this line item is allowed to persist, otherwise we don't
+	 * want to change a persistable transaction with info from a non-persistent line item)
+	 *
+	 * @param bool $update_txn_status
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function recalculate_total_including_taxes($update_txn_status = false)
+	{
+		return $this->calculator->recalculateTotalIncludingTaxes($this, $update_txn_status);
+	}
+
+
+	/**
+	 * Recursively goes through all the children and recalculates sub-totals EXCEPT for
+	 * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
+	 * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
+	 * when this is called on the grand total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function recalculate_pre_tax_total()
+	{
+		return $this->calculator->recalculatePreTaxTotal($this);
+	}
+
+
+	/**
+	 * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
+	 * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
+	 * and tax sub-total if already in the DB
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function recalculate_taxes_and_tax_total()
+	{
+		return $this->calculator->recalculateTaxesAndTaxTotal($this);
+	}
+
+
+	/**
+	 * Gets the total tax on this line item. Assumes taxes have already been calculated using
+	 * recalculate_taxes_and_total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_total_tax()
+	{
+		return $this->calculator->getTotalTax($this);
+	}
+
+
+	/**
+	 * Gets the total for all the items purchased only
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_items_total()
+	{
+		return $this->calculator->getItemsTotal($this);
+	}
+
+
+	/**
+	 * Returns the amount taxable among this line item's children (or if it has no children,
+	 * how much of it is taxable). Does not recalculate totals or subtotals.
+	 * If the taxable total is negative, (eg, if none of the tickets were taxable,
+	 * but there is a "Taxable" discount), returns 0.
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function taxable_total()
+	{
+		return $this->calculator->amountTaxable($this);
+	}
+
+
+	/**
+	 * Gets all the descendants (ie, children or children of children etc) that
+	 * are of the type 'tax'
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function tax_descendants()
+	{
+		return EEH_Line_Item::get_tax_descendants($this);
+	}
+
+
+	/**
+	 * Gets all the real items purchased which are children of this item
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_items()
+	{
+		return EEH_Line_Item::get_line_item_descendants($this);
+	}
+
+
+	/**
+	 * Gets the transaction for this line item
+	 *
+	 * @return EE_Base_Class|EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION);
+	}
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 * Because there currently is no proper parent-child relation on the model,
+	 * save_this_and_cached() will NOT save the descendants.
+	 * Also sets the transaction on this line item and all its descendants before saving
+	 *
+	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function save_this_and_descendants_to_txn($txn_id = null)
+	{
+		$count = 0;
+		if (! $txn_id) {
+			$txn_id = $this->TXN_ID();
+		}
+		$this->set_TXN_ID($txn_id);
+		$children = $this->children();
+		$count    += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function save_this_and_descendants()
+	{
+		$count    = 0;
+		$children = $this->children();
+		$count    += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants();
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * returns the cancellation line item if this item was cancelled
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function get_cancellations()
+	{
+		EE_Registry::instance()->load_helper('Line_Item');
+		return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
+	}
+
+
+	/**
+	 * If this item has an ID, then this saves it again to update the db
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function maybe_save()
+	{
+		if ($this->ID()) {
+			return $this->save();
+		}
+		return false;
+	}
+
+
+	/**
+	 * clears the cached children and parent from the line item
+	 *
+	 * @return void
+	 */
+	public function clear_related_line_item_cache()
+	{
+		$this->_children = [];
+		$this->_parent   = null;
+	}
+
+
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function timestamp($raw = false)
+	{
+		return $raw
+			? $this->get_raw('LIN_timestamp')
+			: $this->get('LIN_timestamp');
+	}
+
+
+
+
+	/************************* DEPRECATED *************************/
+	/**
+	 * @param string $type one of the constants on EEM_Line_Item
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.6.0
+	 */
+	protected function _get_descendants_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::_get_descendants_of_type()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_descendants_of_type()'
+			),
+			'4.6.0'
+		);
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
+	}
+
+
+	/**
+	 * @param string $type like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.6.0
+	 */
+	public function get_nearest_descendant_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::get_nearest_descendant_of_type()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_nearest_descendant_of_type()'
+			),
+			'4.6.0'
+		);
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
+	}
 }

core/db_classes/EE_Payment_Method.class.php

Spacing +8 added lines, -8 removed lines

@@ -445,11 +445,11 @@ 
      */
     public function type_obj()
     {
-        if (! $this->_type_obj) {
+        if ( ! $this->_type_obj) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
                 $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
+                if ( ! class_exists($class_name)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -458,7 +458,7 @@ 
                             ),
                             $class_name,
                             '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
+                            '<a href="'.admin_url('plugins.php').'">',
                             '</a>'
                         )
                     );
@@ -499,7 +499,7 @@ 
         foreach ($fields as $key => $value) {
             if (strpos($key, 'PMD_') === 0) {
                 $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
+                $combined_settings_array [$key_sans_model_prefix] = $value;
             }
         }
         $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
@@ -522,14 +522,14 @@ 
 		 <div id="'
                . $this->slug()
                . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+               . $payment_occurs.'-payment-gateway reg-page-payment-option-dv'.$css_class.'">
 			<a id="payment-gateway-button-' . $this->slug()
                . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
-				<img src="' . $this->button_url() . '" alt="' . sprintf(
+               . $this->slug().'" href="'.$url.'" >
+				<img src="' . $this->button_url().'" alt="'.sprintf(
                    esc_attr__('Pay using %s', 'event_espresso'),
                    $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+               ).'" />
 			</a>
 		</div>
 ';

Indentation +634 added lines, -634 removed lines

@@ -13,644 +13,644 @@
  */
 class EE_Payment_Method extends EE_Base_Class
 {
-    /**
-     * Payment Method type object, which has all the info about this type of payment method,
-     * including functions for processing payments, to get settings forms, etc.
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_type_obj;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values, false);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-
-    /**
-     * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
-     * Otherwise returns a normal EE_Payment_Method
-     *
-     * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
-     *                              the classname minus 'EEPM_')
-     * @return string
-     */
-    // private static function _payment_method_type($props_n_values)
-    // {
-    //     EE_Registry::instance()->load_lib('Payment_Method_Manager');
-    //     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
-    //     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
-    //         return 'EEPM_' . $type_string;
-    //     } else {
-    //         return __CLASS__;
-    //     }
-    // }
-
-
-    /**
-     * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
-     *
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    public function active()
-    {
-        return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
-    }
-
-
-    /**
-     * Sets this PM as active by making it usable within the CART scope. Offline gateways
-     * are also usable from the admin-scope as well. DOES NOT SAVE it
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_active()
-    {
-        $default_scopes = array(EEM_Payment_Method::scope_cart);
-        if (
-            $this->type_obj() &&
-            $this->type_obj()->payment_occurs() === EE_PMT_Base::offline
-        ) {
-            $default_scopes[] = EEM_Payment_Method::scope_admin;
-        }
-        $this->set_scope($default_scopes);
-    }
-
-
-    /**
-     * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
-     *
-     * @throws EE_Error|ReflectionException
-     */
-    public function deactivate()
-    {
-        $this->set_scope(array());
-    }
-
-
-    /**
-     * Gets button_url
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function button_url()
-    {
-        return $this->get('PMD_button_url');
-    }
-
-
-    /**
-     * Sets button_url
-     *
-     * @param string $button_url
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_button_url($button_url)
-    {
-        $this->set('PMD_button_url', $button_url);
-    }
-
-
-    /**
-     * Gets debug_mode
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function debug_mode()
-    {
-        return $this->get('PMD_debug_mode');
-    }
-
-
-    /**
-     * Sets debug_mode
-     *
-     * @param boolean $debug_mode
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_debug_mode($debug_mode)
-    {
-        $this->set('PMD_debug_mode', $debug_mode);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function description()
-    {
-        return $this->get('PMD_desc');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_description($description)
-    {
-        $this->set('PMD_desc', $description);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        return $this->get('PMD_name');
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('PMD_name', $name);
-    }
-
-
-    /**
-     * Gets open_by_default
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function open_by_default()
-    {
-        return $this->get('PMD_open_by_default');
-    }
-
-
-    /**
-     * Sets open_by_default
-     *
-     * @param boolean $open_by_default
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_open_by_default($open_by_default)
-    {
-        $this->set('PMD_open_by_default', $open_by_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('PMD_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('PMD_order', $order);
-    }
-
-
-    /**
-     * Gets slug
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug()
-    {
-        return $this->get('PMD_slug');
-    }
-
-
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_slug($slug)
-    {
-        $this->set('PMD_slug', $slug);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type()
-    {
-        return $this->get('PMD_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_type($type)
-    {
-        $this->set('PMD_type', $type);
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user()
-    {
-        return $this->get('PMD_wp_user');
-    }
-
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('PMD_wp_user', $wp_user_id);
-    }
-
-
-    /**
-     * Overrides parent so when PMD_type is changed we refresh the _type_obj
-     *
-     * @param string  $field_name
-     * @param mixed   $field_value
-     * @param boolean $use_default
-     * @param string  $schema
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set($field_name, $field_value, $use_default = false, $schema = '')
-    {
-        if ($field_name === 'PMD_type') {
-            // the type has probably changed, so forget about its old type object
-            $this->_type_obj = null;
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * Gets admin_name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function admin_name()
-    {
-        return $this->get('PMD_admin_name');
-    }
-
-
-    /**
-     * Sets admin_name
-     *
-     * @param string $admin_name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_admin_name($admin_name)
-    {
-        $this->set('PMD_admin_name', $admin_name);
-    }
-
-
-    /**
-     * Gets admin_desc
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function admin_desc()
-    {
-        return $this->get('PMD_admin_desc');
-    }
-
-
-    /**
-     * Sets admin_desc
-     *
-     * @param string $admin_desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_admin_desc($admin_desc)
-    {
-        $this->set('PMD_admin_desc', $admin_desc);
-    }
-
-
-    /**
-     * Gets scope
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function scope()
-    {
-        return $this->get('PMD_scope');
-    }
-
-
-    /**
-     * Sets scope
-     *
-     * @param array $scope
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_scope($scope)
-    {
-        $this->set('PMD_scope', $scope);
-    }
-
-
-    /**
-     * Gets the payment method type for this payment method instance
-     *
-     * @return EE_PMT_Base
-     * @throws EE_Error|ReflectionException
-     */
-    public function type_obj()
-    {
-        if (! $this->_type_obj) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
-                $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
-                                'event_espresso'
-                            ),
-                            $class_name,
-                            '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
-                            '</a>'
-                        )
-                    );
-                }
-                $r = new ReflectionClass($class_name);
-                $this->_type_obj = $r->newInstanceArgs(array($this));
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->type(),
-                        implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
-                    )
-                );
-            }
-        }
-        return $this->_type_obj;
-    }
-
-
-    /**
-     * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
-     * and the extra meta. Mostly used for passing off ot gateways.     *
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function settings_array()
-    {
-        $fields = $this->model_field_array();
-        $extra_meta = $this->all_extra_meta_array();
-        // remove the model's prefix from the fields
-        $combined_settings_array = array();
-        foreach ($fields as $key => $value) {
-            if (strpos($key, 'PMD_') === 0) {
-                $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
-            }
-        }
-        $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
-        return $combined_settings_array;
-    }
-
-
-    /**
-     * Gets the HTML for displaying the payment method on a page.
-     *
-     * @param string $url
-     * @param string $css_class
-     * @return string of HTML for displaying the button
-     * @throws EE_Error|ReflectionException
-     */
-    public function button_html($url = '', $css_class = '')
-    {
-        $payment_occurs = $this->type_obj()->payment_occurs();
-        return '
+	/**
+	 * Payment Method type object, which has all the info about this type of payment method,
+	 * including functions for processing payments, to get settings forms, etc.
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_type_obj;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values, false);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+
+	/**
+	 * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
+	 * Otherwise returns a normal EE_Payment_Method
+	 *
+	 * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
+	 *                              the classname minus 'EEPM_')
+	 * @return string
+	 */
+	// private static function _payment_method_type($props_n_values)
+	// {
+	//     EE_Registry::instance()->load_lib('Payment_Method_Manager');
+	//     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
+	//     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
+	//         return 'EEPM_' . $type_string;
+	//     } else {
+	//         return __CLASS__;
+	//     }
+	// }
+
+
+	/**
+	 * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
+	 *
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function active()
+	{
+		return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
+	}
+
+
+	/**
+	 * Sets this PM as active by making it usable within the CART scope. Offline gateways
+	 * are also usable from the admin-scope as well. DOES NOT SAVE it
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_active()
+	{
+		$default_scopes = array(EEM_Payment_Method::scope_cart);
+		if (
+			$this->type_obj() &&
+			$this->type_obj()->payment_occurs() === EE_PMT_Base::offline
+		) {
+			$default_scopes[] = EEM_Payment_Method::scope_admin;
+		}
+		$this->set_scope($default_scopes);
+	}
+
+
+	/**
+	 * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
+	 *
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function deactivate()
+	{
+		$this->set_scope(array());
+	}
+
+
+	/**
+	 * Gets button_url
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function button_url()
+	{
+		return $this->get('PMD_button_url');
+	}
+
+
+	/**
+	 * Sets button_url
+	 *
+	 * @param string $button_url
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_button_url($button_url)
+	{
+		$this->set('PMD_button_url', $button_url);
+	}
+
+
+	/**
+	 * Gets debug_mode
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function debug_mode()
+	{
+		return $this->get('PMD_debug_mode');
+	}
+
+
+	/**
+	 * Sets debug_mode
+	 *
+	 * @param boolean $debug_mode
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_debug_mode($debug_mode)
+	{
+		$this->set('PMD_debug_mode', $debug_mode);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function description()
+	{
+		return $this->get('PMD_desc');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_description($description)
+	{
+		$this->set('PMD_desc', $description);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		return $this->get('PMD_name');
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('PMD_name', $name);
+	}
+
+
+	/**
+	 * Gets open_by_default
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function open_by_default()
+	{
+		return $this->get('PMD_open_by_default');
+	}
+
+
+	/**
+	 * Sets open_by_default
+	 *
+	 * @param boolean $open_by_default
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_open_by_default($open_by_default)
+	{
+		$this->set('PMD_open_by_default', $open_by_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('PMD_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('PMD_order', $order);
+	}
+
+
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug()
+	{
+		return $this->get('PMD_slug');
+	}
+
+
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('PMD_slug', $slug);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type()
+	{
+		return $this->get('PMD_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_type($type)
+	{
+		$this->set('PMD_type', $type);
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user()
+	{
+		return $this->get('PMD_wp_user');
+	}
+
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('PMD_wp_user', $wp_user_id);
+	}
+
+
+	/**
+	 * Overrides parent so when PMD_type is changed we refresh the _type_obj
+	 *
+	 * @param string  $field_name
+	 * @param mixed   $field_value
+	 * @param boolean $use_default
+	 * @param string  $schema
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set($field_name, $field_value, $use_default = false, $schema = '')
+	{
+		if ($field_name === 'PMD_type') {
+			// the type has probably changed, so forget about its old type object
+			$this->_type_obj = null;
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * Gets admin_name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function admin_name()
+	{
+		return $this->get('PMD_admin_name');
+	}
+
+
+	/**
+	 * Sets admin_name
+	 *
+	 * @param string $admin_name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_admin_name($admin_name)
+	{
+		$this->set('PMD_admin_name', $admin_name);
+	}
+
+
+	/**
+	 * Gets admin_desc
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function admin_desc()
+	{
+		return $this->get('PMD_admin_desc');
+	}
+
+
+	/**
+	 * Sets admin_desc
+	 *
+	 * @param string $admin_desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_admin_desc($admin_desc)
+	{
+		$this->set('PMD_admin_desc', $admin_desc);
+	}
+
+
+	/**
+	 * Gets scope
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function scope()
+	{
+		return $this->get('PMD_scope');
+	}
+
+
+	/**
+	 * Sets scope
+	 *
+	 * @param array $scope
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_scope($scope)
+	{
+		$this->set('PMD_scope', $scope);
+	}
+
+
+	/**
+	 * Gets the payment method type for this payment method instance
+	 *
+	 * @return EE_PMT_Base
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function type_obj()
+	{
+		if (! $this->_type_obj) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
+				$class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
+				if (! class_exists($class_name)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
+								'event_espresso'
+							),
+							$class_name,
+							'<br />',
+							'<a href="' . admin_url('plugins.php') . '">',
+							'</a>'
+						)
+					);
+				}
+				$r = new ReflectionClass($class_name);
+				$this->_type_obj = $r->newInstanceArgs(array($this));
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
+							'event_espresso'
+						),
+						$this->type(),
+						implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
+					)
+				);
+			}
+		}
+		return $this->_type_obj;
+	}
+
+
+	/**
+	 * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
+	 * and the extra meta. Mostly used for passing off ot gateways.     *
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function settings_array()
+	{
+		$fields = $this->model_field_array();
+		$extra_meta = $this->all_extra_meta_array();
+		// remove the model's prefix from the fields
+		$combined_settings_array = array();
+		foreach ($fields as $key => $value) {
+			if (strpos($key, 'PMD_') === 0) {
+				$key_sans_model_prefix = str_replace('PMD_', '', $key);
+				$combined_settings_array [ $key_sans_model_prefix ] = $value;
+			}
+		}
+		$combined_settings_array = array_merge($extra_meta, $combined_settings_array);
+		return $combined_settings_array;
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the payment method on a page.
+	 *
+	 * @param string $url
+	 * @param string $css_class
+	 * @return string of HTML for displaying the button
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function button_html($url = '', $css_class = '')
+	{
+		$payment_occurs = $this->type_obj()->payment_occurs();
+		return '
 		 <div id="'
-               . $this->slug()
-               . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+			   . $this->slug()
+			   . '-payment-option-dv" class="'
+			   . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
 			<a id="payment-gateway-button-' . $this->slug()
-               . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
+			   . '" class="reg-page-payment-option-lnk" rel="'
+			   . $this->slug() . '" href="' . $url . '" >
 				<img src="' . $this->button_url() . '" alt="' . sprintf(
-                   esc_attr__('Pay using %s', 'event_espresso'),
-                   $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+				   esc_attr__('Pay using %s', 'event_espresso'),
+				   $this->get_pretty('PMD_name', 'form_input')
+			   ) . '" />
 			</a>
 		</div>
 ';
-    }
-
-
-    /**
-     * Gets all the currencies which are an option for this payment method
-     * (as defined by the gateway and the currently active currencies)
-     *
-     * @return EE_Currency[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_usable_currencies()
-    {
-        return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
-    }
-
-
-    /**
-     * Reports whether or not this payment method can be used for this payment method
-     *
-     * @param string $currency_code currency ID (code)
-     * @return boolean
-     * @throws EE_Error|ReflectionException
-     */
-    public function usable_for_currency($currency_code)
-    {
-        foreach ($this->get_all_usable_currencies() as $currency_obj) {
-            if ($currency_obj->ID() === $currency_code) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_on_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_off_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method does not utilize a gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_off_line()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
-    }
-
-    /**
-     * Overrides default __sleep so the object type is NOT cached.
-     * This way we can rely on the normal EE_Payment_Method::type_obj() logic
-     * to load the required classes, and don't need them at the time of unserialization
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_type_obj']);
-        return array_keys($properties);
-    }
-
-
-    /**
-     * Overrides parent to add some logging for when payment methods get deactivated
-     *
-     * @param array $set_cols_n_values
-     * @return int @see EE_Base_Class::save()
-     * @throws EE_Error|ReflectionException
-     */
-    public function save($set_cols_n_values = array())
-    {
-        $results = parent::save($set_cols_n_values);
-        if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
-            /** @var CurrentPage $current_page */
-            $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-            EE_Log::instance()->log(
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
-                    $this->name(),
-                    serialize($this->get_original('PMD_scope')),
-                    serialize($this->get('PMD_scope')),
-                    $current_page->getPermalink()
-                ),
-                'payment_method_change'
-            );
-        }
-        return $results;
-    }
+	}
+
+
+	/**
+	 * Gets all the currencies which are an option for this payment method
+	 * (as defined by the gateway and the currently active currencies)
+	 *
+	 * @return EE_Currency[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_usable_currencies()
+	{
+		return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
+	}
+
+
+	/**
+	 * Reports whether or not this payment method can be used for this payment method
+	 *
+	 * @param string $currency_code currency ID (code)
+	 * @return boolean
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function usable_for_currency($currency_code)
+	{
+		foreach ($this->get_all_usable_currencies() as $currency_obj) {
+			if ($currency_obj->ID() === $currency_code) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_on_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_off_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method does not utilize a gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_off_line()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
+	}
+
+	/**
+	 * Overrides default __sleep so the object type is NOT cached.
+	 * This way we can rely on the normal EE_Payment_Method::type_obj() logic
+	 * to load the required classes, and don't need them at the time of unserialization
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_type_obj']);
+		return array_keys($properties);
+	}
+
+
+	/**
+	 * Overrides parent to add some logging for when payment methods get deactivated
+	 *
+	 * @param array $set_cols_n_values
+	 * @return int @see EE_Base_Class::save()
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		$results = parent::save($set_cols_n_values);
+		if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
+			/** @var CurrentPage $current_page */
+			$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+			EE_Log::instance()->log(
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
+					$this->name(),
+					serialize($this->get_original('PMD_scope')),
+					serialize($this->get('PMD_scope')),
+					$current_page->getPermalink()
+				),
+				'payment_method_change'
+			);
+		}
+		return $results;
+	}
 }

core/db_models/fields/EE_Float_Field.php

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {
         parent::__construct($table_column, $nicename, $nullable, $default_value);
-        if (! $this->number_formatter instanceof NumberFormatter) {
+        if ( ! $this->number_formatter instanceof NumberFormatter) {
             $this->number_formatter = LoaderFactory::getLoader()->getShared(NumberFormatter::class);
         }
         $this->setSchemaType('number');

Indentation +64 added lines, -64 removed lines

@@ -9,79 +9,79 @@
  */
 class EE_Float_Field extends EE_Model_Field_Base
 {
-    /**
-     * @var EE_Currency_Config
-     * @deprecatd $VID:$
-     */
-    public $currency;
+	/**
+	 * @var EE_Currency_Config
+	 * @deprecatd $VID:$
+	 */
+	public $currency;
 
-    /**
-     * @var NumberFormatter
-     * @since $VID:$
-     */
-    protected $number_formatter;
+	/**
+	 * @var NumberFormatter
+	 * @since $VID:$
+	 */
+	protected $number_formatter;
 
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        if (! $this->number_formatter instanceof NumberFormatter) {
-            $this->number_formatter = LoaderFactory::getLoader()->getShared(NumberFormatter::class);
-        }
-        $this->setSchemaType('number');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		if (! $this->number_formatter instanceof NumberFormatter) {
+			$this->number_formatter = LoaderFactory::getLoader()->getShared(NumberFormatter::class);
+		}
+		$this->setSchemaType('number');
+	}
 
 
-    /**
-     * @param float|int|string $amount
-     * @return float
-     * @since $VID:$
-     */
-    public function prepare_for_get($amount)
-    {
-        return $this->number_formatter->filterNumericValue($amount);
-    }
+	/**
+	 * @param float|int|string $amount
+	 * @return float
+	 * @since $VID:$
+	 */
+	public function prepare_for_get($amount)
+	{
+		return $this->number_formatter->filterNumericValue($amount);
+	}
 
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $value
-     * @param string|null  $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value, ?string $schema = null)
-    {
-        return $this->number_formatter->formatForLocale($value);
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $value
+	 * @param string|null  $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value, ?string $schema = null)
+	{
+		return $this->number_formatter->formatForLocale($value);
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators or decimal marks, as per the currency's config.
-     *
-     * @param float|int|string $value
-     * @return float
-     */
-    public function prepare_for_set($value)
-    {
-        $value = $this->number_formatter->parseForLocale($value);
-        return $this->prepare_for_set_from_db($value);
-    }
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators or decimal marks, as per the currency's config.
+	 *
+	 * @param float|int|string $value
+	 * @return float
+	 */
+	public function prepare_for_set($value)
+	{
+		$value = $this->number_formatter->parseForLocale($value);
+		return $this->prepare_for_set_from_db($value);
+	}
 
 
-    /**
-     * @param float $value
-     * @return float
-     */
-    public function prepare_for_set_from_db($value)
-    {
-        return $this->number_formatter->precisionRound($value);
-    }
+	/**
+	 * @param float $value
+	 * @return float
+	 */
+	public function prepare_for_set_from_db($value)
+	{
+		return $this->number_formatter->precisionRound($value);
+	}
 }