eventespresso / event-espresso-core

admin_pages/transactions/templates/txn_admin_details_main_meta_box_txn_details.template.php

Indentation +171 added lines, -171 removed lines

@@ -83,25 +83,25 @@ 
     </div>
     <br class="clear" />
     <?php
-    $no_payments = $grand_raw_total > 0
-                   || $TXN_status !== EEM_Transaction::complete_status_code
-                   || ! empty($payments);
-    ?>
+	$no_payments = $grand_raw_total > 0
+				   || $TXN_status !== EEM_Transaction::complete_status_code
+				   || ! empty($payments);
+	?>
     <?php if ($attendee instanceof EE_Attendee && $no_payments) : ?>
         <?php $no_payment_text = $can_edit_payments
-            ? esc_html__(
-                'No payments have been applied to this transaction yet. Click "Apply Payment" below to make a payment.',
-                'event_espresso'
-            )
-            : esc_html__(
-                'No payments have been applied to this transaction yet.',
-                'event_espresso'
-            );
-        ?>
+			? esc_html__(
+				'No payments have been applied to this transaction yet. Click "Apply Payment" below to make a payment.',
+				'event_espresso'
+			)
+			: esc_html__(
+				'No payments have been applied to this transaction yet.',
+				'event_espresso'
+			);
+		?>
 
         <h3 class="admin-primary-mbox-h4 hdr-has-icon">
             <span class="ee-icon ee-icon-cash"></span><?php
-            esc_html_e('Payment Details', 'event_espresso'); ?>
+			esc_html_e('Payment Details', 'event_espresso'); ?>
         </h3>
 
         <div class="admin-primary-mbox-tbl-wrap">
@@ -117,9 +117,9 @@ 
                         <th class="jst-left"><?php esc_html_e('TXN&nbsp;ID / CHQ&nbsp;#', 'event_espresso'); ?></th>
                         <th class="jst-left"><?php esc_html_e('P.O. / S.O.&nbsp;#', 'event_espresso'); ?></th>
                         <th class="jst-left"><?php esc_html_e(
-                            'Notes / Extra&nbsp;Accounting',
-                            'event_espresso'
-                        ); ?></th>
+							'Notes / Extra&nbsp;Accounting',
+							'event_espresso'
+						); ?></th>
                         <th class="jst-cntr"><?php esc_html_e('Amount', 'event_espresso'); ?></th>
                     </tr>
                 </thead>
@@ -127,14 +127,14 @@ 
                     <?php if ($payments) : ?>
                         <?php $payment_total = 0; ?>
                         <?php foreach ($payments as $PAY_ID => $payment) :
-                            if (! $payment instanceof EE_Payment) {
-                                continue;
-                            }
-                            $PAY_ID = absint($PAY_ID);
-                            $existing_reg_payment_json = isset($existing_reg_payments[ $PAY_ID ])
-                                ? wp_json_encode($existing_reg_payments[ $PAY_ID ])
-                                : '{}';
-                            ?>
+							if (! $payment instanceof EE_Payment) {
+								continue;
+							}
+							$PAY_ID = absint($PAY_ID);
+							$existing_reg_payment_json = isset($existing_reg_payments[ $PAY_ID ])
+								? wp_json_encode($existing_reg_payments[ $PAY_ID ])
+								: '{}';
+							?>
                             <tr id="txn-admin-payment-tr-<?php echo absint($PAY_ID); ?>">
                                 <td>
                 <span id="payment-status-<?php echo absint($PAY_ID); ?>"
@@ -188,15 +188,15 @@ 
                                     </div>
                                     <div id="payment-gateway-<?php echo absint($PAY_ID); ?>">
                                         <?php echo ($payment->payment_method() instanceof EE_Payment_Method
-                                            ? esc_html($payment->payment_method()->admin_name())
-                                            : esc_html__("Unknown", 'event_espresso')); ?>
+											? esc_html($payment->payment_method()->admin_name())
+											: esc_html__("Unknown", 'event_espresso')); ?>
                                     </div>
                                     <div id="payment-gateway-id-<?php echo absint($PAY_ID); ?>"
                                          class="hidden"
                                     >
                                         <?php echo ($payment->payment_method() instanceof EE_Payment_Method
-                                            ? esc_html($payment->payment_method()->ID())
-                                            : 0); ?>
+											? esc_html($payment->payment_method()->ID())
+											: 0); ?>
                                     </div>
                                 </td>
                                 <td class=" jst-left">
@@ -221,18 +221,18 @@ 
                                 </td>
                                 <td class=" jst-rght">
                                     <?php
-                                    $payment_class = $payment->amount() > 0
-                                        ? 'txn-admin-payment-status-' . $payment->STS_ID()
-                                        : 'txn-admin-payment-status-PDC';
-                                    ?>
+									$payment_class = $payment->amount() > 0
+										? 'txn-admin-payment-status-' . $payment->STS_ID()
+										: 'txn-admin-payment-status-PDC';
+									?>
                                     <span class="<?php echo esc_attr($payment_class); ?>">
                                         <span id="payment-amount-<?php echo absint($PAY_ID); ?>" style="display:inline;">
                                         <?php echo EEH_Template::format_currency(
-                                            $payment->amount(),
-                                            false,
-                                            false
-                                        ); // already escaped
-                                        ?>
+											$payment->amount(),
+											false,
+											false
+										); // already escaped
+										?>
                                         </span>
                                     </span>
                                 </td>
@@ -240,9 +240,9 @@ 
                             <?php $payment_total += $payment->STS_ID() == 'PAP' ? $payment->amount() : 0; ?>
                         <?php endforeach; ?>
                         <?php $pay_totals_class = $payment_total > $grand_raw_total
-                            ? ' important-notice'
-                            : '';
-                        ?>
+							? ' important-notice'
+							: '';
+						?>
                         <tr id="txn-admin-no-payments-tr" class="admin-primary-mbox-total-tr hidden">
                             <td class=" jst-rght" colspan="10">
                                 <span class="important-notice"><?php echo wp_kses($no_payment_text, AllowedTags::getAllowedTags()); ?></span>
@@ -254,29 +254,29 @@ 
                             <th class=" jst-rght" colspan="9">
                         <span id="payments-total-spn">
                         <?php
-                        $overpaid = $payment_total > $grand_raw_total
-                            ? '<span id="overpaid">'
-                              . __('This transaction has been overpaid ! ', 'event_espresso')
-                              . '</span>'
-                            : '';
-                        echo wp_kses(
-                            $overpaid
-                            . sprintf(
-                                __('Payments Total %s', 'event_espresso'),
-                                '(' . EE_Registry::instance()->CFG->currency->code . ')'
-                            ),
-                            AllowedTags::getAllowedTags()
-                        ); ?>
+						$overpaid = $payment_total > $grand_raw_total
+							? '<span id="overpaid">'
+							  . __('This transaction has been overpaid ! ', 'event_espresso')
+							  . '</span>'
+							: '';
+						echo wp_kses(
+							$overpaid
+							. sprintf(
+								__('Payments Total %s', 'event_espresso'),
+								'(' . EE_Registry::instance()->CFG->currency->code . ')'
+							),
+							AllowedTags::getAllowedTags()
+						); ?>
                         </span>
                             </th>
                             <th class=" jst-rght">
                         <span id="txn-admin-payment-total">
                         <?php
-                        echo EEH_Template::format_currency(
-                            $payment_total,
-                            false,
-                            false
-                        ); // already escaped ?>
+						echo EEH_Template::format_currency(
+							$payment_total,
+							false,
+							false
+						); // already escaped ?>
                         </span>
                             </th>
                         </tr>
@@ -359,7 +359,7 @@ 
 
         <ul id="txn-admin-payment-options-ul">
             <?php if ($can_edit_payments) :
