eventespresso / event-espresso-core

caffeinated/EE_Caf_Messages.class.php

Indentation +799 added lines, -799 removed lines

@@ -13,803 +13,803 @@
 {
 
 
-    /**
-     * constructor.
-     */
-    public function __construct()
-    {
-        $this->_caf_hooks();
-    }
-
-
-    /**
-     * Contains all the hooks filters for setting up caffeinated messages functionality.
-     *
-     * @since 4.3.2
-     *
-     * @return void
-     */
-    private function _caf_hooks()
-    {
-        add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
-        add_filter(
-            'FHEE__EE_Email_messenger__get_validator_config',
-            array($this, 'email_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Email_messenger__get_template_fields',
-            array($this, 'email_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_template_fields',
-            array($this, 'html_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_validator_config',
-            array($this, 'html_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
-        add_filter(
-            'FHEE__EE_Pdf_messenger__get_validator_config',
-            array($this, 'pdf_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
-            array($this, 'new_default_templates'),
-            5,
-            7
-        );
-        add_filter(
-            'FHEE__EE_Messages_Base__get_valid_shortcodes',
-            array($this, 'message_types_valid_shortcodes'),
-            5,
-            2
-        );
-
-        // shortcode parsers
-        add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
-            array($this, 'additional_recipient_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__parser_after',
-            array($this, 'additional_recipient_details_parser'),
-            5,
-            5
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
-            array($this, 'additional_primary_registration_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
-            array($this, 'additional_primary_registration_details_parser'),
-            5,
-            5
-        );
-
-        /**
-         * @since 4.2.0
-         */
-        add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
-        add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
-
-        /**
-         * @since 4.3.0
-         */
-        // eat our own dog food!
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
-        do_action('EE_Brewing_Regular___messages_caf');
-    }
-
-
-    /**
-     * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
-     * messages system.
-     *
-     * @param  array $dir_ref original array of paths
-     *
-     * @return array           appended paths
-     */
-    public function messages_autoload_paths($dir_ref)
-    {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
-
-        return $dir_ref;
-    }
-
-
-    public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function new_default_templates(
-        $contents,
-        $actual_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-
-        // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $contents;
-        }
-
-        // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
-
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
-
-        if ($messenger->name == 'email' && $message_type->name == 'registration') {
-            switch ($template_file_prefix) {
-                case 'question_list_admin':
-                case 'question_list_attendee':
-                case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
-                    $contents = EEH_Template::display_template(
-                        $path,
-                        array(),
-                        true
-                    );
-                    break;
-
-                case 'attendee_list_attendee':
-                    $contents = '';
-                    break;
-
-                case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
-            switch ($template_file_prefix) {
-                case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
-            switch ($template_file_prefix) {
-                case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        }
-
-        return $contents;
-    }
-
-
-    public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
-    {
-        // make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
-        $include_with = array(
-            'registration',
-            'cancelled_registration',
-            'declined_registration',
-            'not_approved_registration',
-            'payment_declined',
-            'payment_failed',
-            'payment_cancelled',
-            'payment',
-            'payment_reminder',
-            'pending_approval',
-            'registration_summary',
-            'invoice',
-            'receipt',
-        );
-        if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
-            $contexts = array_keys($msg->get_contexts());
-            foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
-            }
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[ANSWER_*]'] = __(
-            'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (strpos($shortcode, '[ANSWER_*') === false
-            || ! isset($extra_data['data']->questions)
-            || ! isset($extra_data['data']->registrations)
-        ) {
-            return $parsed;
-        }
-
-        // let's get the question from the code.
-        $shortcode = str_replace('[ANSWER_*', '', $shortcode);
-        $shortcode = trim(str_replace(']', '', $shortcode));
-
-        $registration = $data instanceof EE_Registration ? $data : null;
-        $registration = ! $registration instanceof EE_Registration && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
-
-        $aee = $data instanceof EE_Messages_Addressee ? $data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
-
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        // now let's figure out which question has this text.
-        foreach ($aee->questions as $ansid => $question) {
-            if ($question instanceof EE_Question
-                && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
-            ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
-                    'ANS_value',
-                    'no_wpautop'
-                );
-            }
-        }
-
-        // nothing!
-        return $parsed;
-    }
-
-
-    /**
-     * Callback for additional shortcodes filter for adding additional datetime shortcodes.
-     *
-     * @since  4.2
-     *
-     * @param  array                  $shortcodes         array of shortcodes and
-     *                                                    descriptions
-     * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
-     *
-     * @return array                                        array of shortcodes and
-     *                                                        descriptions
-     */
-    public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[DTT_NAME]'] = __(
-            'This will be parsed to the Title given for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_DESCRIPTION]'] = __(
-            'This will be parsed to the description for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_NAME_OR_DATES]'] = __(
-            'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for additional shortcodes parser filter used for adding parser for new
-     * Datetime shortcodes
-     *
-     * @since  4.2
-     *
-     * @param  string                 $parsed     The finished parsed string for the given shortcode.
-     * @param  string                 $shortcode  The shortcode being parsed.
-     * @param  object                 $data       The incoming data object for the Shortcode Parser.
-     * @param  object                 $extra_data The incoming extra date object for the Shortcode
-     *                                            Parser.
-     * @param  EE_Datetime_Shortcodes $shortcode_parser
-     *
-     * @return string                   The new parsed string.
-     */
-    public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (! $data instanceof EE_Datetime) {
-            return ''; // get out because we can only parse with the datetime object.
-        }
-
-        switch ($shortcode) {
-            case '[DTT_NAME]':
-                return $data->name();
-                break;
-            case '[DTT_DESCRIPTION]':
-                return $data->description();
-                break;
-            case '[DTT_NAME_OR_DATES]':
-                return $data->get_dtt_display_name(true);
-                break;
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
-            'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[RECIPIENT_QUESTION_LIST]':
-                $att = $recipient->att_obj;
-                $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
-                    : array();
-                $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
-                $answers = array();
-
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-
-                // if the context is main_content then get all answers for all registrations on this attendee
-                if ($data['data'] instanceof EE_Messages_Addressee) {
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                // if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
-                if ($data['data'] instanceof EE_Event) {
-                    $event = $data['data'];
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                $questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
-
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
-            'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_primary_registration_details_parser(
-        $parsed,
-        $shortcode,
-        $data,
-        $extra_data,
-        $shortcode_parser
-    ) {
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
-                    : array();
-                if (empty($answers)) {
-                    return '';
-                }
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
-                $questions = isset($recipient->questions) ? $recipient->questions : array();
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    /**
-     * Takes care of registering the  message types that are only available in caffeinated EE.
-     *
-     * @since   4.3.2
-     *
-     * @return  void
-     */
-    public function register_caf_message_types()
-    {
-        // register newsletter message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
-            'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
-            ),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('newsletter', $setup_args);
-
-        // register payment reminder message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_reminder', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_declined', $setup_args);
-
-        // register registration declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('declined_registration', $setup_args);
-
-        // register registration cancelled message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('cancelled_registration', $setup_args);
-
-
-        // register payment failed message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_failed', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_cancelled', $setup_args);
-    }
-
-
-    /**
-     * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
-     *
-     * @since   4.3.2
-     *
-     * @return void
-     */
-    public function register_caf_shortcodes()
-    {
-        $setup_args = array(
-            'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
-            ),
-            'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
-            'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
-            'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
-        );
-        EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
-    }
-
-
-    /**
-     * Parses a question list shortcode using given data and template
-     *
-     * @param \EE_Shortcodes $shortcode_parser
-     * @param EE_Question[]  $questions        An array of questions indexed by answer id.
-     * @param EE_Answer[]    $answers          An array of answer objects
-     * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
-     * @param array          $extra_data       Extra data that might be used when parsing the template.
-     */
-    protected function _parse_question_list_for_primary_or_recipient_registration(
-        $shortcode_parser,
-        $questions,
-        $answers,
-        $template,
-        $valid_shortcodes,
-        $extra_data
-    ) {
-        $question_list = '';
-        /** @var EEH_Parse_Shortcodes $shortcode_helper */
-        $shortcode_helper = $shortcode_parser->get_shortcode_helper();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
-                $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
-                    || (
-                        $question instanceof EE_Question
-                        && $question->admin_only()
-                    )
-                ) {
-                    continue;
-                }
-                $question_list .= $shortcode_helper->parse_question_list_template(
-                    $template,
-                    $answer,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-            }
-        }
-        return $question_list;
-    }
+	/**
+	 * constructor.
+	 */
+	public function __construct()
+	{
+		$this->_caf_hooks();
+	}
+
+
+	/**
+	 * Contains all the hooks filters for setting up caffeinated messages functionality.
+	 *
+	 * @since 4.3.2
+	 *
+	 * @return void
+	 */
+	private function _caf_hooks()
+	{
+		add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_validator_config',
+			array($this, 'email_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_template_fields',
+			array($this, 'email_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_template_fields',
+			array($this, 'html_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_validator_config',
+			array($this, 'html_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
+		add_filter(
+			'FHEE__EE_Pdf_messenger__get_validator_config',
+			array($this, 'pdf_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
+			array($this, 'new_default_templates'),
+			5,
+			7
+		);
+		add_filter(
+			'FHEE__EE_Messages_Base__get_valid_shortcodes',
+			array($this, 'message_types_valid_shortcodes'),
+			5,
+			2
+		);
+
+		// shortcode parsers
+		add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
+			array($this, 'additional_recipient_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__parser_after',
+			array($this, 'additional_recipient_details_parser'),
+			5,
+			5
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
+			array($this, 'additional_primary_registration_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
+			array($this, 'additional_primary_registration_details_parser'),
+			5,
+			5
+		);
+
+		/**
+		 * @since 4.2.0
+		 */
+		add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
+		add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
+
+		/**
+		 * @since 4.3.0
+		 */
+		// eat our own dog food!
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
+		do_action('EE_Brewing_Regular___messages_caf');
+	}
+
+
+	/**
+	 * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
+	 * messages system.
+	 *
+	 * @param  array $dir_ref original array of paths
+	 *
+	 * @return array           appended paths
+	 */
+	public function messages_autoload_paths($dir_ref)
+	{
+		$dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+
+		return $dir_ref;
+	}
+
+
+	public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function new_default_templates(
+		$contents,
+		$actual_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+
+		// we're only modifying templates for the default template pack
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $contents;
+		}
+
+		// the template file name we're replacing contents for.
+		$template_file_prefix = $field . '_' . $context;
+		$msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+
+		$base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+
+		if ($messenger->name == 'email' && $message_type->name == 'registration') {
+			switch ($template_file_prefix) {
+				case 'question_list_admin':
+				case 'question_list_attendee':
+				case 'question_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'question_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_admin':
+					$path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+					$contents = EEH_Template::display_template(
+						$path,
+						array(),
+						true
+					);
+					break;
+
+				case 'attendee_list_attendee':
+					$contents = '';
+					break;
+
+				case 'event_list_attendee':
+					$path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
+			switch ($template_file_prefix) {
+				case 'content_attendee':
+					$path = $base_path . $msg_prefix . 'content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_content_attendee':
+					$path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_subject_attendee':
+					$path = $base_path . $msg_prefix . 'subject.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
+			switch ($template_file_prefix) {
+				case 'attendee_list_purchaser':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		}
+
+		return $contents;
+	}
+
+
+	public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
+	{
+		// make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
+		$include_with = array(
+			'registration',
+			'cancelled_registration',
+			'declined_registration',
+			'not_approved_registration',
+			'payment_declined',
+			'payment_failed',
+			'payment_cancelled',
+			'payment',
+			'payment_reminder',
+			'pending_approval',
+			'registration_summary',
+			'invoice',
+			'receipt',
+		);
+		if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
+			$contexts = array_keys($msg->get_contexts());
+			foreach ($contexts as $context) {
+				$valid_shortcodes[ $context ][] = 'question_list';
+				$valid_shortcodes[ $context ][] = 'question';
+			}
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[ANSWER_*]'] = __(
+			'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (strpos($shortcode, '[ANSWER_*') === false
+			|| ! isset($extra_data['data']->questions)
+			|| ! isset($extra_data['data']->registrations)
+		) {
+			return $parsed;
+		}
+
+		// let's get the question from the code.
+		$shortcode = str_replace('[ANSWER_*', '', $shortcode);
+		$shortcode = trim(str_replace(']', '', $shortcode));
+
+		$registration = $data instanceof EE_Registration ? $data : null;
+		$registration = ! $registration instanceof EE_Registration && is_array(
+			$extra_data
+		) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
+
+		$aee = $data instanceof EE_Messages_Addressee ? $data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array(
+			$extra_data
+		) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
+
+		if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		// now let's figure out which question has this text.
+		foreach ($aee->questions as $ansid => $question) {
+			if ($question instanceof EE_Question
+				&& trim($question->display_text()) == trim($shortcode)
+				&& isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+			) {
+				return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+					'ANS_value',
+					'no_wpautop'
+				);
+			}
+		}
+
+		// nothing!
+		return $parsed;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes filter for adding additional datetime shortcodes.
+	 *
+	 * @since  4.2
+	 *
+	 * @param  array                  $shortcodes         array of shortcodes and
+	 *                                                    descriptions
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
+	 *
+	 * @return array                                        array of shortcodes and
+	 *                                                        descriptions
+	 */
+	public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[DTT_NAME]'] = __(
+			'This will be parsed to the Title given for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_DESCRIPTION]'] = __(
+			'This will be parsed to the description for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_NAME_OR_DATES]'] = __(
+			'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes parser filter used for adding parser for new
+	 * Datetime shortcodes
+	 *
+	 * @since  4.2
+	 *
+	 * @param  string                 $parsed     The finished parsed string for the given shortcode.
+	 * @param  string                 $shortcode  The shortcode being parsed.
+	 * @param  object                 $data       The incoming data object for the Shortcode Parser.
+	 * @param  object                 $extra_data The incoming extra date object for the Shortcode
+	 *                                            Parser.
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser
+	 *
+	 * @return string                   The new parsed string.
+	 */
+	public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (! $data instanceof EE_Datetime) {
+			return ''; // get out because we can only parse with the datetime object.
+		}
+
+		switch ($shortcode) {
+			case '[DTT_NAME]':
+				return $data->name();
+				break;
+			case '[DTT_DESCRIPTION]':
+				return $data->description();
+				break;
+			case '[DTT_NAME_OR_DATES]':
+				return $data->get_dtt_display_name(true);
+				break;
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
+			'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[RECIPIENT_QUESTION_LIST]':
+				$att = $recipient->att_obj;
+				$registrations_on_attendee = $att instanceof EE_Attendee
+					? $recipient->attendees[ $att->ID() ]['reg_objs']
+					: array();
+				$registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
+				$answers = array();
+
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+
+				// if the context is main_content then get all answers for all registrations on this attendee
+				if ($data['data'] instanceof EE_Messages_Addressee) {
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				// if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
+				if ($data['data'] instanceof EE_Event) {
+					$event = $data['data'];
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				$questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
+
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
+			'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_primary_registration_details_parser(
+		$parsed,
+		$shortcode,
+		$data,
+		$extra_data,
+		$shortcode_parser
+	) {
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
+				if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				$registration = $recipient->primary_reg_obj;
+				$answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
+					? $recipient->registrations[ $registration->ID() ]['ans_objs']
+					: array();
+				if (empty($answers)) {
+					return '';
+				}
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+				$answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+				$questions = isset($recipient->questions) ? $recipient->questions : array();
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	/**
+	 * Takes care of registering the  message types that are only available in caffeinated EE.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return  void
+	 */
+	public function register_caf_message_types()
+	{
+		// register newsletter message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
+			'autoloadpaths'                                    => array(
+				EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+			),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('newsletter', $setup_args);
+
+		// register payment reminder message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_reminder', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_declined', $setup_args);
+
+		// register registration declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('declined_registration', $setup_args);
+
+		// register registration cancelled message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('cancelled_registration', $setup_args);
+
+
+		// register payment failed message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_failed', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_cancelled', $setup_args);
+	}
+
+
+	/**
+	 * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return void
+	 */
+	public function register_caf_shortcodes()
+	{
+		$setup_args = array(
+			'autoloadpaths'                 => array(
+				EE_CAF_LIBRARIES . 'shortcodes/',
+			),
+			'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
+			'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
+			'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
+		);
+		EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
+	}
+
+
+	/**
+	 * Parses a question list shortcode using given data and template
+	 *
+	 * @param \EE_Shortcodes $shortcode_parser
+	 * @param EE_Question[]  $questions        An array of questions indexed by answer id.
+	 * @param EE_Answer[]    $answers          An array of answer objects
+	 * @param string         $template         Template content to be parsed.
+	 * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+	 * @param array          $extra_data       Extra data that might be used when parsing the template.
+	 */
+	protected function _parse_question_list_for_primary_or_recipient_registration(
+		$shortcode_parser,
+		$questions,
+		$answers,
+		$template,
+		$valid_shortcodes,
+		$extra_data
+	) {
+		$question_list = '';
+		/** @var EEH_Parse_Shortcodes $shortcode_helper */
+		$shortcode_helper = $shortcode_parser->get_shortcode_helper();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				// first see if the question is in our $questions array. If not then try to get from answer object.
+				$question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+				$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+				if (! $question instanceof EE_Question
+					|| (
+						$question instanceof EE_Question
+						&& $question->admin_only()
+					)
+				) {
+					continue;
+				}
+				$question_list .= $shortcode_helper->parse_question_list_template(
+					$template,
+					$answer,
+					$valid_shortcodes,
+					$extra_data
+				);
+			}
+		}
+		return $question_list;
+	}
 }

Spacing +44 added lines, -44 removed lines

@@ -130,7 +130,7 @@ 
      */
     public function messages_autoload_paths($dir_ref)
     {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/';
 
         return $dir_ref;
     }
@@ -246,32 +246,32 @@ 
     ) {
 
         // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $contents;
         }
 
         // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+        $template_file_prefix = $field.'_'.$context;
+        $msg_prefix = $messenger->name.'_'.$message_type->name.'_';
 
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/';
 
         if ($messenger->name == 'email' && $message_type->name == 'registration') {
             switch ($template_file_prefix) {
                 case 'question_list_admin':
                 case 'question_list_attendee':
                 case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
+                    $path = $base_path.$msg_prefix.'question_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list_admin.template.php';
                     $contents = EEH_Template::display_template(
                         $path,
                         array(),
@@ -284,31 +284,31 @@ 
                     break;
 
                 case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+                    $path = $base_path.$msg_prefix.'event_list_attendee.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
             switch ($template_file_prefix) {
                 case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
+                    $path = $base_path.$msg_prefix.'content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+                    $path = $base_path.$msg_prefix.'newsletter_content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
+                    $path = $base_path.$msg_prefix.'subject.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
             switch ($template_file_prefix) {
                 case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -339,8 +339,8 @@ 
         if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
             $contexts = array_keys($msg->get_contexts());
             foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
+                $valid_shortcodes[$context][] = 'question_list';
+                $valid_shortcodes[$context][] = 'question';
             }
         }
 
@@ -383,7 +383,7 @@ 
             $extra_data
         ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
 
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+        if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -391,9 +391,9 @@ 
         foreach ($aee->questions as $ansid => $question) {
             if ($question instanceof EE_Question
                 && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+                && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
             ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+                return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty(
                     'ANS_value',
                     'no_wpautop'
                 );
@@ -454,7 +454,7 @@ 
     public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
     {
 
-        if (! $data instanceof EE_Datetime) {
+        if ( ! $data instanceof EE_Datetime) {
             return ''; // get out because we can only parse with the datetime object.
         }
 
@@ -507,7 +507,7 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -515,7 +515,7 @@ 
             case '[RECIPIENT_QUESTION_LIST]':
                 $att = $recipient->att_obj;
                 $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
+                    ? $recipient->attendees[$att->ID()]['reg_objs']
                     : array();
                 $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
                 $answers = array();
@@ -529,12 +529,12 @@ 
                 if ($data['data'] instanceof EE_Messages_Addressee) {
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -546,12 +546,12 @@ 
                     $event = $data['data'];
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -562,7 +562,7 @@ 
 
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
 
@@ -619,18 +619,18 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
         switch ($shortcode) {
             case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+                if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
+                $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
+                    ? $recipient->registrations[$registration->ID()]['ans_objs']
                     : array();
                 if (empty($answers)) {
                     return '';
@@ -639,11 +639,11 @@ 
                     ? $data['template']['question_list']
                     : $extra_data['template']['question_list'];
                 $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+                $answers = $recipient->registrations[$registration->ID()]['ans_objs'];
                 $questions = isset($recipient->questions) ? $recipient->questions : array();
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 return $this->_parse_question_list_for_primary_or_recipient_registration(
@@ -676,7 +676,7 @@ 
         $setup_args = array(
             'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
             'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+                EE_CAF_LIBRARIES.'messages/message_type/newsletter/',
             ),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
@@ -687,7 +687,7 @@ 
         // register payment reminder message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -697,7 +697,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -707,7 +707,7 @@ 
         // register registration declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -717,7 +717,7 @@ 
         // register registration cancelled message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -728,7 +728,7 @@ 
         // register payment failed message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -738,7 +738,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -758,7 +758,7 @@ 
     {
         $setup_args = array(
             'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
+                EE_CAF_LIBRARIES.'shortcodes/',
             ),
             'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
             'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
@@ -792,9 +792,9 @@ 
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
                 // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+                $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
                 $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
+                if ( ! $question instanceof EE_Question
                     || (
                         $question instanceof EE_Question
                         && $question->admin_only()

caffeinated/admin/new/pricing/Prices_List_Table.class.php

Indentation +216 added lines, -216 removed lines

@@ -16,220 +16,220 @@
 class Prices_List_Table extends EE_Admin_List_Table
 {
 
-    private $_PRT;
-
-    /**
-     * Array of price types.
-     *
-     * @var EE_Price_Type[]
-     */
-    protected $_price_types = array();
-
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->_PRT = EEM_Price_Type::instance();
-        $this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
-    }
-
-
-    protected function _setup_data()
-    {
-        $trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
-        $this->_data = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
-        $this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
-        $this->_trashed_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('price', 'event_espresso'),
-            'plural'   => __('prices', '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
-            'name'        => __('Name', 'event_espresso'),
-            'type'        => __('Price Type', 'event_espresso'),
-            'description' => __('Description', 'event_espresso'),
-            'amount'      => __('Amount', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            // true means its already sorted
-            'name'   => array('name' => false),
-            'type'   => array('type' => false),
-            'amount' => array('amount' => false),
-        );
-
-        $this->_hidden_columns = array();
-
-        $this->_ajax_sorting_callback = 'update_prices_order';
-    }
-
-
-    protected function _get_table_filters()
-    {
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_all_data_count;
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
-            $this->_views['trashed']['count'] = $this->_trashed_count;
-        }
-    }
-
-
-    /**
-     * overriding parent method so that we can make sure the row isn't sortable for certain items
-     *
-     * @param  object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        static $row_class = '';
-        $row_class = ($row_class == '' ? 'alternate' : '');
-
-        $new_row = $row_class;
-
-        if ($item->type_obj()->base_type() !== 1 && $item->type_obj()->base_type() !== 4) {
-            $new_row .= ' rowsortable';
-        }
-
-        return ' class="' . $new_row . '"';
-    }
-
-
-    public function column_cb($item)
-    {
-        if ($item->type_obj()->base_type() !== 1) {
-            return sprintf(
-                '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-                $item->ID()
-            );
-        }
-        return '';
-    }
-
-
-    public function column_name($item)
-    {
-
-        // Build row actions
-        $actions = array();
-        // edit price link
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_default_price',
-            'pricing_edit_price',
-            $item->ID()
-        )) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => 'edit_price',
-                'id'     => $item->ID(),
-            ), PRICING_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Price', 'event_espresso') . '">'
-                               . __('Edit', 'event_espresso') . '</a>';
-        }
-
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_default_price',
-            'edit_price',
-            $item->ID()
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Price', 'event_espresso') . '">'
-              . stripslashes($item->name()) . '</a>'
-            : $item->name();
-
-        if ($item->type_obj()->base_type() !== 1) {
-            if ($this->_view == 'all') {
-                // trash price link
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_trash_price',
-                    $item->ID()
-                )) {
-                    $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'trash_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                        . esc_attr__('Move Price to Trash', 'event_espresso') . '">'
-                                        . __('Move to Trash', 'event_espresso') . '</a>';
-                }
-            } else {
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_restore_price',
-                    $item->ID()
-                )) {
-                    // restore price link
-                    $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'restore_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                          . esc_attr__('Restore Price', 'event_espresso') . '">'
-                                          . __('Restore', 'event_espresso') . '</a>';
-                }
-
-                // delete price link
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_delete_price',
-                    $item->ID()
-                )) {
-                    $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'delete_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
-                                         . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
-                                         . __('Delete Permanently', 'event_espresso') . '</a>';
-                }
-            }
-        }
-
-        // Return the name contents
-        return sprintf(
-            '%1$s <span style="color:silver">(id:%2$s)</span>%3$s',
-            $name_link,
-            $item->ID(),
-            $this->row_actions($actions)
-        );
-    }
-
-
-    public function column_type($item)
-    {
-        return $this->_price_types[ $item->type() ]->name();
-    }
-
-
-    public function column_description($item)
-    {
-        return stripslashes($item->desc());
-    }
-
-
-    public function column_amount($item)
-    {
-        if ($this->_price_types[ $item->type() ]->is_percent()) {
-            return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
-        } else {
-            return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
-        }
-    }
+	private $_PRT;
+
+	/**
+	 * Array of price types.
+	 *
+	 * @var EE_Price_Type[]
+	 */
+	protected $_price_types = array();
+
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->_PRT = EEM_Price_Type::instance();
+		$this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
+	}
+
+
+	protected function _setup_data()
+	{
+		$trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
+		$this->_data = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
+		$this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
+		$this->_trashed_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('price', 'event_espresso'),
+			'plural'   => __('prices', '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
+			'name'        => __('Name', 'event_espresso'),
+			'type'        => __('Price Type', 'event_espresso'),
+			'description' => __('Description', 'event_espresso'),
+			'amount'      => __('Amount', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			// true means its already sorted
+			'name'   => array('name' => false),
+			'type'   => array('type' => false),
+			'amount' => array('amount' => false),
+		);
+
+		$this->_hidden_columns = array();
+
+		$this->_ajax_sorting_callback = 'update_prices_order';
+	}
+
+
+	protected function _get_table_filters()
+	{
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_all_data_count;
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
+			$this->_views['trashed']['count'] = $this->_trashed_count;
+		}
+	}
+
+
+	/**
+	 * overriding parent method so that we can make sure the row isn't sortable for certain items
+	 *
+	 * @param  object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		static $row_class = '';
+		$row_class = ($row_class == '' ? 'alternate' : '');
+
+		$new_row = $row_class;
+
+		if ($item->type_obj()->base_type() !== 1 && $item->type_obj()->base_type() !== 4) {
+			$new_row .= ' rowsortable';
+		}
+
+		return ' class="' . $new_row . '"';
+	}
+
+
+	public function column_cb($item)
+	{
+		if ($item->type_obj()->base_type() !== 1) {
+			return sprintf(
+				'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+				$item->ID()
+			);
+		}
+		return '';
+	}
+
+
+	public function column_name($item)
+	{
+
+		// Build row actions
+		$actions = array();
+		// edit price link
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_default_price',
+			'pricing_edit_price',
+			$item->ID()
+		)) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => 'edit_price',
+				'id'     => $item->ID(),
+			), PRICING_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
+							   . esc_attr__('Edit Price', 'event_espresso') . '">'
+							   . __('Edit', 'event_espresso') . '</a>';
+		}
+
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_default_price',
+			'edit_price',
+			$item->ID()
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Price', 'event_espresso') . '">'
+			  . stripslashes($item->name()) . '</a>'
+			: $item->name();
+
+		if ($item->type_obj()->base_type() !== 1) {
+			if ($this->_view == 'all') {
+				// trash price link
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_trash_price',
+					$item->ID()
+				)) {
+					$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'trash_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+										. esc_attr__('Move Price to Trash', 'event_espresso') . '">'
+										. __('Move to Trash', 'event_espresso') . '</a>';
+				}
+			} else {
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_restore_price',
+					$item->ID()
+				)) {
+					// restore price link
+					$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'restore_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
+										  . esc_attr__('Restore Price', 'event_espresso') . '">'
+										  . __('Restore', 'event_espresso') . '</a>';
+				}
+
+				// delete price link
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_delete_price',
+					$item->ID()
+				)) {
+					$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'delete_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
+										 . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
+										 . __('Delete Permanently', 'event_espresso') . '</a>';
+				}
+			}
+		}
+
+		// Return the name contents
+		return sprintf(
+			'%1$s <span style="color:silver">(id:%2$s)</span>%3$s',
+			$name_link,
+			$item->ID(),
+			$this->row_actions($actions)
+		);
+	}
+
+
+	public function column_type($item)
+	{
+		return $this->_price_types[ $item->type() ]->name();
+	}
+
+
+	public function column_description($item)
+	{
+		return stripslashes($item->desc());
+	}
+
+
+	public function column_amount($item)
+	{
+		if ($this->_price_types[ $item->type() ]->is_percent()) {
+			return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
+		} else {
+			return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
+		}
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -28,7 +28,7 @@ 
     public function __construct($admin_page)
     {
         parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+        require_once(EE_MODELS.'EEM_Price_Type.model.php');
         $this->_PRT = EEM_Price_Type::instance();
         $this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
     }
@@ -104,7 +104,7 @@ 
             $new_row .= ' rowsortable';
         }
 
-        return ' class="' . $new_row . '"';
+        return ' class="'.$new_row.'"';
     }
 
 
@@ -135,9 +135,9 @@ 
                 'action' => 'edit_price',
                 'id'     => $item->ID(),
             ), PRICING_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Price', 'event_espresso') . '">'
-                               . __('Edit', 'event_espresso') . '</a>';
+            $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'
+                               . esc_attr__('Edit Price', 'event_espresso').'">'
+                               . __('Edit', 'event_espresso').'</a>';
         }
 
         $name_link = EE_Registry::instance()->CAP->current_user_can(
@@ -145,9 +145,9 @@ 
             'edit_price',
             $item->ID()
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Price', 'event_espresso') . '">'
-              . stripslashes($item->name()) . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Price', 'event_espresso').'">'
+              . stripslashes($item->name()).'</a>'
             : $item->name();
 
         if ($item->type_obj()->base_type() !== 1) {
@@ -163,9 +163,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                        . esc_attr__('Move Price to Trash', 'event_espresso') . '">'
-                                        . __('Move to Trash', 'event_espresso') . '</a>';
+                    $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'
+                                        . esc_attr__('Move Price to Trash', 'event_espresso').'">'
+                                        . __('Move to Trash', 'event_espresso').'</a>';
                 }
             } else {
                 if (EE_Registry::instance()->CAP->current_user_can(
@@ -179,9 +179,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                          . esc_attr__('Restore Price', 'event_espresso') . '">'
-                                          . __('Restore', 'event_espresso') . '</a>';
+                    $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'
+                                          . esc_attr__('Restore Price', 'event_espresso').'">'
+                                          . __('Restore', 'event_espresso').'</a>';
                 }
 
                 // delete price link
@@ -195,9 +195,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
-                                         . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
-                                         . __('Delete Permanently', 'event_espresso') . '</a>';
+                    $actions['delete'] = '<a href="'.$delete_lnk_url.'" title="'
+                                         . esc_attr__('Delete Price Permanently', 'event_espresso').'">'
+                                         . __('Delete Permanently', 'event_espresso').'</a>';
                 }
             }
         }
@@ -214,7 +214,7 @@ 
 
     public function column_type($item)
     {
-        return $this->_price_types[ $item->type() ]->name();
+        return $this->_price_types[$item->type()]->name();
     }
 
 
@@ -226,10 +226,10 @@ 
 
     public function column_amount($item)
     {
-        if ($this->_price_types[ $item->type() ]->is_percent()) {
-            return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
+        if ($this->_price_types[$item->type()]->is_percent()) {
+            return '<div class="pad-amnt-rght">'.number_format($item->amount(), 1).'%</div>';
         } else {
-            return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
+            return '<div class="pad-amnt-rght">'.EEH_Template::format_currency($item->amount()).'</div>';
         }
     }
 }

core/db_classes/EE_Taxes.class.php

Indentation +123 added lines, -123 removed lines

@@ -10,138 +10,138 @@
 class EE_Taxes extends EE_Base
 {
 
-    /**
-     * This is used for when EE_Taxes is used statically by the admin
-     *
-     * @var array
-     */
-    private static $_subtotal = array();
+	/**
+	 * This is used for when EE_Taxes is used statically by the admin
+	 *
+	 * @var array
+	 */
+	private static $_subtotal = array();
 
-    /**
-     * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
-     *
-     * @var EE_Price[]
-     */
-    private static $_default_taxes = array();
+	/**
+	 * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
+	 *
+	 * @var EE_Price[]
+	 */
+	private static $_default_taxes = array();
 
 
-    /**
-     * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
-     * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
-     * calc of taxes for tickets listed in the event editor.
-     *
-     * @param  EE_Ticket $ticket incoming EE_Ticket
-     * @return float             total taxes to apply to ticket.
-     * @throws \EE_Error
-     */
-    public static function get_total_taxes_for_admin(EE_Ticket $ticket)
-    {
-        $tax = 0;
-        $total_tax = 0;
-        // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
-            return $tax;
-        }
-        // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
-        $subtotal = self::get_subtotal_for_admin($ticket);
-        // get taxes
-        $taxes = self::get_taxes_for_admin();
-        // apply taxes to subtotal
-        foreach ($taxes as $tax) {
-            // assuming taxes are not cumulative
-            $total_tax += $subtotal * $tax->get('PRC_amount') / 100;
-        }
-        return $total_tax;
-    }
+	/**
+	 * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
+	 * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
+	 * calc of taxes for tickets listed in the event editor.
+	 *
+	 * @param  EE_Ticket $ticket incoming EE_Ticket
+	 * @return float             total taxes to apply to ticket.
+	 * @throws \EE_Error
+	 */
+	public static function get_total_taxes_for_admin(EE_Ticket $ticket)
+	{
+		$tax = 0;
+		$total_tax = 0;
+		// This first checks to see if the given ticket is taxable.
+		if (! $ticket->get('TKT_taxable')) {
+			return $tax;
+		}
+		// get subtotal (notice we're only retrieving a subtotal if there isn't one given)
+		$subtotal = self::get_subtotal_for_admin($ticket);
+		// get taxes
+		$taxes = self::get_taxes_for_admin();
+		// apply taxes to subtotal
+		foreach ($taxes as $tax) {
+			// assuming taxes are not cumulative
+			$total_tax += $subtotal * $tax->get('PRC_amount') / 100;
+		}
+		return $total_tax;
+	}
 
 
-    /**
-     * Gets the total percentage of tax that should be applied to taxable line items
-     *
-     * @return float the percentage of tax that should be added to taxable items
-     * @throws \EE_Error
-     * eg 20 for %20 tax (NOT 0.20, which
-     */
-    public static function get_total_taxes_percentage()
-    {
-        $total_tax_percent = 0;
-        foreach (self::get_taxes_for_admin() as $tax_price) {
-            $total_tax_percent += $tax_price->get('PRC_amount');
-        }
-        return $total_tax_percent;
-    }
+	/**
+	 * Gets the total percentage of tax that should be applied to taxable line items
+	 *
+	 * @return float the percentage of tax that should be added to taxable items
+	 * @throws \EE_Error
+	 * eg 20 for %20 tax (NOT 0.20, which
+	 */
+	public static function get_total_taxes_percentage()
+	{
+		$total_tax_percent = 0;
+		foreach (self::get_taxes_for_admin() as $tax_price) {
+			$total_tax_percent += $tax_price->get('PRC_amount');
+		}
+		return $total_tax_percent;
+	}
 
 
-    /**
-     * @param EE_Ticket $ticket
-     * @return float
-     * @throws \EE_Error
-     */
-    public static function get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
-            : self::_get_subtotal_for_admin($ticket);
-    }
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public static function get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$TKT_ID = $ticket->ID();
+		return isset(self::$_subtotal[ $TKT_ID ])
+			? self::$_subtotal[ $TKT_ID ]
+			: self::_get_subtotal_for_admin($ticket);
+	}
 
 
-    /**
-     * simply take an incoming ticket and calculate the subtotal for the ticket
-     *
-     * @param  EE_Ticket $ticket
-     * @return float     subtotal calculated from all EE_Price[] on Ticket.
-     * @throws \EE_Error
-     */
-    private static function _get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $subtotal = 0;
-        // get all prices
-        $prices = $ticket->get_many_related(
-            'Price',
-            array(
-                'default_where_conditions' => 'none',
-                'order_by'                 => array('PRC_order' => 'ASC'),
-            )
-        );
-        // let's loop through them (base price is always the first item)
-        foreach ($prices as $price) {
-            if ($price instanceof EE_Price) {
-                $price_type = $price->type_obj();
-                if ($price_type instanceof EE_Price_Type) {
-                    switch ($price->type_obj()->base_type()) {
-                        case 1: // base price
-                        case 3: // surcharges
-                            $subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                        case 2: // discounts
-                            $subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                    }
-                }
-            }
-        }
-        $TKT_ID = $ticket->ID();
-        self::$_subtotal = array($TKT_ID => $subtotal);
-        return $subtotal;
-    }
+	/**
+	 * simply take an incoming ticket and calculate the subtotal for the ticket
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @return float     subtotal calculated from all EE_Price[] on Ticket.
+	 * @throws \EE_Error
+	 */
+	private static function _get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$subtotal = 0;
+		// get all prices
+		$prices = $ticket->get_many_related(
+			'Price',
+			array(
+				'default_where_conditions' => 'none',
+				'order_by'                 => array('PRC_order' => 'ASC'),
+			)
+		);
+		// let's loop through them (base price is always the first item)
+		foreach ($prices as $price) {
+			if ($price instanceof EE_Price) {
+				$price_type = $price->type_obj();
+				if ($price_type instanceof EE_Price_Type) {
+					switch ($price->type_obj()->base_type()) {
+						case 1: // base price
+						case 3: // surcharges
+							$subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+						case 2: // discounts
+							$subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+					}
+				}
+			}
+		}
+		$TKT_ID = $ticket->ID();
+		self::$_subtotal = array($TKT_ID => $subtotal);
+		return $subtotal;
+	}
 
 
-    /**
-     * get all default prices that are a Tax price type (PRT_ID = 4) and return
-     *
-     * @return EE_Price[] EE_Price objects that have PRT_ID == 4
-     * @throws \EE_Error
-     */
-    public static function get_taxes_for_admin()
-    {
-        if (empty(self::$_default_taxes)) {
-            self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
-                array(array('Price_Type.PBT_ID' => 4))
-            );
-        }
-        return self::$_default_taxes;
-    }
+	/**
+	 * get all default prices that are a Tax price type (PRT_ID = 4) and return
+	 *
+	 * @return EE_Price[] EE_Price objects that have PRT_ID == 4
+	 * @throws \EE_Error
+	 */
+	public static function get_taxes_for_admin()
+	{
+		if (empty(self::$_default_taxes)) {
+			self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
+				array(array('Price_Type.PBT_ID' => 4))
+			);
+		}
+		return self::$_default_taxes;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -39,7 +39,7 @@ 
         $tax = 0;
         $total_tax = 0;
         // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
+        if ( ! $ticket->get('TKT_taxable')) {
             return $tax;
         }
         // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
@@ -80,8 +80,8 @@ 
     public static function get_subtotal_for_admin(EE_Ticket $ticket)
     {
         $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
+        return isset(self::$_subtotal[$TKT_ID])
+            ? self::$_subtotal[$TKT_ID]
             : self::_get_subtotal_for_admin($ticket);
     }
 

core/db_classes/EE_Term_Taxonomy.class.php

Indentation +64 added lines, -64 removed lines

@@ -11,80 +11,80 @@
 class EE_Term_Taxonomy extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Taxonomy
-     */
-    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);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Taxonomy
+	 */
+	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);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Taxonomy
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Taxonomy
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
 
-    /**
-     * Gets taxonomy
-     *
-     * @return string
-     */
-    public function taxonomy()
-    {
-        return $this->get('taxonomy');
-    }
+	/**
+	 * Gets taxonomy
+	 *
+	 * @return string
+	 */
+	public function taxonomy()
+	{
+		return $this->get('taxonomy');
+	}
 
 
-    /**
-     * Sets taxonomy
-     *
-     * @param string $taxonomy
-     * @return boolean
-     */
-    public function set_taxonomy($taxonomy)
-    {
-        $this->set('taxonomy', $taxonomy);
-    }
+	/**
+	 * Sets taxonomy
+	 *
+	 * @param string $taxonomy
+	 * @return boolean
+	 */
+	public function set_taxonomy($taxonomy)
+	{
+		$this->set('taxonomy', $taxonomy);
+	}
 
 
-    /**
-     * Gets term_count
-     *
-     * @return int
-     */
-    public function count()
-    {
-        return $this->get('term_count');
-    }
+	/**
+	 * Gets term_count
+	 *
+	 * @return int
+	 */
+	public function count()
+	{
+		return $this->get('term_count');
+	}
 
 
-    /**
-     * Sets term_count
-     *
-     * @param int $term_count
-     * @return boolean
-     */
-    public function set_count($term_count)
-    {
-        $this->set('term_count', $term_count);
-    }
+	/**
+	 * Sets term_count
+	 *
+	 * @param int $term_count
+	 * @return boolean
+	 */
+	public function set_count($term_count)
+	{
+		$this->set('term_count', $term_count);
+	}
 
 
-    /**
-     * Gets the term for this term taxonomy
-     *
-     * @return EE_Term
-     */
-    public function term()
-    {
-        return $this->get_first_related('Term');
-    }
+	/**
+	 * Gets the term for this term taxonomy
+	 *
+	 * @return EE_Term
+	 */
+	public function term()
+	{
+		return $this->get_first_related('Term');
+	}
 }

core/db_classes/EE_Message_Template_Group.class.php

Spacing +8 added lines, -8 removed lines

@@ -48,7 +48,7 @@ 
      */
     public function set_message_type($message_type = false)
     {
-        if (! $message_type) {
+        if ( ! $message_type) {
             throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
         }
         $this->set('MTP_message_type', $message_type);
@@ -61,7 +61,7 @@ 
      */
     public function set_messenger($messenger = false)
     {
-        if (! $messenger) {
+        if ( ! $messenger) {
             throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
         }
         $this->set('MTP_messenger', $messenger);
@@ -74,7 +74,7 @@ 
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(
                 esc_html__(
                     'Missing required value for the message template group id',
@@ -290,7 +290,7 @@ 
         }
         // note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
         foreach ($mtps as $mtp) {
-            $mtps_arr[ $mtp->get('MTP_context') ][ $mtp->get('MTP_template_field') ] = $mtp;
+            $mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
         }
         return $mtps_arr;
     }
@@ -430,7 +430,7 @@ 
     public function deactivate_context($context)
     {
         $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
+        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, false);
     }
 
 
@@ -445,7 +445,7 @@ 
     public function activate_context($context)
     {
         $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
+        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, true);
     }
 
 
@@ -465,7 +465,7 @@ 
     {
         $this->validate_context($context);
         return filter_var(
-            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
+            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, true, true),
             FILTER_VALIDATE_BOOLEAN
         );
     }
@@ -481,7 +481,7 @@ 
     public function validate_context($context)
     {
         $contexts = $this->contexts_config();
-        if (! isset($contexts[ $context ])) {
+        if ( ! isset($contexts[$context])) {
             throw new InvalidIdentifierException(
                 '',
                 '',

Indentation +483 added lines, -483 removed lines

@@ -13,487 +13,487 @@
 class EE_Message_Template_Group extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * Extra Meta key prefix for whether a given context for this message tmeplate group is active or not.
-     */
-    const ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX = 'active_context_';
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group|mixed
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $message_type
-     * @throws EE_Error
-     */
-    public function set_message_type($message_type = false)
-    {
-        if (! $message_type) {
-            throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
-        }
-        $this->set('MTP_message_type', $message_type);
-    }
-
-
-    /**
-     * @param bool $messenger
-     * @throws EE_Error
-     */
-    public function set_messenger($messenger = false)
-    {
-        if (! $messenger) {
-            throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
-        }
-        $this->set('MTP_messenger', $messenger);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(
-                esc_html__(
-                    'Missing required value for the message template group id',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function user()
-    {
-        $user_id = $this->get('MTP_user_id');
-        return empty($user_id) ? get_current_user_id() : $user_id;
-    }
-
-
-    /**
-     * Wrapper for the user function() (preserve backward compat)
-     *
-     * @since  4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->user();
-    }
-
-
-    /**
-     * This simply returns a count of all related events to this message template group
-     *
-     * @return int
-     */
-    public function count_events()
-    {
-        return $this->count_related('Event');
-    }
-
-
-    /**
-     * returns the name saved in the db for this template
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('MTP_name');
-    }
-
-
-    /**
-     * Returns the description saved in the db for this template group
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('MTP_description');
-    }
-
-
-    /**
-     * returns all related EE_Message_Template objects
-     *
-     * @param  array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Message_Template[]
-     * @throws EE_Error
-     */
-    public function message_templates($query_params = array())
-    {
-        return $this->get_many_related('Message_Template', $query_params);
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     */
-    public function messenger()
-    {
-        return $this->get('MTP_messenger');
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     * If an attempt to get the corresponding messenger object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @return EE_messenger
-     * @throws EE_Error
-     */
-    public function messenger_obj()
-    {
-        $messenger = $this->messenger();
-        try {
-            $messenger = EEH_MSG_Template::messenger_obj($messenger);
-        } catch (EE_Error $e) {
-            // if an exception was thrown then let's deactivate this message template group because it means there is no
-            // class for this messenger in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $messenger;
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     */
-    public function message_type()
-    {
-        return $this->get('MTP_message_type');
-    }
-
-
-    /**
-     * get Message type OBJECT
-     * If an attempt to get the corresponding message type object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @throws EE_Error
-     * @return EE_message_type|false if exception thrown.
-     */
-    public function message_type_obj()
-    {
-        $message_type = $this->message_type();
-        try {
-            $message_type = EEH_MSG_Template::message_type_obj($message_type);
-        } catch (EE_Error $e) {
-            // if an exception was thrown then let's deactivate this message template group because it means there is no
-            // class for the message type in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $message_type;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     */
-    public function contexts_config()
-    {
-        return $this->message_type_obj()->get_contexts();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     * Note this is an array with singular and plural keys
-     *
-     * @access public
-     * @return array labels for "context"
-     * @throws EE_Error
-     */
-    public function context_label()
-    {
-        $obj = $this->message_type_obj();
-        return $obj->get_context_label();
-    }
-
-
-    /**
-     * This returns an array of EE_Message_Template objects indexed by context and field.
-     *
-     * @return array ()
-     * @throws EE_Error
-     */
-    public function context_templates()
-    {
-        $mtps_arr = array();
-        $mtps = $this->get_many_related('Message_Template');
-        if (empty($mtps)) {
-            return array();
-        }
-        // note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
-        foreach ($mtps as $mtp) {
-            $mtps_arr[ $mtp->get('MTP_context') ][ $mtp->get('MTP_template_field') ] = $mtp;
-        }
-        return $mtps_arr;
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return bool true if it is, false if it isn't
-     * @throws EE_Error
-     */
-    public function is_global()
-    {
-        return $this->get('MTP_is_global');
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return bool true if it is, false if it isn't
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        return $this->get('MTP_is_active');
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @since 4.3.0
-     * @uses  EEH_MSG_Template::get_shortcodes()
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be returned.
-     * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
-     *                        unique shortcodes for all the given (or all) fields.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *                        shortcodes found.
-     * @throws EE_Error
-     */
-    public function get_shortcodes($context, $fields = array(), $merged = false)
-    {
-        $messenger = $this->messenger();
-        $message_type = $this->message_type();
-        return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
-    }
-
-
-    /**
-     * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
-     * use the default template pack.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_template_pack_name()
-    {
-        return $this->get_extra_meta('MTP_template_pack', true, 'default');
-    }
-
-
-    /**
-     * This returns the specific template pack object referenced by the template pack name attached to this message
-     * template group.  If no template pack is assigned then the default template pack is retrieved.
-     *
-     * @since 4.5.0
-     * @return EE_Messages_Template_Pack
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_template_pack()
-    {
-        $pack_name = $this->get_template_pack_name();
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($pack_name);
-    }
-
-
-    /**
-     * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
-     * use the default template variation.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_template_pack_variation()
-    {
-        return $this->get_extra_meta('MTP_variation', true, 'default');
-    }
-
-
-    /**
-     * This just sets the template pack name attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $template_pack_name What message template pack is assigned.
-     * @return int
-     * @throws EE_Error
-     */
-    public function set_template_pack_name($template_pack_name)
-    {
-        return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
-    }
-
-
-    /**
-     * This just sets the template pack variation attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $variation What variation is being set on the message template group.
-     * @return int
-     * @throws EE_Error
-     */
-    public function set_template_pack_variation($variation)
-    {
-        return $this->update_extra_meta('MTP_variation', $variation);
-    }
-
-
-    /**
-     * Deactivates the given context.
-     *
-     * @param $context
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function deactivate_context($context)
-    {
-        $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
-    }
-
-
-    /**
-     * Activates the given context.
-     *
-     * @param $context
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function activate_context($context)
-    {
-        $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
-    }
-
-
-    /**
-     * Returns whether the context is active or not.
-     * Note, this will default to true if the extra meta record doesn't exist.
-     * Also, this does NOT account for whether the "To" field is empty or not. Some messengers may allow the "To" field
-     * to be empty (@see EE_Messenger::allow_empty_to_field()) so an empty "To" field is not always an indicator of
-     * whether a context is "active" or not.
-     *
-     * @param $context
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function is_context_active($context)
-    {
-        $this->validate_context($context);
-        return filter_var(
-            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Validates the incoming context to verify it matches a registered context for the related message type.
-     *
-     * @param string $context
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function validate_context($context)
-    {
-        $contexts = $this->contexts_config();
-        if (! isset($contexts[ $context ])) {
-            throw new InvalidIdentifierException(
-                '',
-                '',
-                sprintf(
-                    esc_html__(
-                        'An invalid string identifying a context was provided.  "%1$s" was received, and one of "%2$s" was expected.',
-                        'event_espresso'
-                    ),
-                    $context,
-                    implode(',', array_keys($contexts))
-                )
-            );
-        }
-    }
+	/**
+	 * Extra Meta key prefix for whether a given context for this message tmeplate group is active or not.
+	 */
+	const ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX = 'active_context_';
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group|mixed
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $message_type
+	 * @throws EE_Error
+	 */
+	public function set_message_type($message_type = false)
+	{
+		if (! $message_type) {
+			throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
+		}
+		$this->set('MTP_message_type', $message_type);
+	}
+
+
+	/**
+	 * @param bool $messenger
+	 * @throws EE_Error
+	 */
+	public function set_messenger($messenger = false)
+	{
+		if (! $messenger) {
+			throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
+		}
+		$this->set('MTP_messenger', $messenger);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(
+				esc_html__(
+					'Missing required value for the message template group id',
+					'event_espresso'
+				)
+			);
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function user()
+	{
+		$user_id = $this->get('MTP_user_id');
+		return empty($user_id) ? get_current_user_id() : $user_id;
+	}
+
+
+	/**
+	 * Wrapper for the user function() (preserve backward compat)
+	 *
+	 * @since  4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->user();
+	}
+
+
+	/**
+	 * This simply returns a count of all related events to this message template group
+	 *
+	 * @return int
+	 */
+	public function count_events()
+	{
+		return $this->count_related('Event');
+	}
+
+
+	/**
+	 * returns the name saved in the db for this template
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('MTP_name');
+	}
+
+
+	/**
+	 * Returns the description saved in the db for this template group
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('MTP_description');
+	}
+
+
+	/**
+	 * returns all related EE_Message_Template objects
+	 *
+	 * @param  array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Message_Template[]
+	 * @throws EE_Error
+	 */
+	public function message_templates($query_params = array())
+	{
+		return $this->get_many_related('Message_Template', $query_params);
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function messenger()
+	{
+		return $this->get('MTP_messenger');
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 * If an attempt to get the corresponding messenger object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @return EE_messenger
+	 * @throws EE_Error
+	 */
+	public function messenger_obj()
+	{
+		$messenger = $this->messenger();
+		try {
+			$messenger = EEH_MSG_Template::messenger_obj($messenger);
+		} catch (EE_Error $e) {
+			// if an exception was thrown then let's deactivate this message template group because it means there is no
+			// class for this messenger in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $messenger;
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function message_type()
+	{
+		return $this->get('MTP_message_type');
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 * If an attempt to get the corresponding message type object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @throws EE_Error
+	 * @return EE_message_type|false if exception thrown.
+	 */
+	public function message_type_obj()
+	{
+		$message_type = $this->message_type();
+		try {
+			$message_type = EEH_MSG_Template::message_type_obj($message_type);
+		} catch (EE_Error $e) {
+			// if an exception was thrown then let's deactivate this message template group because it means there is no
+			// class for the message type in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $message_type;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function contexts_config()
+	{
+		return $this->message_type_obj()->get_contexts();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 * Note this is an array with singular and plural keys
+	 *
+	 * @access public
+	 * @return array labels for "context"
+	 * @throws EE_Error
+	 */
+	public function context_label()
+	{
+		$obj = $this->message_type_obj();
+		return $obj->get_context_label();
+	}
+
+
+	/**
+	 * This returns an array of EE_Message_Template objects indexed by context and field.
+	 *
+	 * @return array ()
+	 * @throws EE_Error
+	 */
+	public function context_templates()
+	{
+		$mtps_arr = array();
+		$mtps = $this->get_many_related('Message_Template');
+		if (empty($mtps)) {
+			return array();
+		}
+		// note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
+		foreach ($mtps as $mtp) {
+			$mtps_arr[ $mtp->get('MTP_context') ][ $mtp->get('MTP_template_field') ] = $mtp;
+		}
+		return $mtps_arr;
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return bool true if it is, false if it isn't
+	 * @throws EE_Error
+	 */
+	public function is_global()
+	{
+		return $this->get('MTP_is_global');
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return bool true if it is, false if it isn't
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		return $this->get('MTP_is_active');
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @since 4.3.0
+	 * @uses  EEH_MSG_Template::get_shortcodes()
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be returned.
+	 * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
+	 *                        unique shortcodes for all the given (or all) fields.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *                        shortcodes found.
+	 * @throws EE_Error
+	 */
+	public function get_shortcodes($context, $fields = array(), $merged = false)
+	{
+		$messenger = $this->messenger();
+		$message_type = $this->message_type();
+		return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
+	}
+
+
+	/**
+	 * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
+	 * use the default template pack.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_template_pack_name()
+	{
+		return $this->get_extra_meta('MTP_template_pack', true, 'default');
+	}
+
+
+	/**
+	 * This returns the specific template pack object referenced by the template pack name attached to this message
+	 * template group.  If no template pack is assigned then the default template pack is retrieved.
+	 *
+	 * @since 4.5.0
+	 * @return EE_Messages_Template_Pack
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_template_pack()
+	{
+		$pack_name = $this->get_template_pack_name();
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($pack_name);
+	}
+
+
+	/**
+	 * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
+	 * use the default template variation.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_template_pack_variation()
+	{
+		return $this->get_extra_meta('MTP_variation', true, 'default');
+	}
+
+
+	/**
+	 * This just sets the template pack name attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $template_pack_name What message template pack is assigned.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function set_template_pack_name($template_pack_name)
+	{
+		return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
+	}
+
+
+	/**
+	 * This just sets the template pack variation attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $variation What variation is being set on the message template group.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function set_template_pack_variation($variation)
+	{
+		return $this->update_extra_meta('MTP_variation', $variation);
+	}
+
+
+	/**
+	 * Deactivates the given context.
+	 *
+	 * @param $context
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function deactivate_context($context)
+	{
+		$this->validate_context($context);
+		return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
+	}
+
+
+	/**
+	 * Activates the given context.
+	 *
+	 * @param $context
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function activate_context($context)
+	{
+		$this->validate_context($context);
+		return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
+	}
+
+
+	/**
+	 * Returns whether the context is active or not.
+	 * Note, this will default to true if the extra meta record doesn't exist.
+	 * Also, this does NOT account for whether the "To" field is empty or not. Some messengers may allow the "To" field
+	 * to be empty (@see EE_Messenger::allow_empty_to_field()) so an empty "To" field is not always an indicator of
+	 * whether a context is "active" or not.
+	 *
+	 * @param $context
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function is_context_active($context)
+	{
+		$this->validate_context($context);
+		return filter_var(
+			$this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Validates the incoming context to verify it matches a registered context for the related message type.
+	 *
+	 * @param string $context
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function validate_context($context)
+	{
+		$contexts = $this->contexts_config();
+		if (! isset($contexts[ $context ])) {
+			throw new InvalidIdentifierException(
+				'',
+				'',
+				sprintf(
+					esc_html__(
+						'An invalid string identifying a context was provided.  "%1$s" was received, and one of "%2$s" was expected.',
+						'event_espresso'
+					),
+					$context,
+					implode(',', array_keys($contexts))
+				)
+			);
+		}
+	}
 }

core/db_classes/EE_Message_Template.class.php

Indentation +169 added lines, -169 removed lines

@@ -13,173 +13,173 @@
 class EE_Message_Template extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     */
-    public function user()
-    {
-        return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger();
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     *
-     * @access public
-     * @return object Messenger Object for the given messenger
-     */
-    public function messenger_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger_obj();
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type();
-    }
-
-
-    /**
-     * get Message type OBJECT
-     *
-     * @access public
-     * @return object  Message Type object for the given message type
-     */
-    public function message_type_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type_obj();
-    }
-
-
-    /**
-     * This returns the set context array configured in the message type object
-     *
-     * @access public
-     * @return array array of contexts and their configuration.
-     */
-    public function contexts_config()
-    {
-        return $this->get_first_related('Message_Template_Group')->contexts_config();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     *
-     * @access public
-     * @return string label for "context"
-     */
-    public function context_label()
-    {
-        return $this->get_first_related('Message_Template_Group')->context_label();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_global()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_global();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_active()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_active();
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @access public
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be merged and returned.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *               shortcodes found.
-     */
-    public function get_shortcodes($context, $fields = array())
-    {
-        return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function user()
+	{
+		return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger();
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 *
+	 * @access public
+	 * @return object Messenger Object for the given messenger
+	 */
+	public function messenger_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger_obj();
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type();
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 *
+	 * @access public
+	 * @return object  Message Type object for the given message type
+	 */
+	public function message_type_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type_obj();
+	}
+
+
+	/**
+	 * This returns the set context array configured in the message type object
+	 *
+	 * @access public
+	 * @return array array of contexts and their configuration.
+	 */
+	public function contexts_config()
+	{
+		return $this->get_first_related('Message_Template_Group')->contexts_config();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 *
+	 * @access public
+	 * @return string label for "context"
+	 */
+	public function context_label()
+	{
+		return $this->get_first_related('Message_Template_Group')->context_label();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_global()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_global();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_active()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_active();
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @access public
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be merged and returned.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *               shortcodes found.
+	 */
+	public function get_shortcodes($context, $fields = array())
+	{
+		return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
         }
         $this->set('GRP_ID', $GRP_ID);

core/db_classes/EE_CPT_Base.class.php

Indentation +425 added lines, -425 removed lines

@@ -14,429 +14,429 @@
 abstract class EE_CPT_Base extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * This is a property for holding cached feature images on CPT objects.  Cache's are set on the first
-     * "feature_image()" method call.  Each key in the array corresponds to the requested size.
-     *
-     * @var array
-     */
-    protected $_feature_image = array();
-
-    /**
-     * @var WP_Post the WP_Post that corresponds with this CPT model object
-     */
-    protected $_wp_post;
-
-
-    abstract public function wp_user();
-
-
-    /**
-     * Returns the WP post associated with this CPT model object. If this CPT is saved, fetches it
-     * from the DB. Otherwise, create an unsaved WP_POst object. Caches the post internally.
-     *
-     * @return WP_Post
-     */
-    public function wp_post()
-    {
-        global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
-            if ($this->ID()) {
-                $this->_wp_post = get_post($this->ID());
-            } else {
-                $simulated_db_result = new stdClass();
-                foreach ($this->get_model()->field_settings(true) as $field_name => $field_obj) {
-                    if ($this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())->get_table_name()
-                        === $wpdb->posts
-                    ) {
-                        $column = $field_obj->get_table_column();
-
-                        if ($field_obj instanceof EE_Datetime_Field) {
-                            $value_on_model_obj = $this->get_DateTime_object($field_name);
-                        } elseif ($field_obj->is_db_only_field()) {
-                            $value_on_model_obj = $field_obj->get_default_value();
-                        } else {
-                            $value_on_model_obj = $this->get_raw($field_name);
-                        }
-                        $simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
-                    }
-                }
-                $this->_wp_post = new WP_Post($simulated_db_result);
-            }
-            // and let's make retrieving the EE CPT object easy too
-            $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
-                $this->_wp_post->{$classname} = $this;
-            }
-        }
-        return $this->_wp_post;
-    }
-
-    /**
-     * When fetching a new value for a post field that uses the global $post for rendering,
-     * set the global $post temporarily to be this model object; and afterwards restore it
-     *
-     * @param string $fieldname
-     * @param bool   $pretty
-     * @param string $extra_cache_ref
-     * @return mixed
-     */
-    protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        global $post;
-
-        if ($pretty
-            && (
-                ! (
-                    $post instanceof WP_Post
-                    && $post->ID
-                )
-                || (int) $post->ID !== $this->ID()
-            )
-            && $this->get_model()->field_settings_for($fieldname) instanceof EE_Post_Content_Field) {
-            $old_post = $post;
-            $post = $this->wp_post();
-            $return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-            $post = $old_post;
-        } else {
-            $return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-        }
-        return $return_value;
-    }
-
-    /**
-     * Adds to the specified event category. If it category doesn't exist, creates it.
-     *
-     * @param string $category_name
-     * @param string $category_description    optional
-     * @param int    $parent_term_taxonomy_id optional
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
-    {
-        return $this->get_model()->add_event_category(
-            $this,
-            $category_name,
-            $category_description,
-            $parent_term_taxonomy_id
-        );
-    }
-
-
-    /**
-     * Removes the event category by specified name from being related ot this event
-     *
-     * @param string $category_name
-     * @return bool
-     */
-    public function remove_event_category($category_name)
-    {
-        return $this->get_model()->remove_event_category($this, $category_name);
-    }
-
-
-    /**
-     * Removes the relation to the specified term taxonomy, and maintains the
-     * data integrity of the term taxonomy provided
-     *
-     * @param EE_Term_Taxonomy $term_taxonomy
-     * @return EE_Base_Class the relation was removed from
-     */
-    public function remove_relation_to_term_taxonomy($term_taxonomy)
-    {
-        if (! $term_taxonomy) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "No Term_Taxonomy provided which to remove from model object of type %s and id %d",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $term_taxonomy->set_count($term_taxonomy->count() - 1);
-        $term_taxonomy->save();
-        return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * The main purpose of this method is to return the post type for the model object
-     *
-     * @access public
-     * @return string
-     */
-    public function post_type()
-    {
-        return $this->get_model()->post_type();
-    }
-
-
-    /**
-     * The main purpose of this method is to return the parent for the model object
-     *
-     * @access public
-     * @return int
-     */
-    public function parent()
-    {
-        return $this->get('parent');
-    }
-
-
-    /**
-     * return the _status property
-     *
-     * @return string
-     */
-    public function status()
-    {
-        return $this->get('status');
-    }
-
-
-    /**
-     * @param string $status
-     */
-    public function set_status($status)
-    {
-        $this->set('status', $status);
-    }
-
-
-    /**
-     * This calls the equivalent model method for retrieving the feature image which in turn is a wrapper for
-     * WordPress' get_the_post_thumbnail() function.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access protected
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    protected function _get_feature_image($size, $attr)
-    {
-        // first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
-        $attr_key = is_array($attr) ? implode('_', $attr) : $attr;
-        $cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
-    }
-
-
-    /**
-     * See _get_feature_image. Returns the HTML to display a featured image
-     *
-     * @param string       $size
-     * @param string|array $attr
-     * @return string of html
-     */
-    public function feature_image($size = 'thumbnail', $attr = '')
-    {
-        return $this->_get_feature_image($size, $attr);
-    }
-
-
-    /**
-     * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
-     * using the given size params.
-     *
-     * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
-     *                            representing width and height in pixels eg. array(32,32).
-     * @return string|boolean          the url of the image or false if not found
-     */
-    public function feature_image_url($size = 'thumbnail')
-    {
-        $attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
-        return ! empty($attachment) ? $attachment[0] : false;
-    }
-
-
-    /**
-     * This is a method for restoring this_obj using details from the given $revision_id
-     *
-     * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
-     *                                 if not included then we just do restore on the meta.
-     *                                 We will accept an array of related_obj_names for restoration here.
-     * @param array $where_query       You can optionally include an array of key=>value pairs
-     *                                 that allow you to further constrict the relation to being added.
-     *                                 However, keep in mind that the columns (keys) given
-     *                                 must match a column on the JOIN table and currently
-     *                                 only the HABTM models accept these additional conditions.
-     *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
-     *                                 then a NEW row is created in the join table.
-     *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
-     *                                 sent);
-     * @return void
-     */
-    public function restore_revision($revision_id, $related_obj_names = array(), $where_query = array())
-    {
-        // get revision object
-        $revision_obj = $this->get_model()->get_one_by_ID($revision_id);
-        if ($revision_obj instanceof EE_CPT_Base) {
-            // no related_obj_name so we assume we're saving a revision on this object.
-            if (empty($related_obj_names)) {
-                $fields = $this->get_model()->get_meta_table_fields();
-                foreach ($fields as $field) {
-                    $this->set($field, $revision_obj->get($field));
-                }
-                $this->save();
-            }
-            $related_obj_names = (array) $related_obj_names;
-            foreach ($related_obj_names as $related_name) {
-                // related_obj_name so we're saving a revision on an object related to this object
-                // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
-                $where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
-                $related_objs = $this->get_many_related($related_name, $where_params);
-                $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
-                // load helper
-                // remove related objs from this object that are not in revision
-                // array_diff *should* work cause I think objects are indexed by ID?
-                $related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
-                foreach ($related_to_remove as $rr) {
-                    $this->_remove_relation_to($rr, $related_name, $cols_n_values);
-                }
-                // add all related objs attached to revision to this object
-                foreach ($revision_related_objs as $r_obj) {
-                    $this->_add_relation_to($r_obj, $related_name, $cols_n_values);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
-     * <li>If $single is set to false, or left blank, the function returns an array containing all values of the
-     * specified key.</li>
-     * <li>If $single is set to true, the function returns the first value of the specified key (not in an
-     * array</li></ul>
-     */
-    public function get_post_meta($meta_key = null, $single = false)
-    {
-        return get_post_meta($this->ID(), $meta_key, $single);
-    }
-
-
-    /**
-     * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $prev_value
-     * @return mixed Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure.
-     *               NOTE: If the meta_value passed to this function is the same as the value that is already in the
-     *               database, this function returns false.
-     */
-    public function update_post_meta($meta_key, $meta_value, $prev_value = null)
-    {
-        if (! $this->ID()) {
-            $this->save();
-        }
-        return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
-    }
-
-
-    /**
-     * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
-     * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given
-     *                 key already exists, in which case false is returned.
-     */
-    public function add_post_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($this->ID()) {
-            $this->save();
-        }
-        return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
-    }
-
-
-    /**
-     * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @return boolean False for failure. True for success.
-     */
-    public function delete_post_meta($meta_key, $meta_value = '')
-    {
-        if (! $this->ID()) {
-            // there are obviously no postmetas for this if it's not saved
-            // so let's just report this as a success
-            return true;
-        }
-        return delete_post_meta($this->ID(), $meta_key, $meta_value);
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end
-     *
-     * @return string
-     */
-    public function get_permalink()
-    {
-        return get_permalink($this->ID());
-    }
-
-
-    /**
-     * Gets all the term-taxonomies for this CPT
-     *
-     * @param array $query_params
-     * @return EE_Term_Taxonomy
-     */
-    public function term_taxonomies($query_params = array())
-    {
-        return $this->get_many_related('Term_Taxonomy', $query_params);
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_custom_post_statuses()
-    {
-        return $this->get_model()->get_custom_post_statuses();
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_all_post_statuses()
-    {
-        return $this->get_model()->get_status_array();
-    }
-
-
-    /**
-     * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties_to_serialize = parent::__sleep();
-        $properties_to_serialize = array_diff($properties_to_serialize, array('_wp_post'));
-        return $properties_to_serialize;
-    }
+	/**
+	 * This is a property for holding cached feature images on CPT objects.  Cache's are set on the first
+	 * "feature_image()" method call.  Each key in the array corresponds to the requested size.
+	 *
+	 * @var array
+	 */
+	protected $_feature_image = array();
+
+	/**
+	 * @var WP_Post the WP_Post that corresponds with this CPT model object
+	 */
+	protected $_wp_post;
+
+
+	abstract public function wp_user();
+
+
+	/**
+	 * Returns the WP post associated with this CPT model object. If this CPT is saved, fetches it
+	 * from the DB. Otherwise, create an unsaved WP_POst object. Caches the post internally.
+	 *
+	 * @return WP_Post
+	 */
+	public function wp_post()
+	{
+		global $wpdb;
+		if (! $this->_wp_post instanceof WP_Post) {
+			if ($this->ID()) {
+				$this->_wp_post = get_post($this->ID());
+			} else {
+				$simulated_db_result = new stdClass();
+				foreach ($this->get_model()->field_settings(true) as $field_name => $field_obj) {
+					if ($this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())->get_table_name()
+						=== $wpdb->posts
+					) {
+						$column = $field_obj->get_table_column();
+
+						if ($field_obj instanceof EE_Datetime_Field) {
+							$value_on_model_obj = $this->get_DateTime_object($field_name);
+						} elseif ($field_obj->is_db_only_field()) {
+							$value_on_model_obj = $field_obj->get_default_value();
+						} else {
+							$value_on_model_obj = $this->get_raw($field_name);
+						}
+						$simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
+					}
+				}
+				$this->_wp_post = new WP_Post($simulated_db_result);
+			}
+			// and let's make retrieving the EE CPT object easy too
+			$classname = get_class($this);
+			if (! isset($this->_wp_post->{$classname})) {
+				$this->_wp_post->{$classname} = $this;
+			}
+		}
+		return $this->_wp_post;
+	}
+
+	/**
+	 * When fetching a new value for a post field that uses the global $post for rendering,
+	 * set the global $post temporarily to be this model object; and afterwards restore it
+	 *
+	 * @param string $fieldname
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref
+	 * @return mixed
+	 */
+	protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		global $post;
+
+		if ($pretty
+			&& (
+				! (
+					$post instanceof WP_Post
+					&& $post->ID
+				)
+				|| (int) $post->ID !== $this->ID()
+			)
+			&& $this->get_model()->field_settings_for($fieldname) instanceof EE_Post_Content_Field) {
+			$old_post = $post;
+			$post = $this->wp_post();
+			$return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+			$post = $old_post;
+		} else {
+			$return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+		}
+		return $return_value;
+	}
+
+	/**
+	 * Adds to the specified event category. If it category doesn't exist, creates it.
+	 *
+	 * @param string $category_name
+	 * @param string $category_description    optional
+	 * @param int    $parent_term_taxonomy_id optional
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
+	{
+		return $this->get_model()->add_event_category(
+			$this,
+			$category_name,
+			$category_description,
+			$parent_term_taxonomy_id
+		);
+	}
+
+
+	/**
+	 * Removes the event category by specified name from being related ot this event
+	 *
+	 * @param string $category_name
+	 * @return bool
+	 */
+	public function remove_event_category($category_name)
+	{
+		return $this->get_model()->remove_event_category($this, $category_name);
+	}
+
+
+	/**
+	 * Removes the relation to the specified term taxonomy, and maintains the
+	 * data integrity of the term taxonomy provided
+	 *
+	 * @param EE_Term_Taxonomy $term_taxonomy
+	 * @return EE_Base_Class the relation was removed from
+	 */
+	public function remove_relation_to_term_taxonomy($term_taxonomy)
+	{
+		if (! $term_taxonomy) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"No Term_Taxonomy provided which to remove from model object of type %s and id %d",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$term_taxonomy->set_count($term_taxonomy->count() - 1);
+		$term_taxonomy->save();
+		return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the post type for the model object
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function post_type()
+	{
+		return $this->get_model()->post_type();
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the parent for the model object
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function parent()
+	{
+		return $this->get('parent');
+	}
+
+
+	/**
+	 * return the _status property
+	 *
+	 * @return string
+	 */
+	public function status()
+	{
+		return $this->get('status');
+	}
+
+
+	/**
+	 * @param string $status
+	 */
+	public function set_status($status)
+	{
+		$this->set('status', $status);
+	}
+
+
+	/**
+	 * This calls the equivalent model method for retrieving the feature image which in turn is a wrapper for
+	 * WordPress' get_the_post_thumbnail() function.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access protected
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	protected function _get_feature_image($size, $attr)
+	{
+		// first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
+		$attr_key = is_array($attr) ? implode('_', $attr) : $attr;
+		$cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
+		$this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
+			? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+		return $this->_feature_image[ $cache_key ];
+	}
+
+
+	/**
+	 * See _get_feature_image. Returns the HTML to display a featured image
+	 *
+	 * @param string       $size
+	 * @param string|array $attr
+	 * @return string of html
+	 */
+	public function feature_image($size = 'thumbnail', $attr = '')
+	{
+		return $this->_get_feature_image($size, $attr);
+	}
+
+
+	/**
+	 * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
+	 * using the given size params.
+	 *
+	 * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
+	 *                            representing width and height in pixels eg. array(32,32).
+	 * @return string|boolean          the url of the image or false if not found
+	 */
+	public function feature_image_url($size = 'thumbnail')
+	{
+		$attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
+		return ! empty($attachment) ? $attachment[0] : false;
+	}
+
+
+	/**
+	 * This is a method for restoring this_obj using details from the given $revision_id
+	 *
+	 * @param int   $revision_id       ID of the revision we're getting data from
+	 * @param array $related_obj_names if included this will be used to restore for related obj
+	 *                                 if not included then we just do restore on the meta.
+	 *                                 We will accept an array of related_obj_names for restoration here.
+	 * @param array $where_query       You can optionally include an array of key=>value pairs
+	 *                                 that allow you to further constrict the relation to being added.
+	 *                                 However, keep in mind that the columns (keys) given
+	 *                                 must match a column on the JOIN table and currently
+	 *                                 only the HABTM models accept these additional conditions.
+	 *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
+	 *                                 then a NEW row is created in the join table.
+	 *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
+	 *                                 sent);
+	 * @return void
+	 */
+	public function restore_revision($revision_id, $related_obj_names = array(), $where_query = array())
+	{
+		// get revision object
+		$revision_obj = $this->get_model()->get_one_by_ID($revision_id);
+		if ($revision_obj instanceof EE_CPT_Base) {
+			// no related_obj_name so we assume we're saving a revision on this object.
+			if (empty($related_obj_names)) {
+				$fields = $this->get_model()->get_meta_table_fields();
+				foreach ($fields as $field) {
+					$this->set($field, $revision_obj->get($field));
+				}
+				$this->save();
+			}
+			$related_obj_names = (array) $related_obj_names;
+			foreach ($related_obj_names as $related_name) {
+				// related_obj_name so we're saving a revision on an object related to this object
+				// do we have $where_query params for this related object?  If we do then we include that.
+				$cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
+				$where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
+				$related_objs = $this->get_many_related($related_name, $where_params);
+				$revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
+				// load helper
+				// remove related objs from this object that are not in revision
+				// array_diff *should* work cause I think objects are indexed by ID?
+				$related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
+				foreach ($related_to_remove as $rr) {
+					$this->_remove_relation_to($rr, $related_name, $cols_n_values);
+				}
+				// add all related objs attached to revision to this object
+				foreach ($revision_related_objs as $r_obj) {
+					$this->_add_relation_to($r_obj, $related_name, $cols_n_values);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
+	 * <li>If $single is set to false, or left blank, the function returns an array containing all values of the
+	 * specified key.</li>
+	 * <li>If $single is set to true, the function returns the first value of the specified key (not in an
+	 * array</li></ul>
+	 */
+	public function get_post_meta($meta_key = null, $single = false)
+	{
+		return get_post_meta($this->ID(), $meta_key, $single);
+	}
+
+
+	/**
+	 * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $prev_value
+	 * @return mixed Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure.
+	 *               NOTE: If the meta_value passed to this function is the same as the value that is already in the
+	 *               database, this function returns false.
+	 */
+	public function update_post_meta($meta_key, $meta_value, $prev_value = null)
+	{
+		if (! $this->ID()) {
+			$this->save();
+		}
+		return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
+	}
+
+
+	/**
+	 * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
+	 * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given
+	 *                 key already exists, in which case false is returned.
+	 */
+	public function add_post_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($this->ID()) {
+			$this->save();
+		}
+		return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
+	}
+
+
+	/**
+	 * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @return boolean False for failure. True for success.
+	 */
+	public function delete_post_meta($meta_key, $meta_value = '')
+	{
+		if (! $this->ID()) {
+			// there are obviously no postmetas for this if it's not saved
+			// so let's just report this as a success
+			return true;
+		}
+		return delete_post_meta($this->ID(), $meta_key, $meta_value);
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end
+	 *
+	 * @return string
+	 */
+	public function get_permalink()
+	{
+		return get_permalink($this->ID());
+	}
+
+
+	/**
+	 * Gets all the term-taxonomies for this CPT
+	 *
+	 * @param array $query_params
+	 * @return EE_Term_Taxonomy
+	 */
+	public function term_taxonomies($query_params = array())
+	{
+		return $this->get_many_related('Term_Taxonomy', $query_params);
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_custom_post_statuses()
+	{
+		return $this->get_model()->get_custom_post_statuses();
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_all_post_statuses()
+	{
+		return $this->get_model()->get_status_array();
+	}
+
+
+	/**
+	 * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties_to_serialize = parent::__sleep();
+		$properties_to_serialize = array_diff($properties_to_serialize, array('_wp_post'));
+		return $properties_to_serialize;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -40,7 +40,7 @@ 
     public function wp_post()
     {
         global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
+        if ( ! $this->_wp_post instanceof WP_Post) {
             if ($this->ID()) {
                 $this->_wp_post = get_post($this->ID());
             } else {
@@ -65,7 +65,7 @@ 
             }
             // and let's make retrieving the EE CPT object easy too
             $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
+            if ( ! isset($this->_wp_post->{$classname})) {
                 $this->_wp_post->{$classname} = $this;
             }
         }
@@ -144,7 +144,7 @@ 
      */
     public function remove_relation_to_term_taxonomy($term_taxonomy)
     {
-        if (! $term_taxonomy) {
+        if ( ! $term_taxonomy) {
             EE_Error::add_error(
                 sprintf(
                     __(
@@ -225,10 +225,10 @@ 
     {
         // first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
         $attr_key = is_array($attr) ? implode('_', $attr) : $attr;
-        $cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
+        $cache_key = is_array($size) ? implode('_', $size).$attr_key : $size.$attr_key;
+        $this->_feature_image[$cache_key] = isset($this->_feature_image[$cache_key])
+            ? $this->_feature_image[$cache_key] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+        return $this->_feature_image[$cache_key];
     }
 
 
@@ -295,7 +295,7 @@ 
             foreach ($related_obj_names as $related_name) {
                 // related_obj_name so we're saving a revision on an object related to this object
                 // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
+                $cols_n_values = isset($where_query[$related_name]) ? $where_query[$related_name] : array();
                 $where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
                 $related_objs = $this->get_many_related($related_name, $where_params);
                 $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
@@ -344,7 +344,7 @@ 
      */
     public function update_post_meta($meta_key, $meta_value, $prev_value = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $this->save();
         }
         return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
@@ -378,7 +378,7 @@ 
      */
     public function delete_post_meta($meta_key, $meta_value = '')
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             // there are obviously no postmetas for this if it's not saved
             // so let's just report this as a success
             return true;

core/db_classes/EE_Ticket_Price.class.php

Indentation +19 added lines, -19 removed lines

@@ -11,25 +11,25 @@
 class EE_Ticket_Price extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Price|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Price|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
 
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Price
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Price
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Ticket_Template.class.php

Indentation +19 added lines, -19 removed lines

@@ -12,25 +12,25 @@
 class EE_Ticket_Template extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
 
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }