eventespresso / event-espresso-core

core/libraries/rest_api/changes/ChangesIn40836.php

Spacing +4 added lines, -4 removed lines

@@ -119,9 +119,9 @@ 
                 $headers,
                 array_flip(
                     array(
-                        Base::HEADER_PREFIX_FOR_WP . 'Total',
-                        Base::HEADER_PREFIX_FOR_WP . 'TotalPages',
-                        Base::HEADER_PREFIX_FOR_WP . 'PageSize',
+                        Base::HEADER_PREFIX_FOR_WP.'Total',
+                        Base::HEADER_PREFIX_FOR_WP.'TotalPages',
+                        Base::HEADER_PREFIX_FOR_WP.'PageSize',
                     )
                 )
             );
@@ -151,7 +151,7 @@ 
             && $model instanceof \EEM_CPT_Base
         ) {
             $attachment = wp_get_attachment_image_src(
-                get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]),
+                get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
                 'full'
             );
             $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;

Indentation +162 added lines, -162 removed lines

@@ -16,176 +16,176 @@
 class ChangesIn40836 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        // set a hook to remove the "calculate" query param
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array($this, 'removeCalculateQueryParam'),
-            10,
-            3
-        );
-        // don't add the _calculated_fields either
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            array($this, 'removeCalculatedFieldsFromResponse'),
-            10,
-            5
-        );
-        // and also don't add the count headers
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'removeHeadersNewInThisVersion'),
-            10,
-            3
-        );
-        // remove the old featured_image part of the response...
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            array($this, 'addOldFeaturedImagePartOfCptEntities'),
-            10,
-            5
-        );
-        // assuming ticket 9425's change gets pushed with 9406, we don't need to
-        // remove it from the calculated fields on older requests (because this will
-        // be the first version with calculated fields)
-        // before this, infinity was -1, now it's null
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            array($this, 'useNegativeOneForInfinityBeforeThisVersion'),
-            10,
-            4
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		// set a hook to remove the "calculate" query param
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array($this, 'removeCalculateQueryParam'),
+			10,
+			3
+		);
+		// don't add the _calculated_fields either
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			array($this, 'removeCalculatedFieldsFromResponse'),
+			10,
+			5
+		);
+		// and also don't add the count headers
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'removeHeadersNewInThisVersion'),
+			10,
+			3
+		);
+		// remove the old featured_image part of the response...
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			array($this, 'addOldFeaturedImagePartOfCptEntities'),
+			10,
+			5
+		);
+		// assuming ticket 9425's change gets pushed with 9406, we don't need to
+		// remove it from the calculated fields on older requests (because this will
+		// be the first version with calculated fields)
+		// before this, infinity was -1, now it's null
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			array($this, 'useNegativeOneForInfinityBeforeThisVersion'),
+			10,
+			4
+		);
+	}
 
 
-    /**
-     * Don't show "calculate" as an query param option in the index
-     *
-     * @param array    $query_params
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    public function removeCalculateQueryParam($query_params, EEM_Base $model, $version)
-    {
-        if ($this->appliesToVersion($version)) {
-            unset($query_params['calculate']);
-        }
-        return $query_params;
-    }
+	/**
+	 * Don't show "calculate" as an query param option in the index
+	 *
+	 * @param array    $query_params
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	public function removeCalculateQueryParam($query_params, EEM_Base $model, $version)
+	{
+		if ($this->appliesToVersion($version)) {
+			unset($query_params['calculate']);
+		}
+		return $query_params;
+	}
 
 
-    /**
-     * Removes the "_calculate_fields" part of entity responses before 4.8.36
-     *
-     * @param array           $entity_response_array
-     * @param EEM_Base        $model
-     * @param string          $request_context
-     * @param WP_REST_Request $request
-     * @param Read            $controller
-     * @return array
-     */
-    public function removeCalculatedFieldsFromResponse(
-        $entity_response_array,
-        EEM_Base $model,
-        $request_context,
-        WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) {
-            unset($entity_response_array['_calculated_fields']);
-        }
-        return $entity_response_array;
-    }
+	/**
+	 * Removes the "_calculate_fields" part of entity responses before 4.8.36
+	 *
+	 * @param array           $entity_response_array
+	 * @param EEM_Base        $model
+	 * @param string          $request_context
+	 * @param WP_REST_Request $request
+	 * @param Read            $controller
+	 * @return array
+	 */
+	public function removeCalculatedFieldsFromResponse(
+		$entity_response_array,
+		EEM_Base $model,
+		$request_context,
+		WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) {
+			unset($entity_response_array['_calculated_fields']);
+		}
+		return $entity_response_array;
+	}
 
 
-    /**
-     * Removes the new headers for requests before 4.8.36
-     *
-     * @param array           $headers
-     * @param Controller_Base $controller
-     * @param string          $version
-     * @return array
-     */
-    public function removeHeadersNewInThisVersion(
-        $headers,
-        Controller_Base $controller,
-        $version
-    ) {
-        if ($this->appliesToVersion($version)) {
-            $headers = array_diff_key(
-                $headers,
-                array_flip(
-                    array(
-                        Base::HEADER_PREFIX_FOR_WP . 'Total',
-                        Base::HEADER_PREFIX_FOR_WP . 'TotalPages',
-                        Base::HEADER_PREFIX_FOR_WP . 'PageSize',
-                    )
-                )
-            );
-        }
-        return $headers;
-    }
+	/**
+	 * Removes the new headers for requests before 4.8.36
+	 *
+	 * @param array           $headers
+	 * @param Controller_Base $controller
+	 * @param string          $version
+	 * @return array
+	 */
+	public function removeHeadersNewInThisVersion(
+		$headers,
+		Controller_Base $controller,
+		$version
+	) {
+		if ($this->appliesToVersion($version)) {
+			$headers = array_diff_key(
+				$headers,
+				array_flip(
+					array(
+						Base::HEADER_PREFIX_FOR_WP . 'Total',
+						Base::HEADER_PREFIX_FOR_WP . 'TotalPages',
+						Base::HEADER_PREFIX_FOR_WP . 'PageSize',
+					)
+				)
+			);
+		}
+		return $headers;
+	}
 
 
-    /**
-     * Puts the 'featured_image_url' back in for responses before 4.8.36.
-     *
-     * @param array           $entity_response_array
-     * @param EEM_Base        $model
-     * @param string          $request_context
-     * @param WP_REST_Request $request
-     * @param Read            $controller
-     * @return array
-     */
-    public function addOldFeaturedImagePartOfCptEntities(
-        $entity_response_array,
-        EEM_Base $model,
-        $request_context,
-        WP_REST_Request $request,
-        Read $controller
-    ) {
-        if (
-            $this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())
-            && $model instanceof \EEM_CPT_Base
-        ) {
-            $attachment = wp_get_attachment_image_src(
-                get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]),
-                'full'
-            );
-            $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
-        }
-        return $entity_response_array;
-    }
+	/**
+	 * Puts the 'featured_image_url' back in for responses before 4.8.36.
+	 *
+	 * @param array           $entity_response_array
+	 * @param EEM_Base        $model
+	 * @param string          $request_context
+	 * @param WP_REST_Request $request
+	 * @param Read            $controller
+	 * @return array
+	 */
+	public function addOldFeaturedImagePartOfCptEntities(
+		$entity_response_array,
+		EEM_Base $model,
+		$request_context,
+		WP_REST_Request $request,
+		Read $controller
+	) {
+		if (
+			$this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())
+			&& $model instanceof \EEM_CPT_Base
+		) {
+			$attachment = wp_get_attachment_image_src(
+				get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]),
+				'full'
+			);
+			$entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
+		}
+		return $entity_response_array;
+	}
 
 
-    /**
-     * If the value was infinity, we now use null in our JSON responses,
-     * but before this version we used -1.
-     *
-     * @param mixed                $new_value
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_value
-     * @return mixed
-     */
-    public function useNegativeOneForInfinityBeforeThisVersion(
-        $new_value,
-        $field_obj,
-        $original_value,
-        $requested_value
-    ) {
-        if (
-            $this->appliesToVersion($requested_value)
-            && $original_value === EE_INF
-        ) {
-            // return the old representation of infinity in the JSON
-            return -1;
-        }
-        return $new_value;
-    }
+	/**
+	 * If the value was infinity, we now use null in our JSON responses,
+	 * but before this version we used -1.
+	 *
+	 * @param mixed                $new_value
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_value
+	 * @return mixed
+	 */
+	public function useNegativeOneForInfinityBeforeThisVersion(
+		$new_value,
+		$field_obj,
+		$original_value,
+		$requested_value
+	) {
+		if (
+			$this->appliesToVersion($requested_value)
+			&& $original_value === EE_INF
+		) {
+			// return the old representation of infinity in the JSON
+			return -1;
+		}
+		return $new_value;
+	}
 }

