eventespresso / event-espresso-core

core/libraries/rest_api/controllers/config/Read.php

Indentation +77 added lines, -77 removed lines

@@ -20,85 +20,85 @@
 class Read
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return EE_Config|WP_Error
-     */
-    public static function handleRequest(WP_REST_Request $request, $version)
-    {
-        $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
-            return EE_Config::instance();
-        } else {
-            return new WP_Error(
-                'cannot_read_config',
-                sprintf(
-                    __(
-                        'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
-                        'event_espresso'
-                    ),
-                    $cap
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return EE_Config|WP_Error
+	 */
+	public static function handleRequest(WP_REST_Request $request, $version)
+	{
+		$cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
+			return EE_Config::instance();
+		} else {
+			return new WP_Error(
+				'cannot_read_config',
+				sprintf(
+					__(
+						'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
+						'event_espresso'
+					),
+					$cap
+				),
+				array('status' => 403)
+			);
+		}
+	}
 
 
-    /**
-     * Handles the request for public site info
-     *
-     * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
-     *                                                           current user could be authenticated using basic auth
-     *                                                           data
-     * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
-     *                                                           basic auth data was somehow received
-     * @param WP_REST_Request  $request
-     * @param string           $version
-     * @return array|WP_Error
-     */
-    public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
-    {
-        global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
-        $insecure_usage_of_basic_auth = apply_filters(
-        // @codingStandardsIgnoreStart
-            'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
-            // @codingStandardsIgnoreEnd
-            $wp_json_basic_auth_success && ! is_ssl(),
-            $request
-        );
-        if ($insecure_usage_of_basic_auth) {
-            $warning = sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
-                '</a>'
-            );
-        } else {
-            $warning = '';
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
-            array(
-                'default_timezone' => array(
-                    'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
-                    'string' => get_option('timezone_string'),
-                    'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-                ),
-                'default_currency' => EE_Config::instance()->currency,
-                'authentication'   => array(
-                    'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
-                    'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
-                    'warning'                      => $warning,
-                ),
-            )
-        );
-    }
+	/**
+	 * Handles the request for public site info
+	 *
+	 * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
+	 *                                                           current user could be authenticated using basic auth
+	 *                                                           data
+	 * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
+	 *                                                           basic auth data was somehow received
+	 * @param WP_REST_Request  $request
+	 * @param string           $version
+	 * @return array|WP_Error
+	 */
+	public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
+	{
+		global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
+		$insecure_usage_of_basic_auth = apply_filters(
+		// @codingStandardsIgnoreStart
+			'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
+			// @codingStandardsIgnoreEnd
+			$wp_json_basic_auth_success && ! is_ssl(),
+			$request
+		);
+		if ($insecure_usage_of_basic_auth) {
+			$warning = sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
+				'</a>'
+			);
+		} else {
+			$warning = '';
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
+			array(
+				'default_timezone' => array(
+					'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
+					'string' => get_option('timezone_string'),
+					'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+				),
+				'default_currency' => EE_Config::instance()->currency,
+				'authentication'   => array(
+					'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
+					'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
+					'warning'                      => $warning,
+				),
+			)
+		);
+	}
 }
 
 // End of file Read.php

core/libraries/rest_api/controllers/model/Meta.php

Indentation +109 added lines, -109 removed lines

@@ -23,122 +23,122 @@
 {
 
 
-    /**
-     * @param \WP_REST_Request $request
-     * @param string           $version
-     * @return array|\WP_REST_Response
-     */
-    public static function handleRequestModelsMeta(\WP_REST_Request $request, $version)
-    {
-        $controller = new Meta();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse($controller->getModelsMetadataEntity());
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * @param \WP_REST_Request $request
+	 * @param string           $version
+	 * @return array|\WP_REST_Response
+	 */
+	public static function handleRequestModelsMeta(\WP_REST_Request $request, $version)
+	{
+		$controller = new Meta();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse($controller->getModelsMetadataEntity());
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /*
+	/*
      * Gets the model metadata resource entity
      * @return array for JSON response, describing all the models available in teh requested version
      */
-    protected function getModelsMetadataEntity()
-    {
-        $response = array();
-        foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
-            $model = $this->getModelVersionInfo()->loadModel($model_name);
-            $fields_json = array();
-            foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
-                if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) {
-                    continue;
-                }
-                if ($field_obj instanceof EE_Boolean_Field) {
-                    $datatype = 'Boolean';
-                } elseif ($field_obj->get_wpdb_data_type() == '%d') {
-                    $datatype = 'Number';
-                } elseif ($field_name instanceof EE_Serialized_Text_Field) {
-                    $datatype = 'Object';
-                } else {
-                    $datatype = 'String';
-                }
-                $default_value = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-                $field_json = array(
-                    'name'                => $field_name,
-                    'nicename'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
-                    'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
-                    'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj),
-                    'type'                => str_replace('EE_', '', get_class($field_obj)),
-                    'datatype'            => $datatype,
-                    'nullable'            => $field_obj->is_nullable(),
-                    'default'             => $default_value,
-                    'table_alias'         => $field_obj->get_table_alias(),
-                    'table_column'        => $field_obj->get_table_column(),
-                );
-                $fields_json[ $field_json['name'] ] = $field_json;
-            }
-            $fields_json = array_merge(
-                $fields_json,
-                $this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
-            );
-            $response[ $model_name ]['fields'] = apply_filters(
-                'FHEE__Meta__handle_request_models_meta__fields',
-                $fields_json,
-                $model
-            );
-            $relations_json = array();
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-                $relation_json = array(
-                    'name'   => $relation_name,
-                    'type'   => str_replace('EE_', '', get_class($relation_obj)),
-                    'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
-                );
-                $relations_json[ $relation_name ] = $relation_json;
-            }
-            $response[ $model_name ]['relations'] = apply_filters(
-                'FHEE__Meta__handle_request_models_meta__relations',
-                $relations_json,
-                $model
-            );
-        }
-        return $response;
-    }
+	protected function getModelsMetadataEntity()
+	{
+		$response = array();
+		foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
+			$model = $this->getModelVersionInfo()->loadModel($model_name);
+			$fields_json = array();
+			foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
+				if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) {
+					continue;
+				}
+				if ($field_obj instanceof EE_Boolean_Field) {
+					$datatype = 'Boolean';
+				} elseif ($field_obj->get_wpdb_data_type() == '%d') {
+					$datatype = 'Number';
+				} elseif ($field_name instanceof EE_Serialized_Text_Field) {
+					$datatype = 'Object';
+				} else {
+					$datatype = 'String';
+				}
+				$default_value = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+				$field_json = array(
+					'name'                => $field_name,
+					'nicename'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
+					'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
+					'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj),
+					'type'                => str_replace('EE_', '', get_class($field_obj)),
+					'datatype'            => $datatype,
+					'nullable'            => $field_obj->is_nullable(),
+					'default'             => $default_value,
+					'table_alias'         => $field_obj->get_table_alias(),
+					'table_column'        => $field_obj->get_table_column(),
+				);
+				$fields_json[ $field_json['name'] ] = $field_json;
+			}
+			$fields_json = array_merge(
+				$fields_json,
+				$this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
+			);
+			$response[ $model_name ]['fields'] = apply_filters(
+				'FHEE__Meta__handle_request_models_meta__fields',
+				$fields_json,
+				$model
+			);
+			$relations_json = array();
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+				$relation_json = array(
+					'name'   => $relation_name,
+					'type'   => str_replace('EE_', '', get_class($relation_obj)),
+					'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
+				);
+				$relations_json[ $relation_name ] = $relation_json;
+			}
+			$response[ $model_name ]['relations'] = apply_filters(
+				'FHEE__Meta__handle_request_models_meta__relations',
+				$relations_json,
+				$model
+			);
+		}
+		return $response;
+	}
 
 
-    /**
-     * Adds EE metadata to the index
-     *
-     * @param \WP_REST_Response $rest_response_obj
-     * @return \WP_REST_Response
-     */
-    public static function filterEeMetadataIntoIndex(\WP_REST_Response $rest_response_obj)
-    {
-        $response_data = $rest_response_obj->get_data();
-        $addons = array();
-        foreach (EE_Registry::instance()->addons as $addon) {
-            $addon_json = array(
-                'name'    => $addon->name(),
-                'version' => $addon->version(),
-            );
-            $addons[ $addon_json['name'] ] = $addon_json;
-        }
-        $response_data['ee'] = array(
-            'version'              => EEM_System_Status::instance()->get_ee_version(),
-            // @codingStandardsIgnoreStart
-            'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
-            // @codingStandardsIgnoreEnd
-            'addons'               => $addons,
-            'maintenance_mode'     => EE_Maintenance_Mode::instance()->real_level(),
-            'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()),
-        );
-        $rest_response_obj->set_data($response_data);
-        return $rest_response_obj;
-    }
+	/**
+	 * Adds EE metadata to the index
+	 *
+	 * @param \WP_REST_Response $rest_response_obj
+	 * @return \WP_REST_Response
+	 */
+	public static function filterEeMetadataIntoIndex(\WP_REST_Response $rest_response_obj)
+	{
+		$response_data = $rest_response_obj->get_data();
+		$addons = array();
+		foreach (EE_Registry::instance()->addons as $addon) {
+			$addon_json = array(
+				'name'    => $addon->name(),
+				'version' => $addon->version(),
+			);
+			$addons[ $addon_json['name'] ] = $addon_json;
+		}
+		$response_data['ee'] = array(
+			'version'              => EEM_System_Status::instance()->get_ee_version(),
+			// @codingStandardsIgnoreStart
+			'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
+			// @codingStandardsIgnoreEnd
+			'addons'               => $addons,
+			'maintenance_mode'     => EE_Maintenance_Mode::instance()->real_level(),
+			'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()),
+		);
+		$rest_response_obj->set_data($response_data);
+		return $rest_response_obj;
+	}
 }
 
 