-                ?>
+				?>
                 <li>
                     <a id="display-txn-admin-apply-payment"
                        class="button-primary no-icon no-hide"
@@ -384,12 +384,12 @@ 
                 </li>
             <?php endif; ?>
             <?php
-            // Allows extend the fields at actions area.
-            do_action(
-                'AHEE__txn_admin_details_main_meta_box_txn_details__after_actions_buttons',
-                $can_edit_payments
-            );
-            ?>
+			// Allows extend the fields at actions area.
+			do_action(
+				'AHEE__txn_admin_details_main_meta_box_txn_details__after_actions_buttons',
+				$can_edit_payments
+			);
+			?>
         </ul>
         <br class="clear" />
 
@@ -400,7 +400,7 @@ 
             >
                 <div class="ee-icon ee-icon-cash-add float-left"></div>
                 <?php
-                echo esc_html__('Apply a Payment to Transaction #', 'event_espresso') . esc_html($txn_nmbr['value']); ?>
+				echo esc_html__('Apply a Payment to Transaction #', 'event_espresso') . esc_html($txn_nmbr['value']); ?>
             </h2>
 
             <h2 id="admin-modal-dialog-edit-payment-h2" class="admin-modal-dialog-h2 hdr-has-icon"
@@ -408,23 +408,23 @@ 
             >
                 <div class="ee-icon ee-icon-cash-edit float-left"></div>
                 <?php
-                printf(
-                    esc_html__('Edit Payment #%s for Transaction #%s', 'event_espresso'),
-                    '<span></span>',
-                    $txn_nmbr['value']
-                );
-                ?>
+				printf(
+					esc_html__('Edit Payment #%s for Transaction #%s', 'event_espresso'),
+					'<span></span>',
+					$txn_nmbr['value']
+				);
+				?>
             </h2>
 
             <h2 id="admin-modal-dialog-edit-refund-h2" class="admin-modal-dialog-h2 hdr-has-icon" style="display:none;">
                 <div class="ee-icon ee-icon-cash-edit float-left"></div>
                 <?php
-                printf(
-                    esc_html__('Edit Refund #%s for Transaction #%s', 'event_espresso'),
-                    '<span></span>',
-                    $txn_nmbr['value']
-                );
-                ?>
+				printf(
+					esc_html__('Edit Refund #%s for Transaction #%s', 'event_espresso'),
+					'<span></span>',
+					$txn_nmbr['value']
+				);
+				?>
             </h2>
 
             <h2 id="admin-modal-dialog-apply-refund-h2" class="admin-modal-dialog-h2 hdr-has-icon"
@@ -432,9 +432,9 @@ 
             >
                 <div class="ee-icon ee-icon-cash-remove float-left"></div>
                 <?php
-                echo esc_html__('Apply a Refund to Transaction #', 'event_espresso');
-                echo esc_html($txn_nmbr['value']);
-                ?>
+				echo esc_html__('Apply a Refund to Transaction #', 'event_espresso');
+				echo esc_html($txn_nmbr['value']);
+				?>
             </h2>
 
             <form name="txn-admin-apply-payment-frm"
@@ -533,29 +533,29 @@ 
                             >
                                 <?php foreach ($payment_methods as $method) : ?>
                                     <?php
-                                    $selected = $method->slug() == 'cash'
-                                        ? ' selected'
-                                        : '';
-                                    ?>
+									$selected = $method->slug() == 'cash'
+										? ' selected'
+										: '';
+									?>
                                     <option id="payment-method-opt-<?php echo esc_attr($method->slug()); ?>"
                                             value="<?php echo esc_attr($method->ID()); ?>"
                                         <?php echo esc_attr($selected); ?>
                                     >
                                         <?php
-                                        echo esc_html(
-                                            sanitize_key($method->admin_desc())
-                                                ? substr($method->admin_desc(), 0, 128)
-                                                : $method->admin_name()
-                                        );
-                                        ?>&nbsp;&nbsp;
+										echo esc_html(
+											sanitize_key($method->admin_desc())
+												? substr($method->admin_desc(), 0, 128)
+												: $method->admin_name()
+										);
+										?>&nbsp;&nbsp;
                                     </option>
                                 <?php endforeach; ?>
                             </select>
                             <p class="description">
                                 <?php esc_html_e(
-                                    'Whether the payment was made via PayPal, Credit Card, Cheque, or Cash',
-                                    'event_espresso'
-                                ); ?>
+									'Whether the payment was made via PayPal, Credit Card, Cheque, or Cash',
+									'event_espresso'
+								); ?>
                             </p>
                         </div>
 
@@ -563,9 +563,9 @@ 
                             <div class="txn-admin-apply-payment-gw-txn-id-dv admin-modal-dialog-row">
                                 <label for="txn-admin-payment-txn-id-chq-nmbr-inp" class="">
                                     <?php esc_html_e(
-                                        'TXN ID / CHQ #',
-                                        'event_espresso'
-                                    ); ?>
+										'TXN ID / CHQ #',
+										'event_espresso'
+									); ?>
                                 </label>
                                 <input name="txn_admin_payment[txn_id_chq_nmbr]"
                                        id="txn-admin-payment-txn-id-chq-nmbr-inp"
@@ -574,9 +574,9 @@ 
                                 />
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'The Transaction ID sent back from the payment gateway, or the Cheque #',
-                                        'event_espresso'
-                                    ); ?>
+										'The Transaction ID sent back from the payment gateway, or the Cheque #',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -593,9 +593,9 @@ 
                                 />
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'The gateway response string (optional)',
-                                        'event_espresso'
-                                    ); ?>
+										'The gateway response string (optional)',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -604,9 +604,9 @@ 
                             <div class="txn-admin-apply-payment-status-dv admin-modal-dialog-row">
                                 <label for="txn-admin-payment-status-slct" class="">
                                     <?php esc_html_e(
-                                        'Payment Status',
-                                        'event_espresso'
-                                    ); ?>
+										'Payment Status',
+										'event_espresso'
+									); ?>
                                 </label>
                                 <select name="txn_admin_payment[status]"
                                         id="txn-admin-payment-status-slct"
@@ -615,10 +615,10 @@ 
                                 >
                                     <?php foreach ($payment_status as $STS_ID => $STS_code) : ?>
                                         <?php
-                                        $selected = $STS_ID == 'PAP'
-                                            ? 'selected'
-                                            : '';
-                                        ?>
+										$selected = $STS_ID == 'PAP'
+											? 'selected'
+											: '';
+										?>
                                         <option id="payment-status-opt-<?php echo esc_attr($STS_ID); ?>"
                                                 value="<?php echo esc_attr($STS_ID); ?>"
                                             <?php echo esc_attr($selected); ?>
@@ -629,10 +629,10 @@ 
                                 </select>
                                 <p class="description">
                                     <?php
-                                    esc_html_e(
-                                        'Whether the payment was approved, cancelled, declined or failed after submission to the gateway',
-                                        'event_espresso'
-                                    ); ?>
+									esc_html_e(
+										'Whether the payment was approved, cancelled, declined or failed after submission to the gateway',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -649,9 +649,9 @@ 
                             />
                             <p class="description">
                                 <?php esc_html_e(
-                                    'The Purchase or Sales Order Number if any (optional)',
-                                    'event_espresso'
-                                ); ?>
+									'The Purchase or Sales Order Number if any (optional)',
+									'event_espresso'
+								); ?>
                             </p>
                         </div>
 
@@ -672,9 +672,9 @@ 
                             />
                             <p class="description">
                                 <?php esc_html_e(
-                                    'An extra field you may use for accounting purposes or simple notes. Defaults to the primary registrant\'s registration code.',
-                                    'event_espresso'
-                                ); ?>
+									'An extra field you may use for accounting purposes or simple notes. Defaults to the primary registrant\'s registration code.',
+									'event_espresso'
+								); ?>
                             </p>
                         </div>
 
