<?php

/**
 * EE_Recipient_Details_Shortcodes
 *
 * this is a child class for the EE_Shortcodes library.  The EE_Recipient_Details_Shortcodes lists all shortcodes
 * related to recipient specific info.  Meaning, that when this is parsed, we're parsing for WHO is receiving the
 * message.  This only parses for Registrants and Primary Registrants as recipients.
 *
 * NOTE: if a method doesn't have any phpdoc commenting the details can be found in the comments in EE_Shortcodes
 * parent class.
 *
 * @package        Event Espresso
 * @subpackage     libraries/shortcodes/EE_Recipient_Details_Shortcodes.lib.php
 * @author         Darren Ethier
 *
 * ------------------------------------------------------------------------
 */
class EE_Recipient_Details_Shortcodes extends EE_Shortcodes
{

    protected $_recipient;

    protected $_registrations_for_recipient;


    protected function _init_props()
    {
        $this->label = esc_html__('Recipient Details Shortcodes', 'event_espresso');
        $this->description = esc_html__('All shortcodes specific to recipient registration data', 'event_espresso');
        $this->_shortcodes = array(
            '[RECIPIENT_FNAME]'                  => esc_html__(
                'Parses to the first name of the recipient for the message.',
                'event_espresso'
            ),
            '[RECIPIENT_LNAME]'                  => esc_html__(
                'Parses to the last name of the recipient for the message.',
                'event_espresso'
            ),
            '[RECIPIENT_EMAIL]'                  => esc_html__(
                'Parses to the email address of the recipient for the message.',
                'event_espresso'
            ),
            '[RECIPIENT_REGISTRATION_ID]'        => esc_html__(
                'Parses to the registration ID of the recipient for the message.',
                'event_espresso'
            ),
            '[RECIPIENT_REGISTRATION_CODE]'      => esc_html__(
                'Parses to the registration code of the recipient for the message.',
                'event_espresso'
            ),
            '[RECIPIENT_EDIT_REGISTRATION_LINK]' => esc_html__(
                'Parses to a link for frontend editing of the registration for the recipient.',
                'event_espresso'
            ),
            '[RECIPIENT_PHONE_NUMBER]'           => esc_html__(
                'The Phone Number for the recipient of the message.',
                'event_espresso'
            ),
            '[RECIPIENT_ADDRESS]'                => esc_html__(
                'The Address for the recipient of the message.',
                'event_espresso'
            ),
            '[RECIPIENT_ADDRESS2]'               => esc_html__(
                'Whatever was in the address 2 field for the recipient of the message.',
                'event_espresso'
            ),
            '[RECIPIENT_CITY]'                   => esc_html__(
                'The city for the recipient of the message.',
                'event_espresso'
            ),
            '[RECIPIENT_ZIP_PC]'                 => esc_html__(
                'The ZIP (or Postal) Code for the recipient of the message.',
                'event_espresso'
            ),
            '[RECIPIENT_ADDRESS_STATE]'          => esc_html__(
                'The state/province for the recipient of the message.',
                'event_espresso'
            ),
            '[RECIPIENT_COUNTRY]'                => esc_html__(
                'The country for the recipient of the message.',
                'event_espresso'
            ),
            '[RECIPIENT_ANSWER_*]'               => esc_html__(
                'This is a special dynamic shortcode.  After the "*", add the exact text of an existing question, and if there is an answer for that question for this recipient, then it will be output in place of this shortcode.',
                'event_espresso'
            ),
            '[RECIPIENT_TOTAL_AMOUNT_PAID]'      => esc_html__(
                'If a single registration related to the recipient is available, that is used to retrieve the total amount that has been paid for this recipient.  Otherwise the value of 0 is printed.',
                'event_espresso'
            ),
        );
    }