Spacing +5 added lines, -5 removed lines

@@ -80,13 +80,13 @@ 
                     'table_alias'         => $field_obj->get_table_alias(),
                     'table_column'        => $field_obj->get_table_column(),
                 );
-                $fields_json[ $field_json['name'] ] = $field_json;
+                $fields_json[$field_json['name']] = $field_json;
             }
             $fields_json = array_merge(
                 $fields_json,
                 $this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
             );
-            $response[ $model_name ]['fields'] = apply_filters(
+            $response[$model_name]['fields'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__fields',
                 $fields_json,
                 $model
@@ -98,9 +98,9 @@ 
                     'type'   => str_replace('EE_', '', get_class($relation_obj)),
                     'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
                 );
-                $relations_json[ $relation_name ] = $relation_json;
+                $relations_json[$relation_name] = $relation_json;
             }
-            $response[ $model_name ]['relations'] = apply_filters(
+            $response[$model_name]['relations'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__relations',
                 $relations_json,
                 $model
@@ -125,7 +125,7 @@ 
                 'name'    => $addon->name(),
                 'version' => $addon->version(),
             );
-            $addons[ $addon_json['name'] ] = $addon_json;
+            $addons[$addon_json['name']] = $addon_json;
         }
         $response_data['ee'] = array(
             'version'              => EEM_System_Status::instance()->get_ee_version(),

core/libraries/rest_api/changes/ChangesInBase.php

Indentation +64 added lines, -64 removed lines

@@ -35,74 +35,74 @@
 abstract class ChangesInBase
 {
 
-    /**
-     * The version that these changes happened
-     *
-     * @var string
-     */
-    protected $version = null;
+	/**
+	 * The version that these changes happened
+	 *
+	 * @var string
+	 */
+	protected $version = null;
 
 
-    /**
-     * Called when an EE4 REST API request is made to an earlier version than
-     * what is indicated in this class' name.
-     * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
-     * so that regardless of what version of EE4 core is running, API clients
-     * will have a consistent response
-     *
-     * @return void
-     */
-    abstract public function setHooks();
+	/**
+	 * Called when an EE4 REST API request is made to an earlier version than
+	 * what is indicated in this class' name.
+	 * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
+	 * so that regardless of what version of EE4 core is running, API clients
+	 * will have a consistent response
+	 *
+	 * @return void
+	 */
+	abstract public function setHooks();
 
 
-    /**
-     * Returns whether or not this class' name indicates its hooks should
-     * apply when a request comes in for $requested_version. A class can use
-     * other conditions when determining whether to perform their callbacks or not,
-     * but this will typically be enough
-     *
-     * @param string $requested_version eg "4.8.33"
-     * @return boolean true: this class' name indicates its filters and actions
-     *                                  should take effect. False: this class' name indicates it shouldn't do anything
-     */
-    public function appliesToVersion($requested_version)
-    {
-        if ($this->version() > $requested_version) {
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * Returns whether or not this class' name indicates its hooks should
+	 * apply when a request comes in for $requested_version. A class can use
+	 * other conditions when determining whether to perform their callbacks or not,
+	 * but this will typically be enough
+	 *
+	 * @param string $requested_version eg "4.8.33"
+	 * @return boolean true: this class' name indicates its filters and actions
+	 *                                  should take effect. False: this class' name indicates it shouldn't do anything
+	 */
+	public function appliesToVersion($requested_version)
+	{
+		if ($this->version() > $requested_version) {
+			return true;
+		}
+		return false;
+	}
 
 
-    /**
-     * Gets the EE core version when this changes were made to the rest api.
-     * Any requests to earlier versions should have modifications made to them
-     * by the callbacks of this class.
-     *
-     * @return string eg "4.8.33"
-     * @throws EE_Error
-     */
-    public function version()
-    {
-        if ($this->version === null) {
-            $matches = array();
-            $regex = '~ChangesIn(\d)(\d\d)(\d\d)$~';
-            $success = preg_match(
-                $regex,
-                get_class($this),
-                $matches
-            );
-            if (! $success) {
-                throw new EE_Error(
-                    sprintf(
-                        __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
-                        get_class($this),
-                        $regex
-                    )
-                );
-            }
-            $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
-        }
-        return $this->version;
-    }
+	/**
+	 * Gets the EE core version when this changes were made to the rest api.
+	 * Any requests to earlier versions should have modifications made to them
+	 * by the callbacks of this class.
+	 *
+	 * @return string eg "4.8.33"
+	 * @throws EE_Error
+	 */
+	public function version()
+	{
+		if ($this->version === null) {
+			$matches = array();
+			$regex = '~ChangesIn(\d)(\d\d)(\d\d)$~';
+			$success = preg_match(
+				$regex,
+				get_class($this),
+				$matches
+			);
+			if (! $success) {
+				throw new EE_Error(
+					sprintf(
+						__('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
+						get_class($this),
+						$regex
+					)
+				);
+			}
+			$this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
+		}
+		return $this->version;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -92,7 +92,7 @@ 
                 get_class($this),
                 $matches
             );
-            if (! $success) {
+            if ( ! $success) {
                 throw new EE_Error(
                     sprintf(
                         __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
@@ -101,7 +101,7 @@ 
                     )
                 );
             }
-            $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
+            $this->version = (int) $matches[1].'.'.(int) $matches[2].'.'.(int) $matches[3];
         }
         return $this->version;
     }

core/libraries/rest_api/changes/ChangesIn40836.php

Indentation +160 added lines, -160 removed lines

@@ -14,174 +14,174 @@
 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;
+	}
 }

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;

core/libraries/rest_api/ModelVersionInfo.php

Spacing +12 added lines, -12 removed lines

@@ -114,10 +114,10 @@ 
         foreach ($this->resource_changes as $version => $model_classnames) {
             foreach ($model_classnames as $model_classname => $extra_fields) {
                 foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+                    $this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+                        if ( ! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+                            $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
                 }
@@ -139,7 +139,7 @@ 
             $model_changes = array();
             foreach ($this->modelChanges() as $version => $models_changed_in_version) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
+                    $model_changes[$version] = $models_changed_in_version;
                 }
             }
             $this->cached_model_changes_between_requested_version_and_current = $model_changes;
@@ -161,7 +161,7 @@ 
             $resource_changes = array();
             foreach ($this->resourceChanges() as $version => $model_classnames) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
+                    $resource_changes[$version] = $model_classnames;
                 }
             }
             $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
