eventespresso / event-espresso-core

core/libraries/batch/JobHandlers/ExecuteBatchDeletion.php

Indentation +148 added lines, -148 removed lines

@@ -32,158 +32,158 @@
  */
 class ExecuteBatchDeletion extends JobHandler
 {
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
-    public function __construct(NodeGroupDao $model_obj_node_group_persister)
-    {
-        $this->model_obj_node_group_persister = $model_obj_node_group_persister;
-    }
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
+	public function __construct(NodeGroupDao $model_obj_node_group_persister)
+	{
+		$this->model_obj_node_group_persister = $model_obj_node_group_persister;
+	}
 
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     *
-     * @param JobParameters $job_parameters
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $deletion_job_code = $job_parameters->request_datum('deletion_job_code', null);
-        $roots = $this->model_obj_node_group_persister->getModelObjNodesInGroup($deletion_job_code);
-        if ($roots === null) {
-            throw new UnexpectedEntityException($roots, 'array', esc_html__('The job seems to be stale. Please press the back button in your browser twice.', 'event_espresso'));
-        }
-        $models_and_ids_to_delete = [];
-        foreach ($roots as $root) {
-            if (! $root instanceof ModelObjNode) {
-                throw new UnexpectedEntityException($root, 'ModelObjNode');
-            }
-            $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
-        }
-        $job_parameters->set_extra_data(
-            [
-                'models_and_ids_to_delete' => $models_and_ids_to_delete
-            ]
-        );
-        // Find the job's actual size.
-        $job_size = 0;
-        foreach ($models_and_ids_to_delete as $model_name => $ids) {
-            $job_size += count($ids);
-        }
-        $job_parameters->set_job_size($job_size);
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Beginning to delete items...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 *
+	 * @param JobParameters $job_parameters
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$deletion_job_code = $job_parameters->request_datum('deletion_job_code', null);
+		$roots = $this->model_obj_node_group_persister->getModelObjNodesInGroup($deletion_job_code);
+		if ($roots === null) {
+			throw new UnexpectedEntityException($roots, 'array', esc_html__('The job seems to be stale. Please press the back button in your browser twice.', 'event_espresso'));
+		}
+		$models_and_ids_to_delete = [];
+		foreach ($roots as $root) {
+			if (! $root instanceof ModelObjNode) {
+				throw new UnexpectedEntityException($root, 'ModelObjNode');
+			}
+			$models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
+		}
+		$job_parameters->set_extra_data(
+			[
+				'models_and_ids_to_delete' => $models_and_ids_to_delete
+			]
+		);
+		// Find the job's actual size.
+		$job_size = 0;
+		foreach ($models_and_ids_to_delete as $model_name => $ids) {
+			$job_size += count($ids);
+		}
+		$job_parameters->set_job_size($job_size);
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Beginning to delete items...', 'event_espresso')
+		);
+	}
 