    /**
     * @access protected
     * @param  string $shortcode the shortcode to be parsed.
     * @return string parsed shortcode
     */
    protected function _parser($shortcode)
    {

        // make sure we end up with a copy of the EE_Messages_Addressee object
        $this->_recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
        $this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
                            && is_array($this->_data)
                            && isset($this->_data['data'])
                            && $this->_data['data'] instanceof EE_Messages_Addressee
            ? $this->_data['data']
            :
            $this->_recipient;
        $this->_recipient = ! $this->_recipient instanceof EE_Messages_Addressee
                            && ! empty($this->_extra_data['data'])
                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
            ? $this->_extra_data['data']
            : $this->_recipient;

        if (! $this->_recipient instanceof EE_Messages_Addressee) {
            return '';
        }

        $attendee = $this->_recipient->att_obj;
        if (! $attendee instanceof EE_Attendee) {
            return '';
        }

        $this->_registrations_for_recipient = isset($this->_recipient->attendees[ $attendee->ID() ]['reg_objs'])
            ? $this->_recipient->attendees[ $attendee->ID() ]['reg_objs']
            : array();

        switch ($shortcode) {
            case '[RECIPIENT_FNAME]':
                return $attendee->fname();
                break;

            case '[RECIPIENT_LNAME]':
                return $attendee->lname();
                break;

            case '[RECIPIENT_EMAIL]':
                return $attendee->email();
                break;

            case '[RECIPIENT_REGISTRATION_ID]':
                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
                    return '';
                }
                return $this->_get_reg_id();
                break;

            case '[RECIPIENT_REGISTRATION_CODE]':
                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
                    return '';
                }
                return $this->_get_reg_code();
                break;

            case '[RECIPIENT_EDIT_REGISTRATION_LINK]':
                if (! $this->_recipient->reg_obj instanceof EE_Registration) {
                    return '';
                }
                return $this->_recipient->reg_obj->edit_attendee_information_url();
                break;

            case '[RECIPIENT_PHONE_NUMBER]':
                return $attendee->phone();
                break;

            case '[RECIPIENT_ADDRESS]':
                return $attendee->address();
                break;

            case '[RECIPIENT_ADDRESS2]':
                return $attendee->address2();
                break;

            case '[RECIPIENT_CITY]':
                return $attendee->city();
                break;

            case '[RECIPIENT_ZIP_PC]':
                return $attendee->zip();
                break;

            case '[RECIPIENT_ADDRESS_STATE]':
                $state_obj = $attendee->state_obj();
                return $state_obj instanceof EE_State ? $state_obj->name() : '';
                break;

