eventespresso / event-espresso-core

core/domain/services/registration/CreateRegistrationService.php

Spacing +2 added lines, -2 removed lines

@@ -70,14 +70,14 @@
                 'REG_code'        => $reg_code,
             )
         );
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new UnexpectedEntityException($registration, 'EE_Registration');
         }
         // save registration so that we have an ID
         $registration->save();
         // track reservation on reg but don't adjust ticket and datetime reserved counts
         // because that is done as soon as the tickets are added/removed from the cart
-        $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
+        $registration->reserve_ticket(false, 'CreateRegistrationService:'.__LINE__);
         $registration->_add_relation_to($event, 'Event', array(), $event->ID());
         $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
         $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());

Indentation +94 added lines, -94 removed lines

@@ -27,102 +27,102 @@
  */
 class CreateRegistrationService extends DomainService
 {
-    /**
-     * @param EE_Event        $event
-     * @param EE_Transaction  $transaction
-     * @param EE_Ticket       $ticket
-     * @param EE_Line_Item    $ticket_line_item
-     * @param                 $reg_count
-     * @param                 $reg_group_size
-     * @param string          $reg_status
-     * @return EE_Registration
-     * @throws OutOfRangeException
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function create(
-        EE_Event $event,
-        EE_Transaction $transaction,
-        EE_Ticket $ticket,
-        EE_Line_Item $ticket_line_item,
-        $reg_count,
-        $reg_group_size,
-        $reg_status = EEM_Registration::status_id_incomplete
-    ) {
-        $registrations = $transaction->registrations();
-        $reg_count = $reg_count ? $reg_count : count($registrations) + 1;
-        $reg_url_link = new RegUrlLink($reg_count, $ticket_line_item);
-        $reg_code = new RegCode($reg_url_link, $transaction, $ticket);
-        // generate new EE_Registration
-        $registration = EE_Registration::new_instance(
-            array(
-                'EVT_ID'          => $event->ID(),
-                'TXN_ID'          => $transaction->ID(),
-                'TKT_ID'          => $ticket->ID(),
-                'STS_ID'          => $reg_status,
-                'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item),
-                'REG_session'     => EE_Registry::instance()->SSN->id(),
-                'REG_count'       => $reg_count,
-                'REG_group_size'  => $reg_group_size ? $reg_group_size : $this->incrementRegGroupSize($registrations),
-                'REG_url_link'    => $reg_url_link,
-                'REG_code'        => $reg_code,
-            )
-        );
-        if (! $registration instanceof EE_Registration) {
-            throw new UnexpectedEntityException($registration, 'EE_Registration');
-        }
-        // save registration so that we have an ID
-        $registration->save();
-        // track reservation on reg but don't adjust ticket and datetime reserved counts
-        // because that is done as soon as the tickets are added/removed from the cart
-        $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
-        $registration->_add_relation_to($event, 'Event', array(), $event->ID());
-        $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
-        $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());
-        $registration->save();
-        return $registration;
-    }
+	/**
+	 * @param EE_Event        $event
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Ticket       $ticket
+	 * @param EE_Line_Item    $ticket_line_item
+	 * @param                 $reg_count
+	 * @param                 $reg_group_size
+	 * @param string          $reg_status
+	 * @return EE_Registration
+	 * @throws OutOfRangeException
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function create(
+		EE_Event $event,
+		EE_Transaction $transaction,
+		EE_Ticket $ticket,
+		EE_Line_Item $ticket_line_item,
+		$reg_count,
+		$reg_group_size,
+		$reg_status = EEM_Registration::status_id_incomplete
+	) {
+		$registrations = $transaction->registrations();
+		$reg_count = $reg_count ? $reg_count : count($registrations) + 1;
+		$reg_url_link = new RegUrlLink($reg_count, $ticket_line_item);
+		$reg_code = new RegCode($reg_url_link, $transaction, $ticket);
+		// generate new EE_Registration
+		$registration = EE_Registration::new_instance(
+			array(
+				'EVT_ID'          => $event->ID(),
+				'TXN_ID'          => $transaction->ID(),
+				'TKT_ID'          => $ticket->ID(),
+				'STS_ID'          => $reg_status,
+				'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item),
+				'REG_session'     => EE_Registry::instance()->SSN->id(),
+				'REG_count'       => $reg_count,
+				'REG_group_size'  => $reg_group_size ? $reg_group_size : $this->incrementRegGroupSize($registrations),
+				'REG_url_link'    => $reg_url_link,
+				'REG_code'        => $reg_code,
+			)
+		);
+		if (! $registration instanceof EE_Registration) {
+			throw new UnexpectedEntityException($registration, 'EE_Registration');
+		}
+		// save registration so that we have an ID
+		$registration->save();
+		// track reservation on reg but don't adjust ticket and datetime reserved counts
+		// because that is done as soon as the tickets are added/removed from the cart
+		$registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
+		$registration->_add_relation_to($event, 'Event', array(), $event->ID());
+		$registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
+		$transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());
+		$registration->save();
+		return $registration;
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param EE_Ticket      $ticket
-     * @param EE_Line_Item   $ticket_line_item
-     * @return float
-     * @throws EE_Error
-     * @throws OutOfRangeException
-     */
-    protected function resolveFinalPrice(
-        EE_Transaction $transaction,
-        EE_Ticket $ticket,
-        EE_Line_Item $ticket_line_item
-    ) {
-        $final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item(
-            $transaction->total_line_item(),
-            $ticket_line_item
-        );
-        $final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes();
-        return (float) $final_price;
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param EE_Ticket      $ticket
+	 * @param EE_Line_Item   $ticket_line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws OutOfRangeException
+	 */
+	protected function resolveFinalPrice(
+		EE_Transaction $transaction,
+		EE_Ticket $ticket,
+		EE_Line_Item $ticket_line_item
+	) {
+		$final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item(
+			$transaction->total_line_item(),
+			$ticket_line_item
+		);
+		$final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes();
+		return (float) $final_price;
+	}
 
 
-    /**
-     * @param  EE_Registration[] $registrations
-     * @param  boolean           $update_existing_registrations
-     * @return int
-     * @throws EE_Error
-     */
-    protected function incrementRegGroupSize(array $registrations, $update_existing_registrations = true)
-    {
-        $new_reg_group_size = count($registrations) + 1;
-        if ($update_existing_registrations) {
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_group_size($new_reg_group_size);
-                    $registration->save();
-                }
-            }
-        }
-        return $new_reg_group_size;
-    }
+	/**
+	 * @param  EE_Registration[] $registrations
+	 * @param  boolean           $update_existing_registrations
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function incrementRegGroupSize(array $registrations, $update_existing_registrations = true)
+	{
+		$new_reg_group_size = count($registrations) + 1;
+		if ($update_existing_registrations) {
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration->set_group_size($new_reg_group_size);
+					$registration->save();
+				}
+			}
+		}
+		return $new_reg_group_size;
+	}
 }

core/domain/services/registration/CopyRegistrationService.php

Spacing +5 added lines, -5 removed lines

@@ -83,7 +83,7 @@ 
         $reindexed_answers = array();
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
+                $reindexed_answers[$answer->question_ID()] = $answer->value();
             }
         }
         return $reindexed_answers;
@@ -103,8 +103,8 @@ 
         EE_Registration $registration,
         $previous_answers
     ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
+        $old_answer_value = isset($previous_answers[$question->ID()])
+            ? $previous_answers[$question->ID()]
             : '';
         $new_answer = EE_Answer::new_instance(
             array(
@@ -113,7 +113,7 @@ 
                 'ANS_value' => $old_answer_value,
             )
         );
-        if (! $new_answer instanceof EE_Answer) {
+        if ( ! $new_answer instanceof EE_Answer) {
             throw new UnexpectedEntityException($new_answer, 'EE_Answer');
         }
         $new_answer->save();
@@ -150,7 +150,7 @@ 
                         'RPY_amount' => $payment_amount,
                     )
                 );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
+                if ( ! $new_registration_payment instanceof EE_Registration_Payment) {
                     throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
                 }
                 $new_registration_payment->save();

Indentation +142 added lines, -142 removed lines

@@ -25,152 +25,152 @@
  */
 class CopyRegistrationService extends DomainService
 {
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EntityNotFoundException
-     * @throws RuntimeException
-     * @throws EE_Error
-     */
-    public function copyRegistrationDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        // copy attendee
-        $target_registration->set_attendee_id($registration_to_copy->attendee_ID());
-        $target_registration->updateStatusBasedOnTotalPaid(false);
-        $target_registration->save();
-        // get answers to previous reg questions
-        $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
-        // get questions to new event reg form
-        $new_event = $target_registration->event();
-        $field_name = 'Event_Question_Group.'
-            . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                $registration_to_copy->is_primary_registrant()
-            );
-        $question_groups = $new_event->question_groups([
-                [
-                    'Event.EVT_ID' => $new_event->ID(),
-                    $field_name => true,
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]);
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof \EE_Question_Group) {
-                foreach ($question_group->questions() as $question) {
-                    if ($question instanceof EE_Question) {
-                        $this->generateNewAnswer(
-                            $question,
-                            $target_registration,
-                            $answers
-                        );
-                    }
-                }
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EntityNotFoundException
+	 * @throws RuntimeException
+	 * @throws EE_Error
+	 */
+	public function copyRegistrationDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		// copy attendee
+		$target_registration->set_attendee_id($registration_to_copy->attendee_ID());
+		$target_registration->updateStatusBasedOnTotalPaid(false);
+		$target_registration->save();
+		// get answers to previous reg questions
+		$answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
+		// get questions to new event reg form
+		$new_event = $target_registration->event();
+		$field_name = 'Event_Question_Group.'
+			. EEM_Event_Question_Group::instance()->fieldNameForContext(
+				$registration_to_copy->is_primary_registrant()
+			);
+		$question_groups = $new_event->question_groups([
+				[
+					'Event.EVT_ID' => $new_event->ID(),
+					$field_name => true,
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]);
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof \EE_Question_Group) {
+				foreach ($question_group->questions() as $question) {
+					if ($question instanceof EE_Question) {
+						$this->generateNewAnswer(
+							$question,
+							$target_registration,
+							$answers
+						);
+					}
+				}
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param EE_Answer[] $answers
-     * @return array
-     * @throws EE_Error
-     */
-    protected function reindexAnswersByQuestionId(array $answers)
-    {
-        $reindexed_answers = array();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
-            }
-        }
-        return $reindexed_answers;
-    }
+	/**
+	 * @param EE_Answer[] $answers
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function reindexAnswersByQuestionId(array $answers)
+	{
+		$reindexed_answers = array();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				$reindexed_answers[ $answer->question_ID() ] = $answer->value();
+			}
+		}
+		return $reindexed_answers;
+	}
 
 
-    /**
-     * @param EE_Question      $question
-     * @param EE_Registration  $registration
-     * @param                  $previous_answers
-     * @return EE_Answer
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function generateNewAnswer(
-        EE_Question $question,
-        EE_Registration $registration,
-        $previous_answers
-    ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
-            : '';
-        $new_answer = EE_Answer::new_instance(
-            array(
-                'QST_ID'    => $question->ID(),
-                'REG_ID'    => $registration->ID(),
-                'ANS_value' => $old_answer_value,
-            )
-        );
-        if (! $new_answer instanceof EE_Answer) {
-            throw new UnexpectedEntityException($new_answer, 'EE_Answer');
-        }
-        $new_answer->save();
-        return $new_answer;
-    }
+	/**
+	 * @param EE_Question      $question
+	 * @param EE_Registration  $registration
+	 * @param                  $previous_answers
+	 * @return EE_Answer
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function generateNewAnswer(
+		EE_Question $question,
+		EE_Registration $registration,
+		$previous_answers
+	) {
+		$old_answer_value = isset($previous_answers[ $question->ID() ])
+			? $previous_answers[ $question->ID() ]
+			: '';
+		$new_answer = EE_Answer::new_instance(
+			array(
+				'QST_ID'    => $question->ID(),
+				'REG_ID'    => $registration->ID(),
+				'ANS_value' => $old_answer_value,
+			)
+		);
+		if (! $new_answer instanceof EE_Answer) {
+			throw new UnexpectedEntityException($new_answer, 'EE_Answer');
+		}
+		$new_answer->save();
+		return $new_answer;
+	}
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function copyPaymentDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        $save = false;
-        $previous_registration_payments = $registration_to_copy->registration_payments();
-        $new_registration_payment_total = 0;
-        $registration_to_copy_total = $registration_to_copy->paid();
-        foreach ($previous_registration_payments as $previous_registration_payment) {
-            if (
-                $previous_registration_payment instanceof EE_Registration_Payment
-                && $previous_registration_payment->payment() instanceof EE_Payment
-                && $previous_registration_payment->payment()->is_approved()
-            ) {
-                $payment_amount = $previous_registration_payment->amount();
-                $new_registration_payment = EE_Registration_Payment::new_instance(
-                    array(
-                        'REG_ID'     => $target_registration->ID(),
-                        'PAY_ID'     => $previous_registration_payment->payment()->ID(),
-                        'RPY_amount' => $payment_amount,
-                    )
-                );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
-                    throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
-                }
-                $new_registration_payment->save();
-                // if new reg payment is good, then set old reg payment amount to zero
-                $previous_registration_payment->set_amount(0);
-                $previous_registration_payment->save();
-                // now  increment/decrement payment amounts
-                $new_registration_payment_total += $payment_amount;
-                $registration_to_copy_total -= $payment_amount;
-                $save = true;
-            }
-        }
-        if ($save) {
-            $target_registration->set_paid($new_registration_payment_total);
-            $target_registration->save();
-            $registration_to_copy->set_paid($registration_to_copy_total);
-            $registration_to_copy->save();
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function copyPaymentDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		$save = false;
+		$previous_registration_payments = $registration_to_copy->registration_payments();
+		$new_registration_payment_total = 0;
+		$registration_to_copy_total = $registration_to_copy->paid();
+		foreach ($previous_registration_payments as $previous_registration_payment) {
+			if (
+				$previous_registration_payment instanceof EE_Registration_Payment
+				&& $previous_registration_payment->payment() instanceof EE_Payment
+				&& $previous_registration_payment->payment()->is_approved()
+			) {
+				$payment_amount = $previous_registration_payment->amount();
+				$new_registration_payment = EE_Registration_Payment::new_instance(
+					array(
+						'REG_ID'     => $target_registration->ID(),
+						'PAY_ID'     => $previous_registration_payment->payment()->ID(),
+						'RPY_amount' => $payment_amount,
+					)
+				);
+				if (! $new_registration_payment instanceof EE_Registration_Payment) {
+					throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
+				}
+				$new_registration_payment->save();
+				// if new reg payment is good, then set old reg payment amount to zero
+				$previous_registration_payment->set_amount(0);
+				$previous_registration_payment->save();
+				// now  increment/decrement payment amounts
+				$new_registration_payment_total += $payment_amount;
+				$registration_to_copy_total -= $payment_amount;
+				$save = true;
+			}
+		}
+		if ($save) {
+			$target_registration->set_paid($new_registration_payment_total);
+			$target_registration->save();
+			$registration_to_copy->set_paid($registration_to_copy_total);
+			$registration_to_copy->save();
+		}
+		return true;
+	}
 }

core/services/assets/AssetRegistrationException.php

Indentation +20 added lines, -20 removed lines

@@ -16,24 +16,24 @@
  */
 class AssetRegistrationException extends RuntimeException
 {
-    /**
-     * @param                $script_handle
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html_x(
-                    'The "%1$s" script could not be registered with WordPress core.',
-                    'The "script-handle" script could not be registered with WordPress core.',
-                    'event_espresso'
-                ),
-                $script_handle
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * @param                $script_handle
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html_x(
+					'The "%1$s" script could not be registered with WordPress core.',
+					'The "script-handle" script could not be registered with WordPress core.',
+					'event_espresso'
+				),
+				$script_handle
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }
\ No newline at end of file

core/domain/services/admin/privacy/export/ExportTransaction.php

Indentation +96 added lines, -96 removed lines

@@ -15,106 +15,106 @@
  */
 class ExportTransaction implements PersonalDataExporterInterface
 {
-    /**
-     * @var EEM_Transaction $transaction_model
-     */
-    protected $transaction_model;
+	/**
+	 * @var EEM_Transaction $transaction_model
+	 */
+	protected $transaction_model;
 
-    /**
-     * ExportTransaction constructor.
-     *
-     * @param $transaction_model
-     */
-    public function __construct(EEM_Transaction $transaction_model)
-    {
-        $this->transaction_model = $transaction_model;
-    }
+	/**
+	 * ExportTransaction constructor.
+	 *
+	 * @param $transaction_model
+	 */
+	public function __construct(EEM_Transaction $transaction_model)
+	{
+		$this->transaction_model = $transaction_model;
+	}
 
 
-    /**
-     * Returns data for export.
-     *
-     * @param string    $email_address ,
-     * @param int       $page          starts at 1, not 0
-     * @return array {
-     * @type array      $data          {
-     * @type array {
-     * @type string     $group_id      (not translated, same for all exports)
-     * @type string     $group_label   (translated string)
-     * @type string|int $item_id
-     * @type array      $data          {
-     * @type array {
-     * @type string     $name          what's shown in the left-column of the export row
-     * @type string     $value         what's showin the right-column of the export row
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     */
-    public function export($email_address, $page = 1)
-    {
-        $page_size = 10;
-        $transactions = $this->transaction_model->get_all(
-            array(
-                array(
-                    'Registration.Attendee.ATT_email' => $email_address,
-                ),
-                'limit' => array(
-                    ($page - 1) * $page_size,
-                    $page_size,
-                ),
-            )
-        );
-        $export_fields = array_intersect_key(
-            EEM_Transaction::instance()->field_settings(),
-            array_flip(
-                array(
-                    'TXN_timestamp',
-                    'TXN_total',
-                    'TXN_paid',
-                    'TXN_session_data',
-                )
-            )
-        );
-        $export_items = array();
-        $found_something = false;
-        foreach ($transactions as $transaction) {
-            $found_something = true;
-            $data = array();
-            foreach ($export_fields as $field_name => $field_obj) {
-                if ($field_name === 'TXN_session_data') {
-                    $value = $transaction->get_pretty($field_name, 'print_r');
-                } else {
-                    $value = $transaction->get_pretty($field_name);
-                }
-                $data[] = array(
-                    'name'  => $field_obj->get_nicename(),
-                    'value' => $value,
-                );
-            }
-            $export_items[] = array(
-                'group_id'    => 'transactions',
-                'group_label' => esc_html__('Transactions', 'event_espresso'),
-                'item_id'     => $transaction->ID(),
-                'data'        => $data,
-            );
-        }
-        return array(
-            'data' => $export_items,
-            'done' => ! $found_something,
-        );
-    }
+	/**
+	 * Returns data for export.
+	 *
+	 * @param string    $email_address ,
+	 * @param int       $page          starts at 1, not 0
+	 * @return array {
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $group_id      (not translated, same for all exports)
+	 * @type string     $group_label   (translated string)
+	 * @type string|int $item_id
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $name          what's shown in the left-column of the export row
+	 * @type string     $value         what's showin the right-column of the export row
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 */
+	public function export($email_address, $page = 1)
+	{
+		$page_size = 10;
+		$transactions = $this->transaction_model->get_all(
+			array(
+				array(
+					'Registration.Attendee.ATT_email' => $email_address,
+				),
+				'limit' => array(
+					($page - 1) * $page_size,
+					$page_size,
+				),
+			)
+		);
+		$export_fields = array_intersect_key(
+			EEM_Transaction::instance()->field_settings(),
+			array_flip(
+				array(
+					'TXN_timestamp',
+					'TXN_total',
+					'TXN_paid',
+					'TXN_session_data',
+				)
+			)
+		);
+		$export_items = array();
+		$found_something = false;
+		foreach ($transactions as $transaction) {
+			$found_something = true;
+			$data = array();
+			foreach ($export_fields as $field_name => $field_obj) {
+				if ($field_name === 'TXN_session_data') {
+					$value = $transaction->get_pretty($field_name, 'print_r');
+				} else {
+					$value = $transaction->get_pretty($field_name);
+				}
+				$data[] = array(
+					'name'  => $field_obj->get_nicename(),
+					'value' => $value,
+				);
+			}
+			$export_items[] = array(
+				'group_id'    => 'transactions',
+				'group_label' => esc_html__('Transactions', 'event_espresso'),
+				'item_id'     => $transaction->ID(),
+				'data'        => $data,
+			);
+		}
+		return array(
+			'data' => $export_items,
+			'done' => ! $found_something,
+		);
+	}
 
-    /**
-     * Gets the Translated name of this exporter
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return esc_html__('Event Espresso Transaction Exporter', 'event_espresso');
-    }
+	/**
+	 * Gets the Translated name of this exporter
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return esc_html__('Event Espresso Transaction Exporter', 'event_espresso');
+	}
 }
 // End of file ExportTransaction.php
 // Location: EventEspresso\core\domain\services\admin\privacy\export/ExportTransaction.php

core/domain/services/admin/privacy/export/ExportAttendee.php

Indentation +104 added lines, -104 removed lines

@@ -15,116 +15,116 @@
  */
 class ExportAttendee implements PersonalDataExporterInterface
 {
-    /**
-     * @var EEM_Attendee
-     */
-    protected $attendee_model;
+	/**
+	 * @var EEM_Attendee
+	 */
+	protected $attendee_model;
 
-    /**
-     * ExportAttendee constructor.
-     *
-     * @param EEM_Attendee $attendee_model
-     */
-    public function __construct(EEM_Attendee $attendee_model)
-    {
-        $this->attendee_model = $attendee_model;
-    }
+	/**
+	 * ExportAttendee constructor.
+	 *
+	 * @param EEM_Attendee $attendee_model
+	 */
+	public function __construct(EEM_Attendee $attendee_model)
+	{
+		$this->attendee_model = $attendee_model;
+	}
 
 
-    /**
-     * Returns data for export.
-     *
-     * @param string    $email_address ,
-     * @param int       $page          starts at 1, not 0
-     * @return array {
-     * @type array      $data          {
-     * @type array {
-     * @type string     $group_id      (not translated, same for all exports)
-     * @type string     $group_label   (translated string)
-     * @type string|int $item_id
-     * @type array      $data          {
-     * @type array {
-     * @type string     $name          what's shown in the left-column of the export row
-     * @type string     $value         what's showin the right-column of the export row
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     */
-    public function export($email_address, $page = 1)
-    {
-        $attendees = $this->attendee_model->get_all(
-            array(
-                array(
-                    'ATT_email' => $email_address,
-                ),
-            )
-        );
+	/**
+	 * Returns data for export.
+	 *
+	 * @param string    $email_address ,
+	 * @param int       $page          starts at 1, not 0
+	 * @return array {
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $group_id      (not translated, same for all exports)
+	 * @type string     $group_label   (translated string)
+	 * @type string|int $item_id
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $name          what's shown in the left-column of the export row
+	 * @type string     $value         what's showin the right-column of the export row
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 */
+	public function export($email_address, $page = 1)
+	{
+		$attendees = $this->attendee_model->get_all(
+			array(
+				array(
+					'ATT_email' => $email_address,
+				),
+			)
+		);
 
-        if (empty($attendees)) {
-            return array(
-                'data' => array(),
-                'done' => true,
-            );
-        }
+		if (empty($attendees)) {
+			return array(
+				'data' => array(),
+				'done' => true,
+			);
+		}
 
-        $export_items = array();
-        foreach ($attendees as $attendee) {
-            $export_fields = array_intersect_key(
-                $this->attendee_model->field_settings(),
-                array_flip(
-                    array(
-                        'ATT_fname',
-                        'ATT_lname',
-                        'ATT_email',
-                        'ATT_address1',
-                        'ATT_address2',
-                        'ATT_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'ATT_zip',
-                        'ATT_phone',
-                    )
-                )
-            );
-            $data = array();
-            foreach ($export_fields as $field_name => $field_obj) {
-                if ($field_name === 'STA_ID') {
-                    $value = $attendee->state_name();
-                } elseif ($field_name == 'CNT_ISO') {
-                    $value = $attendee->country_name();
-                } else {
-                    $value = $attendee->get_pretty($field_name);
-                }
-                $data[] = array(
-                    'name'  => $field_obj->get_nicename(),
-                    'value' => $value,
-                );
-            }
-            $export_items[] =
-                array(
-                    'group_id'    => 'att-' . $attendee->ID(),
-                    'group_label' => esc_html__('Contact Profiles', 'event_espresso'),
-                    'item_id'     => $attendee->ID(),
-                    'data'        => $data,
-                );
-        }
-        return array(
-            'data' => $export_items,
-            'done' => true,
-        );
-    }
+		$export_items = array();
+		foreach ($attendees as $attendee) {
+			$export_fields = array_intersect_key(
+				$this->attendee_model->field_settings(),
+				array_flip(
+					array(
+						'ATT_fname',
+						'ATT_lname',
+						'ATT_email',
+						'ATT_address1',
+						'ATT_address2',
+						'ATT_city',
+						'STA_ID',
+						'CNT_ISO',
+						'ATT_zip',
+						'ATT_phone',
+					)
+				)
+			);
+			$data = array();
+			foreach ($export_fields as $field_name => $field_obj) {
+				if ($field_name === 'STA_ID') {
+					$value = $attendee->state_name();
+				} elseif ($field_name == 'CNT_ISO') {
+					$value = $attendee->country_name();
+				} else {
+					$value = $attendee->get_pretty($field_name);
+				}
+				$data[] = array(
+					'name'  => $field_obj->get_nicename(),
+					'value' => $value,
+				);
+			}
+			$export_items[] =
+				array(
+					'group_id'    => 'att-' . $attendee->ID(),
+					'group_label' => esc_html__('Contact Profiles', 'event_espresso'),
+					'item_id'     => $attendee->ID(),
+					'data'        => $data,
+				);
+		}
+		return array(
+			'data' => $export_items,
+			'done' => true,
+		);
+	}
 
-    /**
-     * Gets the Translated name of this exporter
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return esc_html__('Event Espresso Attendee Data Exporter', 'event_espresso');
-    }
+	/**
+	 * Gets the Translated name of this exporter
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return esc_html__('Event Espresso Attendee Data Exporter', 'event_espresso');
+	}
 }
 // End of file ExportAttendee.php
 // Location: EventEspresso\core\domain\services\admin\privacy\export/ExportAttendee.php

Spacing +1 added lines, -1 removed lines

@@ -104,7 +104,7 @@
             }
             $export_items[] =
                 array(
-                    'group_id'    => 'att-' . $attendee->ID(),
+                    'group_id'    => 'att-'.$attendee->ID(),
                     'group_label' => esc_html__('Contact Profiles', 'event_espresso'),
                     'item_id'     => $attendee->ID(),
                     'data'        => $data,

core/domain/services/admin/privacy/export/ExportRegistration.php

Indentation +122 added lines, -122 removed lines

@@ -18,133 +18,133 @@
  */
 class ExportRegistration implements PersonalDataExporterInterface
 {
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
 
-    /**
-     * ExportRegistration constructor.
-     *
-     * @param EEM_Registration $registration_model
-     */
-    public function __construct(EEM_Registration $registration_model)
-    {
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * ExportRegistration constructor.
+	 *
+	 * @param EEM_Registration $registration_model
+	 */
+	public function __construct(EEM_Registration $registration_model)
+	{
+		$this->registration_model = $registration_model;
+	}
 
 
-    /**
-     * Returns data for export.
-     *
-     * @param string    $email_address ,
-     * @param int       $page          starts at 1, not 0
-     * @return array {
-     * @type array      $data          {
-     * @type array {
-     * @type string     $group_id      (not translated, same for all exports)
-     * @type string     $group_label   (translated string)
-     * @type string|int $item_id
-     * @type array      $data          {
-     * @type array {
-     * @type string     $name          what's shown in the left-column of the export row
-     * @type string     $value         what's showin the right-column of the export row
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     */
-    public function export($email_address, $page = 1)
-    {
-        $page_size = 10;
-        $registrations = $this->registration_model->get_all(
-            array(
-                array(
-                    'Attendee.ATT_email' => $email_address,
-                ),
-                'limit' => array(
-                    ($page - 1) * $page_size,
-                    $page_size,
-                ),
-            )
-        );
-        $export_fields = array_intersect_key(
-            $this->registration_model->field_settings(),
-            array_flip(
-                array(
-                    'REG_code',
-                    'REG_date',
-                    'REG_final_price',
-                    'REG_paid',
-                    'REG_url_link',
-                    'REG_count',
-                    'REG_group_size',
-                    'REG_att_is_going',
-                )
-            )
-        );
-        $export_items = array();
-        $found_something = false;
-        foreach ($registrations as $registration) {
-            /**
-             * @var $registration EE_Registration
-             */
-            $found_something = true;
-            $data = array();
-            foreach ($export_fields as $field_name => $field_obj) {
-                $data[] = array(
-                    'name'  => $field_obj->get_nicename(),
-                    'value' => $registration->get_pretty($field_name),
-                );
-            }
-            $answers = $registration->answers(
-                array(
-                    'force_join' => array(
-                        'Question',
-                    ),
-                )
-            );
-            foreach ($answers as $answer) {
-                $data[] = array(
-                    'name'  => $answer->question()->display_text(),
-                    'value' => $answer->pretty_value(),
-                );
-            }
-            $ticket = $registration->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                $data[] = array(
-                    'name'  => esc_html__('Ticket', 'event_espresso'),
-                    'value' => $ticket->name_and_info(),
-                );
-                $data[] = array(
-                    'name'  => esc_html__('Event', 'event_espresso'),
-                    'value' => $ticket->get_event_name(),
-                );
-            }
+	/**
+	 * Returns data for export.
+	 *
+	 * @param string    $email_address ,
+	 * @param int       $page          starts at 1, not 0
+	 * @return array {
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $group_id      (not translated, same for all exports)
+	 * @type string     $group_label   (translated string)
+	 * @type string|int $item_id
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $name          what's shown in the left-column of the export row
+	 * @type string     $value         what's showin the right-column of the export row
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 */
+	public function export($email_address, $page = 1)
+	{
+		$page_size = 10;
+		$registrations = $this->registration_model->get_all(
+			array(
+				array(
+					'Attendee.ATT_email' => $email_address,
+				),
+				'limit' => array(
+					($page - 1) * $page_size,
+					$page_size,
+				),
+			)
+		);
+		$export_fields = array_intersect_key(
+			$this->registration_model->field_settings(),
+			array_flip(
+				array(
+					'REG_code',
+					'REG_date',
+					'REG_final_price',
+					'REG_paid',
+					'REG_url_link',
+					'REG_count',
+					'REG_group_size',
+					'REG_att_is_going',
+				)
+			)
+		);
+		$export_items = array();
+		$found_something = false;
+		foreach ($registrations as $registration) {
+			/**
+			 * @var $registration EE_Registration
+			 */
+			$found_something = true;
+			$data = array();
+			foreach ($export_fields as $field_name => $field_obj) {
+				$data[] = array(
+					'name'  => $field_obj->get_nicename(),
+					'value' => $registration->get_pretty($field_name),
+				);
+			}
+			$answers = $registration->answers(
+				array(
+					'force_join' => array(
+						'Question',
+					),
+				)
+			);
+			foreach ($answers as $answer) {
+				$data[] = array(
+					'name'  => $answer->question()->display_text(),
+					'value' => $answer->pretty_value(),
+				);
+			}
+			$ticket = $registration->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				$data[] = array(
+					'name'  => esc_html__('Ticket', 'event_espresso'),
+					'value' => $ticket->name_and_info(),
+				);
+				$data[] = array(
+					'name'  => esc_html__('Event', 'event_espresso'),
+					'value' => $ticket->get_event_name(),
+				);
+			}
 
-            $export_items[] = array(
-                'group_id'    => 'registration',
-                'group_label' => esc_html__('Event Registrations', 'event_espresso'),
-                'item_id'     => $registration->ID(),
-                'data'        => $data,
-            );
-        }
-        return array(
-            'data' => $export_items,
-            'done' => ! $found_something,
-        );
-    }
+			$export_items[] = array(
+				'group_id'    => 'registration',
+				'group_label' => esc_html__('Event Registrations', 'event_espresso'),
+				'item_id'     => $registration->ID(),
+				'data'        => $data,
+			);
+		}
+		return array(
+			'data' => $export_items,
+			'done' => ! $found_something,
+		);
+	}
 
-    /**
-     * Gets the Translated name of this exporter
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return esc_html__('Event Espresso Registration Data Exporter', 'event_espresso');
-    }
+	/**
+	 * Gets the Translated name of this exporter
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return esc_html__('Event Espresso Registration Data Exporter', 'event_espresso');
+	}
 }
 // End of file ExportRegistration.php
 // Location: EventEspresso\core\domain\services\admin\privacy\export/ExportRegistration.php

modules/single_page_checkout/inc/EE_SPCO_JSON_Response.php

Spacing +2 added lines, -2 removed lines

@@ -122,7 +122,7 @@ 
             $JSON_response['success'] = $this->success();
         }
         // but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-        if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
+        if ( ! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
             $JSON_response['success'] = null;
         }
         // set redirect_url, IF it exists
@@ -162,7 +162,7 @@ 
         // and finally, add return_data array to main JSON response array, IF it contains anything
         // why did we add some of the above properties to the return data array?
         // because it is easier and cleaner in the Javascript to deal with this way
-        if (! empty($return_data)) {
+        if ( ! empty($return_data)) {
             $JSON_response['return_data'] = $return_data;
         }
         // filter final array

Indentation +396 added lines, -396 removed lines

@@ -14,400 +14,400 @@
  */
 class EE_SPCO_JSON_Response
 {
-    /**
-     * @var string
-     */
-    protected $_errors = '';
-
-    /**
-     * @var string
-     */
-    protected $_unexpected_errors = '';
-
-    /**
-     * @var string
-     */
-    protected $_attention = '';
-
-    /**
-     * @var string
-     */
-    protected $_success = '';
-
-    /**
-     * @var string
-     */
-    protected $_plz_select_method_of_payment = '';
-
-    /**
-     * @var string
-     */
-    protected $_redirect_url = '';
-
-    /**
-     * @var string
-     */
-    protected $_registration_time_limit = '';
-
-    /**
-     * @var string
-     */
-    protected $_redirect_form = '';
-
-    /**
-     * @var string
-     */
-    protected $_reg_step_html = '';
-
-    /**
-     * @var string
-     */
-    protected $_method_of_payment = '';
-
-    /**
-     * @var float
-     */
-    protected $_payment_amount;
-
-    /**
-     * @var array
-     */
-    protected $_return_data = array();
-
-
-    /**
-     * @var array
-     */
-    protected $_validation_rules = array();
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     *    __toString
-     *
-     *        allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
-     *
-     * @access    public
-     * @return    string
-     */
-    public function __toString()
-    {
-        $JSON_response = array();
-        // grab notices
-        $notices = EE_Error::get_notices(false);
-        $this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
-        $this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
-        $this->set_success(isset($notices['success']) ? $notices['success'] : '');
-        // add notices to JSON response, but only if they exist
-        if ($this->attention()) {
-            $JSON_response['attention'] = $this->attention();
-        }
-        if ($this->errors()) {
-            $JSON_response['errors'] = $this->errors();
-        }
-        if ($this->unexpected_errors()) {
-            $JSON_response['unexpected_errors'] = $this->unexpected_errors();
-        }
-        if ($this->success()) {
-            $JSON_response['success'] = $this->success();
-        }
-        // but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-        if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
-            $JSON_response['success'] = null;
-        }
-        // set redirect_url, IF it exists
-        if ($this->redirect_url()) {
-            $JSON_response['redirect_url'] = $this->redirect_url();
-        }
-        // set registration_time_limit, IF it exists
-        if ($this->registration_time_limit()) {
-            $JSON_response['registration_time_limit'] = $this->registration_time_limit();
-        }
-        // set payment_amount, IF it exists
-        if ($this->payment_amount() !== null) {
-            $JSON_response['payment_amount'] = $this->payment_amount();
-        }
-        // grab generic return data
-        $return_data = $this->return_data();
-        // add billing form validation rules
-        if ($this->validation_rules()) {
-            $return_data['validation_rules'] = $this->validation_rules();
-        }
-        // set reg_step_html, IF it exists
-        if ($this->reg_step_html()) {
-            $return_data['reg_step_html'] = $this->reg_step_html();
-        }
-        // set method of payment, IF it exists
-        if ($this->method_of_payment()) {
-            $return_data['method_of_payment'] = $this->method_of_payment();
-        }
-        // set "plz_select_method_of_payment" message, IF it exists
-        if ($this->plz_select_method_of_payment()) {
-            $return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
-        }
-        // set redirect_form, IF it exists
-        if ($this->redirect_form()) {
-            $return_data['redirect_form'] = $this->redirect_form();
-        }
-        // and finally, add return_data array to main JSON response array, IF it contains anything
-        // why did we add some of the above properties to the return data array?
-        // because it is easier and cleaner in the Javascript to deal with this way
-        if (! empty($return_data)) {
-            $JSON_response['return_data'] = $return_data;
-        }
-        // filter final array
-        $JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
-        // return encoded array
-        return (string) wp_json_encode($JSON_response);
-    }
-
-
-    /**
-     * @param string $attention
-     */
-    public function set_attention($attention)
-    {
-        $this->_attention = $attention;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function attention()
-    {
-        return $this->_attention;
-    }
-
-
-    /**
-     * @param string $errors
-     */
-    public function set_errors($errors)
-    {
-        $this->_errors = $errors;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function errors()
-    {
-        return $this->_errors;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function unexpected_errors()
-    {
-        return $this->_unexpected_errors;
-    }
-
-
-    /**
-     * @param string $unexpected_errors
-     */
-    public function set_unexpected_errors($unexpected_errors)
-    {
-        $this->_unexpected_errors = $unexpected_errors;
-    }
-
-
-    /**
-     * @param string $success
-     */
-    public function set_success($success)
-    {
-        $this->_success = $success;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success()
-    {
-        return $this->_success;
-    }
-
-
-    /**
-     * @param string $method_of_payment
-     */
-    public function set_method_of_payment($method_of_payment)
-    {
-        $this->_method_of_payment = $method_of_payment;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function method_of_payment()
-    {
-        return $this->_method_of_payment;
-    }
-
-
-    /**
-     * @return float
-     */
-    public function payment_amount()
-    {
-        return $this->_payment_amount;
-    }
-
-
-    /**
-     * @param float $payment_amount
-     * @throws EE_Error
-     */
-    public function set_payment_amount($payment_amount)
-    {
-        $this->_payment_amount = (float) $payment_amount;
-    }
-
-
-    /**
-     * @param string $next_step_html
-     */
-    public function set_reg_step_html($next_step_html)
-    {
-        $this->_reg_step_html = $next_step_html;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_step_html()
-    {
-        return $this->_reg_step_html;
-    }
-
-
-    /**
-     * @param string $redirect_form
-     */
-    public function set_redirect_form($redirect_form)
-    {
-        $this->_redirect_form = $redirect_form;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function redirect_form()
-    {
-        return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
-    }
-
-
-    /**
-     * @param string $plz_select_method_of_payment
-     */
-    public function set_plz_select_method_of_payment($plz_select_method_of_payment)
-    {
-        $this->_plz_select_method_of_payment = $plz_select_method_of_payment;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plz_select_method_of_payment()
-    {
-        return $this->_plz_select_method_of_payment;
-    }
-
-
-    /**
-     * @param string $redirect_url
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->_redirect_url = $redirect_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function redirect_url()
-    {
-        return $this->_redirect_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function registration_time_limit()
-    {
-        return $this->_registration_time_limit;
-    }
-
-
-    /**
-     * @param string $registration_time_limit
-     */
-    public function set_registration_time_limit($registration_time_limit)
-    {
-        $this->_registration_time_limit = $registration_time_limit;
-    }
-
-
-    /**
-     * @param array $return_data
-     */
-    public function set_return_data($return_data)
-    {
-        $this->_return_data = array_merge($this->_return_data, $return_data);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function return_data()
-    {
-        return $this->_return_data;
-    }
-
-
-    /**
-     * @param array $validation_rules
-     */
-    public function add_validation_rules(array $validation_rules = array())
-    {
-        if (is_array($validation_rules) && ! empty($validation_rules)) {
-            $this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
-        }
-    }
-
-
-    /**
-     * @return array | bool
-     */
-    public function validation_rules()
-    {
-        return ! empty($this->_validation_rules) ? $this->_validation_rules : false;
-    }
-
-
-    public function echoAndExit()
-    {
-        exit($this->__toString());
-    }
+	/**
+	 * @var string
+	 */
+	protected $_errors = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_unexpected_errors = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_attention = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_success = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_plz_select_method_of_payment = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_redirect_url = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_registration_time_limit = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_redirect_form = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_reg_step_html = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_method_of_payment = '';
+
+	/**
+	 * @var float
+	 */
+	protected $_payment_amount;
+
+	/**
+	 * @var array
+	 */
+	protected $_return_data = array();
+
+
+	/**
+	 * @var array
+	 */
+	protected $_validation_rules = array();
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 *    __toString
+	 *
+	 *        allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function __toString()
+	{
+		$JSON_response = array();
+		// grab notices
+		$notices = EE_Error::get_notices(false);
+		$this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
+		$this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
+		$this->set_success(isset($notices['success']) ? $notices['success'] : '');
+		// add notices to JSON response, but only if they exist
+		if ($this->attention()) {
+			$JSON_response['attention'] = $this->attention();
+		}
+		if ($this->errors()) {
+			$JSON_response['errors'] = $this->errors();
+		}
+		if ($this->unexpected_errors()) {
+			$JSON_response['unexpected_errors'] = $this->unexpected_errors();
+		}
+		if ($this->success()) {
+			$JSON_response['success'] = $this->success();
+		}
+		// but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
+		if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
+			$JSON_response['success'] = null;
+		}
+		// set redirect_url, IF it exists
+		if ($this->redirect_url()) {
+			$JSON_response['redirect_url'] = $this->redirect_url();
+		}
+		// set registration_time_limit, IF it exists
+		if ($this->registration_time_limit()) {
+			$JSON_response['registration_time_limit'] = $this->registration_time_limit();
+		}
+		// set payment_amount, IF it exists
+		if ($this->payment_amount() !== null) {
+			$JSON_response['payment_amount'] = $this->payment_amount();
+		}
+		// grab generic return data
+		$return_data = $this->return_data();
+		// add billing form validation rules
+		if ($this->validation_rules()) {
+			$return_data['validation_rules'] = $this->validation_rules();
+		}
+		// set reg_step_html, IF it exists
+		if ($this->reg_step_html()) {
+			$return_data['reg_step_html'] = $this->reg_step_html();
+		}
+		// set method of payment, IF it exists
+		if ($this->method_of_payment()) {
+			$return_data['method_of_payment'] = $this->method_of_payment();
+		}
+		// set "plz_select_method_of_payment" message, IF it exists
+		if ($this->plz_select_method_of_payment()) {
+			$return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
+		}
+		// set redirect_form, IF it exists
+		if ($this->redirect_form()) {
+			$return_data['redirect_form'] = $this->redirect_form();
+		}
+		// and finally, add return_data array to main JSON response array, IF it contains anything
+		// why did we add some of the above properties to the return data array?
+		// because it is easier and cleaner in the Javascript to deal with this way
+		if (! empty($return_data)) {
+			$JSON_response['return_data'] = $return_data;
+		}
+		// filter final array
+		$JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
+		// return encoded array
+		return (string) wp_json_encode($JSON_response);
+	}
+
+
+	/**
+	 * @param string $attention
+	 */
+	public function set_attention($attention)
+	{
+		$this->_attention = $attention;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function attention()
+	{
+		return $this->_attention;
+	}
+
+
+	/**
+	 * @param string $errors
+	 */
+	public function set_errors($errors)
+	{
+		$this->_errors = $errors;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function errors()
+	{
+		return $this->_errors;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function unexpected_errors()
+	{
+		return $this->_unexpected_errors;
+	}
+
+
+	/**
+	 * @param string $unexpected_errors
+	 */
+	public function set_unexpected_errors($unexpected_errors)
+	{
+		$this->_unexpected_errors = $unexpected_errors;
+	}
+
+
+	/**
+	 * @param string $success
+	 */
+	public function set_success($success)
+	{
+		$this->_success = $success;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success()
+	{
+		return $this->_success;
+	}
+
+
+	/**
+	 * @param string $method_of_payment
+	 */
+	public function set_method_of_payment($method_of_payment)
+	{
+		$this->_method_of_payment = $method_of_payment;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function method_of_payment()
+	{
+		return $this->_method_of_payment;
+	}
+
+
+	/**
+	 * @return float
+	 */
+	public function payment_amount()
+	{
+		return $this->_payment_amount;
+	}
+
+
+	/**
+	 * @param float $payment_amount
+	 * @throws EE_Error
+	 */
+	public function set_payment_amount($payment_amount)
+	{
+		$this->_payment_amount = (float) $payment_amount;
+	}
+
+
+	/**
+	 * @param string $next_step_html
+	 */
+	public function set_reg_step_html($next_step_html)
+	{
+		$this->_reg_step_html = $next_step_html;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_step_html()
+	{
+		return $this->_reg_step_html;
+	}
+
+
+	/**
+	 * @param string $redirect_form
+	 */
+	public function set_redirect_form($redirect_form)
+	{
+		$this->_redirect_form = $redirect_form;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function redirect_form()
+	{
+		return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
+	}
+
+
+	/**
+	 * @param string $plz_select_method_of_payment
+	 */
+	public function set_plz_select_method_of_payment($plz_select_method_of_payment)
+	{
+		$this->_plz_select_method_of_payment = $plz_select_method_of_payment;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plz_select_method_of_payment()
+	{
+		return $this->_plz_select_method_of_payment;
+	}
+
+
+	/**
+	 * @param string $redirect_url
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->_redirect_url = $redirect_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function redirect_url()
+	{
+		return $this->_redirect_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function registration_time_limit()
+	{
+		return $this->_registration_time_limit;
+	}
+
+
+	/**
+	 * @param string $registration_time_limit
+	 */
+	public function set_registration_time_limit($registration_time_limit)
+	{
+		$this->_registration_time_limit = $registration_time_limit;
+	}
+
+
+	/**
+	 * @param array $return_data
+	 */
+	public function set_return_data($return_data)
+	{
+		$this->_return_data = array_merge($this->_return_data, $return_data);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function return_data()
+	{
+		return $this->_return_data;
+	}
+
+
+	/**
+	 * @param array $validation_rules
+	 */
+	public function add_validation_rules(array $validation_rules = array())
+	{
+		if (is_array($validation_rules) && ! empty($validation_rules)) {
+			$this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
+		}
+	}
+
+
+	/**
+	 * @return array | bool
+	 */
+	public function validation_rules()
+	{
+		return ! empty($this->_validation_rules) ? $this->_validation_rules : false;
+	}
+
+
+	public function echoAndExit()
+	{
+		exit($this->__toString());
+	}
 }

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

@@ -12,487 +12,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_Status.class.php

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     {
         $id = $this->get('STS_ID');
         $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
+        return $code[$id];
     }
 
 

Indentation +138 added lines, -138 removed lines

@@ -11,142 +11,142 @@
  */
 class EE_Status extends EE_Base_Class
 {
-    /**
-     * @param array $props_n_values
-     * @return EE_Status
-     */
-    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_Status
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @param bool   $plural
-     * @param string $schema
-     * @return string
-     */
-    public function code($plural = false, $schema = 'upper')
-    {
-        $id = $this->get('STS_ID');
-        $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @return boolean
-     */
-    public function set_code($code)
-    {
-        $this->set('STS_code', $code);
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     */
-    public function desc()
-    {
-        return $this->get('STS_desc');
-    }
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @return boolean
-     */
-    public function set_desc($desc)
-    {
-        $this->set('STS_desc', $desc);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('STS_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @return boolean
-     */
-    public function set_type($type)
-    {
-        $this->set('STS_type', $type);
-    }
-
-
-    /**
-     * Gets can_edit
-     *
-     * @return boolean
-     */
-    public function can_edit()
-    {
-        return $this->get('STS_can_edit');
-    }
-
-
-    /**
-     * Sets can_edit
-     *
-     * @param boolean $can_edit
-     * @return boolean
-     */
-    public function set_can_edit($can_edit)
-    {
-        $this->set('STS_can_edit', $can_edit);
-    }
-
-
-    /**
-     * Gets open
-     *
-     * @return boolean
-     */
-    public function open()
-    {
-        return $this->get('STS_open');
-    }
-
-
-    /**
-     * Sets open
-     *
-     * @param boolean $open
-     * @return boolean
-     */
-    public function set_open($open)
-    {
-        $this->set('STS_open', $open);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Status
+	 */
+	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_Status
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @param bool   $plural
+	 * @param string $schema
+	 * @return string
+	 */
+	public function code($plural = false, $schema = 'upper')
+	{
+		$id = $this->get('STS_ID');
+		$code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
+		return $code[ $id ];
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @return boolean
+	 */
+	public function set_code($code)
+	{
+		$this->set('STS_code', $code);
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 */
+	public function desc()
+	{
+		return $this->get('STS_desc');
+	}
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @return boolean
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('STS_desc', $desc);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('STS_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @return boolean
+	 */
+	public function set_type($type)
+	{
+		$this->set('STS_type', $type);
+	}
+
+
+	/**
+	 * Gets can_edit
+	 *
+	 * @return boolean
+	 */
+	public function can_edit()
+	{
+		return $this->get('STS_can_edit');
+	}
+
+
+	/**
+	 * Sets can_edit
+	 *
+	 * @param boolean $can_edit
+	 * @return boolean
+	 */
+	public function set_can_edit($can_edit)
+	{
+		$this->set('STS_can_edit', $can_edit);
+	}
+
+
+	/**
+	 * Gets open
+	 *
+	 * @return boolean
+	 */
+	public function open()
+	{
+		return $this->get('STS_open');
+	}
+
+
+	/**
+	 * Sets open
+	 *
+	 * @param boolean $open
+	 * @return boolean
+	 */
+	public function set_open($open)
+	{
+		$this->set('STS_open', $open);
+	}
 }