-    /**
-     * Performs another step of the job
-     * @param JobParameters $job_parameters
-     * @param int $batch_size
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        // We already have the items IDs. So deleting is really fast. Let's speed it up.
-        $batch_size *= 10;
-        $units_processed = 0;
-        $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
-        // Build a new list of everything leftover after this request's of deletions.
-        $models_and_ids_remaining = [];
-        foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
-            if ($units_processed < $batch_size) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                $ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
-                if ($model->has_primary_key_field()) {
-                    $where_conditions = [
-                        $model->primary_key_name() => [
-                            'IN',
-                            $ids_to_delete_this_query
-                        ]
-                    ];
-                } else {
-                    $where_conditions = [
-                        'OR' => []
-                    ];
-                    foreach ($ids_to_delete_this_query as $index_primary_key_string) {
-                        $keys_n_values = $model->parse_index_primary_key_string($index_primary_key_string);
-                        $where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
-                    }
-                }
-                // Deleting time!
-                // The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
-                // two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
-                $model->delete_permanently(
-                    [
-                        $where_conditions
-                    ],
-                    false
-                );
-                $units_processed += count($ids_to_delete_this_query);
-                $remaining_ids = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
-                // If there's any more from this model, we'll do them next time.
-                if (count($remaining_ids) > 0) {
-                    $models_and_ids_remaining[ $model_name ] = $remaining_ids;
-                }
-            } else {
-                $models_and_ids_remaining[ $model_name ] = $models_and_ids_to_delete[ $model_name ];
-            }
-        }
-        $job_parameters->mark_processed($units_processed);
-        // All done deleting for this request. Is there anything to do next time?
-        if (empty($models_and_ids_remaining)) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            return new JobStepResponse(
-                $job_parameters,
-                esc_html__('Deletion complete.', 'event_espresso')
-            );
-        }
-        $job_parameters->add_extra_data('models_and_ids_to_delete', $models_and_ids_remaining);
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                esc_html__('Deleted %d items.', 'event_espresso'),
-                $units_processed
-            )
-        );
-    }
+	/**
+	 * Performs another step of the job
+	 * @param JobParameters $job_parameters
+	 * @param int $batch_size
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		// We already have the items IDs. So deleting is really fast. Let's speed it up.
+		$batch_size *= 10;
+		$units_processed = 0;
+		$models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
+		// Build a new list of everything leftover after this request's of deletions.
+		$models_and_ids_remaining = [];
+		foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
+			if ($units_processed < $batch_size) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				$ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
+				if ($model->has_primary_key_field()) {
+					$where_conditions = [
+						$model->primary_key_name() => [
+							'IN',
+							$ids_to_delete_this_query
+						]
+					];
+				} else {
+					$where_conditions = [
+						'OR' => []
+					];
+					foreach ($ids_to_delete_this_query as $index_primary_key_string) {
+						$keys_n_values = $model->parse_index_primary_key_string($index_primary_key_string);
+						$where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
+					}
+				}
+				// Deleting time!
+				// The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
+				// two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
+				$model->delete_permanently(
+					[
+						$where_conditions
+					],
+					false
+				);
+				$units_processed += count($ids_to_delete_this_query);
+				$remaining_ids = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
+				// If there's any more from this model, we'll do them next time.
+				if (count($remaining_ids) > 0) {
+					$models_and_ids_remaining[ $model_name ] = $remaining_ids;
+				}
+			} else {
+				$models_and_ids_remaining[ $model_name ] = $models_and_ids_to_delete[ $model_name ];
+			}
+		}
+		$job_parameters->mark_processed($units_processed);
+		// All done deleting for this request. Is there anything to do next time?
+		if (empty($models_and_ids_remaining)) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			return new JobStepResponse(
+				$job_parameters,
+				esc_html__('Deletion complete.', 'event_espresso')
+			);
+		}
+		$job_parameters->add_extra_data('models_and_ids_to_delete', $models_and_ids_remaining);
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				esc_html__('Deleted %d items.', 'event_espresso'),
+				$units_processed
+			)
+		);
+	}
 
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->model_obj_node_group_persister->deleteModelObjNodesInGroup(
-            $job_parameters->request_datum('deletion_job_code')
-        );
-        // For backwards compatibility with how we used to delete events, make sure we still trigger the old action.
-        $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
-        foreach ($models_and_ids_to_delete['Event'] as $event_id) {
-            // Create a log entry so we know who and when this event was permanently deleted.
-            (EE_Change_Log::new_instance(
-                [
-                    'OBJ_ID' => $event_id,
-                    'OBJ_type' => 'Event',
-                    'LOG_message' => sprintf(
-                        esc_html__('Event %1$d permanently deleted using ExecuteBatchDeletion.', 'event_espresso'),
-                        $event_id
-                    )
-                ]
-            ))->save();
-            do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $event_id);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('All done', 'event_espresso')
-        );
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->model_obj_node_group_persister->deleteModelObjNodesInGroup(
+			$job_parameters->request_datum('deletion_job_code')
+		);
+		// For backwards compatibility with how we used to delete events, make sure we still trigger the old action.
+		$models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
+		foreach ($models_and_ids_to_delete['Event'] as $event_id) {
+			// Create a log entry so we know who and when this event was permanently deleted.
+			(EE_Change_Log::new_instance(
+				[
+					'OBJ_ID' => $event_id,
+					'OBJ_type' => 'Event',
+					'LOG_message' => sprintf(
+						esc_html__('Event %1$d permanently deleted using ExecuteBatchDeletion.', 'event_espresso'),
+						$event_id
+					)
+				]
+			))->save();
+			do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $event_id);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('All done', 'event_espresso')
+		);
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php

Spacing +4 added lines, -4 removed lines

@@ -58,7 +58,7 @@ 
         }
         $models_and_ids_to_delete = [];
         foreach ($roots as $root) {
-            if (! $root instanceof ModelObjNode) {
+            if ( ! $root instanceof ModelObjNode) {
                 throw new UnexpectedEntityException($root, 'ModelObjNode');
             }
             $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
@@ -112,7 +112,7 @@ 
                     ];
                     foreach ($ids_to_delete_this_query as $index_primary_key_string) {
                         $keys_n_values = $model->parse_index_primary_key_string($index_primary_key_string);
-                        $where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
+                        $where_conditions['OR']['AND*'.$index_primary_key_string] = $keys_n_values;
                     }
                 }
                 // Deleting time!
@@ -128,10 +128,10 @@ 
                 $remaining_ids = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
                 // If there's any more from this model, we'll do them next time.
                 if (count($remaining_ids) > 0) {
-                    $models_and_ids_remaining[ $model_name ] = $remaining_ids;
+                    $models_and_ids_remaining[$model_name] = $remaining_ids;
                 }
             } else {
-                $models_and_ids_remaining[ $model_name ] = $models_and_ids_to_delete[ $model_name ];
+                $models_and_ids_remaining[$model_name] = $models_and_ids_to_delete[$model_name];
             }
         }
         $job_parameters->mark_processed($units_processed);

core/domain/services/admin/events/data/PreviewDeletion.php

Spacing +4 added lines, -4 removed lines

@@ -89,17 +89,17 @@ 
         $deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
         $models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
         $event_ids = isset($models_and_ids_to_delete['Event']) ? $models_and_ids_to_delete['Event'] : array();
-        if (empty($event_ids) || !is_array($event_ids)) {
+        if (empty($event_ids) || ! is_array($event_ids)) {
             throw new EE_Error(
                 esc_html__('No Events were found to delete.', 'event_espresso')
             );
         }
         $datetime_ids = isset($models_and_ids_to_delete['Datetime']) ? $models_and_ids_to_delete['Datetime'] : array();
-        if (!is_array($datetime_ids)) {
+        if ( ! is_array($datetime_ids)) {
             throw new UnexpectedEntityException($datetime_ids, 'array');
         }
         $registration_ids = isset($models_and_ids_to_delete['Registration']) ? $models_and_ids_to_delete['Registration'] : array();
-        if (!is_array($registration_ids)) {
+        if ( ! is_array($registration_ids)) {
             throw new UnexpectedEntityException($registration_ids, 'array');
         }
         $num_registrations_to_show = 10;
@@ -135,7 +135,7 @@ 
         ];
         return [
             'admin_page_content' => EEH_Template::display_template(
-                EVENTS_TEMPLATE_PATH . 'event_preview_deletion.template.php',
+                EVENTS_TEMPLATE_PATH.'event_preview_deletion.template.php',
                 [
                     'form_url' => EE_Admin_Page::add_query_args_and_nonce(
                         $confirm_deletion_args,

Indentation +116 added lines, -116 removed lines

@@ -31,127 +31,127 @@
  */
 class PreviewDeletion
 {
-    /**
-     * @var NodeGroupDao
-     */
-    protected $dao;
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $dao;
 
-    /**
-     * @var EEM_Event
-     */
-    protected $event_model;
+	/**
+	 * @var EEM_Event
+	 */
+	protected $event_model;
 
-    /**
-     * @var EEM_Datetime
-     */
-    protected $datetime_model;
+	/**
+	 * @var EEM_Datetime
+	 */
+	protected $datetime_model;
 
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
 
-    /**
-     * PreviewDeletion constructor.
-     * @param NodeGroupDao $dao
-     * @param EEM_Event $event_model
-     * @param EEM_Datetime $datetime_model
-     * @param EEM_Registration $registration_model
-     */
-    public function __construct(
-        NodeGroupDao $dao,
-        EEM_Event $event_model,
-        EEM_Datetime $datetime_model,
-        EEM_Registration $registration_model
-    ) {
-        $this->dao = $dao;
-        $this->event_model = $event_model;
-        $this->datetime_model = $datetime_model;
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * PreviewDeletion constructor.
+	 * @param NodeGroupDao $dao
+	 * @param EEM_Event $event_model
+	 * @param EEM_Datetime $datetime_model
+	 * @param EEM_Registration $registration_model
+	 */
+	public function __construct(
+		NodeGroupDao $dao,
+		EEM_Event $event_model,
+		EEM_Datetime $datetime_model,
+		EEM_Registration $registration_model
+	) {
+		$this->dao = $dao;
+		$this->event_model = $event_model;
+		$this->datetime_model = $datetime_model;
+		$this->registration_model = $registration_model;
+	}
 
-    /**
-     * Renders the preview deletion page.
-     * @since 4.10.12.p
-     * @param $request_data
-     * @param $admin_base_url
-     * @return array
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function handle($request_data, $admin_base_url)
-    {
-        $deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
-        $models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
-        $event_ids = isset($models_and_ids_to_delete['Event']) ? $models_and_ids_to_delete['Event'] : array();
-        if (empty($event_ids) || !is_array($event_ids)) {
-            throw new EE_Error(
-                esc_html__('No Events were found to delete.', 'event_espresso')
-            );
-        }
-        $datetime_ids = isset($models_and_ids_to_delete['Datetime']) ? $models_and_ids_to_delete['Datetime'] : array();
-        if (!is_array($datetime_ids)) {
-            throw new UnexpectedEntityException($datetime_ids, 'array');
-        }
-        $registration_ids = isset($models_and_ids_to_delete['Registration']) ? $models_and_ids_to_delete['Registration'] : array();
-        if (!is_array($registration_ids)) {
-            throw new UnexpectedEntityException($registration_ids, 'array');
-        }
-        $num_registrations_to_show = 10;
-        $reg_count = count($registration_ids);
-        if ($reg_count > $num_registrations_to_show) {
-            $registration_ids = array_slice($registration_ids, 0, $num_registrations_to_show);
-        }
-        $form = new ConfirmEventDeletionForm($event_ids);
-        $events = $this->event_model->get_all_deleted_and_undeleted(
-            [
-                [
-                    'EVT_ID' => ['IN', $event_ids]
-                ]
-            ]
-        );
-        $datetimes = $this->datetime_model->get_all_deleted_and_undeleted(
-            [
-                [
-                    'DTT_ID' => ['IN', $datetime_ids]
-                ]
-            ]
-        );
-        $registrations = $this->registration_model->get_all_deleted_and_undeleted(
-            [
-                [
-                    'REG_ID' => ['IN', $registration_ids]
-                ]
-            ]
-        );
-        $confirm_deletion_args = [
-            'action' => 'confirm_deletion',
-            'deletion_job_code' => $deletion_job_code
-        ];
-        return [
-            'admin_page_content' => EEH_Template::display_template(
-                EVENTS_TEMPLATE_PATH . 'event_preview_deletion.template.php',
-                [
-                    'form_url' => EE_Admin_Page::add_query_args_and_nonce(
-                        $confirm_deletion_args,
-                        $admin_base_url
-                    ),
-                    'form' => $form,
-                    'events' => $events,
-                    'datetimes' => $datetimes,
-                    'registrations' => $registrations,
-                    'reg_count' => $reg_count,
-                    'num_registrations_to_show' => $num_registrations_to_show
-                ],
-                true
-            )
-        ];
-    }
+	/**
+	 * Renders the preview deletion page.
+	 * @since 4.10.12.p
+	 * @param $request_data
+	 * @param $admin_base_url
+	 * @return array
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function handle($request_data, $admin_base_url)
+	{
+		$deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
+		$models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
+		$event_ids = isset($models_and_ids_to_delete['Event']) ? $models_and_ids_to_delete['Event'] : array();
+		if (empty($event_ids) || !is_array($event_ids)) {
+			throw new EE_Error(
+				esc_html__('No Events were found to delete.', 'event_espresso')
+			);
+		}
+		$datetime_ids = isset($models_and_ids_to_delete['Datetime']) ? $models_and_ids_to_delete['Datetime'] : array();
+		if (!is_array($datetime_ids)) {
+			throw new UnexpectedEntityException($datetime_ids, 'array');
+		}
+		$registration_ids = isset($models_and_ids_to_delete['Registration']) ? $models_and_ids_to_delete['Registration'] : array();
+		if (!is_array($registration_ids)) {
+			throw new UnexpectedEntityException($registration_ids, 'array');
+		}
+		$num_registrations_to_show = 10;
+		$reg_count = count($registration_ids);
+		if ($reg_count > $num_registrations_to_show) {
+			$registration_ids = array_slice($registration_ids, 0, $num_registrations_to_show);
+		}
+		$form = new ConfirmEventDeletionForm($event_ids);
+		$events = $this->event_model->get_all_deleted_and_undeleted(
+			[
+				[
+					'EVT_ID' => ['IN', $event_ids]
+				]
+			]
+		);
+		$datetimes = $this->datetime_model->get_all_deleted_and_undeleted(
+			[
+				[
+					'DTT_ID' => ['IN', $datetime_ids]
+				]
+			]
+		);
+		$registrations = $this->registration_model->get_all_deleted_and_undeleted(
+			[
+				[
+					'REG_ID' => ['IN', $registration_ids]
+				]
+			]
+		);
+		$confirm_deletion_args = [
+			'action' => 'confirm_deletion',
+			'deletion_job_code' => $deletion_job_code
+		];
+		return [
+			'admin_page_content' => EEH_Template::display_template(
+				EVENTS_TEMPLATE_PATH . 'event_preview_deletion.template.php',
+				[
+					'form_url' => EE_Admin_Page::add_query_args_and_nonce(
+						$confirm_deletion_args,
+						$admin_base_url
+					),
+					'form' => $form,
+					'events' => $events,
+					'datetimes' => $datetimes,
+					'registrations' => $registrations,
+					'reg_count' => $reg_count,
+					'num_registrations_to_show' => $num_registrations_to_show
+				],
+				true
+			)
+		];
+	}
 }
 // End of file PreviewDeletion.php
 // Location: EventEspresso\core\domain\services\admin\events\data/PreviewDeletion.php

core/services/orm/tree_traversal/RelationNode.php

Spacing +7 added lines, -7 removed lines

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

Indentation +264 added lines, -264 removed lines

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

admin_pages/events/form_sections/ConfirmEventDeletionForm.php

Indentation +49 added lines, -49 removed lines

@@ -22,55 +22,55 @@
  */
 class ConfirmEventDeletionForm extends \EE_Form_Section_Proper
 {
-    /**
-     * @var EE_Event[]
-     */
-    protected $events;
-    public function __construct($event_ids, $options_array = array())
-    {
-        if (! isset($options_array['subsections'])) {
-            $options_array['subsections'] = [];
-        }
-        if (! isset($options_array['subsections']['events'])) {
-            $events_subsection = new \EE_Form_Section_Proper();
-            $options_array['subsections']['events'] = $events_subsection;
-        }
-        $events = EEM_Event::instance()->get_all_deleted_and_undeleted(
-            [
-                [
-                    'EVT_ID' => ['IN',$event_ids]
-                ]
-            ]
-        );
-        if (! is_array($events)) {
-            throw new UnexpectedEntityException($event_ids, 'array');
-        }
-        $this->events = $events;
-        $events_inputs = [
-        ];
-        foreach ($events as $event) {
-            $events_inputs[ $event->ID() ] = new EE_Checkbox_Multi_Input(
-                [
-                    'yes' => $event->name(),
-                ],
-                [
-                    'html_label_text' => esc_html__('Please confirm you wish to delete:', 'event_espresso'),
-                    'required' => true
-                ]
-            );
-        }
-        $events_subsection->add_subsections($events_inputs);
-        $options_array['subsections']['backup'] = new EE_Checkbox_Multi_Input(
-            [
-                'yes' => esc_html__('I have backed up my database.', 'event_espresso')
-            ],
-            [
-                'html_label_text' => esc_html__('Deleting this data cannot be undone. Please confirm you have a usable database backup.', 'event_espresso'),
-                'required' => true
-            ]
-        );
-        parent::__construct($options_array);
-    }
+	/**
+	 * @var EE_Event[]
+	 */
+	protected $events;
+	public function __construct($event_ids, $options_array = array())
+	{
+		if (! isset($options_array['subsections'])) {
+			$options_array['subsections'] = [];
+		}
+		if (! isset($options_array['subsections']['events'])) {
+			$events_subsection = new \EE_Form_Section_Proper();
+			$options_array['subsections']['events'] = $events_subsection;
+		}
+		$events = EEM_Event::instance()->get_all_deleted_and_undeleted(
+			[
+				[
+					'EVT_ID' => ['IN',$event_ids]
+				]
+			]
+		);
+		if (! is_array($events)) {
+			throw new UnexpectedEntityException($event_ids, 'array');
+		}
+		$this->events = $events;
+		$events_inputs = [
+		];
+		foreach ($events as $event) {
+			$events_inputs[ $event->ID() ] = new EE_Checkbox_Multi_Input(
+				[
+					'yes' => $event->name(),
+				],
+				[
+					'html_label_text' => esc_html__('Please confirm you wish to delete:', 'event_espresso'),
+					'required' => true
+				]
+			);
+		}
+		$events_subsection->add_subsections($events_inputs);
+		$options_array['subsections']['backup'] = new EE_Checkbox_Multi_Input(
+			[
+				'yes' => esc_html__('I have backed up my database.', 'event_espresso')
+			],
+			[
+				'html_label_text' => esc_html__('Deleting this data cannot be undone. Please confirm you have a usable database backup.', 'event_espresso'),
+				'required' => true
+			]
+		);
+		parent::__construct($options_array);
+	}
 }
 // End of file ConfirmEventDeletionForm.php
 // Location: EventEspresso\admin_pages\events\form_sections/ConfirmEventDeletionForm.php

Spacing +5 added lines, -5 removed lines

@@ -28,28 +28,28 @@
     protected $events;
     public function __construct($event_ids, $options_array = array())
     {
-        if (! isset($options_array['subsections'])) {
+        if ( ! isset($options_array['subsections'])) {
             $options_array['subsections'] = [];
         }
-        if (! isset($options_array['subsections']['events'])) {
+        if ( ! isset($options_array['subsections']['events'])) {
             $events_subsection = new \EE_Form_Section_Proper();
             $options_array['subsections']['events'] = $events_subsection;
         }
         $events = EEM_Event::instance()->get_all_deleted_and_undeleted(
             [
                 [
-                    'EVT_ID' => ['IN',$event_ids]
+                    'EVT_ID' => ['IN', $event_ids]
                 ]
             ]
         );
-        if (! is_array($events)) {
+        if ( ! is_array($events)) {
             throw new UnexpectedEntityException($event_ids, 'array');
         }
         $this->events = $events;
         $events_inputs = [
         ];
         foreach ($events as $event) {
-            $events_inputs[ $event->ID() ] = new EE_Checkbox_Multi_Input(
+            $events_inputs[$event->ID()] = new EE_Checkbox_Multi_Input(
                 [
                     'yes' => $event->name(),
                 ],

core/libraries/form_sections/inputs/EE_Email_Confirm_Input.input.php

Spacing +2 added lines, -2 removed lines

@@ -29,10 +29,10 @@
                 isset($input_settings['validation_error_message'])
                     ? $input_settings['validation_error_message']
                     : null,
-                '#' . str_replace('email_confirm', 'email', $input_settings['html_id'])
+                '#'.str_replace('email_confirm', 'email', $input_settings['html_id'])
             )
         );
         parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . ' email');
+        $this->set_html_class($this->html_class().' email');
     }
 }

Indentation +25 added lines, -25 removed lines

@@ -10,29 +10,29 @@
  */
 class EE_Email_Confirm_Input extends EE_Form_Input_Base
 {
-    /**
-     * @param array $input_settings
-     */
-    public function __construct($input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Text_Input_Display_Strategy('email'));
-        $this->_set_normalization_strategy(new EE_Text_Normalization());
-        $this->_add_validation_strategy(
-            new EE_Email_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ? $input_settings['validation_error_message']
-                    : null
-            )
-        );
-        $this->_add_validation_strategy(
-            new EE_Equal_To_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ? $input_settings['validation_error_message']
-                    : null,
-                '#' . str_replace('email_confirm', 'email', $input_settings['html_id'])
-            )
-        );
-        parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . ' email');
-    }
+	/**
+	 * @param array $input_settings
+	 */
+	public function __construct($input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy('email'));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
+		$this->_add_validation_strategy(
+			new EE_Email_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
+					: null
+			)
+		);
+		$this->_add_validation_strategy(
+			new EE_Equal_To_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
+					: null,
+				'#' . str_replace('email_confirm', 'email', $input_settings['html_id'])
+			)
+		);
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class() . ' email');
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Equal_To_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      */
     public function __construct($validation_error_message = '', $compare_to)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = apply_filters(
                 'FHEE__EE_Equal_To_Validation_Strategy____construct__validation_error_message',
                 esc_html__('Fields do not match.', 'event_espresso')

Indentation +45 added lines, -45 removed lines

@@ -15,49 +15,49 @@
  */
 class EE_Equal_To_Validation_Strategy extends EE_Text_Validation_Strategy
 {
-    protected $_compare_to = null;
-
-
-    /**
-     * @param string               $validation_error_message
-     */
-    public function __construct($validation_error_message = '', $compare_to)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = apply_filters(
-                'FHEE__EE_Equal_To_Validation_Strategy____construct__validation_error_message',
-                esc_html__('Fields do not match.', 'event_espresso')
-            );
-        }
-        parent::__construct($validation_error_message);
-        $this->_compare_to = $compare_to;
-    }
-
-
-
-    /**
-     * just checks the field isn't blank
-     *
-     * @param $normalized_value
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        // No need to be validated
-        return true;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array('equalTo' => $this->_compare_to, 'messages' => array('equalTo' => $this->get_validation_error_message()));
-    }
+	protected $_compare_to = null;
+
+
+	/**
+	 * @param string               $validation_error_message
+	 */
+	public function __construct($validation_error_message = '', $compare_to)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = apply_filters(
+				'FHEE__EE_Equal_To_Validation_Strategy____construct__validation_error_message',
+				esc_html__('Fields do not match.', 'event_espresso')
+			);
+		}
+		parent::__construct($validation_error_message);
+		$this->_compare_to = $compare_to;
+	}
+
+
+
+	/**
+	 * just checks the field isn't blank
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		// No need to be validated
+		return true;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array('equalTo' => $this->_compare_to, 'messages' => array('equalTo' => $this->get_validation_error_message()));
+	}
 }

core/domain/services/assets/CoreAssetManager.php

Spacing +11 added lines, -11 removed lines

@@ -202,7 +202,7 @@ 
         $this->addJs(self::JS_HANDLE_MODEL)->setRequiresTranslation();
         $this->addJs(self::JS_HANDLE_VALUE_OBJECTS)->setRequiresTranslation();
         $this->addJs(self::JS_HANDLE_DATA_STORES)->setRequiresTranslation()->setInlineDataCallback(
-            static function () {
+            static function() {
                 wp_add_inline_script(
                     CoreAssetManager::JS_HANDLE_DATA_STORES,
                     is_admin()
@@ -261,11 +261,11 @@ 
 
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_CORE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             array(CoreAssetManager::JS_HANDLE_JQUERY)
         )
         ->setInlineDataCallback(
-            static function () {
+            static function() {
                 wp_localize_script(
                     CoreAssetManager::JS_HANDLE_CORE,
                     CoreAssetManager::JS_HANDLE_I18N,
@@ -370,16 +370,16 @@ 
         if ($this->template_config->enable_default_style && ! is_admin()) {
             $this->addStylesheet(
                 CoreAssetManager::CSS_HANDLE_DEFAULT,
-                is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css')
+                is_readable(EVENT_ESPRESSO_UPLOAD_DIR.'css/espresso_default.css')
                     ? EVENT_ESPRESSO_UPLOAD_URL . 'css/espresso_default.css'
-                    : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+                    : EE_GLOBAL_ASSETS_URL.'css/espresso_default.css',
                 array('dashicons')
             );
             //Load custom style sheet if available
             if ($this->template_config->custom_style_sheet !== null) {
                 $this->addStylesheet(
                     CoreAssetManager::CSS_HANDLE_CUSTOM,
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+                    EVENT_ESPRESSO_UPLOAD_URL.'css/'.$this->template_config->custom_style_sheet,
                     array(CoreAssetManager::CSS_HANDLE_DEFAULT)
                 );
             }
@@ -402,7 +402,7 @@ 
     {
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.min.js',
             array(CoreAssetManager::JS_HANDLE_JQUERY),
             true,
             '1.15.0'
@@ -410,7 +410,7 @@ 
 
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.additional-methods.min.js',
             array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE),
             true,
             '1.15.0'
@@ -433,7 +433,7 @@ 
         // @link http://josscrowcroft.github.io/accounting.js/
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+            EE_THIRD_PARTY_URL.'accounting/accounting.js',
             array(CoreAssetManager::JS_HANDLE_UNDERSCORE),
             true,
             '0.3.2'
@@ -441,11 +441,11 @@ 
 
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_ACCOUNTING,
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/ee-accounting-config.js',
             array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
         )
         ->setInlineDataCallback(
-            function () {
+            function() {
                  wp_localize_script(
                      CoreAssetManager::JS_HANDLE_ACCOUNTING,
                      'EE_ACCOUNTING_CFG',

Indentation +438 added lines, -438 removed lines

@@ -32,461 +32,461 @@
 class CoreAssetManager extends AssetManager
 {
 
-    // WordPress core / Third party JS asset handles
-    const JS_HANDLE_JQUERY = 'jquery';
+	// WordPress core / Third party JS asset handles
+	const JS_HANDLE_JQUERY = 'jquery';
 
-    const JS_HANDLE_JQUERY_VALIDATE = 'jquery-validate';
+	const JS_HANDLE_JQUERY_VALIDATE = 'jquery-validate';
 
-    const JS_HANDLE_JQUERY_VALIDATE_EXTRA = 'jquery-validate-extra-methods';
+	const JS_HANDLE_JQUERY_VALIDATE_EXTRA = 'jquery-validate-extra-methods';
 
-    const JS_HANDLE_UNDERSCORE = 'underscore';
+	const JS_HANDLE_UNDERSCORE = 'underscore';
 
-    const JS_HANDLE_ACCOUNTING_CORE = 'ee-accounting-core';
+	const JS_HANDLE_ACCOUNTING_CORE = 'ee-accounting-core';
 
-    /**
-     * @since 4.9.71.p
-     */
-    const JS_HANDLE_REACT = 'react';
+	/**
+	 * @since 4.9.71.p
+	 */
+	const JS_HANDLE_REACT = 'react';
 