@@ -212,7 +212,7 @@ 
             foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
                 foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
                     if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
+                        unset($all_models_in_current_version[$model_name]);
                     }
                 }
             }
@@ -237,7 +237,7 @@ 
     public function isModelNameInThisVersion($model_name)
     {
         $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
+        if (isset($model_names[$model_name])) {
             return true;
         } else {
             return false;
@@ -280,19 +280,19 @@ 
      */
     public function fieldsOnModelInThisVersion($model)
     {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+        if ( ! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
             // get all model changes between the requested version and current core version
             $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
             // fetch all fields currently on this model
             $current_fields = $model->field_settings();
             // remove all fields that have been added since
             foreach ($changes as $version => $changes_in_version) {
-                if (isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+                if (isset($changes_in_version[$model->get_this_model_name()])
+                    && $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
                 ) {
                     $current_fields = array_diff_key(
                         $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
+                        array_flip($changes_in_version[$model->get_this_model_name()])
                     );
                 }
             }
@@ -447,7 +447,7 @@ 
         $relations = array();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
+                $relations[$relation_name] = $relation_obj;
             }
         }
         // filter the results, but use the old filter name

Indentation +436 added lines, -436 removed lines

@@ -21,440 +21,440 @@
 class ModelVersionInfo
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const MODEL_ADDED = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $cached_fields_on_models = array();
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->requested_version = (string) $requested_version;
-        $this->model_changes = array(
-            '4.8.29' => array(
-                // first version where the REST API is in EE core, so no need
-                // to specify how its different from the previous
-            ),
-        );
-        // setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function modelChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->modelChanges() as $version => $models_changed_in_version) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
-                }
-            }
-            $this->cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->cached_model_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resourceChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resourceChanges() as $version => $model_classnames) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
-                }
-            }
-            $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requestedVersion()
-    {
-        return $this->requested_version;
-    }
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function modelChanges()
-    {
-        return $this->model_changes;
-    }
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function modelsForRequestedVersion()
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
-                    }
-                }
-            }
-            $this->cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->cached_models_for_requested_version;
-    }
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function isModelNameInThisVersion($model_name)
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function loadModel($model_name)
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requestedVersion()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fieldsOnModelInThisVersion($model)
-    {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
-            // get all model changes between the requested version and current core version
-            $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
-            // fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            // remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
-                    );
-                }
-            }
-            $this->cached_fields_on_models = $current_fields;
-        }
-        return $this->cached_fields_on_models;
-    }
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array()
-        );
-    }
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldIsIgnored($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHaveRenderedFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasRenderedFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHavePrettyFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasPrettyFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
-    }
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resourceChanges()
-    {
-        return $this->resource_changes;
-    }
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extraResourcePropertiesForModel($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relationSettings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
-            }
-        }
-        // filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const MODEL_ADDED = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $cached_fields_on_models = array();
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->requested_version = (string) $requested_version;
+		$this->model_changes = array(
+			'4.8.29' => array(
+				// first version where the REST API is in EE core, so no need
+				// to specify how its different from the previous
+			),
+		);
+		// setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
+							$this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function modelChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->modelChanges() as $version => $models_changed_in_version) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$model_changes[ $version ] = $models_changed_in_version;
+				}
+			}
+			$this->cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->cached_model_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resourceChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resourceChanges() as $version => $model_classnames) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$resource_changes[ $version ] = $model_classnames;
+				}
+			}
+			$this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requestedVersion()
+	{
+		return $this->requested_version;
+	}
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function modelChanges()
+	{
+		return $this->model_changes;
+	}
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function modelsForRequestedVersion()
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
+						unset($all_models_in_current_version[ $model_name ]);
+					}
+				}
+			}
+			$this->cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->cached_models_for_requested_version;
+	}
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function isModelNameInThisVersion($model_name)
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		if (isset($model_names[ $model_name ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function loadModel($model_name)
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requestedVersion()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fieldsOnModelInThisVersion($model)
+	{
+		if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+			// get all model changes between the requested version and current core version
+			$changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
+			// fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			// remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (isset($changes_in_version[ $model->get_this_model_name() ])
+					&& $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[ $model->get_this_model_name() ])
+					);
+				}
+			}
+			$this->cached_fields_on_models = $current_fields;
+		}
+		return $this->cached_fields_on_models;
+	}
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array()
+		);
+	}
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldIsIgnored($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHaveRenderedFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasRenderedFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHavePrettyFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasPrettyFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
+	}
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resourceChanges()
+	{
+		return $this->resource_changes;
+	}
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extraResourcePropertiesForModel($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relationSettings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->isModelNameInThisVersion($relation_name)) {
+				$relations[ $relation_name ] = $relation_obj;
+			}
+		}
+		// filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }

