eventespresso / event-espresso-core

core/domain/services/registration/form/v1/CopyAttendeeInfoForm.php

Indentation +70 added lines, -70 removed lines

@@ -12,77 +12,77 @@
 
 class CopyAttendeeInfoForm extends EE_Form_Section_Proper
 {
-    /**
-     * CopyAttendeeInfoForm constructor.
-     *
-     * @param EE_Registration[] $registrations
-     * @param string            $slug
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(array $registrations, string $slug)
-    {
-        parent::__construct(
-            [
-                'subsections'     => $this->copyAttendeeInfoInputs($registrations),
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $slug
-                                                      . '/copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    ]
-                ),
-            ]
-        );
-    }
+	/**
+	 * CopyAttendeeInfoForm constructor.
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param string            $slug
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(array $registrations, string $slug)
+	{
+		parent::__construct(
+			[
+				'subsections'     => $this->copyAttendeeInfoInputs($registrations),
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $slug
+													  . '/copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					]
+				),
+			]
+		);
+	}
 
 
-    /**
-     * @param array $registrations
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function copyAttendeeInfoInputs(array $registrations): array
-    {
-        $copy_attendee_info_inputs = [];
-        $prev_ticket               = null;
-        foreach ($registrations as $registration) {
-            // for all  attendees other than the primary attendee
-            if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
-                // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-                if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name   = $registration->ticket()->name();
-                    $item_name   .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
-                        : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ]
-                                 = new EE_Form_Section_HTML(
-                                     '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
-                                 );
-                    $prev_ticket = $registration->ticket()->ID();
-                }
+	/**
+	 * @param array $registrations
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function copyAttendeeInfoInputs(array $registrations): array
+	{
+		$copy_attendee_info_inputs = [];
+		$prev_ticket               = null;
+		foreach ($registrations as $registration) {
+			// for all  attendees other than the primary attendee
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
+				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
+				if ($registration->ticket()->ID() !== $prev_ticket) {
+					$item_name   = $registration->ticket()->name();
+					$item_name   .= $registration->ticket()->description() !== ''
+						? ' - ' . $registration->ticket()->description()
+						: '';
+					$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ]
+								 = new EE_Form_Section_HTML(
+									 '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+								 );
+					$prev_ticket = $registration->ticket()->ID();
+				}
 
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ]
-                    = new EE_Checkbox_Multi_Input(
-                        [
-                        $registration->ID() => sprintf(
-                            esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
-                            $registration->count()
-                        )
-                        ],
-                        [
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
-                            'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
-                            'display_html_label_text' => false,
-                        ]
-                    );
-            }
-        }
-        return $copy_attendee_info_inputs;
-    }
+				$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ]
+					= new EE_Checkbox_Multi_Input(
+						[
+						$registration->ID() => sprintf(
+							esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
+							$registration->count()
+						)
+						],
+						[
+							'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+							'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
+							'display_html_label_text' => false,
+						]
+					);
+			}
+		}
+		return $copy_attendee_info_inputs;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -56,18 +56,18 @@ 
             if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
                 // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
                 if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name   = $registration->ticket()->name();
-                    $item_name   .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
+                    $item_name = $registration->ticket()->name();
+                    $item_name .= $registration->ticket()->description() !== ''
+                        ? ' - '.$registration->ticket()->description()
                         : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ]
+                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'.$registration->ticket()->ID().']']
                                  = new EE_Form_Section_HTML(
-                                     '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+                                     '<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
                                  );
                     $prev_ticket = $registration->ticket()->ID();
                 }
 
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ]
+                $copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']']
                     = new EE_Checkbox_Multi_Input(
                         [
                         $registration->ID() => sprintf(
@@ -76,7 +76,7 @@ 
                         )
                         ],
                         [
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+                            'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
                             'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
                             'display_html_label_text' => false,
                         ]

core/domain/services/registration/form/v1/RegForm.php

Spacing +14 added lines, -14 removed lines

@@ -139,7 +139,7 @@ 
      */
     public function addRequiredQuestion(string $identifier, string $required_question): void
     {
-        $this->required_questions[ $identifier ] = $required_question;
+        $this->required_questions[$identifier] = $required_question;
     }
 
 
@@ -203,17 +203,17 @@ 
                     // Increment the reg forms number if form is valid.
                     if ($registrant_form->hasQuestions()) {
                         $this->reg_form_count++;
-                        $subsections[ $reg_url_link ] = $registrant_form;
+                        $subsections[$reg_url_link] = $registrant_form;
                     } else {
                         // or just add a blank section if there are no questions
-                        $subsections[ $reg_url_link ] = new EE_Form_Section_HTML();
+                        $subsections[$reg_url_link] = new EE_Form_Section_HTML();
                     }
 
-                    $this->template_args['registrations'][ $reg_url_link ]                = $registration;
-                    $this->template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
-                        $this->template_args['ticket_count'][ $registration->ticket()->ID() ]
+                    $this->template_args['registrations'][$reg_url_link]                = $registration;
+                    $this->template_args['ticket_count'][$registration->ticket()->ID()] = isset(
+                        $this->template_args['ticket_count'][$registration->ticket()->ID()]
                     )
-                        ? $this->template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+                        ? $this->template_args['ticket_count'][$registration->ticket()->ID()] + 1
                         : 1;
                     $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
                         $this->reg_step->checkout->cart->get_grand_total(),
@@ -223,7 +223,7 @@ 
                     $ticket_line_item = is_array($ticket_line_item)
                         ? reset($ticket_line_item)
                         : $ticket_line_item;
-                    $this->template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+                    $this->template_args['ticket_line_item'][$registration->ticket()->ID()] =
                         $Line_Item_Display->display_line_item($ticket_line_item);
                     if ($registration->is_primary_registrant()) {
                         $primary_registrant = $reg_url_link;
@@ -233,13 +233,13 @@ 
 
             if ($primary_registrant && count($registrations) > 1) {
                 if (
-                    isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+                    isset($subsections[$primary_registrant])
+                    && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
                 ) {
                     $copy_options['spco_copy_attendee_chk'] = $this->print_copy_info
                         ? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
                         : new AutoCopyAttendeeInfoForm($this->reg_step->slug());
-                    $subsections[ $primary_registrant ]->add_subsections(
+                    $subsections[$primary_registrant]->add_subsections(
                         $copy_options,
                         'primary_registrant',
                         false
@@ -251,8 +251,8 @@ 
         // Set the registration form template (default: one form per ticket details table).
         // We decide the template to used based on the number of forms.
         $template = $this->reg_form_count > 1
-            ? SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_main.template.php'
-            : SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_single.template.php';
+            ? SPCO_REG_STEPS_PATH . $this->reg_step->slug().'/attendee_info_main.template.php'
+            : SPCO_REG_STEPS_PATH.$this->reg_step->slug().'/attendee_info_single.template.php';
         $this->reg_step->setTemplate($template);
 
         return $subsections;
@@ -266,7 +266,7 @@ 
     private function addPrivacyConsentCheckbox(EE_Form_Section_Proper $extra_inputs_section)
     {
         // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
+        if ( ! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
             $extra_inputs_section->add_subsections(
                 [
                     'consent_box' => new PrivacyConsentCheckboxForm(

Indentation +220 added lines, -220 removed lines

@@ -31,251 +31,251 @@
  */
 class RegForm extends EE_Form_Section_Proper
 {
-    /**
-     * @var bool
-     */
-    private $print_copy_info = false;
+	/**
+	 * @var bool
+	 */
+	private $print_copy_info = false;
 
-    /**
-     * @var EE_Registration_Config
-     */
-    public $reg_config;
+	/**
+	 * @var EE_Registration_Config
+	 */
+	public $reg_config;
 
-    /**
-     * @var int
-     */
-    protected $reg_form_count = 0;
+	/**
+	 * @var int
+	 */
+	protected $reg_form_count = 0;
 
-    /**
-     * @var EE_SPCO_Reg_Step_Attendee_Information
-     */
-    public $reg_step;
+	/**
+	 * @var EE_SPCO_Reg_Step_Attendee_Information
+	 */
+	public $reg_step;
 
-    /**
-     * @var array
-     */
-    private $required_questions = [];
+	/**
+	 * @var array
+	 */
+	private $required_questions = [];
 
-    /**
-     * @var array
-     */
-    private $template_args = [];
+	/**
+	 * @var array
+	 */
+	private $template_args = [];
 
 
-    /**
-     * RegForm constructor.
-     *
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration_Config                $reg_config
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct(
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration_Config $reg_config
-    ) {
-        $this->reg_step   = $reg_step;
-        $this->reg_config = $reg_config;
-        // setup some classes so that they are ready for loading during construction of other classes
-        LoaderFactory::getShared(CountryOptions::class, [$this->reg_step->checkout->action]);
-        LoaderFactory::getShared(StateOptions::class, [$this->reg_step->checkout->action]);
-        LoaderFactory::getShared(RegFormQuestionFactory::class, [[$this, 'addRequiredQuestion']]);
-        parent::__construct(
-            [
-                'name'            => $this->reg_step->reg_form_name(),
-                'html_id'         => $this->reg_step->reg_form_name(),
-                'subsections'     => $this->generateSubsections(),
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => $this->reg_step->template(), // layout_template
-                        'template_args'        => $this->template_args,
-                    ]
-                ),
-            ]
-        );
-    }
+	/**
+	 * RegForm constructor.
+	 *
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration_Config                $reg_config
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration_Config $reg_config
+	) {
+		$this->reg_step   = $reg_step;
+		$this->reg_config = $reg_config;
+		// setup some classes so that they are ready for loading during construction of other classes
+		LoaderFactory::getShared(CountryOptions::class, [$this->reg_step->checkout->action]);
+		LoaderFactory::getShared(StateOptions::class, [$this->reg_step->checkout->action]);
+		LoaderFactory::getShared(RegFormQuestionFactory::class, [[$this, 'addRequiredQuestion']]);
+		parent::__construct(
+			[
+				'name'            => $this->reg_step->reg_form_name(),
+				'html_id'         => $this->reg_step->reg_form_name(),
+				'subsections'     => $this->generateSubsections(),
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => $this->reg_step->template(), // layout_template
+						'template_args'        => $this->template_args,
+					]
+				),
+			]
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    public function enablePrintCopyInfo(): void
-    {
-        $this->print_copy_info = true;
-    }
+	/**
+	 * @return void
+	 */
+	public function enablePrintCopyInfo(): void
+	{
+		$this->print_copy_info = true;
+	}
 
 
-    /**
-     * @return bool
-     */
-    public function printCopyInfo(): bool
-    {
-        return $this->print_copy_info;
-    }
+	/**
+	 * @return bool
+	 */
+	public function printCopyInfo(): bool
+	{
+		return $this->print_copy_info;
+	}
 
 
-    /**
-     * @return int
-     */
-    public function regFormCount(): int
-    {
-        return $this->reg_form_count;
-    }
+	/**
+	 * @return int
+	 */
+	public function regFormCount(): int
+	{
+		return $this->reg_form_count;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function requiredQuestions(): array
-    {
-        return $this->required_questions;
-    }
+	/**
+	 * @return array
+	 */
+	public function requiredQuestions(): array
+	{
+		return $this->required_questions;
+	}
 
 
-    /**
-     * @param string $identifier
-     * @param string $required_question
-     */
-    public function addRequiredQuestion(string $identifier, string $required_question): void
-    {
-        $this->required_questions[ $identifier ] = $required_question;
-    }
+	/**
+	 * @param string $identifier
+	 * @param string $required_question
+	 */
+	public function addRequiredQuestion(string $identifier, string $required_question): void
+	{
+		$this->required_questions[ $identifier ] = $required_question;
+	}
 
 
-    /**
-     * @return EE_Form_Section_Proper[]
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function generateSubsections(): array
-    {
-        // Init reg forms count.
-        $this->reg_form_count = 0;
+	/**
+	 * @return EE_Form_Section_Proper[]
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function generateSubsections(): array
+	{
+		// Init reg forms count.
+		$this->reg_form_count = 0;
 
-        $primary_registrant = null;
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display();
-        // calculate taxes
-        $Line_Item_Display->display_line_item(
-            $this->reg_step->checkout->cart->get_grand_total(),
-            ['set_tax_rate' => true]
-        );
-        $extra_inputs_section = $this->reg_step->reg_step_hidden_inputs();
-        $this->addPrivacyConsentCheckbox($extra_inputs_section);
-        $subsections = [
-            'default_hidden_inputs' => $extra_inputs_section,
-        ];
+		$primary_registrant = null;
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display();
+		// calculate taxes
+		$Line_Item_Display->display_line_item(
+			$this->reg_step->checkout->cart->get_grand_total(),
+			['set_tax_rate' => true]
+		);
+		$extra_inputs_section = $this->reg_step->reg_step_hidden_inputs();
+		$this->addPrivacyConsentCheckbox($extra_inputs_section);
+		$subsections = [
+			'default_hidden_inputs' => $extra_inputs_section,
+		];
 
-        $this->template_args = [
-            'revisit'       => $this->reg_step->checkout->revisit,
-            'registrations' => [],
-            'ticket_count'  => [],
-        ];
-        // grab the saved registrations from the transaction
-        $registrations = $this->reg_step->checkout->transaction->registrations(
-            $this->reg_step->checkout->reg_cache_where_params
-        );
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                // can this registration be processed during this visit ?
-                if (
-                    $registration instanceof EE_Registration
-                    && $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)
-                ) {
-                    $reg_url_link = $registration->reg_url_link();
-                    /** @var RegistrantForm $registrant_form */
-                    $registrant_form = LoaderFactory::getNew(
-                        RegistrantForm::class,
-                        [
-                            $registration,
-                            $this->reg_config->copyAttendeeInfo(),
-                            [$this, 'enablePrintCopyInfo'],
-                            $this->reg_step,
-                        ]
-                    );
-                    // Increment the reg forms number if form is valid.
-                    if ($registrant_form->hasQuestions()) {
-                        $this->reg_form_count++;
-                        $subsections[ $reg_url_link ] = $registrant_form;
-                    } else {
-                        // or just add a blank section if there are no questions
-                        $subsections[ $reg_url_link ] = new EE_Form_Section_HTML();
-                    }
+		$this->template_args = [
+			'revisit'       => $this->reg_step->checkout->revisit,
+			'registrations' => [],
+			'ticket_count'  => [],
+		];
+		// grab the saved registrations from the transaction
+		$registrations = $this->reg_step->checkout->transaction->registrations(
+			$this->reg_step->checkout->reg_cache_where_params
+		);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				// can this registration be processed during this visit ?
+				if (
+					$registration instanceof EE_Registration
+					&& $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)
+				) {
+					$reg_url_link = $registration->reg_url_link();
+					/** @var RegistrantForm $registrant_form */
+					$registrant_form = LoaderFactory::getNew(
+						RegistrantForm::class,
+						[
+							$registration,
+							$this->reg_config->copyAttendeeInfo(),
+							[$this, 'enablePrintCopyInfo'],
+							$this->reg_step,
+						]
+					);
+					// Increment the reg forms number if form is valid.
+					if ($registrant_form->hasQuestions()) {
+						$this->reg_form_count++;
+						$subsections[ $reg_url_link ] = $registrant_form;
+					} else {
+						// or just add a blank section if there are no questions
+						$subsections[ $reg_url_link ] = new EE_Form_Section_HTML();
+					}
 
-                    $this->template_args['registrations'][ $reg_url_link ]                = $registration;
-                    $this->template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
-                        $this->template_args['ticket_count'][ $registration->ticket()->ID() ]
-                    )
-                        ? $this->template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
-                        : 1;
-                    $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                        $this->reg_step->checkout->cart->get_grand_total(),
-                        'Ticket',
-                        [$registration->ticket()->ID()]
-                    );
-                    $ticket_line_item = is_array($ticket_line_item)
-                        ? reset($ticket_line_item)
-                        : $ticket_line_item;
-                    $this->template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
-                        $Line_Item_Display->display_line_item($ticket_line_item);
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $reg_url_link;
-                    }
-                }
-            }
+					$this->template_args['registrations'][ $reg_url_link ]                = $registration;
+					$this->template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
+						$this->template_args['ticket_count'][ $registration->ticket()->ID() ]
+					)
+						? $this->template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+						: 1;
+					$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+						$this->reg_step->checkout->cart->get_grand_total(),
+						'Ticket',
+						[$registration->ticket()->ID()]
+					);
+					$ticket_line_item = is_array($ticket_line_item)
+						? reset($ticket_line_item)
+						: $ticket_line_item;
+					$this->template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+						$Line_Item_Display->display_line_item($ticket_line_item);
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $reg_url_link;
+					}
+				}
+			}
 
-            if ($primary_registrant && count($registrations) > 1) {
-                if (
-                    isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
-                ) {
-                    $copy_options['spco_copy_attendee_chk'] = $this->print_copy_info
-                        ? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
-                        : new AutoCopyAttendeeInfoForm($this->reg_step->slug());
-                    $subsections[ $primary_registrant ]->add_subsections(
-                        $copy_options,
-                        'primary_registrant',
-                        false
-                    );
-                }
-            }
-        }
+			if ($primary_registrant && count($registrations) > 1) {
+				if (
+					isset($subsections[ $primary_registrant ])
+					&& $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+				) {
+					$copy_options['spco_copy_attendee_chk'] = $this->print_copy_info
+						? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
+						: new AutoCopyAttendeeInfoForm($this->reg_step->slug());
+					$subsections[ $primary_registrant ]->add_subsections(
+						$copy_options,
+						'primary_registrant',
+						false
+					);
+				}
+			}
+		}
 
-        // Set the registration form template (default: one form per ticket details table).
-        // We decide the template to used based on the number of forms.
-        $template = $this->reg_form_count > 1
-            ? SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_main.template.php'
-            : SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_single.template.php';
-        $this->reg_step->setTemplate($template);
+		// Set the registration form template (default: one form per ticket details table).
+		// We decide the template to used based on the number of forms.
+		$template = $this->reg_form_count > 1
+			? SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_main.template.php'
+			: SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_single.template.php';
+		$this->reg_step->setTemplate($template);
 
-        return $subsections;
-    }
+		return $subsections;
+	}
 
 
-    /**
-     * @param EE_Form_Section_Proper $extra_inputs_section
-     * @throws EE_Error
-     */
-    private function addPrivacyConsentCheckbox(EE_Form_Section_Proper $extra_inputs_section)
-    {
-        // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
-            $extra_inputs_section->add_subsections(
-                [
-                    'consent_box' => new PrivacyConsentCheckboxForm(
-                        $this->reg_step->slug(),
-                        $this->reg_config->getConsentCheckboxLabelText()
-                    )
-                ],
-                null,
-                false
-            );
-        }
-    }
+	/**
+	 * @param EE_Form_Section_Proper $extra_inputs_section
+	 * @throws EE_Error
+	 */
+	private function addPrivacyConsentCheckbox(EE_Form_Section_Proper $extra_inputs_section)
+	{
+		// if this isn't a revisit, and they have the privacy consent box enabled, add it
+		if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
+			$extra_inputs_section->add_subsections(
+				[
+					'consent_box' => new PrivacyConsentCheckboxForm(
+						$this->reg_step->slug(),
+						$this->reg_config->getConsentCheckboxLabelText()
+					)
+				],
+				null,
+				false
+			);
+		}
+	}
 }

