EventEspresso\core\domain\services\registration\form\v1\RegistrantData

Complexity

Total Complexity

38

Size/Duplication

Total Lines	354
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	initializeRegistrantData()	0	8	1
A	attendeeCount()	0	4	1
A	copyPrimary()	0	4	1
A	setCopyPrimary()	0	4	1
A	getRegistrant()	0	4	1
A	getRegistrantData()	0	4	1
A	addRegistrantDataValue()	0	4	1
B	ensureCriticalRegistrantDataIsSet()	0	34	6
A	setRegistrantData()	0	4	1
A	getRequiredQuestions()	0	4	1
A	addRequiredQuestion()	0	4	1
A	registrantAnswers()	0	4	1
A	addRegistrantAnswer()	0	4	1
A	getRegistrantAnswer()	0	4	1
A	registrantAnswerIsObject()	0	5	1
A	primaryRegistrantData()	0	4	1
A	addPrimaryRegistrantDataValue()	0	4	1
A	getPrimaryRegistrantDataValue()	0	4	1
A	setPrimaryRegistrantData()	0	4	1
A	primaryRegistrant()	0	4	1
A	primaryRegistrantIsValid()	0	4	1
A	setPrimaryRegistrant()	0	4	1
A	currentRegistrantIsPrimary()	0	9	4
A	currentRegistrantIsNotPrimary()	0	4	1
A	saveOrCopyPrimaryRegistrantData()	0	13	5

<?php

namespace EventEspresso\core\domain\services\registration\form\v1;

use EE_Answer;
use EE_Attendee;
use EE_Error;
use EE_Registration;
use ReflectionException;

/**
 * Class RegistrantData
 * DTO for tracking and sharing data during the registration process
 *
 * @author  Brent Christensen
 * @package EventEspresso\core\domain\services\registration\form\v1
 * @since   $VID:$
 */
class RegistrantData
{

    /**
     * @var int
     */
    private $attendee_counter = 0;

    /**
     * @var array
     */
    private $registrant_data = [];

    /**
     * @var bool
     */
    private $copy_primary = false;

    /**
     * @var array
     */
    private $required_questions = [];

    /**
     * @var EE_Registration[]
     */
    private $registrations = [];

    /**
     * @var EE_Answer[][]
     */
    private $registrant_answers = [];

    /**
     * array for tracking reg form data for the primary registrant
     *
     * @var array
     */
    private $primary_registrant_data;

    /**
     * the attendee object created for the primary registrant
     *
     * @var EE_Attendee
     */
    private $primary_registrant;


    /**
     * RegistrantData constructor.
     */
    public function __construct()
    {
        $this->primary_registrant_data = ['line_item_id' => null,];
    }


    /**
     * @param EE_Registration $registration
     * @throws EE_Error
     */
    public function initializeRegistrantData(EE_Registration $registration): void
    {
        $reg_url_link = $registration->reg_url_link();
        $this->registrations[ $reg_url_link ] = $registration;
        $this->registrant_answers[ $reg_url_link ] = $registration->answers();
        $this->registrant_data[ $reg_url_link ] = [];
        $this->attendee_counter++;
    }


    /**
     * @return int
     */
    public function attendeeCount(): int
    {
        return $this->attendee_counter;
    }


    /**
     * @return bool
     */
    public function copyPrimary(): bool
    {
        return $this->copy_primary;
    }


    /**
     * @param bool $copy_primary
     */
    public function setCopyPrimary(bool $copy_primary): void
    {
        $this->copy_primary = filter_var($copy_primary, FILTER_VALIDATE_BOOLEAN);
    }


    /**
     * @param string $reg_url_link
     * @return array|null
     */
    public function getRegistrant(string $reg_url_link): ?EE_Registration
    {
        return $this->registrations[ $reg_url_link ] ?? null;
    }


    /**
     * @param string $reg_url_link
     * @return array|null
     */
    public function getRegistrantData(string $reg_url_link): ?array
    {
        return $this->registrant_data[ $reg_url_link ] ?? null;
    }


    /**
     * @param string $reg_url_link
     * @param string $key
     * @param mixed $value
     */
    public function addRegistrantDataValue(string $reg_url_link, string $key, $value): void
    {
        $this->registrant_data[ $reg_url_link ][ $key ] = $value;
    }