core/libraries/batch/JobHandlers/AttendeesReport.php

Indentation +96 added lines, -96 removed lines

@@ -19,106 +19,106 @@
 class AttendeesReport extends JobHandlerFile
 {
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function create_job(JobParameters $job_parameters)
-    {
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
-            throw new BatchRequestException(
-                __('You do not have permission to view contacts', 'event_espresso')
-            );
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            __('contact-list-report.csv', 'event_espresso')
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        $job_parameters->set_job_size($this->count_units_to_process());
-        // we should also set the header columns
-        $csv_data_for_row = $this->get_csv_data(0, 1);
-        \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
-        // if we actually processed a row there, record it
-        if ($job_parameters->job_size()) {
-            $job_parameters->mark_processed(1);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            __('Contacts report started successfully...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function create_job(JobParameters $job_parameters)
+	{
+		if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
+			throw new BatchRequestException(
+				__('You do not have permission to view contacts', 'event_espresso')
+			);
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			__('contact-list-report.csv', 'event_espresso')
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		$job_parameters->set_job_size($this->count_units_to_process());
+		// we should also set the header columns
+		$csv_data_for_row = $this->get_csv_data(0, 1);
+		\EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
+		// if we actually processed a row there, record it
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			__('Contacts report started successfully...', 'event_espresso')
+		);
+	}
 
 
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        $csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size);
-        \EEH_Export::write_data_array_to_csv(
-            $job_parameters->extra_datum('filepath'),
-            $csv_data,
-            false
-        );
-        $units_processed = count($csv_data);
-        $job_parameters->mark_processed($units_processed);
-        $extra_response_data = array(
-            'file_url' => '',
-        );
-        if ($units_processed < $batch_size) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                __('Wrote %1$s rows to report CSV file...', 'event_espresso'),
-                count($csv_data)
-            ),
-            $extra_response_data
-        );
-    }
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		$csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size);
+		\EEH_Export::write_data_array_to_csv(
+			$job_parameters->extra_datum('filepath'),
+			$csv_data,
+			false
+		);
+		$units_processed = count($csv_data);
+		$job_parameters->mark_processed($units_processed);
+		$extra_response_data = array(
+			'file_url' => '',
+		);
+		if ($units_processed < $batch_size) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
+				count($csv_data)
+			),
+			$extra_response_data
+		);
+	}
 
 
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->_file_helper->delete(
-            \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
-    }
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->_file_helper->delete(
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
+	}
 