@@ -709,9 +709,9 @@ 
                             <?php echo wp_kses($status_change_select, AllowedTags::getWithFormTags()); ?>
                             <p class="description">
                                 <?php esc_html_e(
-                                    'If you wish to change the status for the registrations selected above, then select which status from this dropdown.',
-                                    'event_espresso'
-                                ); ?>
+									'If you wish to change the status for the registrations selected above, then select which status from this dropdown.',
+									'event_espresso'
+								); ?>
                             </p>
                             <br />
                         </div>
@@ -742,14 +742,14 @@ 
                             <br class="clear-float" />
                             <p class="description">
                                 <?php printf(
-                                    esc_html__(
-                                        'By default %1$sa payment message is sent to the primary registrant%2$s after submitting this form.%3$sHowever, if you check the "Registration Messages" box, the system will also send any related messages matching the status of the registrations to %1$seach registration for this transaction%2$s.',
-                                        'event_espresso'
-                                    ),
-                                    '<strong>',
-                                    '</strong>',
-                                    '<br />'
-                                ); ?>
+									esc_html__(
+										'By default %1$sa payment message is sent to the primary registrant%2$s after submitting this form.%3$sHowever, if you check the "Registration Messages" box, the system will also send any related messages matching the status of the registrations to %1$seach registration for this transaction%2$s.',
+										'event_espresso'
+									),
+									'<strong>',
+									'</strong>',
+									'<br />'
+								); ?>
                             </p>
                         </div>
                         <div class="clear"></div>
@@ -814,10 +814,10 @@ 
             >
                 <span class="ee-icon ee-icon-cash-add"></span>
                 <?php printf(
-                    esc_html__('Delete Payment/Refund for Transaction #', 'event_espresso'),
-                    $txn_nmbr['value']
-                );
-                ?>
+					esc_html__('Delete Payment/Refund for Transaction #', 'event_espresso'),
+					$txn_nmbr['value']
+				);
+				?>
             </h2>
 
             <form name="txn-admin-delete-payment-frm"
@@ -853,13 +853,13 @@ 
                             <?php echo wp_kses($delete_status_change_select, AllowedTags::getWithFormTags()); ?>
                             <p class="description">
                                 <?php printf(
-                                    esc_html__(
-                                        'If you wish to change the status of all the registrations associated with this transaction after deleting this payment/refund, then select which status from this dropdown. %sNote: ALL registrations associated with this transaction will be updated to this new status.%s',
-                                        'event_espresso'
-                                    ),
-                                    '<strong>',
-                                    '</strong>'
-                                ); ?>
+									esc_html__(
+										'If you wish to change the status of all the registrations associated with this transaction after deleting this payment/refund, then select which status from this dropdown. %sNote: ALL registrations associated with this transaction will be updated to this new status.%s',
+										'event_espresso'
+									),
+									'<strong>',
+									'</strong>'
+								); ?>
                             </p>
                         </div>
 
@@ -874,10 +874,10 @@ 
                             />
                             <p class="description">
                                 <?php
-                                esc_html_e(
-                                    'If you check this box, the system will send any related registration messages matching the status of the registrations to each registration for this transaction. No Payment notifications are sent when deleting a payment.',
-                                    'event_espresso'
-                                ); ?>
+								esc_html_e(
+									'If you check this box, the system will send any related registration messages matching the status of the registrations to each registration for this transaction. No Payment notifications are sent when deleting a payment.',
+									'event_espresso'
+								); ?>
                             </p>
                         </div>
                         <div class="clear"></div>
@@ -910,8 +910,8 @@ 
     <?php endif; // $grand_raw_total > 0?>
 
     <?php if (WP_DEBUG) {
-        $delivered_messages = get_option('EED_Messages__payment', []);
-        if (isset($delivered_messages[ $TXN_ID ])) { ?>
+		$delivered_messages = get_option('EED_Messages__payment', []);
+		if (isset($delivered_messages[ $TXN_ID ])) { ?>
             <h4 class="admin-primary-mbox-h4 hdr-has-icon">
                 <span class="dashicons dashicons-email-alt"></span>
                 <?php esc_html_e('Messages Sent to Primary Registrant', 'event_espresso'); ?>
@@ -923,39 +923,39 @@ 
                             <th class="jst-left"><?php esc_html_e('Date & Time', 'event_espresso'); ?></th>
                             <th class="jst-left"><?php esc_html_e('Message Type', 'event_espresso'); ?></th>
                             <th class="jst-left"><?php esc_html_e(
-                                'Payment Status Upon Sending',
-                                'event_espresso'
-                            ); ?></th>
+								'Payment Status Upon Sending',
+								'event_espresso'
+							); ?></th>
                             <th class="jst-left"><?php esc_html_e('TXN Status Upon Sending', 'event_espresso'); ?></th>
                         </tr>
                     </thead>
                     <tbody>
                         <?php
-                        foreach ($delivered_messages[ $TXN_ID ] as $timestamp => $delivered_message) :
-                            ?>
+						foreach ($delivered_messages[ $TXN_ID ] as $timestamp => $delivered_message) :
+							?>
                             <tr>
                                 <td class="jst-left">
                                     <?php echo esc_html(
-                                        date(
-                                            get_option('date_format') . ' ' . get_option('time_format'),
-                                            ($timestamp + (get_option('gmt_offset') * HOUR_IN_SECONDS))
-                                        )
-                                    ); ?>
+										date(
+											get_option('date_format') . ' ' . get_option('time_format'),
+											($timestamp + (get_option('gmt_offset') * HOUR_IN_SECONDS))
+										)
+									); ?>
                                 </td>
                                 <td class="jst-left"><?php
-                                    echo isset($delivered_message['message_type'])
-                                        ? esc_html($delivered_message['message_type'])
-                                        : ''; ?>
+									echo isset($delivered_message['message_type'])
+										? esc_html($delivered_message['message_type'])
+										: ''; ?>
                                 </td>
                                 <td class="jst-left"><?php
-                                    echo isset($delivered_message['pay_status'])
-                                        ? esc_html($delivered_message['pay_status'])
-                                        : ''; ?>
+									echo isset($delivered_message['pay_status'])
+										? esc_html($delivered_message['pay_status'])
+										: ''; ?>
                                 </td>
                                 <td class="jst-left"><?php
-                                    echo isset($delivered_message['txn_status'])
-                                        ? esc_html($delivered_message['txn_status'])
-                                        : ''; ?>
+									echo isset($delivered_message['txn_status'])
+										? esc_html($delivered_message['txn_status'])
+										: ''; ?>
                                 </td>
                             </tr>
                         <?php endforeach; // $delivered_messages?>
@@ -963,7 +963,7 @@ 
                 </table>
             </div>
             <?php
-        }
-    }
-    ?>
+		}
+	}
+	?>
 </div>

Spacing +9 added lines, -9 removed lines

@@ -127,12 +127,12 @@ 
                     <?php if ($payments) : ?>
                         <?php $payment_total = 0; ?>
                         <?php foreach ($payments as $PAY_ID => $payment) :