core/libraries/batch/JobHandlers/DatetimeOffsetFix.php

Indentation +467 added lines, -467 removed lines

@@ -24,471 +24,471 @@
 class DatetimeOffsetFix extends JobHandler
 {
 
-    /**
-     * Key for the option used to track which models have been processed when doing the batches.
-     */
-    const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
-
-
-    const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
-
-    /**
-     * Key for the option used to track what the current offset is that will be applied when this tool is executed.
-     */
-    const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
-
-
-    const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
-
-
-    const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
-
-
-    /**
-     * String labelling the datetime offset fix type for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
-
-
-    /**
-     * String labelling a datetime offset fix error for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
-
-    /**
-     * @var EEM_Base[]
-     */
-    protected $models_with_datetime_fields = array();
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $models_with_datetime_fields = $this->getModelsWithDatetimeFields();
-        // we'll be doing each model as a batch.
-        $job_parameters->set_job_size(count($models_with_datetime_fields));
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Starting Datetime Offset Fix', 'event_espresso')
-        );
-    }
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        $models_to_process = $this->getModelsWithDatetimeFields();
-        // let's pop off the a model and do the query to apply the offset.
-        $model_to_process = array_pop($models_to_process);
-        // update our record
-        $this->setModelsToProcess($models_to_process);
-        $this->processModel($model_to_process);
-        $this->updateCountOfModelsProcessed();
-        $job_parameters->set_units_processed($this->getCountOfModelsProcessed());
-        if (count($models_to_process) > 0) {
-            $job_parameters->set_status(JobParameters::status_continue);
-        } else {
-            $job_parameters->set_status(JobParameters::status_complete);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
-                $model_to_process
-            )
-        );
-    }
-
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        // delete important saved options.
-        delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
-        delete_option(self::COUNT_OF_MODELS_PROCESSED);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
-        return new JobStepResponse($job_parameters, esc_html__(
-            'Offset has been applied to all affected fields.',
-            'event_espresso'
-        ));
-    }
-
-
-    /**
-     * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
-     *
-     * @param string $model_class_name
-     * @throws EE_Error
-     */
-    protected function processModel($model_class_name)
-    {
-        global $wpdb;
-        /** @var EEM_Base $model */
-        $model = $model_class_name::instance();
-        $original_offset = self::getOffset();
-        $start_date_range = self::getStartDateRange();
-        $end_date_range = self::getEndDateRange();
-        $sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
-        $offset = abs($original_offset) * 60;
-        $date_ranges = array();
-        // since some affected models might have two tables, we have to get our tables and set up a query for each table.
-        foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
-            $fields_affected = array();
-            $inner_query = array();
-            foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
-                if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
-                                                                       . $model_field->get_table_column()
-                                                                       . ", INTERVAL {$offset} MINUTE)";
-                    $fields_affected[] = $model_field;
-                }
-            }
-            if (! $fields_affected) {
-                continue;
-            }
-            // do we do one query per column/field or one query for all fields on the model? It all depends on whether
-            // there is a date range applied or not.
-            if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
-                $result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
-            } else {
-                $result = $this->doQueryForAllFields($query, $inner_query);
-            }
-
-            // record appropriate logs for the query
-            switch (true) {
-                case $result === false:
-                    // record error.
-                    $error_message = $wpdb->last_error;
-                    // handle the edgecases where last_error might be empty.
-                    if (! $error_message) {
-                        $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
-                    }
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
-                    break;
-                case is_array($result) && ! empty($result):
-                    foreach ($result as $field_name => $error_message) {
-                        $this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
-                    }
-                    break;
-                default:
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected);
-            }
-        }
-    }
-
-
-    /**
-     * Does the query on each $inner_query individually.
-     *
-     * @param string              $query
-     * @param array               $inner_query
-     * @param DbSafeDateTime|null $start_date_range
-     * @param DbSafeDateTime|null $end_date_range
-     * @return array  An array of any errors encountered and the fields they were for.
-     */
-    private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
-    {
-        global $wpdb;
-        $errors = array();
-        foreach ($inner_query as $field_name => $field_query) {
-            $query_to_run = $query;
-            $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
-            if ($start_date_range instanceof DbSafeDateTime) {
-                $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} > '{$start_date}'";
-            }
-            if ($end_date_range instanceof DbSafeDateTime) {
-                $end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} < '{$end_date}'";
-            }
-            if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
-            }
-            $result = $wpdb->query($query_to_run);
-            if ($result === false) {
-                // record error.
-                $error_message = $wpdb->last_error;
-                // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
-                    $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
-                }
-                $errors[ $field_name ] = $error_message;
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * Performs the query for all fields within the inner_query
-     *
-     * @param string $query
-     * @param array  $inner_query
-     * @return false|int
-     */
-    private function doQueryForAllFields($query, array $inner_query)
-    {
-        global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * Records a changelog entry using the given information.
-     *
-     * @param EEM_Base              $model
-     * @param float                 $offset
-     * @param EE_Table_Base         $table
-     * @param EE_Model_Field_Base[] $model_fields_affected
-     * @param string                $error_message If present then there was an error so let's record that instead.
-     * @throws EE_Error
-     */
-    private function recordChangeLog(
-        EEM_Base $model,
-        $offset,
-        EE_Table_Base $table,
-        $model_fields_affected,
-        $error_message = ''
-    ) {
-        // setup $fields list.
-        $fields = array();
-        /** @var EE_Datetime_Field $model_field */
-        foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
-                continue;
-            }
-            $fields[] = $model_field->get_name();
-        }
-        // setup the message for the changelog entry.
-        $message = $error_message
-            ? sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields),
-                $error_message
-            )
-            : sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields)
-            );
-        // write to the log
-        $changelog = EE_Change_Log::new_instance(array(
-            'LOG_type'    => $error_message
-                ? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
-                : self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
-            'LOG_message' => $message,
-        ));
-        $changelog->save();
-    }
-
-
-    /**
-     * Returns an array of models that have datetime fields.
-     * This array is added to a short lived transient cache to keep having to build this list to a minimum.
-     *
-     * @return array an array of model class names.
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getModelsWithDatetimeFields()
-    {
-        $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
-            return $this->models_with_datetime_fields;
-        }
-
-        $all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
-        foreach ($all_non_abstract_models as $non_abstract_model) {
-            // get model instance
-            /** @var EEM_Base $non_abstract_model */
-            $non_abstract_model = $non_abstract_model::instance();
-            if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
-                $this->models_with_datetime_fields[] = get_class($non_abstract_model);
-            }
-        }
-        $this->setModelsToProcess($this->models_with_datetime_fields);
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * This simply records the models that have been processed with our tracking option.
-     *
-     * @param array $models_to_set array of model class names.
-     */
-    private function setModelsToProcess($models_to_set)
-    {
-        update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
-    }
-
-
-    /**
-     * Used to keep track of how many models have been processed for the batch
-     *
-     * @param $count
-     */
-    private function updateCountOfModelsProcessed($count = 1)
-    {
-        $count = $this->getCountOfModelsProcessed() + (int) $count;
-        update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
-    }
-
-
-    /**
-     * Retrieve the tracked number of models processed between requests.
-     *
-     * @return int
-     */
-    private function getCountOfModelsProcessed()
-    {
-        return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
-    }
-
-
-    /**
-     * Returns the models that are left to process.
-     *
-     * @return array  an array of model class names.
-     */
-    private function getModelsToProcess()
-    {
-        if (empty($this->models_with_datetime_fields)) {
-            $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
-        }
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @param float $offset
-     */
-    public static function updateOffset($offset)
-    {
-        update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
-    }
-
-
-    /**
-     * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @return float
-     */
-    public static function getOffset()
-    {
-        return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
-    }
-
-
-    /**
-     * Used to set the saved offset range start date.
-     *
-     * @param DbSafeDateTime|null $start_date
-     */
-    public static function updateStartDateRange(DbSafeDateTime $start_date = null)
-    {
-        $date_to_save = $start_date instanceof DbSafeDateTime
-            ? $start_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range start date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getStartDateRange()
-    {
-        $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
-        try {
-            $datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
-            $start_date = $datetime instanceof DateTime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $start_date = null;
-        }
-        return $start_date;
-    }
-
-
-    /**
-     * Used to set the saved offset range end date.
-     *
-     * @param DbSafeDateTime|null $end_date
-     */
-    public static function updateEndDateRange(DbSafeDateTime $end_date = null)
-    {
-        $date_to_save = $end_date instanceof DbSafeDateTime
-            ? $end_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range end date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getEndDateRange()
-    {
-        $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
-        try {
-            $datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
-            $end_date = $datetime instanceof Datetime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $end_date = null;
-        }
-        return $end_date;
-    }
+	/**
+	 * Key for the option used to track which models have been processed when doing the batches.
+	 */
+	const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
+
+
+	const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
+
+	/**
+	 * Key for the option used to track what the current offset is that will be applied when this tool is executed.
+	 */
+	const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
+
+
+	const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
+
+
+	const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
+
+
+	/**
+	 * String labelling the datetime offset fix type for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
+
+
+	/**
+	 * String labelling a datetime offset fix error for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
+
+	/**
+	 * @var EEM_Base[]
+	 */
+	protected $models_with_datetime_fields = array();
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$models_with_datetime_fields = $this->getModelsWithDatetimeFields();
+		// we'll be doing each model as a batch.
+		$job_parameters->set_job_size(count($models_with_datetime_fields));
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Starting Datetime Offset Fix', 'event_espresso')
+		);
+	}
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		$models_to_process = $this->getModelsWithDatetimeFields();
+		// let's pop off the a model and do the query to apply the offset.
+		$model_to_process = array_pop($models_to_process);
+		// update our record
+		$this->setModelsToProcess($models_to_process);
+		$this->processModel($model_to_process);
+		$this->updateCountOfModelsProcessed();
+		$job_parameters->set_units_processed($this->getCountOfModelsProcessed());
+		if (count($models_to_process) > 0) {
+			$job_parameters->set_status(JobParameters::status_continue);
+		} else {
+			$job_parameters->set_status(JobParameters::status_complete);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
+				$model_to_process
+			)
+		);
+	}
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		// delete important saved options.
+		delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
+		delete_option(self::COUNT_OF_MODELS_PROCESSED);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
+		return new JobStepResponse($job_parameters, esc_html__(
+			'Offset has been applied to all affected fields.',
+			'event_espresso'
+		));
+	}
+
+
+	/**
+	 * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
+	 *
+	 * @param string $model_class_name
+	 * @throws EE_Error
+	 */
+	protected function processModel($model_class_name)
+	{
+		global $wpdb;
+		/** @var EEM_Base $model */
+		$model = $model_class_name::instance();
+		$original_offset = self::getOffset();
+		$start_date_range = self::getStartDateRange();
+		$end_date_range = self::getEndDateRange();
+		$sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
+		$offset = abs($original_offset) * 60;
+		$date_ranges = array();
+		// since some affected models might have two tables, we have to get our tables and set up a query for each table.
+		foreach ($model->get_tables() as $table) {
+			$query = 'UPDATE ' . $table->get_table_name();
+			$fields_affected = array();
+			$inner_query = array();
+			foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
+				if ($model_field instanceof EE_Datetime_Field) {
+					$inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
+																	   . $sql_date_function . '('
+																	   . $model_field->get_table_column()
+																	   . ", INTERVAL {$offset} MINUTE)";
+					$fields_affected[] = $model_field;
+				}
+			}
+			if (! $fields_affected) {
+				continue;
+			}
+			// do we do one query per column/field or one query for all fields on the model? It all depends on whether
+			// there is a date range applied or not.
+			if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
+				$result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
+			} else {
+				$result = $this->doQueryForAllFields($query, $inner_query);
+			}
+
+			// record appropriate logs for the query
+			switch (true) {
+				case $result === false:
+					// record error.
+					$error_message = $wpdb->last_error;
+					// handle the edgecases where last_error might be empty.
+					if (! $error_message) {
+						$error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
+					}
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
+					break;
+				case is_array($result) && ! empty($result):
+					foreach ($result as $field_name => $error_message) {
+						$this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
+					}
+					break;
+				default:
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected);
+			}
+		}
+	}
+
+
+	/**
+	 * Does the query on each $inner_query individually.
+	 *
+	 * @param string              $query
+	 * @param array               $inner_query
+	 * @param DbSafeDateTime|null $start_date_range
+	 * @param DbSafeDateTime|null $end_date_range
+	 * @return array  An array of any errors encountered and the fields they were for.
+	 */
+	private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
+	{
+		global $wpdb;
+		$errors = array();
+		foreach ($inner_query as $field_name => $field_query) {
+			$query_to_run = $query;
+			$where_conditions = array();
+			$query_to_run .= ' SET ' . $field_query;
+			if ($start_date_range instanceof DbSafeDateTime) {
+				$start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} > '{$start_date}'";
+			}
+			if ($end_date_range instanceof DbSafeDateTime) {
+				$end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} < '{$end_date}'";
+			}
+			if ($where_conditions) {
+				$query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+			}
+			$result = $wpdb->query($query_to_run);
+			if ($result === false) {
+				// record error.
+				$error_message = $wpdb->last_error;
+				// handle the edgecases where last_error might be empty.
+				if (! $error_message) {
+					$error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
+				}
+				$errors[ $field_name ] = $error_message;
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * Performs the query for all fields within the inner_query
+	 *
+	 * @param string $query
+	 * @param array  $inner_query
+	 * @return false|int
+	 */
+	private function doQueryForAllFields($query, array $inner_query)
+	{
+		global $wpdb;
+		$query .= ' SET ' . implode(',', $inner_query);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * Records a changelog entry using the given information.
+	 *
+	 * @param EEM_Base              $model
+	 * @param float                 $offset
+	 * @param EE_Table_Base         $table
+	 * @param EE_Model_Field_Base[] $model_fields_affected
+	 * @param string                $error_message If present then there was an error so let's record that instead.
+	 * @throws EE_Error
+	 */
+	private function recordChangeLog(
+		EEM_Base $model,
+		$offset,
+		EE_Table_Base $table,
+		$model_fields_affected,
+		$error_message = ''
+	) {
+		// setup $fields list.
+		$fields = array();
+		/** @var EE_Datetime_Field $model_field */
+		foreach ($model_fields_affected as $model_field) {
+			if (! $model_field instanceof EE_Datetime_Field) {
+				continue;
+			}
+			$fields[] = $model_field->get_name();
+		}
+		// setup the message for the changelog entry.
+		$message = $error_message
+			? sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields),
+				$error_message
+			)
+			: sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields)
+			);
+		// write to the log
+		$changelog = EE_Change_Log::new_instance(array(
+			'LOG_type'    => $error_message
+				? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
+				: self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
+			'LOG_message' => $message,
+		));
+		$changelog->save();
+	}
+
+
+	/**
+	 * Returns an array of models that have datetime fields.
+	 * This array is added to a short lived transient cache to keep having to build this list to a minimum.
+	 *
+	 * @return array an array of model class names.
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getModelsWithDatetimeFields()
+	{
+		$this->getModelsToProcess();
+		if (! empty($this->models_with_datetime_fields)) {
+			return $this->models_with_datetime_fields;
+		}
+
+		$all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
+		foreach ($all_non_abstract_models as $non_abstract_model) {
+			// get model instance
+			/** @var EEM_Base $non_abstract_model */
+			$non_abstract_model = $non_abstract_model::instance();
+			if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
+				$this->models_with_datetime_fields[] = get_class($non_abstract_model);
+			}
+		}
+		$this->setModelsToProcess($this->models_with_datetime_fields);
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * This simply records the models that have been processed with our tracking option.
+	 *
+	 * @param array $models_to_set array of model class names.
+	 */
+	private function setModelsToProcess($models_to_set)
+	{
+		update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
+	}
+
+
+	/**
+	 * Used to keep track of how many models have been processed for the batch
+	 *
+	 * @param $count
+	 */
+	private function updateCountOfModelsProcessed($count = 1)
+	{
+		$count = $this->getCountOfModelsProcessed() + (int) $count;
+		update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
+	}
+
+
+	/**
+	 * Retrieve the tracked number of models processed between requests.
+	 *
+	 * @return int
+	 */
+	private function getCountOfModelsProcessed()
+	{
+		return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
+	}
+
+
+	/**
+	 * Returns the models that are left to process.
+	 *
+	 * @return array  an array of model class names.
+	 */
+	private function getModelsToProcess()
+	{
+		if (empty($this->models_with_datetime_fields)) {
+			$this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
+		}
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @param float $offset
+	 */
+	public static function updateOffset($offset)
+	{
+		update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
+	}
+
+
+	/**
+	 * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @return float
+	 */
+	public static function getOffset()
+	{
+		return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
+	}
+
+
+	/**
+	 * Used to set the saved offset range start date.
+	 *
+	 * @param DbSafeDateTime|null $start_date
+	 */
+	public static function updateStartDateRange(DbSafeDateTime $start_date = null)
+	{
+		$date_to_save = $start_date instanceof DbSafeDateTime
+			? $start_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range start date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getStartDateRange()
+	{
+		$start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
+		try {
+			$datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
+			$start_date = $datetime instanceof DateTime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$start_date = null;
+		}
+		return $start_date;
+	}
+
+
+	/**
+	 * Used to set the saved offset range end date.
+	 *
+	 * @param DbSafeDateTime|null $end_date
+	 */
+	public static function updateEndDateRange(DbSafeDateTime $end_date = null)
+	{
+		$date_to_save = $end_date instanceof DbSafeDateTime
+			? $end_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range end date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getEndDateRange()
+	{
+		$end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
+		try {
+			$datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
+			$end_date = $datetime instanceof Datetime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$end_date = null;
+		}
+		return $end_date;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -160,19 +160,19 @@ 
         $date_ranges = array();
         // since some affected models might have two tables, we have to get our tables and set up a query for each table.
         foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
+            $query = 'UPDATE '.$table->get_table_name();
             $fields_affected = array();
             $inner_query = array();
             foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
                 if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
+                    $inner_query[$model_field->get_table_column()] = $model_field->get_table_column().' = '
+                                                                       . $sql_date_function.'('
                                                                        . $model_field->get_table_column()
                                                                        . ", INTERVAL {$offset} MINUTE)";
                     $fields_affected[] = $model_field;
                 }
             }
-            if (! $fields_affected) {
+            if ( ! $fields_affected) {
                 continue;
             }
             // do we do one query per column/field or one query for all fields on the model? It all depends on whether
@@ -189,7 +189,7 @@ 
                     // record error.
                     $error_message = $wpdb->last_error;
                     // handle the edgecases where last_error might be empty.
-                    if (! $error_message) {
+                    if ( ! $error_message) {
                         $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
                     }
                     $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
@@ -222,7 +222,7 @@ 
         foreach ($inner_query as $field_name => $field_query) {
             $query_to_run = $query;
             $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
+            $query_to_run .= ' SET '.$field_query;
             if ($start_date_range instanceof DbSafeDateTime) {
                 $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
                 $where_conditions[] = "{$field_name} > '{$start_date}'";
@@ -232,17 +232,17 @@ 
                 $where_conditions[] = "{$field_name} < '{$end_date}'";
             }
             if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+                $query_to_run .= ' WHERE '.implode(' AND ', $where_conditions);
             }
             $result = $wpdb->query($query_to_run);
             if ($result === false) {
                 // record error.
                 $error_message = $wpdb->last_error;
                 // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
+                if ( ! $error_message) {
                     $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
                 }
-                $errors[ $field_name ] = $error_message;
+                $errors[$field_name] = $error_message;
             }
         }
         return $errors;
@@ -259,7 +259,7 @@ 
     private function doQueryForAllFields($query, array $inner_query)
     {
         global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
+        $query .= ' SET '.implode(',', $inner_query);
         return $wpdb->query($query);
     }
 
@@ -285,7 +285,7 @@ 
         $fields = array();
         /** @var EE_Datetime_Field $model_field */
         foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
+            if ( ! $model_field instanceof EE_Datetime_Field) {
                 continue;
             }
             $fields[] = $model_field->get_name();
@@ -337,7 +337,7 @@ 
     private function getModelsWithDatetimeFields()
     {
         $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
+        if ( ! empty($this->models_with_datetime_fields)) {
             return $this->models_with_datetime_fields;
         }
 

core/libraries/batch/Helpers/JobStepResponse.php

Indentation +84 added lines, -84 removed lines

@@ -13,99 +13,99 @@
  */
 class JobStepResponse
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * Description fo what happened during this step
-     *
-     * @var string
-     */
-    protected $_update_text;
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * Description fo what happened during this step
+	 *
+	 * @var string
+	 */
+	protected $_update_text;
 
-    /**
-     * @var JobParameters
-     */
-    protected $_job_parameters;
+	/**
+	 * @var JobParameters
+	 */
+	protected $_job_parameters;
 
-    /**
-     * Extra data to include as part of the response.
-     *
-     * @var array
-     */
-    protected $_extra_data = array();
-    // phpcs:enable
+	/**
+	 * Extra data to include as part of the response.
+	 *
+	 * @var array
+	 */
+	protected $_extra_data = array();
+	// phpcs:enable
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters
-     * @param string                                           $update_text
-     * @param array                                            $extra_data
-     */
-    public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array())
-    {
-        $this->_job_parameters = $job_parameters;
-        $this->_update_text = $update_text;
-        $this->_extra_data = (array) $extra_data;
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters
+	 * @param string                                           $update_text
+	 * @param array                                            $extra_data
+	 */
+	public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array())
+	{
+		$this->_job_parameters = $job_parameters;
+		$this->_update_text = $update_text;
+		$this->_extra_data = (array) $extra_data;
+	}
 
 
-    /**
-     * @return JobParameters
-     */
-    public function job_parameters()
-    {
-        return $this->_job_parameters;
-    }
+	/**
+	 * @return JobParameters
+	 */
+	public function job_parameters()
+	{
+		return $this->_job_parameters;
+	}
 
 
-    /**
-     * Gets the update_text of what happened in this job during the current step
-     *
-     * @return string
-     */
-    public function update_text()
-    {
-        return $this->_update_text;
-    }
+	/**
+	 * Gets the update_text of what happened in this job during the current step
+	 *
+	 * @return string
+	 */
+	public function update_text()
+	{
+		return $this->_update_text;
+	}
 
 
-    /**
-     * Returns any extra data we may want to include with this response
-     *
-     * @return array
-     */
-    public function extra_data()
-    {
-        return $this->_extra_data;
-    }
+	/**
+	 * Returns any extra data we may want to include with this response
+	 *
+	 * @return array
+	 */
+	public function extra_data()
+	{
+		return $this->_extra_data;
+	}
 
 
-    /**
-     * Converts this response into an array that can be easily serialized.
-     * This is most useful for serializing or json encoding
-     *
-     * @return array {
-     * @type string $status          , one of JobParameters::valid_stati()
-     * @type int    $units_processed count of units processed
-     * @type int    $job_size        total number of units TO process
-     * @type string $job_id          unique string identifying the job
-     * @type string $update_text     string describing what happened during this step
-     * } and any other items from $this->extra_data()
-     */
-    public function to_array()
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
-            array_merge(
-                $this->extra_data(),
-                array(
-                    'status'          => $this->job_parameters()->status(),
-                    'units_processed' => $this->job_parameters()->units_processed(),
-                    'job_size'        => $this->job_parameters()->job_size(),
-                    'job_id'          => $this->job_parameters()->job_id(),
-                    'update_text'     => $this->update_text(),
-                )
-            ),
-            $this
-        );
-    }
+	/**
+	 * Converts this response into an array that can be easily serialized.
+	 * This is most useful for serializing or json encoding
+	 *
+	 * @return array {
+	 * @type string $status          , one of JobParameters::valid_stati()
+	 * @type int    $units_processed count of units processed
+	 * @type int    $job_size        total number of units TO process
+	 * @type string $job_id          unique string identifying the job
+	 * @type string $update_text     string describing what happened during this step
+	 * } and any other items from $this->extra_data()
+	 */
+	public function to_array()
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
+			array_merge(
+				$this->extra_data(),
+				array(
+					'status'          => $this->job_parameters()->status(),
+					'units_processed' => $this->job_parameters()->units_processed(),
+					'job_size'        => $this->job_parameters()->job_size(),
+					'job_id'          => $this->job_parameters()->job_id(),
+					'update_text'     => $this->update_text(),
+				)
+			),
+			$this
+		);
+	}
 }