-    public function count_units_to_process()
-    {
-        return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
-    }
+	public function count_units_to_process()
+	{
+		return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
+	}
 
-    public function get_csv_data($offset, $limit)
-    {
-        $attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results(
-            array(
-                'limit'      => array($offset, $limit),
-                'force_join' => array('State', 'Country'),
-                'caps'       => \EEM_Base::caps_read_admin,
-            )
-        );
-        $csv_data = array();
-        foreach ($attendee_rows as $attendee_row) {
-            $csv_row = array();
-            foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
-                if ($field_name == 'STA_ID') {
-                    $state_name_field = \EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ];
-                } elseif ($field_name == 'CNT_ISO') {
-                    $country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ];
-                } else {
-                    $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
-                }
-            }
-            $csv_data[] = apply_filters(
-                'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row',
-                $csv_row,
-                $attendee_row
-            );
-        }
-        return $csv_data;
-    }
+	public function get_csv_data($offset, $limit)
+	{
+		$attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results(
+			array(
+				'limit'      => array($offset, $limit),
+				'force_join' => array('State', 'Country'),
+				'caps'       => \EEM_Base::caps_read_admin,
+			)
+		);
+		$csv_data = array();
+		foreach ($attendee_rows as $attendee_row) {
+			$csv_row = array();
+			foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
+				if ($field_name == 'STA_ID') {
+					$state_name_field = \EEM_State::instance()->field_settings_for('STA_name');
+					$csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ];
+				} elseif ($field_name == 'CNT_ISO') {
+					$country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name');
+					$csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+				} else {
+					$csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
+				}
+			}
+			$csv_data[] = apply_filters(
+				'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row',
+				$csv_row,
+				$attendee_row
+			);
+		}
+		return $csv_data;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
     // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
     public function create_job(JobParameters $job_parameters)
     {
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
+        if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
             throw new BatchRequestException(
                 __('You do not have permission to view contacts', 'event_espresso')
             );
@@ -105,12 +105,12 @@ 
             foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
                 if ($field_name == 'STA_ID') {
                     $state_name_field = \EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ];
+                    $csv_row[__('State', 'event_espresso')] = $attendee_row[$state_name_field->get_qualified_column()];
                 } elseif ($field_name == 'CNT_ISO') {
                     $country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+                    $csv_row[__('Country', 'event_espresso')] = $attendee_row[$country_name_field->get_qualified_column()];
                 } else {
-                    $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
+                    $csv_row[wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES)] = $attendee_row[$field_obj->get_qualified_column()];
                 }
             }
             $csv_data[] = apply_filters(

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/JobParameters.php

Indentation +392 added lines, -392 removed lines

@@ -14,396 +14,396 @@
  */
 class JobParameters
 {
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * status indicating the job should continue
-     */
-    const status_continue = 'continue';
-
-    /**
-     * status indicated the job has been completed successfully and should be cleaned up next
-     */
-    const status_complete = 'complete';
-
-    /**
-     * status indicating there was an error and the job should be cleaned up
-     */
-    const status_error = 'error';
-
-    /**
-     * status indicating the job has been cleaned up, and so this is probably the last
-     * time you'll see this job
-     */
-    const status_cleaned_up = 'cleaned_up';
-
-    const wp_option_prefix = 'ee_job_parameters_';
-
-
-    /**
-     * String uniquely identifying the job
-     *
-     * @var string
-     */
-    protected $_job_id;
-
-    /**
-     * @var string
-     */
-    protected $_classname;
-
-    /**
-     * @var array
-     */
-    protected $_request_data;
-
-    /**
-     * Array of any extra data we want to remember about this request, that
-     * wasn't necessarily past in with the request data
-     *
-     * @var array
-     */
-    protected $_extra_data;
-
-    /**
-     * Estimate of how many units HAVE been processed
-     *
-     * @var int
-     */
-    protected $_units_processed = 0;
-
-    /**
-     * @var string
-     */
-    protected $_status;
-
-    /**
-     * The size of the total job in whatever units you want.
-     * If you can't provide an estimate leave as 0.
-     * Once _units_processed equals _job_size, we should be done
-     *
-     * @var int
-     */
-    protected $_job_size = 0;
-
-
-    /**
-     * @param string $job_id
-     * @param string $classname
-     * @param array  $request_data
-     * @param array  $extra_data
-     */
-    public function __construct($job_id, $classname, $request_data, $extra_data = array())
-    {
-        $this->set_job_id($job_id);
-        $this->set_classname($classname);
-        $this->set_request_data($request_data);
-        $this->set_extra_data($extra_data);
-        $this->set_status(JobParameters::status_continue);
-    }
-
-
-    /**
-     * Returns the array of strings of valid stati
-     *
-     * @return array
-     */
-    public static function valid_stati()
-    {
-        return array(
-            JobParameters::status_complete,
-            JobParameters::status_continue,
-            JobParameters::status_error,
-            JobParameters::status_cleaned_up,
-        );
-    }
-
-
-    /**
-     * Saves this option to the database (wordpress options table)
-     *
-     * @param boolean $first
-     * @return boolean success
-     */
-    public function save($first = false)
-    {
-        $object_vars = get_object_vars($this);
-        if ($first) {
-            return add_option($this->option_name(), $object_vars, null, 'no');
-        } else {
-            return update_option($this->option_name(), $object_vars);
-        }
-    }
-
-
-    /**
-     * Deletes the job from teh database, although this object is still usable
-     * for the rest of the request
-     *
-     * @return boolean
-     */
-    public function delete()
-    {
-        return delete_option($this->option_name());
-    }
-
-
-    /**
-     * Loads the specified job from the database
-     *
-     * @param string $job_id
-     * @return JobParameters
-     * @throws BatchRequestException
-     */
-    public static function load($job_id)
-    {
-        $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
-        if (! is_array($job_parameter_vars) ||
-            ! isset($job_parameter_vars['_classname']) ||
-            ! isset($job_parameter_vars['_request_data'])
-        ) {
-            throw new BatchRequestException(
-                sprintf(
-                    __(
-                        'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s',
-                        'event_espresso'
-                    ),
-                    $job_id,
-                    get_option(JobParameters::wp_option_prefix . $job_id)
-                )
-            );
-        }
-        $job_parameters = new JobParameters(
-            $job_id,
-            $job_parameter_vars['_classname'],
-            $job_parameter_vars['_request_data']
-        );
-        foreach ($job_parameter_vars as $key => $value) {
-            $job_parameters->{$key} = $value;
-        }
-        return $job_parameters;
-    }
-
-
-    /**
-     * Gets the job's unique string
-     *
-     * @return string
-     */
-    public function job_id()
-    {
-        return $this->_job_id;
-    }
-
-
-    /**
-     * Gets the classname that should run this job
-     *
-     * @return string
-     */
-    public function classname()
-    {
-        return $this->_classname;
-    }
-
-
-    /**
-     * Gets the original array of $_REQUEST data for this job
-     *
-     * @return array
-     */
-    public function request_data()
-    {
-        return $this->_request_data;
-    }
-
-
-    /**
-     * Gets a single item from the request data
-     *
-     * @param string       $key
-     * @param string|array $default
-     * @return string|array
-     */
-    public function request_datum($key, $default = '')
-    {
-        if (isset($this->_request_data[ $key ])) {
-            return $this->_request_data[ $key ];
-        } else {
-            return $default;
-        }
-    }
-
-
-    /**
-     * Gets a single item from the extra data
-     *
-     * @param string       $key
-     * @param string|array $default
-     * @return string|array
-     */
-    public function extra_datum($key, $default = '')
-    {
-        if (isset($this->_extra_data[ $key ])) {
-            return $this->_extra_data[ $key ];
-        } else {
-            return $default;
-        }
-    }
-
-
-    /**
-     * Adds an extra piece of extra data that we're going to want later during the job
-     *
-     * @param string                $key
-     * @param string|int|array|null $value almost any extra data you want to store
-     */
-    public function add_extra_data($key, $value)
-    {
-        $this->_extra_data[ $key ] = $value;
-    }
-
-
-    /**
-     * Array of any extra data we want to store
-     *
-     * @return array
-     */
-    public function extra_data()
-    {
-        return $this->_extra_data;
-    }
-
-
-    /**
-     * Returns the job size, in whatever units you want
-     *
-     * @return int
-     */
-    public function job_size()
-    {
-        return $this->_job_size;
-    }
-
-
-    /**
-     * Sets the job size. You decide what units to use
-     *
-     * @param int $size
-     */
-    public function set_job_size($size)
-    {
-        $this->_job_size = $size;
-    }
-
-
-    /**
-     * The number of "units" processed, in the same units as the "job size"
-     *
-     * @return int
-     */
-    public function units_processed()
-    {
-        return $this->_units_processed;
-    }
-
-
-    /**
-     * Marks more units as processed
-     *
-     * @param int $newly_processed
-     * @return int updated units processed
-     */
-    public function mark_processed($newly_processed)
-    {
-        $this->_units_processed += $newly_processed;
-        return $this->_units_processed;
-    }
-
-
-    /**
-     * Sets the total count of units processed. You might prefer to use mark_processed
-     *
-     * @param int $total_units_processed
-     */
-    public function set_units_processed($total_units_processed)
-    {
-        $this->_units_processed = $total_units_processed;
-    }
-
-
-    /**
-     * Sets the job's ID
-     *
-     * @param string $job_id
-     */
-    public function set_job_id($job_id)
-    {
-        $this->_job_id = $job_id;
-    }
-
-
-    /**
-     * sets the classname
-     *
-     * @param string $classname
-     */
-    public function set_classname($classname)
-    {
-        $this->_classname = $classname;
-    }
-
-
-    /**
-     * Sets the request data
-     *
-     * @param array $request_data
-     */
-    public function set_request_data($request_data)
-    {
-        $this->_request_data = $request_data;
-    }
-
-
-    /**
-     * Sets the array of extra data we want to store on this request
-     *
-     * @param array $extra_data
-     */
-    public function set_extra_data($extra_data)
-    {
-        $this->_extra_data = $extra_data;
-    }
-
-
-    /**
-     * Gets the name of the wordpress option that should store these job parameters
-     *
-     * @return string
-     */
-    public function option_name()
-    {
-        return JobParameters::wp_option_prefix . $this->job_id();
-    }
-
-
-    /**
-     * Gets the job\s current status. One of JobParameters::valid_stati();
-     *
-     * @return string
-     */
-    public function status()
-    {
-        return $this->_status;
-    }
-
-
-    /**
-     * @param string $status on eof JobParameters::valid_stati()
-     */
-    public function set_status($status)
-    {
-        $this->_status = $status;
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * status indicating the job should continue
+	 */
+	const status_continue = 'continue';
+
+	/**
+	 * status indicated the job has been completed successfully and should be cleaned up next
+	 */
+	const status_complete = 'complete';
+
+	/**
+	 * status indicating there was an error and the job should be cleaned up
+	 */
+	const status_error = 'error';
+
+	/**
+	 * status indicating the job has been cleaned up, and so this is probably the last
+	 * time you'll see this job
+	 */
+	const status_cleaned_up = 'cleaned_up';
+
+	const wp_option_prefix = 'ee_job_parameters_';
+
+
+	/**
+	 * String uniquely identifying the job
+	 *
+	 * @var string
+	 */
+	protected $_job_id;
+
+	/**
+	 * @var string
+	 */
+	protected $_classname;
+
+	/**
+	 * @var array
+	 */
+	protected $_request_data;
+
+	/**
+	 * Array of any extra data we want to remember about this request, that
+	 * wasn't necessarily past in with the request data
+	 *
+	 * @var array
+	 */
+	protected $_extra_data;
+
+	/**
+	 * Estimate of how many units HAVE been processed
+	 *
+	 * @var int
+	 */
+	protected $_units_processed = 0;
+
+	/**
+	 * @var string
+	 */
+	protected $_status;
+
+	/**
+	 * The size of the total job in whatever units you want.
+	 * If you can't provide an estimate leave as 0.
+	 * Once _units_processed equals _job_size, we should be done
+	 *
+	 * @var int
+	 */
+	protected $_job_size = 0;
+
+
+	/**
+	 * @param string $job_id
+	 * @param string $classname
+	 * @param array  $request_data
+	 * @param array  $extra_data
+	 */
+	public function __construct($job_id, $classname, $request_data, $extra_data = array())
+	{
+		$this->set_job_id($job_id);
+		$this->set_classname($classname);
+		$this->set_request_data($request_data);
+		$this->set_extra_data($extra_data);
+		$this->set_status(JobParameters::status_continue);
+	}
+
+
+	/**
+	 * Returns the array of strings of valid stati
+	 *
+	 * @return array
+	 */
+	public static function valid_stati()
+	{
+		return array(
+			JobParameters::status_complete,
+			JobParameters::status_continue,
+			JobParameters::status_error,
+			JobParameters::status_cleaned_up,
+		);
+	}
+
+
+	/**
+	 * Saves this option to the database (wordpress options table)
+	 *
+	 * @param boolean $first
+	 * @return boolean success
+	 */
+	public function save($first = false)
+	{
+		$object_vars = get_object_vars($this);
+		if ($first) {
+			return add_option($this->option_name(), $object_vars, null, 'no');
+		} else {
+			return update_option($this->option_name(), $object_vars);
+		}
+	}
+
+
+	/**
+	 * Deletes the job from teh database, although this object is still usable
+	 * for the rest of the request
+	 *
+	 * @return boolean
+	 */
+	public function delete()
+	{
+		return delete_option($this->option_name());
+	}
+
+
+	/**
+	 * Loads the specified job from the database
+	 *
+	 * @param string $job_id
+	 * @return JobParameters
+	 * @throws BatchRequestException
+	 */
+	public static function load($job_id)
+	{
+		$job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
+		if (! is_array($job_parameter_vars) ||
+			! isset($job_parameter_vars['_classname']) ||
+			! isset($job_parameter_vars['_request_data'])
+		) {
+			throw new BatchRequestException(
+				sprintf(
+					__(
+						'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s',
+						'event_espresso'
+					),
+					$job_id,
+					get_option(JobParameters::wp_option_prefix . $job_id)
+				)
+			);
+		}
+		$job_parameters = new JobParameters(
+			$job_id,
+			$job_parameter_vars['_classname'],
+			$job_parameter_vars['_request_data']
+		);
+		foreach ($job_parameter_vars as $key => $value) {
+			$job_parameters->{$key} = $value;
+		}
+		return $job_parameters;
+	}
+
+
+	/**
+	 * Gets the job's unique string
+	 *
+	 * @return string
+	 */
+	public function job_id()
+	{
+		return $this->_job_id;
+	}
+
+
+	/**
+	 * Gets the classname that should run this job
+	 *
+	 * @return string
+	 */
+	public function classname()
+	{
+		return $this->_classname;
+	}
+
+
+	/**
+	 * Gets the original array of $_REQUEST data for this job
+	 *
+	 * @return array
+	 */
+	public function request_data()
+	{
+		return $this->_request_data;
+	}
+
+
+	/**
+	 * Gets a single item from the request data
+	 *
+	 * @param string       $key
+	 * @param string|array $default
+	 * @return string|array
+	 */
+	public function request_datum($key, $default = '')
+	{
+		if (isset($this->_request_data[ $key ])) {
+			return $this->_request_data[ $key ];
+		} else {
+			return $default;
+		}
+	}
+
+
+	/**
+	 * Gets a single item from the extra data
+	 *
+	 * @param string       $key
+	 * @param string|array $default
+	 * @return string|array
+	 */
+	public function extra_datum($key, $default = '')
+	{
+		if (isset($this->_extra_data[ $key ])) {
+			return $this->_extra_data[ $key ];
+		} else {
+			return $default;
+		}
+	}
+
+
+	/**
+	 * Adds an extra piece of extra data that we're going to want later during the job
+	 *
+	 * @param string                $key
+	 * @param string|int|array|null $value almost any extra data you want to store
+	 */
+	public function add_extra_data($key, $value)
+	{
+		$this->_extra_data[ $key ] = $value;
+	}
+
+
+	/**
+	 * Array of any extra data we want to store
+	 *
+	 * @return array
+	 */
+	public function extra_data()
+	{
+		return $this->_extra_data;
+	}
+
+
+	/**
+	 * Returns the job size, in whatever units you want
+	 *
+	 * @return int
+	 */
+	public function job_size()
+	{
+		return $this->_job_size;
+	}
+
+
+	/**
+	 * Sets the job size. You decide what units to use
+	 *
+	 * @param int $size
+	 */
+	public function set_job_size($size)
+	{
+		$this->_job_size = $size;
+	}
+
+
+	/**
+	 * The number of "units" processed, in the same units as the "job size"
+	 *
+	 * @return int
+	 */
+	public function units_processed()
+	{
+		return $this->_units_processed;
+	}
+
+
+	/**
+	 * Marks more units as processed
+	 *
+	 * @param int $newly_processed
+	 * @return int updated units processed
+	 */
+	public function mark_processed($newly_processed)
+	{
+		$this->_units_processed += $newly_processed;
+		return $this->_units_processed;
+	}
+
+
+	/**
+	 * Sets the total count of units processed. You might prefer to use mark_processed
+	 *
+	 * @param int $total_units_processed
+	 */
+	public function set_units_processed($total_units_processed)
+	{
+		$this->_units_processed = $total_units_processed;
+	}
+
+
+	/**
+	 * Sets the job's ID
+	 *
+	 * @param string $job_id
+	 */
+	public function set_job_id($job_id)
+	{
+		$this->_job_id = $job_id;
+	}
+
+
+	/**
+	 * sets the classname
+	 *
+	 * @param string $classname
+	 */
+	public function set_classname($classname)
+	{
+		$this->_classname = $classname;
+	}
+
+
+	/**
+	 * Sets the request data
+	 *
+	 * @param array $request_data
+	 */
+	public function set_request_data($request_data)
+	{
+		$this->_request_data = $request_data;
+	}
+
+
+	/**
+	 * Sets the array of extra data we want to store on this request
+	 *
+	 * @param array $extra_data
+	 */
+	public function set_extra_data($extra_data)
+	{
+		$this->_extra_data = $extra_data;
+	}
+
+
+	/**
+	 * Gets the name of the wordpress option that should store these job parameters
+	 *
+	 * @return string
+	 */
+	public function option_name()
+	{
+		return JobParameters::wp_option_prefix . $this->job_id();
+	}
+
+
+	/**
+	 * Gets the job\s current status. One of JobParameters::valid_stati();
+	 *
+	 * @return string
+	 */
+	public function status()
+	{
+		return $this->_status;
+	}
+
+
+	/**
+	 * @param string $status on eof JobParameters::valid_stati()
+	 */
+	public function set_status($status)
+	{
+		$this->_status = $status;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -158,8 +158,8 @@ 
      */
     public static function load($job_id)
     {
-        $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
-        if (! is_array($job_parameter_vars) ||
+        $job_parameter_vars = get_option(JobParameters::wp_option_prefix.$job_id);
+        if ( ! is_array($job_parameter_vars) ||
             ! isset($job_parameter_vars['_classname']) ||
             ! isset($job_parameter_vars['_request_data'])
         ) {
@@ -170,7 +170,7 @@ 
                         'event_espresso'
                     ),
                     $job_id,
-                    get_option(JobParameters::wp_option_prefix . $job_id)
+                    get_option(JobParameters::wp_option_prefix.$job_id)
                 )
             );
         }
@@ -228,8 +228,8 @@ 
      */
     public function request_datum($key, $default = '')
     {
-        if (isset($this->_request_data[ $key ])) {
-            return $this->_request_data[ $key ];
+        if (isset($this->_request_data[$key])) {
+            return $this->_request_data[$key];
         } else {
             return $default;
         }
@@ -245,8 +245,8 @@ 
      */
     public function extra_datum($key, $default = '')
     {
-        if (isset($this->_extra_data[ $key ])) {
-            return $this->_extra_data[ $key ];
+        if (isset($this->_extra_data[$key])) {
+            return $this->_extra_data[$key];
         } else {
             return $default;
         }
@@ -261,7 +261,7 @@ 
      */
     public function add_extra_data($key, $value)
     {
-        $this->_extra_data[ $key ] = $value;
+        $this->_extra_data[$key] = $value;
     }
 
 
@@ -384,7 +384,7 @@ 
      */
     public function option_name()
     {
-        return JobParameters::wp_option_prefix . $this->job_id();
+        return JobParameters::wp_option_prefix.$this->job_id();
     }
 
 

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
+		);
+	}
 }