-                            if (! $payment instanceof EE_Payment) {
+                            if ( ! $payment instanceof EE_Payment) {
                                 continue;
                             }
                             $PAY_ID = absint($PAY_ID);
-                            $existing_reg_payment_json = isset($existing_reg_payments[ $PAY_ID ])
-                                ? wp_json_encode($existing_reg_payments[ $PAY_ID ])
+                            $existing_reg_payment_json = isset($existing_reg_payments[$PAY_ID])
+                                ? wp_json_encode($existing_reg_payments[$PAY_ID])
                                 : '{}';
                             ?>
                             <tr id="txn-admin-payment-tr-<?php echo absint($PAY_ID); ?>">
@@ -222,7 +222,7 @@ 
                                 <td class=" jst-rght">
                                     <?php
                                     $payment_class = $payment->amount() > 0
-                                        ? 'txn-admin-payment-status-' . $payment->STS_ID()
+                                        ? 'txn-admin-payment-status-'.$payment->STS_ID()
                                         : 'txn-admin-payment-status-PDC';
                                     ?>
                                     <span class="<?php echo esc_attr($payment_class); ?>">
@@ -263,7 +263,7 @@ 
                             $overpaid
                             . sprintf(
                                 __('Payments Total %s', 'event_espresso'),
-                                '(' . EE_Registry::instance()->CFG->currency->code . ')'
+                                '('.EE_Registry::instance()->CFG->currency->code.')'
                             ),
                             AllowedTags::getAllowedTags()
                         ); ?>
@@ -400,7 +400,7 @@ 
             >
                 <div class="ee-icon ee-icon-cash-add float-left"></div>
                 <?php
-                echo esc_html__('Apply a Payment to Transaction #', 'event_espresso') . esc_html($txn_nmbr['value']); ?>
+                echo esc_html__('Apply a Payment to Transaction #', 'event_espresso').esc_html($txn_nmbr['value']); ?>
             </h2>
 
             <h2 id="admin-modal-dialog-edit-payment-h2" class="admin-modal-dialog-h2 hdr-has-icon"