core/domain/entities/RegUrlLink.php

Spacing +2 added lines, -2 removed lines

@@ -72,7 +72,7 @@ 
         $base_code = '',
         $reg_url_link = ''
     ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
+        if ( ! empty($reg_url_link) && is_string($reg_url_link)) {
             $this->reg_url_link = apply_filters(
                 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
                 $reg_url_link,
@@ -94,7 +94,7 @@ 
         }
         $this->reg_url_link = (string) apply_filters(
             'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
+            $reg_count.'-'.md5($base_code.microtime()),
             $reg_count,
             $base_code,
             $reg_url_link

Indentation +83 added lines, -83 removed lines

@@ -17,97 +17,97 @@
  */
 class RegUrlLink
 {
-    /*
+	/*
      * @var string $reg_url_link
      */
-    private $reg_url_link;
+	private $reg_url_link;
 
 
-    /**
-     * @param string $reg_url_link
-     * @return RegUrlLink
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegUrlLinkString($reg_url_link)
-    {
-        if (empty($reg_url_link) || ! is_string($reg_url_link)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'You must supply a valid non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        return new RegUrlLink(1, '', $reg_url_link);
-    }
+	/**
+	 * @param string $reg_url_link
+	 * @return RegUrlLink
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegUrlLinkString($reg_url_link)
+	{
+		if (empty($reg_url_link) || ! is_string($reg_url_link)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'You must supply a valid non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		return new RegUrlLink(1, '', $reg_url_link);
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @return RegUrlLink
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegistration(EE_Registration $registration)
-    {
-        return new RegUrlLink(
-            $registration->count(),
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @return RegUrlLink
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegistration(EE_Registration $registration)
+	{
+		return new RegUrlLink(
+			$registration->count(),
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * CreateRegUrlLinkCommand constructor.
-     *
-     * @param int    $reg_count
-     * @param mixed  $base_code
-     * @param string $reg_url_link
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $reg_count = 1,
-        $base_code = '',
-        $reg_url_link = ''
-    ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
-            $this->reg_url_link = apply_filters(
-                'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-                $reg_url_link,
-                $reg_count,
-                $base_code,
-                $reg_url_link
-            );
-            return;
-        }
-        $reg_count = max(1, absint($reg_count));
-        $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
-        if (empty($base_code) || ! is_string($base_code)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->reg_url_link = (string) apply_filters(
-            'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
-            $reg_count,
-            $base_code,
-            $reg_url_link
-        );
-    }
+	/**
+	 * CreateRegUrlLinkCommand constructor.
+	 *
+	 * @param int    $reg_count
+	 * @param mixed  $base_code
+	 * @param string $reg_url_link
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$reg_count = 1,
+		$base_code = '',
+		$reg_url_link = ''
+	) {
+		if (! empty($reg_url_link) && is_string($reg_url_link)) {
+			$this->reg_url_link = apply_filters(
+				'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+				$reg_url_link,
+				$reg_count,
+				$base_code,
+				$reg_url_link
+			);
+			return;
+		}
+		$reg_count = max(1, absint($reg_count));
+		$base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
+		if (empty($base_code) || ! is_string($base_code)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->reg_url_link = (string) apply_filters(
+			'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+			$reg_count . '-' . md5($base_code . microtime()),
+			$reg_count,
+			$base_code,
+			$reg_url_link
+		);
+	}
 
 
-    /**
-     * Return the object as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->reg_url_link;
-    }
+	/**
+	 * Return the object as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->reg_url_link;
+	}
 }

core/domain/entities/GenericAddress.php

Indentation +201 added lines, -201 removed lines

@@ -12,205 +12,205 @@
  */
 class GenericAddress implements \EEI_Address
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    private $_address = '';
-
-    private $_address2 = '';
-
-    private $_city = '';
-
-    private $_state_ID = '';
-
-    private $_state_obj = '';
-
-    private $_zip = '';
-
-    private $_country_ID = '';
-
-    private $_country_obj = '';
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * @param string               $address
-     * @param string               $address2
-     * @param string               $city
-     * @param \EE_State | string   $state
-     * @param string               $zip
-     * @param \EE_Country | string $country
-     * @return GenericAddress
-     */
-    public function __construct($address, $address2, $city, $state, $zip, $country)
-    {
-        $this->_address = $address;
-        $this->_address2 = $address2;
-        $this->_city = $city;
-        if ($state instanceof \EE_State) {
-            $this->_state_obj = $state;
-        } else {
-            $this->_state_ID = $state;
-            $this->_state_obj = $this->_get_state_obj();
-        }
-        $this->_zip = $zip;
-        if ($country instanceof \EE_Country) {
-            $this->_country_obj = $country;
-        } else {
-            $this->_country_ID = $country;
-            $this->_country_obj = $this->_get_country_obj();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address()
-    {
-        return $this->_address;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->_address2;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function city()
-    {
-        return $this->_city;
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * @return \EE_State
-     */
-    private function _get_state_obj()
-    {
-        return $this->_state_obj instanceof \EE_State
-            ? $this->_state_obj
-            : \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_ID()
-    {
-        return $this->_state_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->abbrev()
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_State
-     */
-    public function state_obj()
-    {
-        return $this->_state_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_obj()->abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    private function _get_country_obj()
-    {
-        return $this->_country_obj instanceof \EE_Country
-            ? $this->_country_obj
-            : \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->_country_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name()
-    {
-        return $this->country_obj() instanceof \EE_Country
-            ? $this->country_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->_country_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->_zip;
-    }
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	private $_address = '';
+
+	private $_address2 = '';
+
+	private $_city = '';
+
+	private $_state_ID = '';
+
+	private $_state_obj = '';
+
+	private $_zip = '';
+
+	private $_country_ID = '';
+
+	private $_country_obj = '';
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * @param string               $address
+	 * @param string               $address2
+	 * @param string               $city
+	 * @param \EE_State | string   $state
+	 * @param string               $zip
+	 * @param \EE_Country | string $country
+	 * @return GenericAddress
+	 */
+	public function __construct($address, $address2, $city, $state, $zip, $country)
+	{
+		$this->_address = $address;
+		$this->_address2 = $address2;
+		$this->_city = $city;
+		if ($state instanceof \EE_State) {
+			$this->_state_obj = $state;
+		} else {
+			$this->_state_ID = $state;
+			$this->_state_obj = $this->_get_state_obj();
+		}
+		$this->_zip = $zip;
+		if ($country instanceof \EE_Country) {
+			$this->_country_obj = $country;
+		} else {
+			$this->_country_ID = $country;
+			$this->_country_obj = $this->_get_country_obj();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->_address;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->_address2;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->_city;
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * @return \EE_State
+	 */
+	private function _get_state_obj()
+	{
+		return $this->_state_obj instanceof \EE_State
+			? $this->_state_obj
+			: \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_ID()
+	{
+		return $this->_state_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->abbrev()
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->_state_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_obj()->abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	private function _get_country_obj()
+	{
+		return $this->_country_obj instanceof \EE_Country
+			? $this->_country_obj
+			: \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->_country_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name()
+	{
+		return $this->country_obj() instanceof \EE_Country
+			? $this->country_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->_country_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->_zip;
+	}
 }

core/domain/services/wp_queries/EventListQuery.php

Spacing +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
                 // set the property value
                 $this->{$property} = $value;
                 // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
+                unset($args[$property]);
             }
         }
         return $args;
@@ -188,7 +188,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;

Indentation +194 added lines, -194 removed lines

@@ -15,198 +15,198 @@
  */
 class EventListQuery extends WP_Query
 {
-    /**
-     * @var string $title
-     */
-    private $title;
-
-    /**
-     * @var integer $limit
-     */
-    private $limit = 10;
-
-    /**
-     * @var string $css_class
-     */
-    private $css_class;
-
-    /**
-     * @var boolean $show_expired
-     */
-    private $show_expired = false;
-
-    /**
-     * @var string $month
-     */
-    private $month;
-
-    /**
-     * @var string $category_slug
-     */
-    private $category_slug;
-
-    /**
-     * @var string $order_by
-     */
-    private $order_by;
-
-    /**
-     * @var string $sort
-     */
-    private $sort;
-
-    /**
-     * @var boolean $show_title
-     */
-    private $show_title = true;
-
-
-    /**
-     * EE_Event_List_Query Constructor     *
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        $args = $this->parseArgs((array) $args);
-        $this->setupEventQueryHelper();
-        $this->setupFilters();
-        $args = $this->getQueryArgs($args);
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * @param array $args
-     * @return array
-     */
-    private function parseArgs(array $args)
-    {
-        // incoming args could be a mix of WP query args + EE shortcode args
-        foreach ($args as $property => $value) {
-            // if the arg is a property of this class, then it's an EE shortcode arg
-            if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
-                // set the property value
-                $this->{$property} = $value;
-                // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
-            }
-        }
-        return $args;
-    }
-
-
-    private function setupEventQueryHelper()
-    {
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            $this->month,
-            $this->category_slug,
-            $this->show_expired,
-            $this->order_by,
-            $this->sort
-        );
-    }
-
-
-    private function setupFilters()
-    {
-        // first off, let's remove any filters from previous queries
-        remove_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        remove_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title')
-        );
-        remove_all_filters('FHEE__content_espresso_events__event_class');
-        // Event List Title ?
-        add_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        add_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title'),
-            10,
-            1
-        );
-        // add the css class
-        add_filter(
-            'FHEE__content_espresso_events__event_class',
-            array($this, 'event_list_css'),
-            10,
-            1
-        );
-    }
-
-
-    private function getQueryArgs(array $args)
-    {
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        return array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $this->limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $this->limit,
-            )
-        );
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * show_event_list_title
-     *
-     * @return boolean
-     */
-    public function show_event_list_title()
-    {
-        return filter_var(
-            $this->show_title,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
-     *
-     * @param string $event_list_title
-     * @return    string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * callback for FHEE__content_espresso_events__event_class filter
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
-        return $event_list_css;
-    }
-    // phpcs:enable
+	/**
+	 * @var string $title
+	 */
+	private $title;
+
+	/**
+	 * @var integer $limit
+	 */
+	private $limit = 10;
+
+	/**
+	 * @var string $css_class
+	 */
+	private $css_class;
+
+	/**
+	 * @var boolean $show_expired
+	 */
+	private $show_expired = false;
+
+	/**
+	 * @var string $month
+	 */
+	private $month;
+
+	/**
+	 * @var string $category_slug
+	 */
+	private $category_slug;
+
+	/**
+	 * @var string $order_by
+	 */
+	private $order_by;
+
+	/**
+	 * @var string $sort
+	 */
+	private $sort;
+
+	/**
+	 * @var boolean $show_title
+	 */
+	private $show_title = true;
+
+
+	/**
+	 * EE_Event_List_Query Constructor     *
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		$args = $this->parseArgs((array) $args);
+		$this->setupEventQueryHelper();
+		$this->setupFilters();
+		$args = $this->getQueryArgs($args);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * @param array $args
+	 * @return array
+	 */
+	private function parseArgs(array $args)
+	{
+		// incoming args could be a mix of WP query args + EE shortcode args
+		foreach ($args as $property => $value) {
+			// if the arg is a property of this class, then it's an EE shortcode arg
+			if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
+				// set the property value
+				$this->{$property} = $value;
+				// then remove it from the array of args that will later be passed to WP_Query()
+				unset($args[ $property ]);
+			}
+		}
+		return $args;
+	}
+
+
+	private function setupEventQueryHelper()
+	{
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			$this->month,
+			$this->category_slug,
+			$this->show_expired,
+			$this->order_by,
+			$this->sort
+		);
+	}
+
+
+	private function setupFilters()
+	{
+		// first off, let's remove any filters from previous queries
+		remove_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		remove_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title')
+		);
+		remove_all_filters('FHEE__content_espresso_events__event_class');
+		// Event List Title ?
+		add_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		add_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title'),
+			10,
+			1
+		);
+		// add the css class
+		add_filter(
+			'FHEE__content_espresso_events__event_class',
+			array($this, 'event_list_css'),
+			10,
+			1
+		);
+	}
+
+
+	private function getQueryArgs(array $args)
+	{
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		return array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $this->limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $this->limit,
+			)
+		);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * show_event_list_title
+	 *
+	 * @return boolean
+	 */
+	public function show_event_list_title()
+	{
+		return filter_var(
+			$this->show_title,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
+	 *
+	 * @param string $event_list_title
+	 * @return    string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * callback for FHEE__content_espresso_events__event_class filter
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
+		return $event_list_css;
+	}
+	// phpcs:enable
 }

core/domain/services/registration/CreateRegistrationService.php

Spacing +2 added lines, -2 removed lines

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

Indentation +94 added lines, -94 removed lines

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

core/domain/services/registration/CopyRegistrationService.php

Spacing +5 added lines, -5 removed lines

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

Indentation +142 added lines, -142 removed lines

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

acceptance_tests/Helpers/MessagesAdmin.php

Indentation +290 added lines, -290 removed lines

@@ -10,294 +10,294 @@
  */
 trait MessagesAdmin
 {
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnMessagesActivityListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
-    }
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * Directs to message settings page
-     */
-    public function amOnMessageSettingsPage()
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
-    }
-
-
-    public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
-    {
-        $this->actor()->dragAndDrop(
-            MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
-            MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
-        );
-    }
-
-
-    /**
-     * Assumes you are already on the list table page that has the ui for editing the template.
-     * @param string $message_type_slug
-     * @param string $context [optional] if you want to click directly to the given context in the editor
-     */
-    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
-    {
-        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
-    }
-
-
-    /**
-     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
-     * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
-     *
-     * @param int    $expected_occurence_count
-     * @param string $text_to_check_for
-     * @param string $field
-     * @param string $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     */
-    public function verifyMatchingCountofTextInMessageActivityListTableFor(
-        $expected_occurence_count,
-        $text_to_check_for,
-        $field,
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin'
-    ) {
-        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
-            $field,
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $text_to_check_for,
-            0
-        ));
-        $actual_count = count($elements);
-        $this->actor()->assertEquals(
-            $expected_occurence_count,
-            $actual_count,
-            sprintf(
-                'Expected %s of the %s text for the %s field but there were actually %s counted.',
-                $expected_occurence_count,
-                $text_to_check_for,
-                $field,
-                $actual_count
-            )
-        );
-    }
-
-
-    /**
-     * This will create a custom message template for the given messenger and message type from the context of the
-     * default (global) message template list table.
-     * Also takes care of verifying the template was created.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     */
-    public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
-    {
-        $this->amOnDefaultMessageTemplateListTablePage();
-        $this->actor()->click(
-            MessagesPage::createCustomButtonForMessageTypeAndMessenger(
-                $message_type_label,
-                $messenger_label
-            )
-        );
-        $this->actor()->seeInField('#title', 'New Custom Template');
-    }
-
-
-    /**
-     * This switches the context of the current messages template to the given reference.
-     * @param string $context_reference  This should be the visible label for the option.
-     */
-    public function switchContextTo($context_reference)
-    {
-        $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
-        $this->actor()->waitForText($context_reference, 10, 'h1');
-    }
-
-
-    /**
-     * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
-     * toggling.
-     *
-     * @param string $context_string           What context is being switched (used for the expected state text)
-     * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
-     *                                         (false)
-     */
-    public function toggleContextState($context_string, $expected_state_is_active = true)
-    {
-        $this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
-        if ($expected_state_is_active) {
-            $this->actor()->waitForText("The template for $context_string is currently active.");
-        } else {
-            $this->actor()->waitForText("The template for $context_string is currently inactive");
-        }
-    }
-
-
-    /**
-     * Triggers saving the message template.
-     * @param bool $and_close   Use to indicate to click the Save and Close button.
-     */
-    public function saveMessageTemplate($and_close = false)
-    {
-        $this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
-        if ($and_close) {
-            $this->actor()->click('Save and Close');
-        } else {
-            $this->actor()->click('Save');
-        }
-        $this->actor()->waitForText('successfully updated');
-    }
-
-
-    /**
-     * This takes care of clicking the View Message icon for the given parameters.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function viewMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        ));
-    }
-
-
-    /**
-     * Takes care of deleting a message matching the given parameters via the message activity list table.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function deleteMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        );
-        $cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $this->actor()->scrollTo($cell_selector, 0, -30);
-        $this->actor()->moveMouseOver(
-            $cell_selector,
-            5,
-            5
-        );
-        $this->actor()->waitForElementVisible(
-            $delete_action_selector
-        );
-        $this->actor()->click(
-            $delete_action_selector
-        );
-        $this->actor()->waitForText('successfully deleted', 20);
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is in that window.
-     * @param string $text_to_view
-     */
-    public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
-        $this->actor()->switchToIframe();
-    }
-
-
-    /**
-     * This returns the value for the link at the given selector in the message modal.
-     * @param string $selector (any selector string accepted by WebDriver)
-     */
-    public function observeLinkAtSelectorInMessageModal($selector)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $link = $this->actor()->observeLinkUrlAt($selector);
-        $this->actor()->switchToIframe();
-        return $link;
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is NOT that window.
-     * @param string $text_to_view
-     */
-    public function dontSeeTextInViewMessageModal($text_to_view)
-    {
-        $this->seeTextInViewMessageModal($text_to_view, true);
-    }
-
-
-    public function dismissMessageModal()
-    {
-        $this->actor()->executeJs('window.dialogHelper.closeModal()');
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnMessagesActivityListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
+	}
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnCustomMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * Directs to message settings page
+	 */
+	public function amOnMessageSettingsPage()
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
+	}
+
+
+	public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
+	{
+		$this->actor()->dragAndDrop(
+			MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
+			MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
+		);
+	}
+
+
+	/**
+	 * Assumes you are already on the list table page that has the ui for editing the template.
+	 * @param string $message_type_slug
+	 * @param string $context [optional] if you want to click directly to the given context in the editor
+	 */
+	public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
+	{
+		$this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
+	}
+
+
+	/**
+	 * Use this action to verify that the count for the given text in the specified field is as expected.  For example
+	 * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
+	 *
+	 * @param int    $expected_occurence_count
+	 * @param string $text_to_check_for
+	 * @param string $field
+	 * @param string $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 */
+	public function verifyMatchingCountofTextInMessageActivityListTableFor(
+		$expected_occurence_count,
+		$text_to_check_for,
+		$field,
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin'
+	) {
+		$elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
+			$field,
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$text_to_check_for,
+			0
+		));
+		$actual_count = count($elements);
+		$this->actor()->assertEquals(
+			$expected_occurence_count,
+			$actual_count,
+			sprintf(
+				'Expected %s of the %s text for the %s field but there were actually %s counted.',
+				$expected_occurence_count,
+				$text_to_check_for,
+				$field,
+				$actual_count
+			)
+		);
+	}
+
+
+	/**
+	 * This will create a custom message template for the given messenger and message type from the context of the
+	 * default (global) message template list table.
+	 * Also takes care of verifying the template was created.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 */
+	public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
+	{
+		$this->amOnDefaultMessageTemplateListTablePage();
+		$this->actor()->click(
+			MessagesPage::createCustomButtonForMessageTypeAndMessenger(
+				$message_type_label,
+				$messenger_label
+			)
+		);
+		$this->actor()->seeInField('#title', 'New Custom Template');
+	}
+
+
+	/**
+	 * This switches the context of the current messages template to the given reference.
+	 * @param string $context_reference  This should be the visible label for the option.
+	 */
+	public function switchContextTo($context_reference)
+	{
+		$this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
+		$this->actor()->waitForText($context_reference, 10, 'h1');
+	}
+
+
+	/**
+	 * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
+	 * toggling.
+	 *
+	 * @param string $context_string           What context is being switched (used for the expected state text)
+	 * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
+	 *                                         (false)
+	 */
+	public function toggleContextState($context_string, $expected_state_is_active = true)
+	{
+		$this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
+		if ($expected_state_is_active) {
+			$this->actor()->waitForText("The template for $context_string is currently active.");
+		} else {
+			$this->actor()->waitForText("The template for $context_string is currently inactive");
+		}
+	}
+
+
+	/**
+	 * Triggers saving the message template.
+	 * @param bool $and_close   Use to indicate to click the Save and Close button.
+	 */
+	public function saveMessageTemplate($and_close = false)
+	{
+		$this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
+		if ($and_close) {
+			$this->actor()->click('Save and Close');
+		} else {
+			$this->actor()->click('Save');
+		}
+		$this->actor()->waitForText('successfully updated');
+	}
+
+
+	/**
+	 * This takes care of clicking the View Message icon for the given parameters.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function viewMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		));
+	}
+
+
+	/**
+	 * Takes care of deleting a message matching the given parameters via the message activity list table.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function deleteMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		);
+		$cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$this->actor()->scrollTo($cell_selector, 0, -30);
+		$this->actor()->moveMouseOver(
+			$cell_selector,
+			5,
+			5
+		);
+		$this->actor()->waitForElementVisible(
+			$delete_action_selector
+		);
+		$this->actor()->click(
+			$delete_action_selector
+		);
+		$this->actor()->waitForText('successfully deleted', 20);
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is in that window.
+	 * @param string $text_to_view
+	 */
+	public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
+		$this->actor()->switchToIframe();
+	}
+
+
+	/**
+	 * This returns the value for the link at the given selector in the message modal.
+	 * @param string $selector (any selector string accepted by WebDriver)
+	 */
+	public function observeLinkAtSelectorInMessageModal($selector)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$link = $this->actor()->observeLinkUrlAt($selector);
+		$this->actor()->switchToIframe();
+		return $link;
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is NOT that window.
+	 * @param string $text_to_view
+	 */
+	public function dontSeeTextInViewMessageModal($text_to_view)
+	{
+		$this->seeTextInViewMessageModal($text_to_view, true);
+	}
+
+
+	public function dismissMessageModal()
+	{
+		$this->actor()->executeJs('window.dialogHelper.closeModal()');
+	}
 }