-    /**
-     * @since 4.9.71.p
-     */
-    const JS_HANDLE_REACT_DOM = 'react-dom';
+	/**
+	 * @since 4.9.71.p
+	 */
+	const JS_HANDLE_REACT_DOM = 'react-dom';
 
-    /**
-     * @since 4.9.71.p
-     */
-    const JS_HANDLE_LODASH = 'lodash';
+	/**
+	 * @since 4.9.71.p
+	 */
+	const JS_HANDLE_LODASH = 'lodash';
 
-    const JS_HANDLE_JS_CORE = 'eejs-core';
+	const JS_HANDLE_JS_CORE = 'eejs-core';
 
-    const JS_HANDLE_VENDOR = 'eventespresso-vendor';
+	const JS_HANDLE_VENDOR = 'eventespresso-vendor';
 
-    const JS_HANDLE_DATA_STORES = 'eventespresso-data-stores';
+	const JS_HANDLE_DATA_STORES = 'eventespresso-data-stores';
 
-    const JS_HANDLE_HELPERS = 'eventespresso-helpers';
+	const JS_HANDLE_HELPERS = 'eventespresso-helpers';
 
-    const JS_HANDLE_MODEL = 'eventespresso-model';
+	const JS_HANDLE_MODEL = 'eventespresso-model';
 