    /**
     * ensures that all attendees at least have data for first name, last name, and email address
     *
     * @param string $reg_url_link
     * @throws EE_Error
     * @throws ReflectionException
     */
    public function ensureCriticalRegistrantDataIsSet(string $reg_url_link): void {
        if ($this->currentRegistrantIsPrimary()) {
            return;
        }
        // bare minimum critical details include first name, last name, email address
        $critical_attendee_details = ['ATT_fname', 'ATT_lname', 'ATT_email'];
        // add address info to critical details?
        if (
        apply_filters(
            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
            false
        )
        ) {
            $critical_attendee_details += [
                'ATT_address',
                'ATT_address2',
                'ATT_city',
                'STA_ID',
                'CNT_ISO',
                'ATT_zip',
                'ATT_phone',
            ];
        }
        foreach ($critical_attendee_details as $critical_attendee_detail) {
            if (
                ! isset($this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ])
                || empty($this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ])
            ) {
                $this->registrant_data[ $reg_url_link ][ $critical_attendee_detail ] = $this->primary_registrant->get(
                    $critical_attendee_detail
                );
            }
        }
    }


    /**
     * @param string $reg_url_link
     * @param array $registrant_data
     */
    public function setRegistrantData(string $reg_url_link, array $registrant_data): void
    {
        $this->registrant_data[ $reg_url_link ] = $registrant_data;
    }


    /**
     * @return array
     */
    public function getRequiredQuestions(): array
    {
        return $this->required_questions;
    }


    /**
     * @param string $identifier
     * @param string $required_question
     */
    public function addRequiredQuestion(string $identifier, string $required_question): void
    {
        $this->required_questions[ $identifier ] = $required_question;
    }


    /**
     * @return EE_Answer[]
     */
    public function registrantAnswers(string $reg_url_link): array
    {
        return $this->registrant_answers[ $reg_url_link ] ?? [];
    }


    /**
     * @param string $reg_url_link
     * @param string $identifier  the answer cache ID
     * @param EE_Answer $answer
     */
    public function addRegistrantAnswer(string $reg_url_link, string $identifier, EE_Answer $answer): void
    {
        $this->registrant_answers[ $reg_url_link ][ $identifier ] = $answer;
    }


    /**
     * @param string $reg_url_link
     * @param string $identifier
     * @return EE_Answer|null
     */
    public function getRegistrantAnswer(string $reg_url_link, string $identifier): ?EE_Answer
    {
        return $this->registrant_answers[ $reg_url_link ][ $identifier ] ?? null;
    }



    /**
     * @param string $reg_url_link
     * @param string $identifier
     * @return bool
     */
    public function registrantAnswerIsObject(string $reg_url_link, string $identifier): bool
    {
        $registrant_answer = $this->getRegistrantAnswer($reg_url_link, $identifier);
        return $registrant_answer instanceof EE_Answer;
    }


    /**
     * @return array
     */
    public function primaryRegistrantData(): array
    {
        return $this->primary_registrant_data;
    }


    /**
     * @param string $key
     * @param mixed  $value
     */
    public function addPrimaryRegistrantDataValue(string $key, $value): void
    {
        $this->primary_registrant_data[ $key ] = $value;
    }


    /**
     * @param string $key
     * @return mixed
     */
    public function getPrimaryRegistrantDataValue(string $key)
    {
        return $this->primary_registrant_data[ $key ] ?? null;
    }


    /**
     * @param array $primary_registrant_data
     */
    public function setPrimaryRegistrantData(array $primary_registrant_data): void
    {
        $this->primary_registrant_data = $primary_registrant_data;
    }


    /**
     * @return EE_Attendee
     */
    public function primaryRegistrant(): EE_Attendee
    {
        return $this->primary_registrant;
    }


    /**
     * @return bool
     */
    public function primaryRegistrantIsValid(): bool
    {
        return $this->primary_registrant instanceof EE_Attendee;
    }


    /**
     * @param EE_Attendee $primary_registrant
     */
    public function setPrimaryRegistrant(EE_Attendee $primary_registrant): void
    {
        $this->primary_registrant = $primary_registrant;
    }


    /**
     * @param string $reg_url_link
     * @return bool
     */
    public function currentRegistrantIsPrimary(string $reg_url_link = ''): bool
    {
        return $this->attendeeCount() === 1
            || (
                $this->attendeeCount() === 1
                && $reg_url_link !== ''
                && $this->getPrimaryRegistrantDataValue('reg_url_link') === $reg_url_link
           );
    }


    /**
     * @return bool
     */
    public function currentRegistrantIsNotPrimary(): bool
    {
        return $this->attendeeCount() > 1;
    }


    /**
     * @param string $reg_url_link
     * @param string $form_input
     * @param mixed  $input_value
     * @return mixed|null
     */
    public function saveOrCopyPrimaryRegistrantData(string $reg_url_link, string $form_input, $input_value)
    {
        // store a bit of data about the primary attendee
        if (! empty($input_value) && $this->currentRegistrantIsPrimary($reg_url_link)) {
            $this->primary_registrant_data[ $form_input ] = $input_value;
            return $input_value;
        }
        // or copy value from primary if incoming value is not set
        if ($input_value === null && $this->copyPrimary()) {
            $input_value = $this->getPrimaryRegistrantDataValue($form_input);
        }
        return $input_value;
    }
}