            case '[RECIPIENT_COUNTRY]':
                $country_obj = $attendee->country_obj();
                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
                break;
            case '[RECIPIENT_TOTAL_AMOUNT_PAID]':
                return $this->_recipient->reg_obj instanceof EE_Registration
                    ? $this->_recipient->reg_obj->pretty_paid()
                    : 0;
                break;
        }

        if (strpos($shortcode, '[RECIPIENT_ANSWER_*') !== false) {
            $shortcode = str_replace('[RECIPIENT_ANSWER_*', '', $shortcode);
            $shortcode = trim(str_replace(']', '', $shortcode));


            // now let's figure out what question has this text
            if (empty($this->_recipient->questions) || ! $this->_recipient->reg_obj instanceof EE_Registration) {
                return '';
            }

            foreach ($this->_recipient->questions as $ansid => $question) {
                if ($question instanceof EE_Question
                    && trim($question->display_text()) === trim($shortcode)
                    && isset($this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ])
                ) {
                    $recipient_ansid = $this->_recipient->registrations[ $this->_recipient->reg_obj->ID() ]['ans_objs'][ $ansid ];
                    
                    // what we show for the answer depends on the question type!
                    switch ($question->get('QST_type')) {
                        case EEM_Question::QST_type_state:
                            $state = EEM_State::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
                            $answer = $state instanceof EE_State ? $state->name() : '';
                            break;
    
                        case EEM_Question::QST_type_country:
                            $country = EEM_Country::instance()->get_one_by_ID($recipient_ansid->get('ANS_value'));
                            $answer = $country instanceof EE_Country ? $country->name() : '';
                            break;
    
                        default:
                            $answer = $recipient_ansid->get_pretty('ANS_value', 'no_wpautop');
                            break;
                    }
                    
                    return $answer;
                    break;
                }
            }
        }

        return '';
    }


    /**
     * Returns the EE_Messages_Addressee object for the recipient.
     *
     * @since 4.5.0
     *
     * @return EE_Messages_Addressee
     */
    public function get_recipient()
    {
        return $this->_recipient;
    }


    /**
     * returns the reg code for the recipient depending on the context and whether the recipient has multiple
     * registrations or not.
     *
     * @return string
     */
    protected function _get_reg_code()
    {

        // if only one related registration for the recipient then just return that reg code.
        if (count($this->_registrations_for_recipient) <= 1) {
            return $this->_recipient->reg_obj->reg_code();
        }

        // k more than one registration so let's see if we can get specific to context
        // are we parsing event_list?
        if ($this->_data instanceof EE_Event) {
            $reg_code = array();
            // loop through registrations for recipient and see if there is a match for this event
            foreach ($this->_registrations_for_recipient as $reg) {
                if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
                    $reg_code[] = $reg->reg_code();
                }
            }
            return implode(', ', $reg_code);
        }

        // are we parsing ticket list?
        if ($this->_data instanceof EE_Ticket) {
            $reg_code = array();
            // loop through each registration for recipient and see if there is a match for this ticket
            foreach ($this->_registrations_for_recipient as $reg) {
                if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
                    $reg_code = $reg->reg_code();
                }
            }
            return implode(', ', $reg_code);
        }

        // do we have a specific reg_obj?  Let's use it
        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
            return $this->_data->reg_obj->reg_code();
        }

        // do we have a specific reg_obj?  Let's use it
        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
            return $this->_data->reg_obj->reg_code();
        }

        // not able to determine the single reg code so let's return a comma delimited list of reg codes.
        $reg_code = array();
        foreach ($this->_registrations_for_recipient as $reg) {
            if ($reg instanceof EE_Registration) {
                $reg_code[] = $reg->reg_code();
            }
        }
        return implode(', ', $reg_code);
    }


    /**
     * returns the reg ID for the recipient depending on the context and whether the recipient has multiple
     * registrations or not.
     *
     * @return int|string
     */
    protected function _get_reg_id()
    {

        // if only one related registration for the recipient then just return that reg code.
        if (count($this->_registrations_for_recipient) <= 1) {
            return $this->_recipient->reg_obj->ID();
        }

        // k more than one registration so let's see if we can get specific to context
        // are we parsing event_list?
        if ($this->_data instanceof EE_Event) {
            $registration_ids = array();
            // loop through registrations for recipient and see if there is a match for this event
            foreach ($this->_registrations_for_recipient as $reg) {
                if ($reg instanceof EE_Registration && $reg->event_ID() == $this->_data->ID()) {
                    $registration_ids[] = $reg->ID();
                }
            }
            return implode(', ', $registration_ids);
        }

        // are we parsing ticket list?
        if ($this->_data instanceof EE_Ticket) {
            $registration_ids = array();
            // loop through each registration for recipient and see if there is a match for this ticket
            foreach ($this->_registrations_for_recipient as $reg) {
                if ($reg instanceof EE_Registration && $reg->ticket_ID() == $this->_data->ID()) {
                    $registration_ids = $reg->ID();
                }
            }
            return implode(', ', $registration_ids);
        }

        // do we have a specific reg_obj?  Let's use it
        if ($this->_data instanceof EE_Messages_Addressee && $this->_data->reg_obj instanceof EE_Registration) {
            return $this->_data->reg_obj->ID();
        }

        // not able to determine the single reg code so let's return a comma delimited list of reg codes.
        $registration_ids = array();
        foreach ($this->_registrations_for_recipient as $reg) {
            if ($reg instanceof EE_Registration) {
                $registration_ids[] = $reg->ID();
            }
        }
        return implode(', ', $registration_ids);
    }
}