@@ -911,7 +911,7 @@ 
 
     <?php if (WP_DEBUG) {
         $delivered_messages = get_option('EED_Messages__payment', []);
-        if (isset($delivered_messages[ $TXN_ID ])) { ?>
+        if (isset($delivered_messages[$TXN_ID])) { ?>
             <h4 class="admin-primary-mbox-h4 hdr-has-icon">
                 <span class="dashicons dashicons-email-alt"></span>
                 <?php esc_html_e('Messages Sent to Primary Registrant', 'event_espresso'); ?>
@@ -931,13 +931,13 @@ 
                     </thead>
                     <tbody>
                         <?php
-                        foreach ($delivered_messages[ $TXN_ID ] as $timestamp => $delivered_message) :
+                        foreach ($delivered_messages[$TXN_ID] as $timestamp => $delivered_message) :
                             ?>
                             <tr>
                                 <td class="jst-left">
                                     <?php echo esc_html(
                                         date(
-                                            get_option('date_format') . ' ' . get_option('time_format'),
+                                            get_option('date_format').' '.get_option('time_format'),
                                             ($timestamp + (get_option('gmt_offset') * HOUR_IN_SECONDS))
                                         )
                                     ); ?>

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.33.rc.013');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.33.rc.013');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file

core/libraries/form_sections/base/EE_Form_Section_Base.form.php

Indentation +476 added lines, -476 removed lines

@@ -15,486 +15,486 @@
 abstract class EE_Form_Section_Base
 {
 
-    /**
-     * the URL the form is submitted to
-     *
-     * @var string
-     */
-    protected $_action;
-
-    /**
-     * POST (default) or GET
-     *
-     * @var string
-     */
-    protected $_method;
-
-    /**
-     * html_id and html_name are derived from this by default
-     *
-     * @var string
-     */
-    protected $_name;
-
-    /**
-     * $_html_id
-     * @var string
-     */
-    protected $_html_id;
-
-    /**
-     * $_html_class
-     * @var string
-     */
-    protected $_html_class;
-
-    /**
-     * $_html_style
-     * @var string
-     */
-    protected $_html_style;
-
-    /**
-     * $_other_html_attributes
-     * @var string
-     */
-    protected $_other_html_attributes;
-
-    /**
-     * The form section of which this form section is a part
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_parent_section;
-
-    /**
-     * flag indicating that _construct_finalize has been called.
-     * If it has not been called and we try to use functions which require it, we call it
-     * with no parameters. But normally, _construct_finalize should be called by the instantiating class
-     *
-     * @var boolean
-     */
-    protected $_construction_finalized;
-
-    /**
-     * Strategy for parsing the form HTML upon display
-     *
-     * @var FormHtmlFilter
-     */
-    protected $_form_html_filter;
-
-
-    /**
-     * @param array $options_array {
-     * @type        $name          string the name for this form section, if you want to explicitly define it
-     *                             }
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($options_array = array())
-    {
-        // used by display strategies
-        // assign incoming values to properties
-        foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
-            if (property_exists($this, $key) && empty($this->{$key})) {
-                $this->{$key} = $value;
-                if ($key === '_subsections' && ! is_array($value)) {
-                    throw new InvalidDataTypeException($key, $value, 'array');
-                }
-            }
-        }
-        // set parser which allows the form section's rendered HTML to be filtered
-        if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
-            $this->_form_html_filter = $options_array['form_html_filter'];
-        }
-    }
-
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws \EE_Error
-     */
-    protected function _construct_finalize($parent_form_section, $name)
-    {
-        $this->_construction_finalized = true;
-        $this->_parent_section = $parent_form_section;
-        if ($name !== null) {
-            $this->_name = $name;
-        }
-    }
-
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function action()
-    {
-        return $this->_action;
-    }
-
-
-
-    /**
-     * @param string $action
-     */
-    public function set_action($action)
-    {
-        $this->_action = $action;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function method()
-    {
-        return ! empty($this->_method) ? $this->_method : 'POST';
-    }
-
-
-
-    /**
-     * @param string $method
-     */
-    public function set_method($method)
-    {
-        switch ($method) {
-            case 'get':
-            case 'GET':
-                $this->_method = 'GET';
-                break;
-            default:
-                $this->_method = 'POST';
-        }
-    }
-
-
-
-    /**
-     * Sets the html_id to its default value, if none was specified in the constructor.
-     * Calculation involves using the name and the parent's html id
-     * return void
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_default_html_id_if_empty()
-    {
-        if (! $this->_html_id) {
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_id = $this->_parent_section->html_id()
-                                  . '-'
-                                  . $this->_prep_name_for_html_id($this->name());
-            } else {
-                $this->_html_id = $this->_prep_name_for_html_id($this->name());
-            }
-        }
-    }
-
-
-
-    /**
-     * _prep_name_for_html_id
-     *
-     * @param $name
-     * @return string
-     */
-    private function _prep_name_for_html_id($name)
-    {
-        return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
-    }
+	/**
+	 * the URL the form is submitted to
+	 *
+	 * @var string
+	 */
+	protected $_action;
+
+	/**
+	 * POST (default) or GET
+	 *
+	 * @var string
+	 */
+	protected $_method;
+
+	/**
+	 * html_id and html_name are derived from this by default
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+	/**
+	 * $_html_id
+	 * @var string
+	 */
+	protected $_html_id;
+
+	/**
+	 * $_html_class
+	 * @var string
+	 */
+	protected $_html_class;
+
+	/**
+	 * $_html_style
+	 * @var string
+	 */
+	protected $_html_style;
+
+	/**
+	 * $_other_html_attributes
+	 * @var string
+	 */
+	protected $_other_html_attributes;
+
+	/**
+	 * The form section of which this form section is a part
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_parent_section;
+
+	/**
+	 * flag indicating that _construct_finalize has been called.
+	 * If it has not been called and we try to use functions which require it, we call it
+	 * with no parameters. But normally, _construct_finalize should be called by the instantiating class
+	 *
+	 * @var boolean
+	 */
+	protected $_construction_finalized;
+
+	/**
+	 * Strategy for parsing the form HTML upon display
+	 *
+	 * @var FormHtmlFilter
+	 */
+	protected $_form_html_filter;
+
+
+	/**
+	 * @param array $options_array {
+	 * @type        $name          string the name for this form section, if you want to explicitly define it
+	 *                             }
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($options_array = array())
+	{
+		// used by display strategies
+		// assign incoming values to properties
+		foreach ($options_array as $key => $value) {
+			$key = '_' . $key;
+			if (property_exists($this, $key) && empty($this->{$key})) {
+				$this->{$key} = $value;
+				if ($key === '_subsections' && ! is_array($value)) {
+					throw new InvalidDataTypeException($key, $value, 'array');
+				}
+			}
+		}
+		// set parser which allows the form section's rendered HTML to be filtered
+		if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
+			$this->_form_html_filter = $options_array['form_html_filter'];
+		}
+	}
+
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws \EE_Error
+	 */
+	protected function _construct_finalize($parent_form_section, $name)
+	{
+		$this->_construction_finalized = true;
+		$this->_parent_section = $parent_form_section;
+		if ($name !== null) {
+			$this->_name = $name;
+		}
+	}
+
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function action()
+	{
+		return $this->_action;
+	}
+
+
+
+	/**
+	 * @param string $action
+	 */
+	public function set_action($action)
+	{
+		$this->_action = $action;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function method()
+	{
+		return ! empty($this->_method) ? $this->_method : 'POST';
+	}
+
+
+
+	/**
+	 * @param string $method
+	 */
+	public function set_method($method)
+	{
+		switch ($method) {
+			case 'get':
+			case 'GET':
+				$this->_method = 'GET';
+				break;
+			default:
+				$this->_method = 'POST';
+		}
+	}
+
+
+
+	/**
+	 * Sets the html_id to its default value, if none was specified in the constructor.
+	 * Calculation involves using the name and the parent's html id
+	 * return void
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_default_html_id_if_empty()
+	{
+		if (! $this->_html_id) {
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_id = $this->_parent_section->html_id()
+								  . '-'
+								  . $this->_prep_name_for_html_id($this->name());
+			} else {
+				$this->_html_id = $this->_prep_name_for_html_id($this->name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * _prep_name_for_html_id
+	 *
+	 * @param $name
+	 * @return string
+	 */
+	private function _prep_name_for_html_id($name)
+	{
+		return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
+	}
 
 
 
-    /**
-     * Returns the HTML, JS, and CSS necessary to display this form section on a page.
-     * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
-     * and call get_html when you want to output the html. Calling get_html_and_js after
-     * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
-     * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
-     * and so might stop working anytime.
-     *
-     * @return string
-     */
-    public function get_html_and_js()
-    {
-        return $this->get_html();
-    }
+	/**
+	 * Returns the HTML, JS, and CSS necessary to display this form section on a page.
+	 * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
+	 * and call get_html when you want to output the html. Calling get_html_and_js after
+	 * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
+	 * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
+	 * and so might stop working anytime.
+	 *
+	 * @return string
+	 */
+	public function get_html_and_js()
+	{
+		return $this->get_html();
+	}
 
 
-
-    /**
-     * Gets the HTML for displaying this form section
-     *
-     * @return string
-     */
-    abstract public function get_html();
-
-
-    /**
-     * @param bool $add_pound_sign
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_id($add_pound_sign = false)
-    {
-        $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_class()
-    {
-        return $this->_html_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_style()
-    {
-        return $this->_html_style;
-    }
-
-
-
-    /**
-     * @param mixed $html_class
-     */
-    public function set_html_class($html_class)
-    {
-        $this->_html_class = $html_class;
-    }
-
-
-
-    /**
-     * @param mixed $html_id
-     */
-    public function set_html_id($html_id)
-    {
-        $this->_html_id = $html_id;
-    }
-
-
-
-    /**
-     * @param mixed $html_style
-     */
-    public function set_html_style($html_style)
-    {
-        $this->_html_style = $html_style;
-    }
-
-
-
-    /**
-     * @param string $other_html_attributes
-     */
-    public function set_other_html_attributes($other_html_attributes)
-    {
-        $this->_other_html_attributes = $other_html_attributes;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function other_html_attributes()
-    {
-        return ! empty($this->_other_html_attributes) ? ' ' . $this->_other_html_attributes : '';
-    }
-
-
-
-    /**
-     * Gets the name of the form section. This is not the same as the HTML name.
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function name()
-    {
-        if (! $this->_construction_finalized) {
-            throw new EE_Error(sprintf(esc_html__(
-                'You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
-                'event_espresso'
-            ), get_class($this)));
-        }
-        return $this->_name;
-    }
-
-
-
-    /**
-     * Gets the parent section
-     *
-     * @return EE_Form_Section_Proper
-     */
-    public function parent_section()
-    {
-        return $this->_parent_section;
-    }
-
-
-    /**
-     * returns HTML for generating the opening form HTML tag (<form>)
-     *
-     * @param string $action           the URL the form is submitted to
-     * @param string $method           POST (default) or GET
-     * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
-     * @return string
-     * @throws EE_Error
-     */
-    public function form_open($action = '', $method = '', $other_attributes = '')
-    {
-        if (! empty($action)) {
-            $this->set_action($action);
-        }
-        if (! empty($method)) {
-            $this->set_method($method);
-        }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= ' name="' . $this->name() . '"';
-        $html .= ' ' . $other_attributes . '>';
-        return $html;
-    }
-
-
-
-    /**
-     * ensures that html id for form either ends in "-form" or "-frm"
-     * so that id doesn't conflict/collide with other elements
-     *
-     * @param string $html_id
-     * @return string
-     */
-    protected function get_html_id_for_form($html_id)
-    {
-        $strlen = strlen($html_id);
-        $html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
-            ? $html_id
-            : $html_id . '-frm';
-        return $html_id;
-    }
-
-
-    /**
-     * returns HTML for generating the closing form HTML tag (</form>)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function form_close()
-    {
-        return EEH_HTML::nl(-1, 'form')
-               . '</form>'
-               . EEH_HTML::nl()
-               . '<!-- end of ee-'
-               . $this->html_id()
-               . '-form -->'
-               . EEH_HTML::nl();
-    }
-
-
-
-    /**
-     * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
-     * wp_enqueue_style; the scripts could have optionally been registered earlier)
-     * Default does nothing, but child classes can override
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        // defaults to enqueue NO js or css
-    }
-
-
-
-    /**
-     * Adds any extra data needed by js. Eventually we'll call wp_localize_script
-     * with it, and it will be on each form section's 'other_data' property.
-     * By default nothing is added, but child classes can extend this method to add something.
-     * Eg, if you have an input that will cause a modal dialog to appear,
-     * here you could add an entry like 'modal_dialog_inputs' to this array
-     * to map between the input's html ID and the modal dialogue's ID, so that
-     * your JS code will know where to find the modal dialog when the input is pressed.
-     * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        return $form_other_js_data;
-    }
-
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        if (strpos($form_section_path, '/') === 0) {
-            $form_section_path = substr($form_section_path, strlen('/'));
-        }
-        if (empty($form_section_path)) {
-            return $this;
-        }
-        if (strpos($form_section_path, '../') === 0) {
-            $parent = $this->parent_section();
-            $form_section_path = substr($form_section_path, strlen('../'));
-            if ($parent instanceof EE_Form_Section_Base) {
-                return $parent->find_section_from_path($form_section_path);
-            }
-            if (empty($form_section_path)) {
-                return $this;
-            }
-        }
-        // couldn't find it using simple parent following
-        return null;
-    }
+
+	/**
+	 * Gets the HTML for displaying this form section
+	 *
+	 * @return string
+	 */
+	abstract public function get_html();
+
+
+	/**
+	 * @param bool $add_pound_sign
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_id($add_pound_sign = false)
+	{
+		$this->_set_default_html_id_if_empty();
+		return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_class()
+	{
+		return $this->_html_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_style()
+	{
+		return $this->_html_style;
+	}
+
+
+
+	/**
+	 * @param mixed $html_class
+	 */
+	public function set_html_class($html_class)
+	{
+		$this->_html_class = $html_class;
+	}
+
+
+
+	/**
+	 * @param mixed $html_id
+	 */
+	public function set_html_id($html_id)
+	{
+		$this->_html_id = $html_id;
+	}
+
+
+
+	/**
+	 * @param mixed $html_style
+	 */
+	public function set_html_style($html_style)
+	{
+		$this->_html_style = $html_style;
+	}
+
+
+
+	/**
+	 * @param string $other_html_attributes
+	 */
+	public function set_other_html_attributes($other_html_attributes)
+	{
+		$this->_other_html_attributes = $other_html_attributes;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function other_html_attributes()
+	{
+		return ! empty($this->_other_html_attributes) ? ' ' . $this->_other_html_attributes : '';
+	}
+
+
+
+	/**
+	 * Gets the name of the form section. This is not the same as the HTML name.
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function name()
+	{
+		if (! $this->_construction_finalized) {
+			throw new EE_Error(sprintf(esc_html__(
+				'You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
+				'event_espresso'
+			), get_class($this)));
+		}
+		return $this->_name;
+	}
+
+
+
+	/**
+	 * Gets the parent section
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	public function parent_section()
+	{
+		return $this->_parent_section;
+	}
+
+
+	/**
+	 * returns HTML for generating the opening form HTML tag (<form>)
+	 *
+	 * @param string $action           the URL the form is submitted to
+	 * @param string $method           POST (default) or GET
+	 * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function form_open($action = '', $method = '', $other_attributes = '')
+	{
+		if (! empty($action)) {
+			$this->set_action($action);
+		}
+		if (! empty($method)) {
+			$this->set_method($method);
+		}
+		$html = EEH_HTML::nl(1, 'form') . '<form';
+		$html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
+		$html .= ' action="' . $this->action() . '"';
+		$html .= ' method="' . $this->method() . '"';
+		$html .= ' name="' . $this->name() . '"';
+		$html .= ' ' . $other_attributes . '>';
+		return $html;
+	}
+
+
+
+	/**
+	 * ensures that html id for form either ends in "-form" or "-frm"
+	 * so that id doesn't conflict/collide with other elements
+	 *
+	 * @param string $html_id
+	 * @return string
+	 */
+	protected function get_html_id_for_form($html_id)
+	{
+		$strlen = strlen($html_id);
+		$html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
+			? $html_id
+			: $html_id . '-frm';
+		return $html_id;
+	}
+
+
+	/**
+	 * returns HTML for generating the closing form HTML tag (</form>)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function form_close()
+	{
+		return EEH_HTML::nl(-1, 'form')
+			   . '</form>'
+			   . EEH_HTML::nl()
+			   . '<!-- end of ee-'
+			   . $this->html_id()
+			   . '-form -->'
+			   . EEH_HTML::nl();
+	}
+
+
+
+	/**
+	 * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
+	 * wp_enqueue_style; the scripts could have optionally been registered earlier)
+	 * Default does nothing, but child classes can override
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		// defaults to enqueue NO js or css
+	}
+
+
+
+	/**
+	 * Adds any extra data needed by js. Eventually we'll call wp_localize_script
+	 * with it, and it will be on each form section's 'other_data' property.
+	 * By default nothing is added, but child classes can extend this method to add something.
+	 * Eg, if you have an input that will cause a modal dialog to appear,
+	 * here you could add an entry like 'modal_dialog_inputs' to this array
+	 * to map between the input's html ID and the modal dialogue's ID, so that
+	 * your JS code will know where to find the modal dialog when the input is pressed.
+	 * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		return $form_other_js_data;
+	}
+
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		if (strpos($form_section_path, '/') === 0) {
+			$form_section_path = substr($form_section_path, strlen('/'));
+		}
+		if (empty($form_section_path)) {
+			return $this;
+		}
+		if (strpos($form_section_path, '../') === 0) {
+			$parent = $this->parent_section();
+			$form_section_path = substr($form_section_path, strlen('../'));
+			if ($parent instanceof EE_Form_Section_Base) {
+				return $parent->find_section_from_path($form_section_path);
+			}
+			if (empty($form_section_path)) {
+				return $this;
+			}
+		}
+		// couldn't find it using simple parent following
+		return null;
+	}
 }
 // End of file EE_Form_Section_Base.form.php

Spacing +15 added lines, -15 removed lines

@@ -95,7 +95,7 @@ 
         // used by display strategies
         // assign incoming values to properties
         foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
+            $key = '_'.$key;
             if (property_exists($this, $key) && empty($this->{$key})) {
                 $this->{$key} = $value;
                 if ($key === '_subsections' && ! is_array($value)) {
@@ -135,7 +135,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }
@@ -198,7 +198,7 @@ 
      */
     protected function _set_default_html_id_if_empty()
     {
-        if (! $this->_html_id) {
+        if ( ! $this->_html_id) {
             if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
                 $this->_html_id = $this->_parent_section->html_id()
                                   . '-'
@@ -257,7 +257,7 @@ 
     public function html_id($add_pound_sign = false)
     {
         $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+        return $add_pound_sign ? '#'.$this->_html_id : $this->_html_id;
     }
 
 
@@ -327,7 +327,7 @@ 
      */
     public function other_html_attributes()
     {
-        return ! empty($this->_other_html_attributes) ? ' ' . $this->_other_html_attributes : '';
+        return ! empty($this->_other_html_attributes) ? ' '.$this->_other_html_attributes : '';
     }
 
 
@@ -340,7 +340,7 @@ 
      */
     public function name()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             throw new EE_Error(sprintf(esc_html__(
                 'You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
                 'event_espresso'
@@ -373,18 +373,18 @@ 
      */
     public function form_open($action = '', $method = '', $other_attributes = '')
     {
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $this->set_action($action);
         }
-        if (! empty($method)) {
+        if ( ! empty($method)) {
             $this->set_method($method);
         }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= ' name="' . $this->name() . '"';
-        $html .= ' ' . $other_attributes . '>';
+        $html = EEH_HTML::nl(1, 'form').'<form';
+        $html .= $this->html_id() !== '' ? ' id="'.$this->get_html_id_for_form($this->html_id()).'"' : '';
+        $html .= ' action="'.$this->action().'"';
+        $html .= ' method="'.$this->method().'"';
+        $html .= ' name="'.$this->name().'"';
+        $html .= ' '.$other_attributes.'>';
         return $html;
     }
 
@@ -402,7 +402,7 @@ 
         $strlen = strlen($html_id);
         $html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
             ? $html_id
-            : $html_id . '-frm';
+            : $html_id.'-frm';
         return $html_id;
     }
 

core/libraries/form_sections/form_handlers/FormHandler.php

Indentation +639 added lines, -639 removed lines

@@ -29,643 +29,643 @@
 abstract class FormHandler implements FormHandlerInterface
 {
 
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * Form constructor.
-     *
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry $registry
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if (
-                $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (
-            ! in_array(
-                $form_config,
-                array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-                ),
-                true
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'
-                    ),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form()->enqueue_js();
-    }
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $additional_props = $this->requiresMultipartEnctype()
-                ? ' enctype="multipart/form-data"'
-                : '';
-            $form_html .= $this->form()->form_open(
-                $this->formAction(),
-                'POST',
-                $additional_props
-            );
-        }
-        $form_html .= $this->form(true)->get_html();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-    /**
-     * Determines if this form needs "enctype='multipart/form-data'" or not.
-     * @since 4.9.80.p
-     * @return bool
-     * @throws EE_Error
-     */
-    public function requiresMultipartEnctype()
-    {
-        foreach ($this->form()->inputs_in_subsections() as $input) {
-            if ($input instanceof EE_File_Input) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    implode('<br />', $this->form()->get_validation_errors_accumulated())
-                )
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
-            $this->form()->valid_data(),
-            $this
-        );
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * Form constructor.
+	 *
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry $registry
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if (
+				$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (
+			! in_array(
+				$form_config,
+				array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+				),
+				true
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'
+					),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form()->enqueue_js();
+	}
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$additional_props = $this->requiresMultipartEnctype()
+				? ' enctype="multipart/form-data"'
+				: '';
+			$form_html .= $this->form()->form_open(
+				$this->formAction(),
+				'POST',
+				$additional_props
+			);
+		}
+		$form_html .= $this->form(true)->get_html();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+	/**
+	 * Determines if this form needs "enctype='multipart/form-data'" or not.
+	 * @since 4.9.80.p
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function requiresMultipartEnctype()
+	{
+		foreach ($this->form()->inputs_in_subsections() as $input) {
+			if ($input instanceof EE_File_Input) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					implode('<br />', $this->form()->get_validation_errors_accumulated())
+				)
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
+			$this->form()->valid_data(),
+			$this
+		);
+	}
 }

core/services/request/sanitizers/AllowedTags.php

Indentation +281 added lines, -281 removed lines

@@ -13,285 +13,285 @@
 class AllowedTags
 {
 
-    /**
-     * @var array[]
-     */
-    private static $attributes = [
-        'accept-charset'    => 1,
-        'action'            => 1,
-        'alt'               => 1,
-        'allow'             => 1,
-        'allowfullscreen'   => 1,
-        'align'             => 1,
-        'aria-*'            => 1,
-        'autocomplete'      => 1,
-        'bgcolor'           => 1,
-        'border'            => 1,
-        'cellpadding'       => 1,
-        'cellspacing'       => 1,
-        'checked'           => 1,
-        'class'             => 1,
-        'cols'              => 1,
-        'content'           => 1,
-        'data-*'            => 1,
-        'dir'               => 1,
-        'disabled'          => 1,
-        'enctype'           => 1,
-        'extension'         => 1,
-        'for'               => 1,
-        'frameborder'       => 1,
-        'height'            => 1,
-        'href'              => 1,
-        'id'                => 1,
-        'itemprop'          => 1,
-        'itemscope'         => 1,
-        'itemtype'          => 1,
-        'label'             => 1,
-        'lang'              => 1,
-        'leftmargin'        => 1,
-        'marginheight'      => 1,
-        'marginwidth'       => 1,
-        'max'               => 1,
-        'maxlength'         => 1,
-        'media'             => 1,
-        'method'            => 1,
-        'min'               => 1,
-        'multiple'          => 1,
-        'name'              => 1,
-        'novalidate'        => 1,
-        'placeholder'       => 1,
-        'property'          => 1,
-        'readonly'          => 1,
-        'rel'               => 1,
-        'required'          => 1,
-        'rows'              => 1,
-        'selected'          => 1,
-        'src'               => 1,
-        'size'              => 1,
-        'style'             => 1,
-        'step'              => 1,
-        'tabindex'          => 1,
-        'target'            => 1,
-        'title'             => 1,
-        'topmargin'         => 1,
-        'type'              => 1,
-        'value'             => 1,
-        'width'             => 1,
-    ];
-
-
-    /**
-     * @var array
-     */
-    private static $tags = [
-        'a',
-        'abbr',
-        'b',
-        'br',
-        'code',
-        'div',
-        'em',
-        'h1',
-        'h2',
-        'h3',
-        'h4',
-        'h5',
-        'h6',
-        'hr',
-        'i',
-        'img',
-        'li',
-        'ol',
-        'p',
-        'pre',
-        'small',
-        'span',
-        'strong',
-        'table',
-        'td',
-        'tr',
-        'ul',
-    ];
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_tags;
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_embed_tags;
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_form_tags;
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_script_and_style_tags;
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_full_tags;
-
-
-    /**
-     * merges additional tags and attributes into the WP post tags
-     */
-    private static function initializeAllowedTags()
-    {
-        $allowed_post_tags = wp_kses_allowed_html('post');
-        $allowed_tags = [];
-        foreach (AllowedTags::$tags as $tag) {
-            $allowed_tags[ $tag ] = AllowedTags::$attributes;
-        }
-        AllowedTags::$allowed_tags = array_merge_recursive($allowed_post_tags, $allowed_tags);
-    }
-
-
-    /**
-     * merges embed tags and attributes into the EE all tags
-     */
-    private static function initializeWithEmbedTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $embed_tags = [
-            'iframe' => AllowedTags::$attributes
-        ];
-        AllowedTags::$allowed_with_embed_tags = array_merge_recursive($all_tags, $embed_tags);
-    }
-
-
-    /**
-     * merges form tags and attributes into the EE all tags
-     */
-    private static function initializeWithFormTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $form_tags = [
-            'form'     => AllowedTags::$attributes,
-            'label'    => AllowedTags::$attributes,
-            'input'    => AllowedTags::$attributes,
-            'select'   => AllowedTags::$attributes,
-            'option'   => AllowedTags::$attributes,
-            'optgroup' => AllowedTags::$attributes,
-            'textarea' => AllowedTags::$attributes,
-            'button'   => AllowedTags::$attributes,
-            'fieldset' => AllowedTags::$attributes,
-            'output'   => AllowedTags::$attributes,
-        ];
-        AllowedTags::$allowed_with_form_tags = array_merge_recursive($all_tags, $form_tags);
-    }
-
-
-    /**
-     * merges form script and style tags and attributes into the EE all tags
-     */
-    private static function initializeWithScriptAndStyleTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $script_and_style_tags = [
-            'script'   => AllowedTags::$attributes,
-            'style'    => AllowedTags::$attributes,
-            'link'     => AllowedTags::$attributes,
-            'noscript' => AllowedTags::$attributes,
-        ];
-        AllowedTags::$allowed_with_script_and_style_tags = array_merge_recursive($all_tags, $script_and_style_tags);
-    }
-
-    /**
-     * merges all head and body tags and attributes into the EE all tags
-     */
-    private static function initializeWithFullTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $full_tags = [
-            'script'    => AllowedTags::$attributes,
-            'style'     => AllowedTags::$attributes,
-            'link'      => AllowedTags::$attributes,
-            'title'     => AllowedTags::$attributes,
-            'meta'      => AllowedTags::$attributes,
-            'iframe'    => AllowedTags::$attributes,
-            'form'      => AllowedTags::$attributes,
-            'label'     => AllowedTags::$attributes,
-            'input'     => AllowedTags::$attributes,
-            'select'    => AllowedTags::$attributes,
-            'option'    => AllowedTags::$attributes,
-            'optgroup'  => AllowedTags::$attributes,
-            'textarea'  => AllowedTags::$attributes,
-            'button'    => AllowedTags::$attributes,
-            'fieldset'  => AllowedTags::$attributes,
-            'output'    => AllowedTags::$attributes,
-            'noscript'  => AllowedTags::$attributes,
-        ];
-        AllowedTags::$allowed_with_full_tags = array_merge_recursive($all_tags, $full_tags);
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getAllowedTags()
-    {
-        if (empty(AllowedTags::$allowed_tags)) {
-            AllowedTags::initializeAllowedTags();
-        }
-        return AllowedTags::$allowed_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithEmbedTags()
-    {
-        if (empty(AllowedTags::$allowed_with_embed_tags)) {
-            AllowedTags::initializeWithEmbedTags();
-        }
-        return AllowedTags::$allowed_with_embed_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithFormTags()
-    {
-        if (empty(AllowedTags::$allowed_with_form_tags)) {
-            AllowedTags::initializeWithFormTags();
-        }
-        return AllowedTags::$allowed_with_form_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithScriptAndStyleTags()
-    {
-        if (empty(AllowedTags::$allowed_with_script_and_style_tags)) {
-            AllowedTags::initializeWithScriptAndStyleTags();
-        }
-        return AllowedTags::$allowed_with_script_and_style_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithFullTags()
-    {
-        if (empty(AllowedTags::$allowed_with_full_tags)) {
-            AllowedTags::initializeWithFullTags();
-        }
-        return AllowedTags::$allowed_with_full_tags;
-    }
+	/**
+	 * @var array[]
+	 */
+	private static $attributes = [
+		'accept-charset'    => 1,
+		'action'            => 1,
+		'alt'               => 1,
+		'allow'             => 1,
+		'allowfullscreen'   => 1,
+		'align'             => 1,
+		'aria-*'            => 1,
+		'autocomplete'      => 1,
+		'bgcolor'           => 1,
+		'border'            => 1,
+		'cellpadding'       => 1,
+		'cellspacing'       => 1,
+		'checked'           => 1,
+		'class'             => 1,
+		'cols'              => 1,
+		'content'           => 1,
+		'data-*'            => 1,
+		'dir'               => 1,
+		'disabled'          => 1,
+		'enctype'           => 1,
+		'extension'         => 1,
+		'for'               => 1,
+		'frameborder'       => 1,
+		'height'            => 1,
+		'href'              => 1,
+		'id'                => 1,
+		'itemprop'          => 1,
+		'itemscope'         => 1,
+		'itemtype'          => 1,
+		'label'             => 1,
+		'lang'              => 1,
+		'leftmargin'        => 1,
+		'marginheight'      => 1,
+		'marginwidth'       => 1,
+		'max'               => 1,
+		'maxlength'         => 1,
+		'media'             => 1,
+		'method'            => 1,
+		'min'               => 1,
+		'multiple'          => 1,
+		'name'              => 1,
+		'novalidate'        => 1,
+		'placeholder'       => 1,
+		'property'          => 1,
+		'readonly'          => 1,
+		'rel'               => 1,
+		'required'          => 1,
+		'rows'              => 1,
+		'selected'          => 1,
+		'src'               => 1,
+		'size'              => 1,
+		'style'             => 1,
+		'step'              => 1,
+		'tabindex'          => 1,
+		'target'            => 1,
+		'title'             => 1,
+		'topmargin'         => 1,
+		'type'              => 1,
+		'value'             => 1,
+		'width'             => 1,
+	];
+
+
+	/**
+	 * @var array
+	 */
+	private static $tags = [
+		'a',
+		'abbr',
+		'b',
+		'br',
+		'code',
+		'div',
+		'em',
+		'h1',
+		'h2',
+		'h3',
+		'h4',
+		'h5',
+		'h6',
+		'hr',
+		'i',
+		'img',
+		'li',
+		'ol',
+		'p',
+		'pre',
+		'small',
+		'span',
+		'strong',
+		'table',
+		'td',
+		'tr',
+		'ul',
+	];
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_tags;
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_embed_tags;
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_form_tags;
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_script_and_style_tags;
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_full_tags;
+
+
+	/**
+	 * merges additional tags and attributes into the WP post tags
+	 */
+	private static function initializeAllowedTags()
+	{
+		$allowed_post_tags = wp_kses_allowed_html('post');
+		$allowed_tags = [];
+		foreach (AllowedTags::$tags as $tag) {
+			$allowed_tags[ $tag ] = AllowedTags::$attributes;
+		}
+		AllowedTags::$allowed_tags = array_merge_recursive($allowed_post_tags, $allowed_tags);
+	}
+
+
+	/**
+	 * merges embed tags and attributes into the EE all tags
+	 */
+	private static function initializeWithEmbedTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$embed_tags = [
+			'iframe' => AllowedTags::$attributes
+		];
+		AllowedTags::$allowed_with_embed_tags = array_merge_recursive($all_tags, $embed_tags);
+	}
+
+
+	/**
+	 * merges form tags and attributes into the EE all tags
+	 */
+	private static function initializeWithFormTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$form_tags = [
+			'form'     => AllowedTags::$attributes,
+			'label'    => AllowedTags::$attributes,
+			'input'    => AllowedTags::$attributes,
+			'select'   => AllowedTags::$attributes,
+			'option'   => AllowedTags::$attributes,
+			'optgroup' => AllowedTags::$attributes,
+			'textarea' => AllowedTags::$attributes,
+			'button'   => AllowedTags::$attributes,
+			'fieldset' => AllowedTags::$attributes,
+			'output'   => AllowedTags::$attributes,
+		];
+		AllowedTags::$allowed_with_form_tags = array_merge_recursive($all_tags, $form_tags);
+	}
+
+
+	/**
+	 * merges form script and style tags and attributes into the EE all tags
+	 */
+	private static function initializeWithScriptAndStyleTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$script_and_style_tags = [
+			'script'   => AllowedTags::$attributes,
+			'style'    => AllowedTags::$attributes,
+			'link'     => AllowedTags::$attributes,
+			'noscript' => AllowedTags::$attributes,
+		];
+		AllowedTags::$allowed_with_script_and_style_tags = array_merge_recursive($all_tags, $script_and_style_tags);
+	}
+
+	/**
+	 * merges all head and body tags and attributes into the EE all tags
+	 */
+	private static function initializeWithFullTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$full_tags = [
+			'script'    => AllowedTags::$attributes,
+			'style'     => AllowedTags::$attributes,
+			'link'      => AllowedTags::$attributes,
+			'title'     => AllowedTags::$attributes,
+			'meta'      => AllowedTags::$attributes,
+			'iframe'    => AllowedTags::$attributes,
+			'form'      => AllowedTags::$attributes,
+			'label'     => AllowedTags::$attributes,
+			'input'     => AllowedTags::$attributes,
+			'select'    => AllowedTags::$attributes,
+			'option'    => AllowedTags::$attributes,
+			'optgroup'  => AllowedTags::$attributes,
+			'textarea'  => AllowedTags::$attributes,
+			'button'    => AllowedTags::$attributes,
+			'fieldset'  => AllowedTags::$attributes,
+			'output'    => AllowedTags::$attributes,
+			'noscript'  => AllowedTags::$attributes,
+		];
+		AllowedTags::$allowed_with_full_tags = array_merge_recursive($all_tags, $full_tags);
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getAllowedTags()
+	{
+		if (empty(AllowedTags::$allowed_tags)) {
+			AllowedTags::initializeAllowedTags();
+		}
+		return AllowedTags::$allowed_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithEmbedTags()
+	{
+		if (empty(AllowedTags::$allowed_with_embed_tags)) {
+			AllowedTags::initializeWithEmbedTags();
+		}
+		return AllowedTags::$allowed_with_embed_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithFormTags()
+	{
+		if (empty(AllowedTags::$allowed_with_form_tags)) {
+			AllowedTags::initializeWithFormTags();
+		}
+		return AllowedTags::$allowed_with_form_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithScriptAndStyleTags()
+	{
+		if (empty(AllowedTags::$allowed_with_script_and_style_tags)) {
+			AllowedTags::initializeWithScriptAndStyleTags();
+		}
+		return AllowedTags::$allowed_with_script_and_style_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithFullTags()
+	{
+		if (empty(AllowedTags::$allowed_with_full_tags)) {
+			AllowedTags::initializeWithFullTags();
+		}
+		return AllowedTags::$allowed_with_full_tags;
+	}
 }