-    const JS_HANDLE_VALUE_OBJECTS = 'eventespresso-value-objects';
+	const JS_HANDLE_VALUE_OBJECTS = 'eventespresso-value-objects';
 
-    const JS_HANDLE_HOCS = 'eventespresso-hocs';
+	const JS_HANDLE_HOCS = 'eventespresso-hocs';
 
-    const JS_HANDLE_COMPONENTS = 'eventespresso-components';
+	const JS_HANDLE_COMPONENTS = 'eventespresso-components';
 
-    const JS_HANDLE_EDITOR_HOCS = 'eventespresso-editor-hocs';
-
-    const JS_HANDLE_VALIDATORS = 'eventespresso-validators';
+	const JS_HANDLE_EDITOR_HOCS = 'eventespresso-editor-hocs';
+
+	const JS_HANDLE_VALIDATORS = 'eventespresso-validators';
 
-    const JS_HANDLE_CORE = 'espresso_core';
+	const JS_HANDLE_CORE = 'espresso_core';
 
-    const JS_HANDLE_I18N = 'eei18n';
+	const JS_HANDLE_I18N = 'eei18n';
 
-    const JS_HANDLE_ACCOUNTING = 'ee-accounting';
-
-    const JS_HANDLE_WP_PLUGINS_PAGE = 'ee-wp-plugins-page';
-
-    // EE CSS assets handles
-    const CSS_HANDLE_DEFAULT = 'espresso_default';
-
-    const CSS_HANDLE_CUSTOM = 'espresso_custom_css';
-
-    const CSS_HANDLE_COMPONENTS = 'eventespresso-components';
-
-    const CSS_HANDLE_CORE_CSS_DEFAULT = 'eventespresso-core-css-default';
-
-    /**
-     * @var EE_Currency_Config $currency_config
-     */
-    protected $currency_config;
-
-    /**
-     * @var EE_Template_Config $template_config
-     */
-    protected $template_config;
-
-
-    /**
-     * CoreAssetRegister constructor.
-     *
-     * @param AssetCollection    $assets
-     * @param EE_Currency_Config $currency_config
-     * @param EE_Template_Config $template_config
-     * @param DomainInterface    $domain
-     * @param Registry           $registry
-     */
-    public function __construct(
-        AssetCollection $assets,
-        EE_Currency_Config $currency_config,
-        EE_Template_Config $template_config,
-        DomainInterface $domain,
-        Registry $registry
-    ) {
-        $this->currency_config = $currency_config;
-        $this->template_config = $template_config;
-        parent::__construct($domain, $assets, $registry);
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     */
-    public function addAssets()
-    {
-        $this->addJavascriptFiles();
-        $this->addStylesheetFiles();
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     */
-    public function addJavascriptFiles()
-    {
-        $this->loadCoreJs();
-        $this->loadJqueryValidate();
-        $this->loadAccountingJs();
-        add_action(
-            'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-            array($this, 'loadQtipJs')
-        );
-        $this->registerAdminAssets();
-    }
-
-
-    /**
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function addStylesheetFiles()
-    {
-        $this->loadCoreCss();
-    }
-
-
-    /**
-     * core default javascript
-     *
-     * @since 4.9.62.p
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     */
-    private function loadCoreJs()
-    {
-        // conditionally load third-party libraries that WP core MIGHT have.
-        $this->registerWpAssets();
-
-        $this->addJs(self::JS_HANDLE_JS_CORE)->setHasInlineData();
-        $this->addJs(self::JS_HANDLE_VENDOR);
-        $this->addJs(self::JS_HANDLE_VALIDATORS)->setRequiresTranslation();
-        $this->addJs(self::JS_HANDLE_HELPERS)->setRequiresTranslation();
-        $this->addJs(self::JS_HANDLE_MODEL)->setRequiresTranslation();
-        $this->addJs(self::JS_HANDLE_VALUE_OBJECTS)->setRequiresTranslation();
-        $this->addJs(self::JS_HANDLE_DATA_STORES)->setRequiresTranslation()->setInlineDataCallback(
-            static function () {
-                wp_add_inline_script(
-                    CoreAssetManager::JS_HANDLE_DATA_STORES,
-                    is_admin()
-                        ? 'wp.apiFetch.use( eejs.middleWares.apiFetch.capsMiddleware( eejs.middleWares.apiFetch.CONTEXT_CAPS_EDIT ) )'
-                        : 'wp.apiFetch.use( eejs.middleWares.apiFetch.capsMiddleware )'
-                );
-            }
-        );
-        $this->addJs(self::JS_HANDLE_HOCS, [self::JS_HANDLE_DATA_STORES])->setRequiresTranslation();
-        $this->addJs(self::JS_HANDLE_COMPONENTS, [self::JS_HANDLE_DATA_STORES])->setRequiresTranslation();
-        $this->addJs(self::JS_HANDLE_EDITOR_HOCS)->setRequiresTranslation();
-
-        $this->registry->addData('eejs_api_nonce', wp_create_nonce('wp_rest'));
-        $this->registry->addData(
-            'paths',
-            array(
-                'base_rest_route' => rest_url(),
-                'rest_route' => rest_url('ee/v4.8.36/'),
-                'collection_endpoints' => EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName(),
-                'primary_keys' => EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName(),
-                'site_url' => site_url('/'),
-                'admin_url' => admin_url('/'),
-            )
-        );
-        // Event Espresso brand name
-        $this->registry->addData('brandName', Domain::brandName());
-        /** site formatting values **/
-        $this->registry->addData(
-            'site_formats',
-            array(
-                'date_formats' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats()
-            )
-        );
-        /** currency data **/
-        $this->registry->addData(
-            'currency_config',
-            $this->getCurrencySettings()
-        );
-        /** site timezone */
-        $this->registry->addData(
-            'default_timezone',
-            array(
-                'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
-                'string' => get_option('timezone_string'),
-                'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-            )
-        );
-        /** site locale (user locale if user logged in) */
-        $this->registry->addData(
-            'locale',
-            array(
-                'user' => get_user_locale(),
-                'site' => get_locale()
-            )
-        );
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_CORE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY)
-        )
-        ->setInlineDataCallback(
-            static function () {
-                wp_localize_script(
-                    CoreAssetManager::JS_HANDLE_CORE,
-                    CoreAssetManager::JS_HANDLE_I18N,
-                    EE_Registry::sanitize_i18n_js_strings()
-                );
-            }
-        );
-    }
-
-
-    /**
-     * Registers vendor files that are bundled with a later version WP but might not be for the current version of
-     * WordPress in the running environment.
-     *
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.71.p
-     */
-    private function registerWpAssets()
-    {
-        global $wp_version;
-        if (version_compare($wp_version, '5.0.beta', '>=')) {
-            return;
-        }
-        $this->addVendorJavascript(CoreAssetManager::JS_HANDLE_REACT, [], true, '16.6.0');
-        $this->addVendorJavascript(
-            CoreAssetManager::JS_HANDLE_REACT_DOM,
-            array(CoreAssetManager::JS_HANDLE_REACT),
-            true,
-            '16.6.0'
-        );
-        $this->addVendorJavascript(CoreAssetManager::JS_HANDLE_LODASH, [], true, '4.17.11')
-            ->setInlineDataCallback(
-                static function() {
-                    wp_add_inline_script(
-                        CoreAssetManager::JS_HANDLE_LODASH,
-                        'window.lodash = _.noConflict();'
-                    );
-                }
-            );
-    }
-
-
-    /**
-     * Returns configuration data for the accounting-js library.
-     * @since 4.9.71.p
-     * @return array
-     */
-    private function getAccountingSettings() {
-        return array(
-            'currency' => array(
-                'symbol'    => $this->currency_config->sign,
-                'format'    => array(
-                    'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
-                    'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
-                    'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
-                ),
-                'decimal'   => $this->currency_config->dec_mrk,
-                'thousand'  => $this->currency_config->thsnds,
-                'precision' => $this->currency_config->dec_plc,
-            ),
-            'number'   => array(
-                'precision' => $this->currency_config->dec_plc,
-                'thousand'  => $this->currency_config->thsnds,
-                'decimal'   => $this->currency_config->dec_mrk,
-            ),
-        );
-    }
-
-
-    /**
-     * Returns configuration data for the js Currency VO.
-     * @since 4.9.71.p
-     * @return array
-     */
-    private function getCurrencySettings()
-    {
-        return array(
-            'code' => $this->currency_config->code,
-            'singularLabel' => $this->currency_config->name,
-            'pluralLabel' => $this->currency_config->plural,
-            'sign' => $this->currency_config->sign,
-            'signB4' => $this->currency_config->sign_b4,
-            'decimalPlaces' => $this->currency_config->dec_plc,
-            'decimalMark' => $this->currency_config->dec_mrk,
-            'thousandsSeparator' => $this->currency_config->thsnds,
-        );
-    }
-
-
-    /**
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    private function loadCoreCss()
-    {
-        if ($this->template_config->enable_default_style && ! is_admin()) {
-            $this->addStylesheet(
-                CoreAssetManager::CSS_HANDLE_DEFAULT,
-                is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css')
-                    ? EVENT_ESPRESSO_UPLOAD_URL . 'css/espresso_default.css'
-                    : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                array('dashicons')
-            );
-            //Load custom style sheet if available
-            if ($this->template_config->custom_style_sheet !== null) {
-                $this->addStylesheet(
-                    CoreAssetManager::CSS_HANDLE_CUSTOM,
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
-                    array(CoreAssetManager::CSS_HANDLE_DEFAULT)
-                );
-            }
-        }
-        $this->addCss(self::CSS_HANDLE_CORE_CSS_DEFAULT, ['dashicons']);
-        $this->addCss(self::CSS_HANDLE_COMPONENTS, [self::CSS_HANDLE_CORE_CSS_DEFAULT]);
-    }
-
-
-    /**
-     * jQuery Validate for form validation
-     *
-     * @since 4.9.62.p
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadJqueryValidate()
-    {
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY),
-            true,
-            '1.15.0'
-        );
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE),
-            true,
-            '1.15.0'
-        );
-    }
-
-
-    /**
-     * accounting.js for performing client-side calculations
-     *
-     * @since 4.9.62.p
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadAccountingJs()
-    {
-        //accounting.js library
-        // @link http://josscrowcroft.github.io/accounting.js/
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
-            array(CoreAssetManager::JS_HANDLE_UNDERSCORE),
-            true,
-            '0.3.2'
-        );
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_ACCOUNTING,
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
-            array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
-        )
-        ->setInlineDataCallback(
-            function () {
-                 wp_localize_script(
-                     CoreAssetManager::JS_HANDLE_ACCOUNTING,
-                     'EE_ACCOUNTING_CFG',
-                     $this->getAccountingSettings()
-                 );
-            }
-        );
-    }
-
-
-    /**
-     * registers assets for cleaning your ears
-     *
-     * @param JavascriptAsset $script
-     */
-    public function loadQtipJs(JavascriptAsset $script)
-    {
-        // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
-        // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
-        if (
-            $script->handle() === CoreAssetManager::JS_HANDLE_WP_PLUGINS_PAGE
-            && apply_filters('FHEE_load_qtip', false)
-        ) {
-            EEH_Qtip_Loader::instance()->register_and_enqueue();
-        }
-    }
-
-
-    /**
-     * assets that are used in the WordPress admin
-     *
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    private function registerAdminAssets()
-    {
-        $this->addJs(self::JS_HANDLE_WP_PLUGINS_PAGE)->setRequiresTranslation();
-        // note usage of the "JS_HANDLE.." constant is intentional here because css uses the same handle.
-        $this->addCss(self::JS_HANDLE_WP_PLUGINS_PAGE);
-    }
+	const JS_HANDLE_ACCOUNTING = 'ee-accounting';
+
+	const JS_HANDLE_WP_PLUGINS_PAGE = 'ee-wp-plugins-page';
+
+	// EE CSS assets handles
+	const CSS_HANDLE_DEFAULT = 'espresso_default';
+
+	const CSS_HANDLE_CUSTOM = 'espresso_custom_css';
+
+	const CSS_HANDLE_COMPONENTS = 'eventespresso-components';
+
+	const CSS_HANDLE_CORE_CSS_DEFAULT = 'eventespresso-core-css-default';
+
+	/**
+	 * @var EE_Currency_Config $currency_config
+	 */
+	protected $currency_config;
+
+	/**
+	 * @var EE_Template_Config $template_config
+	 */
+	protected $template_config;
+
+
+	/**
+	 * CoreAssetRegister constructor.
+	 *
+	 * @param AssetCollection    $assets
+	 * @param EE_Currency_Config $currency_config
+	 * @param EE_Template_Config $template_config
+	 * @param DomainInterface    $domain
+	 * @param Registry           $registry
+	 */
+	public function __construct(
+		AssetCollection $assets,
+		EE_Currency_Config $currency_config,
+		EE_Template_Config $template_config,
+		DomainInterface $domain,
+		Registry $registry
+	) {
+		$this->currency_config = $currency_config;
+		$this->template_config = $template_config;
+		parent::__construct($domain, $assets, $registry);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 */
+	public function addAssets()
+	{
+		$this->addJavascriptFiles();
+		$this->addStylesheetFiles();
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 */
+	public function addJavascriptFiles()
+	{
+		$this->loadCoreJs();
+		$this->loadJqueryValidate();
+		$this->loadAccountingJs();
+		add_action(
+			'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+			array($this, 'loadQtipJs')
+		);
+		$this->registerAdminAssets();
+	}
+
+
+	/**
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheetFiles()
+	{
+		$this->loadCoreCss();
+	}
+
+
+	/**
+	 * core default javascript
+	 *
+	 * @since 4.9.62.p
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 */
+	private function loadCoreJs()
+	{
+		// conditionally load third-party libraries that WP core MIGHT have.
+		$this->registerWpAssets();
+
+		$this->addJs(self::JS_HANDLE_JS_CORE)->setHasInlineData();
+		$this->addJs(self::JS_HANDLE_VENDOR);
+		$this->addJs(self::JS_HANDLE_VALIDATORS)->setRequiresTranslation();
+		$this->addJs(self::JS_HANDLE_HELPERS)->setRequiresTranslation();
+		$this->addJs(self::JS_HANDLE_MODEL)->setRequiresTranslation();
+		$this->addJs(self::JS_HANDLE_VALUE_OBJECTS)->setRequiresTranslation();
+		$this->addJs(self::JS_HANDLE_DATA_STORES)->setRequiresTranslation()->setInlineDataCallback(
+			static function () {
+				wp_add_inline_script(
+					CoreAssetManager::JS_HANDLE_DATA_STORES,
+					is_admin()
+						? 'wp.apiFetch.use( eejs.middleWares.apiFetch.capsMiddleware( eejs.middleWares.apiFetch.CONTEXT_CAPS_EDIT ) )'
+						: 'wp.apiFetch.use( eejs.middleWares.apiFetch.capsMiddleware )'
+				);
+			}
+		);
+		$this->addJs(self::JS_HANDLE_HOCS, [self::JS_HANDLE_DATA_STORES])->setRequiresTranslation();
+		$this->addJs(self::JS_HANDLE_COMPONENTS, [self::JS_HANDLE_DATA_STORES])->setRequiresTranslation();
+		$this->addJs(self::JS_HANDLE_EDITOR_HOCS)->setRequiresTranslation();
+
+		$this->registry->addData('eejs_api_nonce', wp_create_nonce('wp_rest'));
+		$this->registry->addData(
+			'paths',
+			array(
+				'base_rest_route' => rest_url(),
+				'rest_route' => rest_url('ee/v4.8.36/'),
+				'collection_endpoints' => EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName(),
+				'primary_keys' => EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName(),
+				'site_url' => site_url('/'),
+				'admin_url' => admin_url('/'),
+			)
+		);
+		// Event Espresso brand name
+		$this->registry->addData('brandName', Domain::brandName());
+		/** site formatting values **/
+		$this->registry->addData(
+			'site_formats',
+			array(
+				'date_formats' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats()
+			)
+		);
+		/** currency data **/
+		$this->registry->addData(
+			'currency_config',
+			$this->getCurrencySettings()
+		);
+		/** site timezone */
+		$this->registry->addData(
+			'default_timezone',
+			array(
+				'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
+				'string' => get_option('timezone_string'),
+				'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+			)
+		);
+		/** site locale (user locale if user logged in) */
+		$this->registry->addData(
+			'locale',
+			array(
+				'user' => get_user_locale(),
+				'site' => get_locale()
+			)
+		);
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_CORE,
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY)
+		)
+		->setInlineDataCallback(
+			static function () {
+				wp_localize_script(
+					CoreAssetManager::JS_HANDLE_CORE,
+					CoreAssetManager::JS_HANDLE_I18N,
+					EE_Registry::sanitize_i18n_js_strings()
+				);
+			}
+		);
+	}
+
+
+	/**
+	 * Registers vendor files that are bundled with a later version WP but might not be for the current version of
+	 * WordPress in the running environment.
+	 *
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.71.p
+	 */
+	private function registerWpAssets()
+	{
+		global $wp_version;
+		if (version_compare($wp_version, '5.0.beta', '>=')) {
+			return;
+		}
+		$this->addVendorJavascript(CoreAssetManager::JS_HANDLE_REACT, [], true, '16.6.0');
+		$this->addVendorJavascript(
+			CoreAssetManager::JS_HANDLE_REACT_DOM,
+			array(CoreAssetManager::JS_HANDLE_REACT),
+			true,
+			'16.6.0'
+		);
+		$this->addVendorJavascript(CoreAssetManager::JS_HANDLE_LODASH, [], true, '4.17.11')
+			->setInlineDataCallback(
+				static function() {
+					wp_add_inline_script(
+						CoreAssetManager::JS_HANDLE_LODASH,
+						'window.lodash = _.noConflict();'
+					);
+				}
+			);
+	}
+
+
+	/**
+	 * Returns configuration data for the accounting-js library.
+	 * @since 4.9.71.p
+	 * @return array
+	 */
+	private function getAccountingSettings() {
+		return array(
+			'currency' => array(
+				'symbol'    => $this->currency_config->sign,
+				'format'    => array(
+					'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
+					'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
+					'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
+				),
+				'decimal'   => $this->currency_config->dec_mrk,
+				'thousand'  => $this->currency_config->thsnds,
+				'precision' => $this->currency_config->dec_plc,
+			),
+			'number'   => array(
+				'precision' => $this->currency_config->dec_plc,
+				'thousand'  => $this->currency_config->thsnds,
+				'decimal'   => $this->currency_config->dec_mrk,
+			),
+		);
+	}
+
+
+	/**
+	 * Returns configuration data for the js Currency VO.
+	 * @since 4.9.71.p
+	 * @return array
+	 */
+	private function getCurrencySettings()
+	{
+		return array(
+			'code' => $this->currency_config->code,
+			'singularLabel' => $this->currency_config->name,
+			'pluralLabel' => $this->currency_config->plural,
+			'sign' => $this->currency_config->sign,
+			'signB4' => $this->currency_config->sign_b4,
+			'decimalPlaces' => $this->currency_config->dec_plc,
+			'decimalMark' => $this->currency_config->dec_mrk,
+			'thousandsSeparator' => $this->currency_config->thsnds,
+		);
+	}
+
+
+	/**
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	private function loadCoreCss()
+	{
+		if ($this->template_config->enable_default_style && ! is_admin()) {
+			$this->addStylesheet(
+				CoreAssetManager::CSS_HANDLE_DEFAULT,
+				is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css')
+					? EVENT_ESPRESSO_UPLOAD_URL . 'css/espresso_default.css'
+					: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				array('dashicons')
+			);
+			//Load custom style sheet if available
+			if ($this->template_config->custom_style_sheet !== null) {
+				$this->addStylesheet(
+					CoreAssetManager::CSS_HANDLE_CUSTOM,
+					EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+					array(CoreAssetManager::CSS_HANDLE_DEFAULT)
+				);
+			}
+		}
+		$this->addCss(self::CSS_HANDLE_CORE_CSS_DEFAULT, ['dashicons']);
+		$this->addCss(self::CSS_HANDLE_COMPONENTS, [self::CSS_HANDLE_CORE_CSS_DEFAULT]);
+	}
+
+
+	/**
+	 * jQuery Validate for form validation
+	 *
+	 * @since 4.9.62.p
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadJqueryValidate()
+	{
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY),
+			true,
+			'1.15.0'
+		);
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE),
+			true,
+			'1.15.0'
+		);
+	}
+
+
+	/**
+	 * accounting.js for performing client-side calculations
+	 *
+	 * @since 4.9.62.p
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadAccountingJs()
+	{
+		//accounting.js library
+		// @link http://josscrowcroft.github.io/accounting.js/
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
+			EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+			array(CoreAssetManager::JS_HANDLE_UNDERSCORE),
+			true,
+			'0.3.2'
+		);
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_ACCOUNTING,
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+			array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
+		)
+		->setInlineDataCallback(
+			function () {
+				 wp_localize_script(
+					 CoreAssetManager::JS_HANDLE_ACCOUNTING,
+					 'EE_ACCOUNTING_CFG',
+					 $this->getAccountingSettings()
+				 );
+			}
+		);
+	}
+
+
+	/**
+	 * registers assets for cleaning your ears
+	 *
+	 * @param JavascriptAsset $script
+	 */
+	public function loadQtipJs(JavascriptAsset $script)
+	{
+		// qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
+		// can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
+		if (
+			$script->handle() === CoreAssetManager::JS_HANDLE_WP_PLUGINS_PAGE
+			&& apply_filters('FHEE_load_qtip', false)
+		) {
+			EEH_Qtip_Loader::instance()->register_and_enqueue();
+		}
+	}
+
+
+	/**
+	 * assets that are used in the WordPress admin
+	 *
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	private function registerAdminAssets()
+	{
+		$this->addJs(self::JS_HANDLE_WP_PLUGINS_PAGE)->setRequiresTranslation();
+		// note usage of the "JS_HANDLE.." constant is intentional here because css uses the same handle.
+		$this->addCss(self::JS_HANDLE_WP_PLUGINS_PAGE);
+	}
 }

core/db_models/EEM_WP_User.model.php

Spacing +3 added lines, -3 removed lines

@@ -112,10 +112,10 @@
         ];
         $this->_wp_core_model = true;
         $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read] = 'list';
+        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read_admin] = 'list';
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_WP_User();
         }
         // @todo: account for create_users controls whether they can create users at all
         parent::__construct($timezone);

Indentation +123 added lines, -123 removed lines

@@ -12,133 +12,133 @@
  */
 class EEM_WP_User extends EEM_Base
 {
-    /**
-     * private instance of the EEM_WP_User object
-     *
-     * @type EEM_WP_User
-     */
-    protected static $_instance;
+	/**
+	 * private instance of the EEM_WP_User object
+	 *
+	 * @type EEM_WP_User
+	 */
+	protected static $_instance;
 
 
-    /**
-     *    constructor
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = esc_html__('WP_User', 'event_espresso');
-        $this->plural_item = esc_html__('WP_Users', 'event_espresso');
-        global $wpdb;
-        $this->_tables = array(
-            'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
-        );
-        $this->_fields = array(
-            'WP_User' => array(
-                'ID'                  => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('WP_User ID', 'event_espresso')
-                ),
-                'user_login'          => $model_field_factory->createPlainTextField(
-                    'user_login',
-                    esc_html__('User Login', 'event_espresso'),
-                    false
-                ),
-                'user_pass'           => $model_field_factory->createPlainTextField(
-                    'user_pass',
-                    esc_html__('User Password', 'event_espresso'),
-                    false
-                ),
-                'user_nicename'       => $model_field_factory->createPlainTextField(
-                    'user_nicename',
-                    esc_html__(' User Nice Name', 'event_espresso'),
-                    false
-                ),
-                'user_email'          => $model_field_factory->createEmailField(
-                    'user_email',
-                    esc_html__('User Email', 'event_espresso'),
-                    false,
-                    null
-                ),
-                'user_registered'     => $model_field_factory->createDatetimeField(
-                    'user_registered',
-                    esc_html__('Date User Registered', 'event_espresso'),
-                    $timezone
-                ),
-                'user_activation_key' => $model_field_factory->createPlainTextField(
-                    'user_activation_key',
-                    esc_html__('User Activation Key', 'event_espresso'),
-                    false
-                ),
-                'user_status'         => $model_field_factory->createIntegerField(
-                    'user_status',
-                    esc_html__('User Status', 'event_espresso')
-                ),
-                'display_name'        => $model_field_factory->createPlainTextField(
-                    'display_name',
-                    esc_html__('Display Name', 'event_espresso'),
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'       => new EE_Has_Many_Relation(),
-            // all models are related to the change log
-            // 'Change_Log'     => new EE_Has_Many_Relation(),
-            'Event'          => new EE_Has_Many_Relation(),
-            'Message'        => new EE_Has_Many_Relation(),
-            'Payment_Method' => new EE_Has_Many_Relation(),
-            'Price'          => new EE_Has_Many_Relation(),
-            'Price_Type'     => new EE_Has_Many_Relation(),
-            'Question'       => new EE_Has_Many_Relation(),
-            'Question_Group' => new EE_Has_Many_Relation(),
-            'Ticket'         => new EE_Has_Many_Relation(),
-            'Venue'          => new EE_Has_Many_Relation(),
-        );
-        $this->foreign_key_aliases = [
-            'Event.EVT_wp_user'          => 'WP_User.ID',
-            'Payment_Method.PMD_wp_user' => 'WP_User.ID',
-            'Price.PRC_wp_user'          => 'WP_User.ID',
-            'Price_Type.PRT_wp_user'     => 'WP_User.ID',
-            'Question.QST_wp_user'       => 'WP_User.ID',
-            'Question_Group.QSG_wp_user' => 'WP_User.ID',
-            'Ticket.VNU_wp_user'         => 'WP_User.ID',
-            'Venue.TKT_wp_user'          => 'WP_User.ID',
-        ];
-        $this->_wp_core_model = true;
-        $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
-        }
-        // @todo: account for create_users controls whether they can create users at all
-        parent::__construct($timezone);
-    }
+	/**
+	 *    constructor
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = esc_html__('WP_User', 'event_espresso');
+		$this->plural_item = esc_html__('WP_Users', 'event_espresso');
+		global $wpdb;
+		$this->_tables = array(
+			'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
+		);
+		$this->_fields = array(
+			'WP_User' => array(
+				'ID'                  => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('WP_User ID', 'event_espresso')
+				),
+				'user_login'          => $model_field_factory->createPlainTextField(
+					'user_login',
+					esc_html__('User Login', 'event_espresso'),
+					false
+				),
+				'user_pass'           => $model_field_factory->createPlainTextField(
+					'user_pass',
+					esc_html__('User Password', 'event_espresso'),
+					false
+				),
+				'user_nicename'       => $model_field_factory->createPlainTextField(
+					'user_nicename',
+					esc_html__(' User Nice Name', 'event_espresso'),
+					false
+				),
+				'user_email'          => $model_field_factory->createEmailField(
+					'user_email',
+					esc_html__('User Email', 'event_espresso'),
+					false,
+					null
+				),
+				'user_registered'     => $model_field_factory->createDatetimeField(
+					'user_registered',
+					esc_html__('Date User Registered', 'event_espresso'),
+					$timezone
+				),
+				'user_activation_key' => $model_field_factory->createPlainTextField(
+					'user_activation_key',
+					esc_html__('User Activation Key', 'event_espresso'),
+					false
+				),
+				'user_status'         => $model_field_factory->createIntegerField(
+					'user_status',
+					esc_html__('User Status', 'event_espresso')
+				),
+				'display_name'        => $model_field_factory->createPlainTextField(
+					'display_name',
+					esc_html__('Display Name', 'event_espresso'),
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'       => new EE_Has_Many_Relation(),
+			// all models are related to the change log
+			// 'Change_Log'     => new EE_Has_Many_Relation(),
+			'Event'          => new EE_Has_Many_Relation(),
+			'Message'        => new EE_Has_Many_Relation(),
+			'Payment_Method' => new EE_Has_Many_Relation(),
+			'Price'          => new EE_Has_Many_Relation(),
+			'Price_Type'     => new EE_Has_Many_Relation(),
+			'Question'       => new EE_Has_Many_Relation(),
+			'Question_Group' => new EE_Has_Many_Relation(),
+			'Ticket'         => new EE_Has_Many_Relation(),
+			'Venue'          => new EE_Has_Many_Relation(),
+		);
+		$this->foreign_key_aliases = [
+			'Event.EVT_wp_user'          => 'WP_User.ID',
+			'Payment_Method.PMD_wp_user' => 'WP_User.ID',
+			'Price.PRC_wp_user'          => 'WP_User.ID',
+			'Price_Type.PRT_wp_user'     => 'WP_User.ID',
+			'Question.QST_wp_user'       => 'WP_User.ID',
+			'Question_Group.QSG_wp_user' => 'WP_User.ID',
+			'Ticket.VNU_wp_user'         => 'WP_User.ID',
+			'Venue.TKT_wp_user'          => 'WP_User.ID',
+		];
+		$this->_wp_core_model = true;
+		$this->_caps_slug = 'users';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+		}
+		// @todo: account for create_users controls whether they can create users at all
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * We don't need a foreign key to the WP_User model, we just need its primary key
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function wp_user_field_name()
-    {
-        return $this->primary_key_name();
-    }
+	/**
+	 * We don't need a foreign key to the WP_User model, we just need its primary key
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function wp_user_field_name()
+	{
+		return $this->primary_key_name();
+	}
 
 
-    /**
-     * This WP_User model IS owned, even though it doesn't have a foreign key to itself
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        return true;
-    }
+	/**
+	 * This WP_User model IS owned, even though it doesn't have a foreign key to itself
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		return true;
+	}
 }

core/db_models/EEM_Payment_Method.model.php

Spacing +6 added lines, -6 removed lines

@@ -170,7 +170,7 @@ 
     public function is_valid_scope($scope)
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         }
         return false;
@@ -187,7 +187,7 @@ 
      */
     public function get_all_active($scope = null, $query_params = [])
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
             $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
@@ -235,7 +235,7 @@ 
         $count = 0;
         foreach ($this->scopes() as $scope_name => $desc) {
             $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+            $acceptable_scopes['PMD_scope*'.$count] = ['LIKE', '%'.$scope_name.'%'];
         }
         return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
     }
@@ -391,7 +391,7 @@ 
         $usable_payment_methods = [];
         foreach ($payment_methods as $key => $payment_method) {
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -405,7 +405,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         esc_html__(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -413,7 +413,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true

Indentation +452 added lines, -452 removed lines

@@ -16,456 +16,456 @@
  */
 class EEM_Payment_Method extends EEM_Base
 {
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Payment Method', 'event_espresso');
-        $this->plural_item = esc_html__('Payment Methods', 'event_espresso');
-        $this->_tables = [
-            'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
-        ];
-        $this->_fields = [
-            'Payment_Method' => [
-                'PMD_ID'              => new EE_Primary_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'PMD_type'            => new EE_Plain_Text_Field(
-                    'PMD_type',
-                    esc_html__('Payment Method Type', 'event_espresso'),
-                    false,
-                    'Admin_Only'
-                ),
-                'PMD_name'            => new EE_Plain_Text_Field(
-                    'PMD_name',
-                    esc_html__('Name', 'event_espresso'),
-                    false
-                ),
-                'PMD_desc'            => new EE_Post_Content_Field(
-                    'PMD_desc',
-                    esc_html__('Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PMD_admin_name'      => new EE_Plain_Text_Field(
-                    'PMD_admin_name',
-                    esc_html__('Admin-Only Name', 'event_espresso'),
-                    true
-                ),
-                'PMD_admin_desc'      => new EE_Post_Content_Field(
-                    'PMD_admin_desc',
-                    esc_html__('Admin-Only Description', 'event_espresso'),
-                    true
-                ),
-                'PMD_slug'            => new EE_Slug_Field(
-                    'PMD_slug',
-                    esc_html__('Slug', 'event_espresso'),
-                    false
-                ),
-                'PMD_order'           => new EE_Integer_Field(
-                    'PMD_order',
-                    esc_html__('Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PMD_debug_mode'      => new EE_Boolean_Field(
-                    'PMD_debug_mode',
-                    esc_html__('Debug Mode On?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_wp_user'         => new EE_WP_User_Field(
-                    'PMD_wp_user',
-                    esc_html__('Payment Method Creator ID', 'event_espresso'),
-                    false
-                ),
-                'PMD_open_by_default' => new EE_Boolean_Field(
-                    'PMD_open_by_default',
-                    esc_html__('Open by Default?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_button_url'      => new EE_Plain_Text_Field(
-                    'PMD_button_url',
-                    esc_html__('Button URL', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_scope'           => new EE_Serialized_Text_Field(
-                    'PMD_scope',
-                    esc_html__('Usable From?', 'event_espresso'),
-                    false,
-                    []// possible values currently are 'CART','ADMIN','API'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Payment'     => new EE_Has_Many_Relation(),
-            'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User'     => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets one by the slug provided
-     *
-     * @param string $slug
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one([['PMD_slug' => $slug]]);
-    }
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     *
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            [
-                EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
-                EEM_Payment_Method::scope_admin => esc_html__(
-                    'Admin Registration Page (no online processing)',
-                    'event_espresso'
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Determines if this is an valid scope
-     *
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all active payment methods
-     *
-     * @param string $scope one of
-     * @param array  $query_params
-     * @return EE_Base_Class[]|EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_active($scope = null, $query_params = [])
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Counts all active gateways in the specified scope
-     *
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_active($scope = null, $query_params = [])
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
-                    $scope
-                )
-            );
-        }
-        $acceptable_scopes = [];
-        $count = 0;
-        foreach ($this->scopes() as $scope_name => $desc) {
-            $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
-        }
-        return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     *
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_active($scope = null, $query_params = [])
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     *
-     * @param string $type
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one([['PMD_type' => $type]]);
-    }
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     *
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
-     * @throws EE_Error
-     * @see EEM_Base::ensure_is_obj()
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
-                $base_class_obj_or_id
-            )
-        );
-    }
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     *
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     * @throws EE_Error
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url.
-     * If not, resets them to their default.
-     *
-     * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods)
-            ? $payment_methods
-            : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (
-                    empty($current_button_url)
-                    || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->deactivate();
-            }
-        }
-    }
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = [])
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = [];
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        esc_html__(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, ['group_by' => 'PMD_type']),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment
-     * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
-     *                                                    registration.
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = [
-            0          => [
-                'Payment.Registration.REG_ID' => $registration_id,
-            ],
-            'order_by' => ['Payment.PAY_ID' => 'DESC'],
-        ];
-        return $this->get_one($query_params);
-    }
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Payment Method', 'event_espresso');
+		$this->plural_item = esc_html__('Payment Methods', 'event_espresso');
+		$this->_tables = [
+			'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
+		];
+		$this->_fields = [
+			'Payment_Method' => [
+				'PMD_ID'              => new EE_Primary_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'PMD_type'            => new EE_Plain_Text_Field(
+					'PMD_type',
+					esc_html__('Payment Method Type', 'event_espresso'),
+					false,
+					'Admin_Only'
+				),
+				'PMD_name'            => new EE_Plain_Text_Field(
+					'PMD_name',
+					esc_html__('Name', 'event_espresso'),
+					false
+				),
+				'PMD_desc'            => new EE_Post_Content_Field(
+					'PMD_desc',
+					esc_html__('Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PMD_admin_name'      => new EE_Plain_Text_Field(
+					'PMD_admin_name',
+					esc_html__('Admin-Only Name', 'event_espresso'),
+					true
+				),
+				'PMD_admin_desc'      => new EE_Post_Content_Field(
+					'PMD_admin_desc',
+					esc_html__('Admin-Only Description', 'event_espresso'),
+					true
+				),
+				'PMD_slug'            => new EE_Slug_Field(
+					'PMD_slug',
+					esc_html__('Slug', 'event_espresso'),
+					false
+				),
+				'PMD_order'           => new EE_Integer_Field(
+					'PMD_order',
+					esc_html__('Order', 'event_espresso'),
+					false,
+					0
+				),
+				'PMD_debug_mode'      => new EE_Boolean_Field(
+					'PMD_debug_mode',
+					esc_html__('Debug Mode On?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_wp_user'         => new EE_WP_User_Field(
+					'PMD_wp_user',
+					esc_html__('Payment Method Creator ID', 'event_espresso'),
+					false
+				),
+				'PMD_open_by_default' => new EE_Boolean_Field(
+					'PMD_open_by_default',
+					esc_html__('Open by Default?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_button_url'      => new EE_Plain_Text_Field(
+					'PMD_button_url',
+					esc_html__('Button URL', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_scope'           => new EE_Serialized_Text_Field(
+					'PMD_scope',
+					esc_html__('Usable From?', 'event_espresso'),
+					false,
+					[]// possible values currently are 'CART','ADMIN','API'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Payment'     => new EE_Has_Many_Relation(),
+			'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User'     => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets one by the slug provided
+	 *
+	 * @param string $slug
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one([['PMD_slug' => $slug]]);
+	}
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 *
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			[
+				EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
+				EEM_Payment_Method::scope_admin => esc_html__(
+					'Admin Registration Page (no online processing)',
+					'event_espresso'
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Determines if this is an valid scope
+	 *
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all active payment methods
+	 *
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @return EE_Base_Class[]|EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active($scope = null, $query_params = [])
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 *
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_active($scope = null, $query_params = [])
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
+					$scope
+				)
+			);
+		}
+		$acceptable_scopes = [];
+		$count = 0;
+		foreach ($this->scopes() as $scope_name => $desc) {
+			$count++;
+			$acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+		}
+		return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 *
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_active($scope = null, $query_params = [])
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 *
+	 * @param string $type
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one([['PMD_type' => $type]]);
+	}
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 *
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
+	 * @throws EE_Error
+	 * @see EEM_Base::ensure_is_obj()
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
+				$base_class_obj_or_id
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 *
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url.
+	 * If not, resets them to their default.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods)
+			? $payment_methods
+			: $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (
+					empty($current_button_url)
+					|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->deactivate();
+			}
+		}
+	}
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = [])
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = [];
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						esc_html__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, ['group_by' => 'PMD_type']),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment
+	 * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
+	 *                                                    registration.
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = [
+			0          => [
+				'Payment.Registration.REG_ID' => $registration_id,
+			],
+			'order_by' => ['Payment.PAY_ID' => 'DESC'],
+		];
+		return $this->get_one($query_params);
+	}
 }