core/services/orm/tree_traversal/NodeGroupDao.php

Spacing +5 added lines, -5 removed lines

@@ -50,7 +50,7 @@ 
      */
     public function getModelObjNodesInGroup($code)
     {
-        if (! $code) {
+        if ( ! $code) {
             throw new Exception(
                 esc_html__(
                     'We aren’t sure which job you are performing. Please press back in your browser and try again.',
@@ -58,9 +58,9 @@ 
                 )
             );
         }
-        $deletion_data = get_option($this->getOptionPrefix() . $code, []);
+        $deletion_data = get_option($this->getOptionPrefix().$code, []);
         foreach ($deletion_data as $root) {
-            if (! $root instanceof ModelObjNode) {
+            if ( ! $root instanceof ModelObjNode) {
                 throw new UnexpectedEntityException($root, 'ModelObjNode');
             }
         }
@@ -121,7 +121,7 @@ 
     public function persistModelObjNodesGroup(array $model_obj_nodes, $code)
     {
         return add_option(
-            $this->getOptionPrefix() . $code,
+            $this->getOptionPrefix().$code,
             $model_obj_nodes,
             null,
             'no'
@@ -137,7 +137,7 @@ 
      */
     public function deleteModelObjNodesInGroup($code)
     {
-        return delete_option($this->getOptionPrefix() . $code);
+        return delete_option($this->getOptionPrefix().$code);
     }
 }
 // End of file NodeGroupDao.php

Indentation +107 added lines, -107 removed lines

@@ -22,125 +22,125 @@
  */
 class NodeGroupDao
 {
-    /**
-     * @return mixed|void
-     */
-    public function generateGroupCode()
-    {
-        return wp_generate_password(6, false);
-    }
+	/**
+	 * @return mixed|void
+	 */
+	public function generateGroupCode()
+	{
+		return wp_generate_password(6, false);
+	}
 
 
-    /**
-     * Gets the string we put in front of the WP Option name used to store the jobs.
-     *
-     * @return string
-     */
-    private function getOptionPrefix()
-    {
-        return 'ee_deletion_';
-    }
+	/**
+	 * Gets the string we put in front of the WP Option name used to store the jobs.
+	 *
+	 * @return string
+	 */
+	private function getOptionPrefix()
+	{
+		return 'ee_deletion_';
+	}
 
 
-    /**
-     * @param $code
-     * @return ModelObjNode[]
-     * @throws Exception
-     * @throws UnexpectedEntityException
-     * @throws Exception
-     */
-    public function getModelObjNodesInGroup($code)
-    {
-        if (! $code) {
-            throw new Exception(
-                esc_html__(
-                    'We aren’t sure which job you are performing. Please press back in your browser and try again.',
-                    'event_espresso'
-                )
-            );
-        }
-        $deletion_data = get_option($this->getOptionPrefix() . $code, []);
-        foreach ($deletion_data as $root) {
-            if (! $root instanceof ModelObjNode) {
-                throw new UnexpectedEntityException($root, 'ModelObjNode');
-            }
-        }
-        return $deletion_data;
-    }
+	/**
+	 * @param $code
+	 * @return ModelObjNode[]
+	 * @throws Exception
+	 * @throws UnexpectedEntityException
+	 * @throws Exception
+	 */
+	public function getModelObjNodesInGroup($code)
+	{
+		if (! $code) {
+			throw new Exception(
+				esc_html__(
+					'We aren’t sure which job you are performing. Please press back in your browser and try again.',
+					'event_espresso'
+				)
+			);
+		}
+		$deletion_data = get_option($this->getOptionPrefix() . $code, []);
+		foreach ($deletion_data as $root) {
+			if (! $root instanceof ModelObjNode) {
+				throw new UnexpectedEntityException($root, 'ModelObjNode');
+			}
+		}
+		return $deletion_data;
+	}
 
 
-    /**
-     * Gets an array indicating what database rows are contained in the job.
-     * Each top-level key is a model name, and its value is an array of IDs.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function getModelsAndIdsContainedIn(array $model_obj_nodes)
-    {
-        $models_and_ids_to_delete = [];
-        foreach ($model_obj_nodes as $root) {
-            $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
-        }
-        return $models_and_ids_to_delete;
-    }
+	/**
+	 * Gets an array indicating what database rows are contained in the job.
+	 * Each top-level key is a model name, and its value is an array of IDs.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function getModelsAndIdsContainedIn(array $model_obj_nodes)
+	{
+		$models_and_ids_to_delete = [];
+		foreach ($model_obj_nodes as $root) {
+			$models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
+		}
+		return $models_and_ids_to_delete;
+	}
 
 
-    /**
-     * Gets an array indicating what database rows are contained in the job.
-     * Each top-level key is a model name, and its value is an array of IDs.
-     *
-     * @param string $code
-     * @return array
-     * @throws EE_Error
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     * @throws Exception
-     */
-    public function getModelsAndIdsFromGroup($code)
-    {
-        $model_obj_nodes = $this->getModelObjNodesInGroup($code);
-        return $this->getModelsAndIdsContainedIn($model_obj_nodes);
-    }
+	/**
+	 * Gets an array indicating what database rows are contained in the job.
+	 * Each top-level key is a model name, and its value is an array of IDs.
+	 *
+	 * @param string $code
+	 * @return array
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 * @throws Exception
+	 */
+	public function getModelsAndIdsFromGroup($code)
+	{
+		$model_obj_nodes = $this->getModelObjNodesInGroup($code);
+		return $this->getModelsAndIdsContainedIn($model_obj_nodes);
+	}
 
 
-    /**
-     * Persists the ModelObjNodes for future requests, using the code for reference.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @param string         $code
-     * @return bool
-     */
-    public function persistModelObjNodesGroup(array $model_obj_nodes, $code)
-    {
-        return add_option(
-            $this->getOptionPrefix() . $code,
-            $model_obj_nodes,
-            null,
-            'no'
-        );
-    }
+	/**
+	 * Persists the ModelObjNodes for future requests, using the code for reference.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @param string         $code
+	 * @return bool
+	 */
+	public function persistModelObjNodesGroup(array $model_obj_nodes, $code)
+	{
+		return add_option(
+			$this->getOptionPrefix() . $code,
+			$model_obj_nodes,
+			null,
+			'no'
+		);
+	}
 
 
-    /**
-     * Forgets about the group of ModelObjNodes. Doesn't delete the rows in the database they reference though.
-     *
-     * @param $code
-     * @return bool
-     */
-    public function deleteModelObjNodesInGroup($code)
-    {
-        return delete_option($this->getOptionPrefix() . $code);
-    }
+	/**
+	 * Forgets about the group of ModelObjNodes. Doesn't delete the rows in the database they reference though.
+	 *
+	 * @param $code
+	 * @return bool
+	 */
+	public function deleteModelObjNodesInGroup($code)
+	{
+		return delete_option($this->getOptionPrefix() . $code);
+	}
 }
 // End of file NodeGroupDao.php
 // Location: EventEspresso\core\services\orm\tree_traversal/NodeGroupDao.php

core/services/orm/tree_traversal/RelationNode.php

Spacing +8 added lines, -8 removed lines

@@ -98,17 +98,17 @@ 
                     ],
                 ]
             );
-            $new_item_nodes     = [];
+            $new_item_nodes = [];
 
             // Add entity nodes for each of the model objects we fetched.
             foreach ($related_model_objs as $related_model_obj) {
-                $entity_node                                = new ModelObjNode(
+                $entity_node = new ModelObjNode(
                     $related_model_obj->ID(),
                     $related_model_obj->get_model(),
                     $this->dont_traverse_models
                 );
-                $this->nodes[ $related_model_obj->ID() ]    = $entity_node;
-                $new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
+                $this->nodes[$related_model_obj->ID()]    = $entity_node;
+                $new_item_nodes[$related_model_obj->ID()] = $entity_node;
             }
             $num_identified += count($new_item_nodes);
             if ($num_identified < $model_objects_to_identify) {
@@ -135,7 +135,7 @@ 
     protected function allChildrenComplete()
     {
         foreach ($this->nodes as $model_obj_node) {
-            if (! $model_obj_node->isComplete()) {
+            if ( ! $model_obj_node->isComplete()) {
                 return false;
             }
         }
@@ -153,7 +153,7 @@ 
     protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
     {
         $work_done = 0;
-        if (! $model_obj_nodes) {
+        if ( ! $model_obj_nodes) {
             return 0;
         }
         foreach ($model_obj_nodes as $model_obj_node) {
@@ -229,7 +229,7 @@ 
             $relation_settings = null;
         }
         if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
-            $where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] =
+            $where_params[$this->related_model->get_field_containing_related_model_name()->get_name()] =
                 $this->main_model->get_this_model_name();
         }
         return $where_params;
@@ -249,7 +249,7 @@ 
             'objs'     => [],
         ];
         foreach ($this->nodes as $id => $model_obj_node) {
-            $tree['objs'][ $id ] = $model_obj_node->toArray();
+            $tree['objs'][$id] = $model_obj_node->toArray();
         }
         return $tree;
     }

Indentation +303 added lines, -303 removed lines

@@ -24,309 +24,309 @@
  */
 class RelationNode extends BaseNode
 {
-    /**
-     * @var int
-     */
-    protected $count;
-
-    /**
-     * @var string|int
-     */
-    protected $id;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $main_model;
-
-    /**
-     * @var ModelObjNode[]
-     */
-    protected $nodes;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $related_model;
-
-
-
-    /**
-     * RelationNode constructor.
-     *
-     * @param          $main_model_obj_id
-     * @param EEM_Base $main_model
-     * @param EEM_Base $related_model
-     * @param array    $dont_traverse_models array of model names we DON'T want to traverse
-     */
-    public function __construct(
-        $main_model_obj_id,
-        EEM_Base $main_model,
-        EEM_Base $related_model,
-        array $dont_traverse_models = []
-    ) {
-        $this->id                   = $main_model_obj_id;
-        $this->main_model           = $main_model;
-        $this->related_model        = $related_model;
-        $this->nodes                = [];
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
-
-
-    /**
-     * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
-     * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
-     *
-     * @param int $model_objects_to_identify
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
-        if ($num_identified < $model_objects_to_identify) {
-            $related_model_objs = $this->related_model->get_all(
-                [
-                    $this->whereQueryParams(),
-                    'limit' => [
-                        count($this->nodes),
-                        $model_objects_to_identify - $num_identified,
-                    ],
-                ]
-            );
-            $new_item_nodes     = [];
-
-            // Add entity nodes for each of the model objects we fetched.
-            foreach ($related_model_objs as $related_model_obj) {
-                $entity_node                                = new ModelObjNode(
-                    $related_model_obj->ID(),
-                    $related_model_obj->get_model(),
-                    $this->dont_traverse_models
-                );
-                $this->nodes[ $related_model_obj->ID() ]    = $entity_node;
-                $new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
-            }
-            $num_identified += count($new_item_nodes);
-            if ($num_identified < $model_objects_to_identify) {
-                // And lastly do the work.
-                $num_identified += $this->visitAlreadyDiscoveredNodes(
-                    $new_item_nodes,
-                    $model_objects_to_identify - $num_identified
-                );
-            }
-        }
-
-        if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
-            $this->complete = true;
-        }
-        return $num_identified;
-    }
-
-
-    /**
-     * Checks if all the identified child nodes are complete or not.
-     *
-     * @return bool
-     */
-    protected function allChildrenComplete()
-    {
-        foreach ($this->nodes as $model_obj_node) {
-            if (! $model_obj_node->isComplete()) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @param                $work_budget
-     * @return int
-     */
-    protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
-    {
-        $work_done = 0;
-        if (! $model_obj_nodes) {
-            return 0;
-        }
-        foreach ($model_obj_nodes as $model_obj_node) {
-            if ($work_done >= $work_budget) {
-                break;
-            }
-            $work_done += $model_obj_node->visit($work_budget - $work_done);
-        }
-        return $work_done;
-    }
-
-
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->count !== null;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            if (count($this->nodes) === $this->count) {
-                $this->complete = true;
-            } else {
-                $this->complete = false;
-            }
-        }
-        return $this->complete;
-    }
-
-
-    /**
-     * Discovers how many related model objects exist.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function discover()
-    {
-        $this->count = $this->related_model->count([$this->whereQueryParams()]);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function whereQueryParams()
-    {
-        $where_params = [
-            $this->related_model->get_foreign_key_to(
-                $this->main_model->get_this_model_name()
-            )->get_name() => $this->id,
-        ];
-        try {
-            $relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
-        } catch (EE_Error $e) {
-            // This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
-            // which hasn't been explicitly declared in the main model object's model's relations.
-            $relation_settings = null;
-        }
-        if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
-            $where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] =
-                $this->main_model->get_this_model_name();
-        }
-        return $where_params;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function toArray()
-    {
-        $tree = [
-            'count'    => $this->count,
-            'complete' => $this->isComplete(),
-            'objs'     => [],
-        ];
-        foreach ($this->nodes as $id => $model_obj_node) {
-            $tree['objs'][ $id ] = $model_obj_node->toArray();
-        }
-        return $tree;
-    }
-
-
-    /**
-     * Gets the IDs of all the model objects to delete; indexed first by model object name.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getIds()
-    {
-        if (empty($this->nodes)) {
-            return [];
-        }
-        $ids = [
-            $this->related_model->get_this_model_name() => array_combine(
-                array_keys($this->nodes),
-                array_keys($this->nodes)
-            ),
-        ];
-        foreach ($this->nodes as $model_obj_node) {
-            $ids = array_replace_recursive($ids, $model_obj_node->getIds());
-        }
-        return $ids;
-    }
-
-
-    /**
-     * Returns the number of sub-nodes found (ie, related model objects across this relation.)
-     *
-     * @return int
-     */
-    public function countSubNodes()
-    {
-        return count($this->nodes);
-    }
-
-
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $this->m  = $this->main_model->get_this_model_name();
-        $this->rm = $this->related_model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'rm',
-                'id',
-                'count',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
-
-
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        $this->main_model    = EE_Registry::instance()->load_model($this->m);
-        $this->related_model = EE_Registry::instance()->load_model($this->rm);
-        parent::__wakeup();
-    }
+	/**
+	 * @var int
+	 */
+	protected $count;
+
+	/**
+	 * @var string|int
+	 */
+	protected $id;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $main_model;
+
+	/**
+	 * @var ModelObjNode[]
+	 */
+	protected $nodes;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $related_model;
+
+
+
+	/**
+	 * RelationNode constructor.
+	 *
+	 * @param          $main_model_obj_id
+	 * @param EEM_Base $main_model
+	 * @param EEM_Base $related_model
+	 * @param array    $dont_traverse_models array of model names we DON'T want to traverse
+	 */
+	public function __construct(
+		$main_model_obj_id,
+		EEM_Base $main_model,
+		EEM_Base $related_model,
+		array $dont_traverse_models = []
+	) {
+		$this->id                   = $main_model_obj_id;
+		$this->main_model           = $main_model;
+		$this->related_model        = $related_model;
+		$this->nodes                = [];
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
+
+
+	/**
+	 * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
+	 * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
+	 *
+	 * @param int $model_objects_to_identify
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
+		if ($num_identified < $model_objects_to_identify) {
+			$related_model_objs = $this->related_model->get_all(
+				[
+					$this->whereQueryParams(),
+					'limit' => [
+						count($this->nodes),
+						$model_objects_to_identify - $num_identified,
+					],
+				]
+			);
+			$new_item_nodes     = [];
+
+			// Add entity nodes for each of the model objects we fetched.
+			foreach ($related_model_objs as $related_model_obj) {
+				$entity_node                                = new ModelObjNode(
+					$related_model_obj->ID(),
+					$related_model_obj->get_model(),
+					$this->dont_traverse_models
+				);
+				$this->nodes[ $related_model_obj->ID() ]    = $entity_node;
+				$new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
+			}
+			$num_identified += count($new_item_nodes);
+			if ($num_identified < $model_objects_to_identify) {
+				// And lastly do the work.
+				$num_identified += $this->visitAlreadyDiscoveredNodes(
+					$new_item_nodes,
+					$model_objects_to_identify - $num_identified
+				);
+			}
+		}
+
+		if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
+			$this->complete = true;
+		}
+		return $num_identified;
+	}
+
+
+	/**
+	 * Checks if all the identified child nodes are complete or not.
+	 *
+	 * @return bool
+	 */
+	protected function allChildrenComplete()
+	{
+		foreach ($this->nodes as $model_obj_node) {
+			if (! $model_obj_node->isComplete()) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @param                $work_budget
+	 * @return int
+	 */
+	protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
+	{
+		$work_done = 0;
+		if (! $model_obj_nodes) {
+			return 0;
+		}
+		foreach ($model_obj_nodes as $model_obj_node) {
+			if ($work_done >= $work_budget) {
+				break;
+			}
+			$work_done += $model_obj_node->visit($work_budget - $work_done);
+		}
+		return $work_done;
+	}
+
+
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->count !== null;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			if (count($this->nodes) === $this->count) {
+				$this->complete = true;
+			} else {
+				$this->complete = false;
+			}
+		}
+		return $this->complete;
+	}
+
+
+	/**
+	 * Discovers how many related model objects exist.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function discover()
+	{
+		$this->count = $this->related_model->count([$this->whereQueryParams()]);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function whereQueryParams()
+	{
+		$where_params = [
+			$this->related_model->get_foreign_key_to(
+				$this->main_model->get_this_model_name()
+			)->get_name() => $this->id,
+		];
+		try {
+			$relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
+		} catch (EE_Error $e) {
+			// This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
+			// which hasn't been explicitly declared in the main model object's model's relations.
+			$relation_settings = null;
+		}
+		if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
+			$where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] =
+				$this->main_model->get_this_model_name();
+		}
+		return $where_params;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'count'    => $this->count,
+			'complete' => $this->isComplete(),
+			'objs'     => [],
+		];
+		foreach ($this->nodes as $id => $model_obj_node) {
+			$tree['objs'][ $id ] = $model_obj_node->toArray();
+		}
+		return $tree;
+	}
+
+
+	/**
+	 * Gets the IDs of all the model objects to delete; indexed first by model object name.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getIds()
+	{
+		if (empty($this->nodes)) {
+			return [];
+		}
+		$ids = [
+			$this->related_model->get_this_model_name() => array_combine(
+				array_keys($this->nodes),
+				array_keys($this->nodes)
+			),
+		];
+		foreach ($this->nodes as $model_obj_node) {
+			$ids = array_replace_recursive($ids, $model_obj_node->getIds());
+		}
+		return $ids;
+	}
+
+
+	/**
+	 * Returns the number of sub-nodes found (ie, related model objects across this relation.)
+	 *
+	 * @return int
+	 */
+	public function countSubNodes()
+	{
+		return count($this->nodes);
+	}
+
+
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$this->m  = $this->main_model->get_this_model_name();
+		$this->rm = $this->related_model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'rm',
+				'id',
+				'count',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
+
+
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		$this->main_model    = EE_Registry::instance()->load_model($this->m);
+		$this->related_model = EE_Registry::instance()->load_model($this->rm);
+		parent::__wakeup();
+	}
 }
 // End of file RelationNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/RelationNode.php

core/libraries/plugin_api/EE_Register_Personal_Data_Exporter.lib.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      */
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
-        self::$exporters[ $addon_name ] = $setup_args;
+        self::$exporters[$addon_name] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
@@ -44,7 +44,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$exporters[ $addon_name ]);
+        unset(self::$exporters[$addon_name]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,57 +12,57 @@
  */
 class EE_Register_Personal_Data_Exporter implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $exporters = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $exporters = [];
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     * @return bool
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        self::$exporters[ $addon_name ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
-            ['EE_Register_Personal_Data_Exporter', 'addExporters']
-        );
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 * @return bool
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		self::$exporters[ $addon_name ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
+			['EE_Register_Personal_Data_Exporter', 'addExporters']
+		);
+		return true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$exporters[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$exporters[ $addon_name ]);
+	}
 
 
-    /**
-     * Adds our personal data exporters registered by add-ons
-     *
-     * @param string[] $exporters
-     * @return string[]
-     */
-    public static function addExporters(array $exporters): array
-    {
-        return array_merge($exporters, ...self::$exporters);
-    }
+	/**
+	 * Adds our personal data exporters registered by add-ons
+	 *
+	 * @param string[] $exporters
+	 * @return string[]
+	 */
+	public static function addExporters(array $exporters): array
+	{
+		return array_merge($exporters, ...self::$exporters);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$exporters = [];
-    }
+	public static function reset(): void
+	{
+		self::$exporters = [];
+	}
 }
 // End of file EE_Register_Personal_Data_Exporter.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Exporter.lib.php

core/libraries/plugin_api/EE_Register_Personal_Data_Eraser.lib.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      */
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
-        self::$erasers[ $addon_name ] = $setup_args;
+        self::$erasers[$addon_name] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
@@ -44,7 +44,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$erasers[ $addon_name ]);
+        unset(self::$erasers[$addon_name]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,57 +12,57 @@
  */
 class EE_Register_Personal_Data_Eraser implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $erasers = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $erasers = [];
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     * @return bool
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        self::$erasers[ $addon_name ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
-            ['EE_Register_Personal_Data_Eraser', 'addErasers']
-        );
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 * @return bool
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		self::$erasers[ $addon_name ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
+			['EE_Register_Personal_Data_Eraser', 'addErasers']
+		);
+		return true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$erasers[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$erasers[ $addon_name ]);
+	}
 
 
-    /**
-     * Adds our personal data erasers registered by add-ons
-     *
-     * @param string[] $erasers
-     * @return string[]
-     */
-    public static function addErasers(array $erasers): array
-    {
-        return array_merge($erasers, ...self::$erasers);
-    }
+	/**
+	 * Adds our personal data erasers registered by add-ons
+	 *
+	 * @param string[] $erasers
+	 * @return string[]
+	 */
+	public static function addErasers(array $erasers): array
+	{
+		return array_merge($erasers, ...self::$erasers);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$erasers = [];
-    }
+	public static function reset(): void
+	{
+		self::$erasers = [];
+	}
 }
 // End of file EE_Register_Personal_Data_Eraser.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Eraser.lib.php

core/libraries/plugin_api/EE_Register_Messages_Shortcode_Library.lib.php

Spacing +9 added lines, -9 removed lines

@@ -65,7 +65,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_messages_shortcode_registry[ $addon_name ])) {
+        if (isset(self::$_ee_messages_shortcode_registry[$addon_name])) {
             return true;
         }
 
@@ -87,7 +87,7 @@ 
             );
         }
 
-        self::$_ee_messages_shortcode_registry[ $addon_name ] = [
+        self::$_ee_messages_shortcode_registry[$addon_name] = [
             'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
             'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
                 ? (array) $setup_args['list_type_shortcodes'] : [],
@@ -101,19 +101,19 @@ 
         );
 
         // add below filters if the required callback is provided.
-        if (! empty($setup_args['msgr_validator_callback'])) {
+        if ( ! empty($setup_args['msgr_validator_callback'])) {
             add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
         }
 
-        if (! empty($setup_args['msgr_template_fields_callback'])) {
+        if ( ! empty($setup_args['msgr_template_fields_callback'])) {
             add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
         }
 
-        if (! empty($setup_args['valid_shortcodes_callback'])) {
+        if ( ! empty($setup_args['valid_shortcodes_callback'])) {
             add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
         }
 
-        if (! empty($setup_args['list_type_shortcodes'])) {
+        if ( ! empty($setup_args['list_type_shortcodes'])) {
             add_filter(
                 'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
                 ['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
@@ -133,7 +133,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
+        unset(self::$_ee_messages_shortcode_registry[$addon_name]);
     }
 
 
@@ -148,7 +148,7 @@ 
     public static function register_msgs_autoload_paths(array $paths): array
     {
         $autoload_paths = [];
-        if (! empty(self::$_ee_messages_shortcode_registry)) {
+        if ( ! empty(self::$_ee_messages_shortcode_registry)) {
             foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
                 if (empty($st_reg['autoloadpaths'])) {
                     continue;
@@ -176,7 +176,7 @@ 
         }
         $shortcodes = [];
         foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
-            if (! empty($sc_reg['list_type_shortcodes'])) {
+            if ( ! empty($sc_reg['list_type_shortcodes'])) {
                 $shortcodes[] = $sc_reg['list_type_shortcodes'];
             }
         }

Indentation +176 added lines, -176 removed lines

@@ -10,180 +10,180 @@
  */
 class EE_Register_Messages_Shortcode_Library implements EEI_Plugin_API
 {
-    /**
-     * holds values for registered messages shortcode libraries
-     *
-     * @var array
-     */
-    protected static $_ee_messages_shortcode_registry = [];
-
-
-    /**
-     * Helper method for registering a new shortcodes library class for the messages system.
-     *
-     * Note this is not used for adding shortcodes to existing libraries.  It's for registering anything
-     * related to registering a new EE_{shortcode_library_name}_Shortcodes.lib.php class.
-     *
-     * @param string $addon_name    What is the name of this shortcode library (e.g. 'question_list');
-     * @param array  $setup_args    An array of arguments provided for registering the new messages shortcode library.
-     *                              {
-     *
-     * @type array $autoloadpaths                       An array of paths to add to the messages autoloader
-     *                                                  for the new shortcode library class file.
-     * @type string $msgr_validator_callback            Callback for a method that will register the library with the
-     *                                                  messenger _validator_config. Optional.
-     * @type string  $msgr_template_fields_callback     Callback for changing adding the _template_fields property for
-     *                                                  messenger. For example, the shortcode library may add a new
-     *                                                  field to the message templates. Optional.
-     * @type string  $valid_shortcodes_callback         Callback for message types _valid_shortcodes array setup.
-     *                                                  Optional.
-     * @type array $list_type_shortcodes                If there are any specific shortcodes with this message
-     *                                                  shortcode library that should be considered "list type"
-     *                                                  then include them in an array.
-     *                                                  List Type shortcodes are shortcodes that have a corresponding
-     *                                                  field that indicates how they are parsed. Optional.
-     *                              }
-     * @return bool
-     * @throws EE_Error
-     * @throws EE_Error
-     * @since    4.3.0
-     *
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register a messages shortcode library with EE_Register_Messages_Shortcode_Library::register, you must include a "name" (a unique identifier for this set of message shortcodes), and an array containing the following keys: : "autoload_paths"',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_ee_messages_shortcode_registry[ $addon_name ])) {
-            return true;
-        }
-
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-
-        self::$_ee_messages_shortcode_registry[ $addon_name ] = [
-            'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
-            'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
-                ? (array) $setup_args['list_type_shortcodes'] : [],
-        ];
-
-        // add filters
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            ['EE_Register_Messages_Shortcode_Library', 'register_msgs_autoload_paths'],
-            10
-        );
-
-        // add below filters if the required callback is provided.
-        if (! empty($setup_args['msgr_validator_callback'])) {
-            add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['msgr_template_fields_callback'])) {
-            add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['valid_shortcodes_callback'])) {
-            add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['list_type_shortcodes'])) {
-            add_filter(
-                'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
-                ['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
-                10
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * This deregisters any messages shortcode library previously registered with the given name.
-     *
-     * @param string $addon_name name used to register the shortcode library.
-     * @return  void
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
-    }
-
-
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     * @since    4.3.0
-     *
-     */
-    public static function register_msgs_autoload_paths(array $paths): array
-    {
-        $autoload_paths = [];
-        if (! empty(self::$_ee_messages_shortcode_registry)) {
-            foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
-                if (empty($st_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $autoload_paths[] = $st_reg['autoloadpaths'];
-            }
-        }
-        return array_merge($paths, ...$autoload_paths);
-    }
-
-
-    /**
-     * This is the callback for the FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes
-     * filter which is used to add additional list type shortcodes.
-     *
-     * @param array $original_shortcodes
-     * @return  array                                   Modifications to original shortcodes.
-     * @since 4.3.0
-     *
-     */
-    public static function register_list_type_shortcodes(array $original_shortcodes): array
-    {
-        if (empty(self::$_ee_messages_shortcode_registry)) {
-            return $original_shortcodes;
-        }
-        $shortcodes = [];
-        foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
-            if (! empty($sc_reg['list_type_shortcodes'])) {
-                $shortcodes[] = $sc_reg['list_type_shortcodes'];
-            }
-        }
-        return array_merge($original_shortcodes, ...$shortcodes);
-    }
-
-
-    public static function reset(): void
-    {
-        self::$_ee_messages_shortcode_registry = [];
-    }
+	/**
+	 * holds values for registered messages shortcode libraries
+	 *
+	 * @var array
+	 */
+	protected static $_ee_messages_shortcode_registry = [];
+
+
+	/**
+	 * Helper method for registering a new shortcodes library class for the messages system.
+	 *
+	 * Note this is not used for adding shortcodes to existing libraries.  It's for registering anything
+	 * related to registering a new EE_{shortcode_library_name}_Shortcodes.lib.php class.
+	 *
+	 * @param string $addon_name    What is the name of this shortcode library (e.g. 'question_list');
+	 * @param array  $setup_args    An array of arguments provided for registering the new messages shortcode library.
+	 *                              {
+	 *
+	 * @type array $autoloadpaths                       An array of paths to add to the messages autoloader
+	 *                                                  for the new shortcode library class file.
+	 * @type string $msgr_validator_callback            Callback for a method that will register the library with the
+	 *                                                  messenger _validator_config. Optional.
+	 * @type string  $msgr_template_fields_callback     Callback for changing adding the _template_fields property for
+	 *                                                  messenger. For example, the shortcode library may add a new
+	 *                                                  field to the message templates. Optional.
+	 * @type string  $valid_shortcodes_callback         Callback for message types _valid_shortcodes array setup.
+	 *                                                  Optional.
+	 * @type array $list_type_shortcodes                If there are any specific shortcodes with this message
+	 *                                                  shortcode library that should be considered "list type"
+	 *                                                  then include them in an array.
+	 *                                                  List Type shortcodes are shortcodes that have a corresponding
+	 *                                                  field that indicates how they are parsed. Optional.
+	 *                              }
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 *
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register a messages shortcode library with EE_Register_Messages_Shortcode_Library::register, you must include a "name" (a unique identifier for this set of message shortcodes), and an array containing the following keys: : "autoload_paths"',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_ee_messages_shortcode_registry[ $addon_name ])) {
+			return true;
+		}
+
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+
+		self::$_ee_messages_shortcode_registry[ $addon_name ] = [
+			'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
+			'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
+				? (array) $setup_args['list_type_shortcodes'] : [],
+		];
+
+		// add filters
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			['EE_Register_Messages_Shortcode_Library', 'register_msgs_autoload_paths'],
+			10
+		);
+
+		// add below filters if the required callback is provided.
+		if (! empty($setup_args['msgr_validator_callback'])) {
+			add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['msgr_template_fields_callback'])) {
+			add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['valid_shortcodes_callback'])) {
+			add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['list_type_shortcodes'])) {
+			add_filter(
+				'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
+				['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
+				10
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * This deregisters any messages shortcode library previously registered with the given name.
+	 *
+	 * @param string $addon_name name used to register the shortcode library.
+	 * @return  void
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
+	}
+
+
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 * @since    4.3.0
+	 *
+	 */
+	public static function register_msgs_autoload_paths(array $paths): array
+	{
+		$autoload_paths = [];
+		if (! empty(self::$_ee_messages_shortcode_registry)) {
+			foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
+				if (empty($st_reg['autoloadpaths'])) {
+					continue;
+				}
+				$autoload_paths[] = $st_reg['autoloadpaths'];
+			}
+		}
+		return array_merge($paths, ...$autoload_paths);
+	}
+
+
+	/**
+	 * This is the callback for the FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes
+	 * filter which is used to add additional list type shortcodes.
+	 *
+	 * @param array $original_shortcodes
+	 * @return  array                                   Modifications to original shortcodes.
+	 * @since 4.3.0
+	 *
+	 */
+	public static function register_list_type_shortcodes(array $original_shortcodes): array
+	{
+		if (empty(self::$_ee_messages_shortcode_registry)) {
+			return $original_shortcodes;
+		}
+		$shortcodes = [];
+		foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
+			if (! empty($sc_reg['list_type_shortcodes'])) {
+				$shortcodes[] = $sc_reg['list_type_shortcodes'];
+			}
+		}
+		return array_merge($original_shortcodes, ...$shortcodes);
+	}
+
+
+	public static function reset(): void
+	{
+		self::$_ee_messages_shortcode_registry = [];
+	}
 }

core/libraries/plugin_api/EE_Register_Privacy_Policy.lib.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      */
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
-        self::$privacy_policies[ $addon_name ] = $setup_args;
+        self::$privacy_policies[$addon_name] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
@@ -44,7 +44,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$privacy_policies[ $addon_name ]);
+        unset(self::$privacy_policies[$addon_name]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,57 +12,57 @@
  */
 class EE_Register_Privacy_Policy implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $privacy_policies = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $privacy_policies = [];
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     * @return bool
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        self::$privacy_policies[ $addon_name ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
-            ['EE_Register_Privacy_Policy', 'addPrivacyPolicies']
-        );
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 * @return bool
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		self::$privacy_policies[ $addon_name ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
+			['EE_Register_Privacy_Policy', 'addPrivacyPolicies']
+		);
+		return true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$privacy_policies[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$privacy_policies[ $addon_name ]);
+	}
 
 
-    /**
-     * Adds our privacy policy generators registered by add-ons
-     *
-     * @param string[] $privacy_policies
-     * @return string[]
-     */
-    public static function addPrivacyPolicies(array $privacy_policies): array
-    {
-        return array_merge($privacy_policies, ...self::$privacy_policies);
-    }
+	/**
+	 * Adds our privacy policy generators registered by add-ons
+	 *
+	 * @param string[] $privacy_policies
+	 * @return string[]
+	 */
+	public static function addPrivacyPolicies(array $privacy_policies): array
+	{
+		return array_merge($privacy_policies, ...self::$privacy_policies);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$privacy_policies = [];
-    }
+	public static function reset(): void
+	{
+		self::$privacy_policies = [];
+	}
 }
 // End of file EE_Register_Privacy_Policy.lib.php
 // Location: ${NAMESPACE}/EE_Register_Privacy_Policy.lib.php

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Spacing +8 added lines, -8 removed lines

@@ -59,7 +59,7 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
         // make sure this was called in the right place!
@@ -77,7 +77,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // array of full server paths to any EE_PMT_Base children used
             'payment_method_paths' => isset($setup_args['payment_method_paths'])
                 ? (array) $setup_args['payment_method_paths']
@@ -93,12 +93,12 @@ 
         if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
             $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             // register payment methods directly
-            foreach (self::$_settings[ $addon_name ]['payment_method_paths'] as $payment_method_path) {
+            foreach (self::$_settings[$addon_name]['payment_method_paths'] as $payment_method_path) {
                 $payment_method_manager->register_payment_method($payment_method_path);
             }
             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
             $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $addon_name ])
+                self::getPaymentMethodCapabilities(self::$_settings[$addon_name])
             );
         }
         return true;
@@ -135,13 +135,13 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $addon_name ];
-            unset(self::$_settings[ $addon_name ]);
+            $module_settings = self::$_settings[$addon_name];
+            unset(self::$_settings[$addon_name]);
             add_action(
                 'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
+                function() use ($module_settings) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps(
                         EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)

Indentation +155 added lines, -155 removed lines

@@ -18,169 +18,169 @@
  */
 class EE_Register_Payment_Method implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered payment methods
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered payment methods
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     * Method for registering new EE_PMT_Base children
-     *
-     * @param string  $addon_name           a unique identifier for this set of modules Required.
-     * @param array   $setup_args           an array of arguments provided for registering modules Required.{
-     * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
-     *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
-     *                                      the files EE_PMT_Payomatic.pm.php)
-     *                                      }
-     * @return bool
-     * @throws EE_Error
-     * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
-     *                                      children, or to the EED_Module files themselves
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @since    4.5.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
-            return true;
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
-            // array of full server paths to any EE_PMT_Base children used
-            'payment_method_paths' => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : [],
-        ];
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            ['EE_Register_Payment_Method', 'add_payment_methods']
-        );
-        // If EE_Payment_Method_Manager::register_payment_methods has already been called,
-        // then we need to add our caps for this payment method manually
-        if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
-            $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            // register payment methods directly
-            foreach (self::$_settings[ $addon_name ]['payment_method_paths'] as $payment_method_path) {
-                $payment_method_manager->register_payment_method($payment_method_path);
-            }
-            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-            $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $addon_name ])
-            );
-        }
-        return true;
-    }
+	/**
+	 * Method for registering new EE_PMT_Base children
+	 *
+	 * @param string  $addon_name           a unique identifier for this set of modules Required.
+	 * @param array   $setup_args           an array of arguments provided for registering modules Required.{
+	 * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
+	 *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
+	 *                                      the files EE_PMT_Payomatic.pm.php)
+	 *                                      }
+	 * @return bool
+	 * @throws EE_Error
+	 * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
+	 *                                      children, or to the EED_Module files themselves
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @since    4.5.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return true;
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = [
+			// array of full server paths to any EE_PMT_Base children used
+			'payment_method_paths' => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: [],
+		];
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			['EE_Register_Payment_Method', 'add_payment_methods']
+		);
+		// If EE_Payment_Method_Manager::register_payment_methods has already been called,
+		// then we need to add our caps for this payment method manually
+		if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
+			$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			// register payment methods directly
+			foreach (self::$_settings[ $addon_name ]['payment_method_paths'] as $payment_method_path) {
+				$payment_method_manager->register_payment_method($payment_method_path);
+			}
+			$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+			$capabilities->addCaps(
+				self::getPaymentMethodCapabilities(self::$_settings[ $addon_name ])
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * Filters the list of payment methods to add ours.
-     * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
-     *
-     * @param array $payment_method_folders array of paths to all payment methods that require registering
-     * @return array
-     */
-    public static function add_payment_methods(array $payment_method_folders): array
-    {
-        $payment_method_paths = [];
-        foreach (self::$_settings as $settings) {
-            $payment_method_paths[] = $settings['payment_method_paths'];
-        }
-        return array_merge($payment_method_folders, ...$payment_method_paths);
-    }
+	/**
+	 * Filters the list of payment methods to add ours.
+	 * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
+	 *
+	 * @param array $payment_method_folders array of paths to all payment methods that require registering
+	 * @return array
+	 */
+	public static function add_payment_methods(array $payment_method_folders): array
+	{
+		$payment_method_paths = [];
+		foreach (self::$_settings as $settings) {
+			$payment_method_paths[] = $settings['payment_method_paths'];
+		}
+		return array_merge($payment_method_folders, ...$payment_method_paths);
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $addon_name.
-     *
-     * @param string $addon_name the name for the module that was previously registered
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        if (isset(self::$_settings[ $addon_name ])) {
-            // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $addon_name ];
-            unset(self::$_settings[ $addon_name ]);
-            add_action(
-                'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
-                    $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                    $capabilities->removeCaps(
-                        EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
-                    );
-                }
-            );
-        }
-    }
+	/**
+	 * This deregisters a module that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the module that was previously registered
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		if (isset(self::$_settings[ $addon_name ])) {
+			// set action for just this module id to delay deregistration until core is loaded and ready.
+			$module_settings = self::$_settings[ $addon_name ];
+			unset(self::$_settings[ $addon_name ]);
+			add_action(
+				'AHEE__EE_System__core_loaded_and_ready',
+				function () use ($module_settings) {
+					$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+					$capabilities->removeCaps(
+						EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
+					);
+				}
+			);
+		}
+	}
 
 
-    /**
-     * returns an array of the caps that get added when a Payment Method is registered
-     *
-     * @param array $settings
-     * @return array
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
-     *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
-     */
-    public static function getPaymentMethodCapabilities(array $settings): array
-    {
-        $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-        $payment_method_caps    = ['administrator' => []];
-        if (isset($settings['payment_method_paths'])) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_caps = $payment_method_manager->addPaymentMethodCap(
-                    strtolower(basename($payment_method_path)),
-                    $payment_method_caps
-                );
-            }
-        }
-        return $payment_method_caps;
-    }
+	/**
+	 * returns an array of the caps that get added when a Payment Method is registered
+	 *
+	 * @param array $settings
+	 * @return array
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
+	 *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
+	 */
+	public static function getPaymentMethodCapabilities(array $settings): array
+	{
+		$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+		$payment_method_caps    = ['administrator' => []];
+		if (isset($settings['payment_method_paths'])) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_caps = $payment_method_manager->addPaymentMethodCap(
+					strtolower(basename($payment_method_path)),
+					$payment_method_caps
+				);
+			}
+		}
+		return $payment_method_caps;
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_settings = [];
-    }
+	public static function reset(): void
+	{
+		self::$_settings = [];
+	}
 }