eventespresso / event-espresso-core

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

Indentation +1240 added lines, -1240 removed lines

@@ -9,7 +9,7 @@ 
 use EE_Datetime_Field;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,1245 +27,1245 @@ 
 
 
 
-    /**
-     * @var Calculated_Model_Fields
-     */
-    protected $_fields_calculator;
-
-
-
-    /**
-     * Read constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->_fields_calculator = new Calculated_Model_Fields();
-    }
-
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_all(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
-                array('version', 'model')
-            );
-            $controller->set_requested_version($matches['version']);
-            $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entities_from_model(
-                    $controller->get_model_version_info()->load_model($model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $model_name Something like `Event` or `Registration`
-     * @param string $version    The API endpoint version being used.
-     * @return array
-     */
-    public static function handle_schema_request($model_name, $version)
-    {
-        $controller = new Read();
-        try {
-            $controller->set_requested_version($version);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
-                return array();
-            }
-            //get the model for this version
-            $model = $controller->get_model_version_info()->load_model($model_name);
-            $model_schema = new JsonModelSchema($model);
-            return $model_schema->getModelSchemaForRelations(
-                $controller->get_model_version_info()->relation_settings($model),
-                $controller->_customize_schema_for_rest_response(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->get_model_version_info()->fields_on_model_in_this_version($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (\Exception $e) {
-            return array();
-        }
-    }
-
-
-
-    /**
-     * This loops through each field in the given schema for the model and does the following:
-     * - add any extra fields that are REST API specific and related to existing fields.
-     * - transform default values into the correct format for a REST API response.
-     *
-     * @param \EEM_Base $model
-     * @param array     $schema
-     * @return array  The final schema.
-     */
-    protected function _customize_schema_for_rest_response(\EEM_Base $model, array $schema)
-    {
-        foreach ($this->get_model_version_info()->fields_on_model_in_this_version($model) as $field_name => $field) {
-            $schema = $this->_translate_defaults_for_rest_response(
-                $field_name,
-                $field,
-                $this->_maybe_add_extra_fields_to_schema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param \EE_Model_Field_Base $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function _translate_defaults_for_rest_response($field_name, \EE_Model_Field_Base $field, array $schema)
-    {
-        if (isset($schema['properties'][$field_name]['default'])) {
-            if (is_array($schema['properties'][$field_name]['default'])) {
-                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
-                    if ($default_key === 'raw') {
-                        $schema['properties'][$field_name]['default'][$default_key] = Model_Data_Translator::prepare_field_value_for_json(
-                            $field,
-                            $default_value,
-                            $this->get_model_version_info()->requested_version()
-                        );
-                    }
-                }
-            } else {
-                $schema['properties'][$field_name]['default'] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field,
-                    $schema['properties'][$field_name]['default'],
-                    $this->get_model_version_info()->requested_version()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param \EE_Model_Field_Base $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function _maybe_add_extra_fields_to_schema($field_name, \EE_Model_Field_Base $field, array $schema)
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][$field_name . '_gmt'] = $field->getSchema();
-            //modify the description
-            $schema['properties'][$field_name . '_gmt']['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                $field->get_nicename()
-            );
-        }
-        return $schema;
-    }
-
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function get_route_from_request()
-    {
-        if (isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof \WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        } else {
-            return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
-        }
-    }
-
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_one(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
-                array('version', 'model', 'id'));
-            $controller->set_requested_version($matches['version']);
-            $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entity_from_model(
-                    $controller->get_model_version_info()->load_model($model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_related(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
-                array('version', 'model', 'id', 'related_model')
-            );
-            $controller->set_requested_version($matches['version']);
-            $main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $main_model_name_singular
-                        )
-                    )
-                );
-            }
-            $main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
-            //assume the related model name is plural and try to find the model's name
-            $related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
-                //so the word didn't singularize well. Maybe that's just because it's a singular word?
-                $related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
-            }
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $related_model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entities_from_relation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $request
-     * @return array|\WP_Error
-     */
-    public function get_entities_from_model($model, $request)
-    {
-        $query_params = $this->create_model_query_params($model, $request->get_params());
-        if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
-            $model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            return new \WP_Error(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::get_missing_permissions_string($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->_set_headers_from_query_params($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->create_entity_from_wpdb_result(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-
-    /**
-     * @param array                   $primary_model_query_params query params for finding the item from which
-     *                                                            relations will be based
-     * @param \EE_Model_Relation_Base $relation
-     * @param \WP_REST_Request        $request
-     * @return \WP_Error|array
-     */
-    protected function _get_entities_from_relation($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validate_context($request->get_param('caps'));
-        $model = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = array();
-        }
-        //check if they can access the 1st model object
-        $primary_model_query_params = array(
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        );
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($primary_model_query_params);
-        }
-        $restricted_query_params = $primary_model_query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->_set_debug_info('main model query params', $restricted_query_params);
-        $this->_set_debug_info('missing caps', Capabilities::get_missing_permissions_string($related_model, $context));
-        if (
-        ! (
-            Capabilities::current_user_has_partial_access_to($related_model, $context)
-            && $model->exists($restricted_query_params)
-        )
-        ) {
-            if ($relation instanceof \EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = \EEH_Inflector::pluralize_and_lower($related_model->get_this_model_name());
-            }
-            return new \WP_Error(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::get_missing_permissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->create_model_query_params($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][$relation->get_this_model()->get_this_model_name()
-                             . '.'
-                             . $where_condition_key] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->_set_headers_from_query_params($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->create_entity_from_wpdb_result(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof \EE_HABTM_Relation) {
-                //put the unusual stuff (properties from the HABTM relation) first, and make sure
-                //if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->create_entity_from_wpdb_result(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($nice_result, $join_model_result);
-                //but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof \EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                  $id the ID of the thing we are fetching related stuff from
-     * @param \EE_Model_Relation_Base $relation
-     * @param \WP_REST_Request        $request
-     * @return array|\WP_Error
-     * @throws \EE_Error
-     */
-    public function get_entities_from_relation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        'event_espresso'),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->_get_entities_from_relation(
-            array(
-                array(
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ),
-            ),
-            $relation,
-            $request
-        );
-    }
-
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param \EEM_Base $model
-     * @param array     $query_params
-     * @return void
-     */
-    protected function _set_headers_from_query_params($model, $query_params)
-    {
-        $this->_set_debug_info('model query params', $query_params);
-        $this->_set_debug_info('missing caps',
-            Capabilities::get_missing_permissions_string($model, $query_params['caps']));
-        //normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = array(0, $limit_parts[0]);
-            }
-        }
-        //remove the group by and having parts of the query, as those will
-        //make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->_set_response_header('Total', $count, false);
-        $this->_set_response_header('PageSize', $limit_parts[1], false);
-        $this->_set_response_header('TotalPages', ceil($pages), false);
-    }
-
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param \EEM_Base        $model
-     * @param array            $db_row     like results from $wpdb->get_results()
-     * @param \WP_REST_Request $rest_request
-     * @param string           $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     */
-    public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
-    {
-        if (! $rest_request instanceof \WP_REST_Request) {
-            //ok so this was called in the old style, where the 3rd arg was
-            //$include, and the 4th arg was $context
-            //now setup the request just to avoid fatal errors, although we won't be able
-            //to truly make use of it because it's kinda devoid of info
-            $rest_request = new \WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') == null) {
-            $rest_request->set_param('caps', \EEM_Base::caps_read);
-        }
-        $entity_array = $this->_create_bare_entity_from_wpdb_results($model, $db_row);
-        $entity_array = $this->_add_extra_fields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->_get_entity_links($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->_get_entity_calculations($model, $db_row, $rest_request);
-        $entity_array = apply_filters('FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            $entity_array, $model, $rest_request->get_param('caps'), $rest_request, $this);
-        $entity_array = $this->_include_requested_models($model, $rest_request, $entity_array, $db_row);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $result_without_inaccessible_fields = Capabilities::filter_out_inaccessible_entity_fields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->get_model_version_info(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->_set_debug_info(
-            'inaccessible fields',
-            array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param \EEM_Base $model
-     * @param array     $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     */
-    protected function _create_bare_entity_from_wpdb_results(\EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key($result,
-            $this->get_model_version_info()->fields_on_model_in_this_version($model));
-        foreach ($result as $field_name => $raw_field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            $field_value = $field_obj->prepare_for_set_from_db($raw_field_value);
-            if ($this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_ignored())) {
-                unset($result[$field_name]);
-            } elseif (
-            $this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_rendered_format())
-            ) {
-                $result[$field_name] = array(
-                    'raw'      => $field_obj->prepare_for_get($field_value),
-                    'rendered' => $field_obj->prepare_for_pretty_echoing($field_value),
-                );
-            } elseif (
-            $this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_pretty_format())
-            ) {
-                $result[$field_name] = array(
-                    'raw'    => $field_obj->prepare_for_get($field_value),
-                    'pretty' => $field_obj->prepare_for_pretty_echoing($field_value),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                if ($field_value instanceof \DateTime) {
-                    $timezone = $field_value->getTimezone();
-                    $field_value->setTimezone(new \DateTimeZone('UTC'));
-                    $result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
-                        $field_obj,
-                        $field_value,
-                        $this->get_model_version_info()->requested_version()
-                    );
-                    $field_value->setTimezone($timezone);
-                    $result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
-                        $field_obj,
-                        $field_value,
-                        $this->get_model_version_info()->requested_version()
-                    );
-                }
-            } else {
-                $result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $field_obj->prepare_for_get($field_value),
-                    $this->get_model_version_info()->requested_version()
-                );
-            }
-        }
-        return $result;
-    }
-
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param \EEM_Base $model
-     * @param array     $db_row
-     * @param array     $entity_array
-     * @return array modified entity
-     */
-    protected function _add_extra_fields(\EEM_Base $model, $db_row, $entity_array)
-    {
-        if ($model instanceof \EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
-        }
-        return $entity_array;
-    }
-
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @global \WP_REST_Server $wp_rest_server
-     * @param \EEM_Base        $model
-     * @param array            $db_row
-     * @param array            $entity_array
-     * @return array the _links item in the entity
-     */
-    protected function _get_entity_links($model, $db_row, $entity_array)
-    {
-        //add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->get_versioned_link_to(
-                        \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[$model->primary_key_name()]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->get_versioned_link_to(
-                    \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        //add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
-                $links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
-                    array(
-                        'href'   => $this->get_versioned_link_to(
-                            \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[$model->primary_key_name()]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
-                    ),
-                );
-            }
-        }
-        return $links;
-    }
-
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $rest_request
-     * @param array            $entity_array
-     * @param array            $db_row
-     * @return array the modified entity
-     */
-    protected function _include_requested_models(
-        \EEM_Base $model,
-        \WP_REST_Request $rest_request,
-        $entity_array,
-        $db_row = array()
-    ) {
-        //if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
-        //if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                //always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explode_and_get_items_prefixed_with($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        $relation_settings = $this->get_model_version_info()->relation_settings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explode_and_get_items_prefixed_with(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explode_and_get_items_prefixed_with(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            //did they specify they wanted to include a related model, or
-            //specific fields from a related model?
-            //or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                //if so, we should include at least some part of the related model
-                $pretend_related_request = new \WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    array(
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                    )
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                $related_results = $this->_get_entities_from_relation(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[Read::get_related_entity_name($relation_name, $relation_obj)] = $related_results
-                                                                                              instanceof
-                                                                                              \WP_Error
-                    ? null
-                    : $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $arr
-     * @return array
-     */
-    private function _remove_model_names_from_array($arr)
-    {
-        return array_diff($arr, array_keys(\EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param \EEM_Base        $model
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $rest_request
-     * @return \stdClass the _calculations item in the entity
-     */
-    protected function _get_entity_calculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explode_and_get_items_prefixed_with(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        //note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new \stdClass();
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                $calculated_fields_to_return->$field_to_calculate = Model_Data_Translator::prepare_field_value_for_json(
-                    null,
-                    $this->_fields_calculator->retrieve_calculated_field_value(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->get_model_version_info()->requested_version()
-                );
-            } catch (Rest_Exception $e) {
-                //if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->_set_response_header(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->get_string_code()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    true
-                );
-            }
-        }
-        return $calculated_fields_to_return;
-    }
-
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     */
-    public function get_versioned_link_to($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            \EED_Core_Rest_Api::ee_api_namespace
-            . $this->get_model_version_info()->requested_version()
-            . '/'
-            . $link_part_after_version_and_slash
-        );
-    }
-
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                  $relation_name
-     * @param \EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function get_related_entity_name($relation_name, $relation_obj)
-    {
-        if ($relation_obj instanceof \EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return \EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $request
-     * @return array|\WP_Error
-     */
-    public function get_entity_from_model($model, $request)
-    {
-        $query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params = $query_params;
-        $restricted_query_params['caps'] = $this->validate_context($request->get_param('caps'));
-        $this->_set_debug_info('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty ($model_rows)) {
-            return $this->create_entity_from_wpdb_result(
-                $model,
-                array_shift($model_rows),
-                $request);
-        } else {
-            //ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
-                //you got shafted- it existed but we didn't want to tell you!
-                return new \WP_Error(
-                    'rest_user_cannot_read',
-                    sprintf(
-                        __('Sorry, you cannot read this %1$s. Missing permissions are: %2$s', 'event_espresso'),
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::get_missing_permissions_string(
-                            $model,
-                            $this->validate_context($request->get_param('caps')))
-                    ),
-                    array('status' => 403)
-                );
-            } else {
-                //it's not you. It just doesn't exist
-                return new \WP_Error(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    array('status' => 404)
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validate_context($context)
-    {
-        if (! $context) {
-            $context = \EEM_Base::caps_read;
-        }
-        $valid_contexts = \EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return \EEM_Base::caps_read;
-        }
-    }
-
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validate_default_query_params($default_query_params)
-    {
-        $valid_default_where_conditions_for_api_calls = array(
-            \EEM_Base::default_where_conditions_all,
-            \EEM_Base::default_where_conditions_minimum_all,
-            \EEM_Base::default_where_conditions_minimum_others,
-        );
-        if (! $default_query_params) {
-            $default_query_params = \EEM_Base::default_where_conditions_all;
-        }
-        if (
-        in_array(
-            $default_query_params,
-            $valid_default_where_conditions_for_api_calls,
-            true
-        )
-        ) {
-            return $default_query_params;
-        } else {
-            return \EEM_Base::default_where_conditions_all;
-        }
-    }
-
-
-
-    /**
-     * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
-     * Note: right now the query parameter keys for fields (and related fields)
-     * can be left as-is, but it's quite possible this will change someday.
-     * Also, this method's contents might be candidate for moving to Model_Data_Translator
-     *
-     * @param \EEM_Base $model
-     * @param array     $query_parameters from $_GET parameter @see Read:handle_request_get_all
-     * @return array like what EEM_Base::get_all() expects or FALSE to indicate
-     *                                    that absolutely no results should be returned
-     * @throws \EE_Error
-     */
-    public function create_model_query_params($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = Model_Data_Translator::prepare_conditions_query_params_for_models(
-                $query_parameters['where'],
-                $model,
-                $this->get_model_version_info()->requested_version()
-            );
-        }
-        if (isset($query_parameters['order_by'])) {
-            $order_by = $query_parameters['order_by'];
-        } elseif (isset($query_parameters['orderby'])) {
-            $order_by = $query_parameters['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = Model_Data_Translator::prepare_field_names_in_array_keys_from_json($order_by);
-            } else {
-                //it's a single item
-                $order_by = Model_Data_Translator::prepare_field_name_from_json($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_parameters['group_by'])) {
-            $group_by = $query_parameters['group_by'];
-        } elseif (isset($query_parameters['groupby'])) {
-            $group_by = $query_parameters['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        //make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = Model_Data_Translator::prepare_field_names_from_json($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_models(
-                $query_parameters['having'],
-                $model,
-                $this->get_model_version_info()->requested_version()
-            );
-        }
-        if (isset($query_parameters['order'])) {
-            $model_query_params['order'] = $query_parameters['order'];
-        }
-        if (isset($query_parameters['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_parameters['limit'])) {
-            //limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string)$query_parameters['limit']);
-            } else {
-                $limit_array = $query_parameters['limit'];
-            }
-            $sanitized_limit = array();
-            foreach ($limit_array as $key => $limit_part) {
-                if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new \EE_Error(
-                        sprintf(
-                            __('An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                'event_espresso'),
-                            wp_json_encode($query_parameters['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int)$limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_parameters['caps'])) {
-            $model_query_params['caps'] = $this->validate_context($query_parameters['caps']);
-        } else {
-            $model_query_params['caps'] = \EEM_Base::caps_read;
-        }
-        if (isset($query_parameters['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validate_default_query_params($query_parameters['default_where_conditions']);
-        }
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
-    }
-
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @deprecated
-     * @param \EEM_Base $model
-     * @param array     $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     */
-    public function prepare_rest_query_params_key_for_models($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[$key] = $this->prepare_rest_query_params_key_for_models($model, $value);
-            } else {
-                $model_ready_query_params[$key] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepare_rest_query_params_values_for_models($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[$key] = $this->prepare_rest_query_params_values_for_models($model, $value);
-            } else {
-                $model_ready_query_params[$key] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blaabla" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explode_and_get_items_prefixed_with($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } else if (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = array();
-        }
-        //if the string was empty, we want an empty array
-        $exploded_contents = array_filter($exploded_contents);
-        $contents_with_prefix = array();
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            //if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                //does this item have a period?
-                if (strpos($item, '.') === false) {
-                    //if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } else if (strpos($item, $prefix . '.') === 0) {
-                //this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } else if ($item === $prefix) {
-                //this item is JUST the prefix
-                //so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-
-    /**
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     * Deprecated because its return values were really quite confusing- sometimes it returned
-     * an empty array (when the include string was blank or '*') or sometimes it returned
-     * array('*') (when you provided a model and a model of that kind was found).
-     * Parses the $include_string so we fetch all the field names relating to THIS model
-     * (ie have NO period in them), or for the provided model (ie start with the model
-     * name and then a period).
-     * @param string $include_string @see Read:handle_request_get_all
-     * @param string $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                               the fields for that model, with the model's name removed from each.
-     *                               If $include_string was blank or '*' returns an empty array
-     */
-    public function extract_includes_for_this_model($include_string, $model_name = null)
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return array();
-        }
-        $includes = explode(',', $include_string);
-        $extracted_fields_to_include = array();
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    //found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include == $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            //look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (
-                    strpos($field_to_include, '.') === false
-                    && ! $this->get_model_version_info()->is_model_name_in_this_version($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
+	/**
+	 * @var Calculated_Model_Fields
+	 */
+	protected $_fields_calculator;
+
+
+
+	/**
+	 * Read constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->_fields_calculator = new Calculated_Model_Fields();
+	}
+
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_all(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
+				array('version', 'model')
+			);
+			$controller->set_requested_version($matches['version']);
+			$model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entities_from_model(
+					$controller->get_model_version_info()->load_model($model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @param string $version    The API endpoint version being used.
+	 * @return array
+	 */
+	public static function handle_schema_request($model_name, $version)
+	{
+		$controller = new Read();
+		try {
+			$controller->set_requested_version($version);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
+				return array();
+			}
+			//get the model for this version
+			$model = $controller->get_model_version_info()->load_model($model_name);
+			$model_schema = new JsonModelSchema($model);
+			return $model_schema->getModelSchemaForRelations(
+				$controller->get_model_version_info()->relation_settings($model),
+				$controller->_customize_schema_for_rest_response(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->get_model_version_info()->fields_on_model_in_this_version($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (\Exception $e) {
+			return array();
+		}
+	}
+
+
+
+	/**
+	 * This loops through each field in the given schema for the model and does the following:
+	 * - add any extra fields that are REST API specific and related to existing fields.
+	 * - transform default values into the correct format for a REST API response.
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $schema
+	 * @return array  The final schema.
+	 */
+	protected function _customize_schema_for_rest_response(\EEM_Base $model, array $schema)
+	{
+		foreach ($this->get_model_version_info()->fields_on_model_in_this_version($model) as $field_name => $field) {
+			$schema = $this->_translate_defaults_for_rest_response(
+				$field_name,
+				$field,
+				$this->_maybe_add_extra_fields_to_schema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param \EE_Model_Field_Base $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function _translate_defaults_for_rest_response($field_name, \EE_Model_Field_Base $field, array $schema)
+	{
+		if (isset($schema['properties'][$field_name]['default'])) {
+			if (is_array($schema['properties'][$field_name]['default'])) {
+				foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
+					if ($default_key === 'raw') {
+						$schema['properties'][$field_name]['default'][$default_key] = Model_Data_Translator::prepare_field_value_for_json(
+							$field,
+							$default_value,
+							$this->get_model_version_info()->requested_version()
+						);
+					}
+				}
+			} else {
+				$schema['properties'][$field_name]['default'] = Model_Data_Translator::prepare_field_value_for_json(
+					$field,
+					$schema['properties'][$field_name]['default'],
+					$this->get_model_version_info()->requested_version()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param \EE_Model_Field_Base $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function _maybe_add_extra_fields_to_schema($field_name, \EE_Model_Field_Base $field, array $schema)
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][$field_name . '_gmt'] = $field->getSchema();
+			//modify the description
+			$schema['properties'][$field_name . '_gmt']['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				$field->get_nicename()
+			);
+		}
+		return $schema;
+	}
+
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function get_route_from_request()
+	{
+		if (isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof \WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		} else {
+			return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
+		}
+	}
+
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_one(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
+				array('version', 'model', 'id'));
+			$controller->set_requested_version($matches['version']);
+			$model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entity_from_model(
+					$controller->get_model_version_info()->load_model($model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_related(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
+				array('version', 'model', 'id', 'related_model')
+			);
+			$controller->set_requested_version($matches['version']);
+			$main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$main_model_name_singular
+						)
+					)
+				);
+			}
+			$main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
+			//assume the related model name is plural and try to find the model's name
+			$related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+				//so the word didn't singularize well. Maybe that's just because it's a singular word?
+				$related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
+			}
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$related_model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entities_from_relation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $request
+	 * @return array|\WP_Error
+	 */
+	public function get_entities_from_model($model, $request)
+	{
+		$query_params = $this->create_model_query_params($model, $request->get_params());
+		if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
+			$model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			return new \WP_Error(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::get_missing_permissions_string($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->_set_headers_from_query_params($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->create_entity_from_wpdb_result(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+
+	/**
+	 * @param array                   $primary_model_query_params query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param \WP_REST_Request        $request
+	 * @return \WP_Error|array
+	 */
+	protected function _get_entities_from_relation($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validate_context($request->get_param('caps'));
+		$model = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = array();
+		}
+		//check if they can access the 1st model object
+		$primary_model_query_params = array(
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($primary_model_query_params);
+		}
+		$restricted_query_params = $primary_model_query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->_set_debug_info('main model query params', $restricted_query_params);
+		$this->_set_debug_info('missing caps', Capabilities::get_missing_permissions_string($related_model, $context));
+		if (
+		! (
+			Capabilities::current_user_has_partial_access_to($related_model, $context)
+			&& $model->exists($restricted_query_params)
+		)
+		) {
+			if ($relation instanceof \EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = \EEH_Inflector::pluralize_and_lower($related_model->get_this_model_name());
+			}
+			return new \WP_Error(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::get_missing_permissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->create_model_query_params($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][$relation->get_this_model()->get_this_model_name()
+							 . '.'
+							 . $where_condition_key] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps'] = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->_set_headers_from_query_params($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->create_entity_from_wpdb_result(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof \EE_HABTM_Relation) {
+				//put the unusual stuff (properties from the HABTM relation) first, and make sure
+				//if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->create_entity_from_wpdb_result(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($nice_result, $join_model_result);
+				//but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof \EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                  $id the ID of the thing we are fetching related stuff from
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param \WP_REST_Request        $request
+	 * @return array|\WP_Error
+	 * @throws \EE_Error
+	 */
+	public function get_entities_from_relation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new \EE_Error(
+				sprintf(
+					__('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						'event_espresso'),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->_get_entities_from_relation(
+			array(
+				array(
+					$relation->get_this_model()->primary_key_name() => $id,
+				),
+			),
+			$relation,
+			$request
+		);
+	}
+
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $query_params
+	 * @return void
+	 */
+	protected function _set_headers_from_query_params($model, $query_params)
+	{
+		$this->_set_debug_info('model query params', $query_params);
+		$this->_set_debug_info('missing caps',
+			Capabilities::get_missing_permissions_string($model, $query_params['caps']));
+		//normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = array(0, $limit_parts[0]);
+			}
+		}
+		//remove the group by and having parts of the query, as those will
+		//make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->_set_response_header('Total', $count, false);
+		$this->_set_response_header('PageSize', $limit_parts[1], false);
+		$this->_set_response_header('TotalPages', ceil($pages), false);
+	}
+
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param \EEM_Base        $model
+	 * @param array            $db_row     like results from $wpdb->get_results()
+	 * @param \WP_REST_Request $rest_request
+	 * @param string           $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 */
+	public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
+	{
+		if (! $rest_request instanceof \WP_REST_Request) {
+			//ok so this was called in the old style, where the 3rd arg was
+			//$include, and the 4th arg was $context
+			//now setup the request just to avoid fatal errors, although we won't be able
+			//to truly make use of it because it's kinda devoid of info
+			$rest_request = new \WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') == null) {
+			$rest_request->set_param('caps', \EEM_Base::caps_read);
+		}
+		$entity_array = $this->_create_bare_entity_from_wpdb_results($model, $db_row);
+		$entity_array = $this->_add_extra_fields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->_get_entity_links($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->_get_entity_calculations($model, $db_row, $rest_request);
+		$entity_array = apply_filters('FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			$entity_array, $model, $rest_request->get_param('caps'), $rest_request, $this);
+		$entity_array = $this->_include_requested_models($model, $rest_request, $entity_array, $db_row);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$result_without_inaccessible_fields = Capabilities::filter_out_inaccessible_entity_fields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->get_model_version_info(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->_set_debug_info(
+			'inaccessible fields',
+			array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 */
+	protected function _create_bare_entity_from_wpdb_results(\EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key($result,
+			$this->get_model_version_info()->fields_on_model_in_this_version($model));
+		foreach ($result as $field_name => $raw_field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			$field_value = $field_obj->prepare_for_set_from_db($raw_field_value);
+			if ($this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_ignored())) {
+				unset($result[$field_name]);
+			} elseif (
+			$this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_rendered_format())
+			) {
+				$result[$field_name] = array(
+					'raw'      => $field_obj->prepare_for_get($field_value),
+					'rendered' => $field_obj->prepare_for_pretty_echoing($field_value),
+				);
+			} elseif (
+			$this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_pretty_format())
+			) {
+				$result[$field_name] = array(
+					'raw'    => $field_obj->prepare_for_get($field_value),
+					'pretty' => $field_obj->prepare_for_pretty_echoing($field_value),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				if ($field_value instanceof \DateTime) {
+					$timezone = $field_value->getTimezone();
+					$field_value->setTimezone(new \DateTimeZone('UTC'));
+					$result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
+						$field_obj,
+						$field_value,
+						$this->get_model_version_info()->requested_version()
+					);
+					$field_value->setTimezone($timezone);
+					$result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
+						$field_obj,
+						$field_value,
+						$this->get_model_version_info()->requested_version()
+					);
+				}
+			} else {
+				$result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$field_obj->prepare_for_get($field_value),
+					$this->get_model_version_info()->requested_version()
+				);
+			}
+		}
+		return $result;
+	}
+
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $db_row
+	 * @param array     $entity_array
+	 * @return array modified entity
+	 */
+	protected function _add_extra_fields(\EEM_Base $model, $db_row, $entity_array)
+	{
+		if ($model instanceof \EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
+		}
+		return $entity_array;
+	}
+
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @global \WP_REST_Server $wp_rest_server
+	 * @param \EEM_Base        $model
+	 * @param array            $db_row
+	 * @param array            $entity_array
+	 * @return array the _links item in the entity
+	 */
+	protected function _get_entity_links($model, $db_row, $entity_array)
+	{
+		//add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->get_versioned_link_to(
+						\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[$model->primary_key_name()]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->get_versioned_link_to(
+					\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		//add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
+				$links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
+					array(
+						'href'   => $this->get_versioned_link_to(
+							\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[$model->primary_key_name()]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
+					),
+				);
+			}
+		}
+		return $links;
+	}
+
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $rest_request
+	 * @param array            $entity_array
+	 * @param array            $db_row
+	 * @return array the modified entity
+	 */
+	protected function _include_requested_models(
+		\EEM_Base $model,
+		\WP_REST_Request $rest_request,
+		$entity_array,
+		$db_row = array()
+	) {
+		//if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
+		//if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				//always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explode_and_get_items_prefixed_with($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		$relation_settings = $this->get_model_version_info()->relation_settings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explode_and_get_items_prefixed_with(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explode_and_get_items_prefixed_with(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			//did they specify they wanted to include a related model, or
+			//specific fields from a related model?
+			//or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				//if so, we should include at least some part of the related model
+				$pretend_related_request = new \WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					array(
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+					)
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				$related_results = $this->_get_entities_from_relation(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[Read::get_related_entity_name($relation_name, $relation_obj)] = $related_results
+																							  instanceof
+																							  \WP_Error
+					? null
+					: $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	private function _remove_model_names_from_array($arr)
+	{
+		return array_diff($arr, array_keys(\EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param \EEM_Base        $model
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $rest_request
+	 * @return \stdClass the _calculations item in the entity
+	 */
+	protected function _get_entity_calculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explode_and_get_items_prefixed_with(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		//note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new \stdClass();
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				$calculated_fields_to_return->$field_to_calculate = Model_Data_Translator::prepare_field_value_for_json(
+					null,
+					$this->_fields_calculator->retrieve_calculated_field_value(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->get_model_version_info()->requested_version()
+				);
+			} catch (Rest_Exception $e) {
+				//if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->_set_response_header(
+					'Notices-Field-Calculation-Errors['
+					. $e->get_string_code()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					true
+				);
+			}
+		}
+		return $calculated_fields_to_return;
+	}
+
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 */
+	public function get_versioned_link_to($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			\EED_Core_Rest_Api::ee_api_namespace
+			. $this->get_model_version_info()->requested_version()
+			. '/'
+			. $link_part_after_version_and_slash
+		);
+	}
+
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                  $relation_name
+	 * @param \EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function get_related_entity_name($relation_name, $relation_obj)
+	{
+		if ($relation_obj instanceof \EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return \EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $request
+	 * @return array|\WP_Error
+	 */
+	public function get_entity_from_model($model, $request)
+	{
+		$query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params = $query_params;
+		$restricted_query_params['caps'] = $this->validate_context($request->get_param('caps'));
+		$this->_set_debug_info('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty ($model_rows)) {
+			return $this->create_entity_from_wpdb_result(
+				$model,
+				array_shift($model_rows),
+				$request);
+		} else {
+			//ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			$model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
+			if (! empty($model_rows_found_sans_restrictions)) {
+				//you got shafted- it existed but we didn't want to tell you!
+				return new \WP_Error(
+					'rest_user_cannot_read',
+					sprintf(
+						__('Sorry, you cannot read this %1$s. Missing permissions are: %2$s', 'event_espresso'),
+						strtolower($model->get_this_model_name()),
+						Capabilities::get_missing_permissions_string(
+							$model,
+							$this->validate_context($request->get_param('caps')))
+					),
+					array('status' => 403)
+				);
+			} else {
+				//it's not you. It just doesn't exist
+				return new \WP_Error(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					array('status' => 404)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validate_context($context)
+	{
+		if (! $context) {
+			$context = \EEM_Base::caps_read;
+		}
+		$valid_contexts = \EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return \EEM_Base::caps_read;
+		}
+	}
+
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validate_default_query_params($default_query_params)
+	{
+		$valid_default_where_conditions_for_api_calls = array(
+			\EEM_Base::default_where_conditions_all,
+			\EEM_Base::default_where_conditions_minimum_all,
+			\EEM_Base::default_where_conditions_minimum_others,
+		);
+		if (! $default_query_params) {
+			$default_query_params = \EEM_Base::default_where_conditions_all;
+		}
+		if (
+		in_array(
+			$default_query_params,
+			$valid_default_where_conditions_for_api_calls,
+			true
+		)
+		) {
+			return $default_query_params;
+		} else {
+			return \EEM_Base::default_where_conditions_all;
+		}
+	}
+
+
+
+	/**
+	 * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
+	 * Note: right now the query parameter keys for fields (and related fields)
+	 * can be left as-is, but it's quite possible this will change someday.
+	 * Also, this method's contents might be candidate for moving to Model_Data_Translator
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $query_parameters from $_GET parameter @see Read:handle_request_get_all
+	 * @return array like what EEM_Base::get_all() expects or FALSE to indicate
+	 *                                    that absolutely no results should be returned
+	 * @throws \EE_Error
+	 */
+	public function create_model_query_params($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = Model_Data_Translator::prepare_conditions_query_params_for_models(
+				$query_parameters['where'],
+				$model,
+				$this->get_model_version_info()->requested_version()
+			);
+		}
+		if (isset($query_parameters['order_by'])) {
+			$order_by = $query_parameters['order_by'];
+		} elseif (isset($query_parameters['orderby'])) {
+			$order_by = $query_parameters['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = Model_Data_Translator::prepare_field_names_in_array_keys_from_json($order_by);
+			} else {
+				//it's a single item
+				$order_by = Model_Data_Translator::prepare_field_name_from_json($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_parameters['group_by'])) {
+			$group_by = $query_parameters['group_by'];
+		} elseif (isset($query_parameters['groupby'])) {
+			$group_by = $query_parameters['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		//make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = Model_Data_Translator::prepare_field_names_from_json($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_models(
+				$query_parameters['having'],
+				$model,
+				$this->get_model_version_info()->requested_version()
+			);
+		}
+		if (isset($query_parameters['order'])) {
+			$model_query_params['order'] = $query_parameters['order'];
+		}
+		if (isset($query_parameters['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_parameters['limit'])) {
+			//limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_parameters['limit'])) {
+				$limit_array = explode(',', (string)$query_parameters['limit']);
+			} else {
+				$limit_array = $query_parameters['limit'];
+			}
+			$sanitized_limit = array();
+			foreach ($limit_array as $key => $limit_part) {
+				if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new \EE_Error(
+						sprintf(
+							__('An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								'event_espresso'),
+							wp_json_encode($query_parameters['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int)$limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_parameters['caps'])) {
+			$model_query_params['caps'] = $this->validate_context($query_parameters['caps']);
+		} else {
+			$model_query_params['caps'] = \EEM_Base::caps_read;
+		}
+		if (isset($query_parameters['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validate_default_query_params($query_parameters['default_where_conditions']);
+		}
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
+	}
+
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @deprecated
+	 * @param \EEM_Base $model
+	 * @param array     $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 */
+	public function prepare_rest_query_params_key_for_models($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[$key] = $this->prepare_rest_query_params_key_for_models($model, $value);
+			} else {
+				$model_ready_query_params[$key] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepare_rest_query_params_values_for_models($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[$key] = $this->prepare_rest_query_params_values_for_models($model, $value);
+			} else {
+				$model_ready_query_params[$key] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blaabla" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explode_and_get_items_prefixed_with($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} else if (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = array();
+		}
+		//if the string was empty, we want an empty array
+		$exploded_contents = array_filter($exploded_contents);
+		$contents_with_prefix = array();
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			//if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				//does this item have a period?
+				if (strpos($item, '.') === false) {
+					//if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} else if (strpos($item, $prefix . '.') === 0) {
+				//this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} else if ($item === $prefix) {
+				//this item is JUST the prefix
+				//so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+
+	/**
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 * Deprecated because its return values were really quite confusing- sometimes it returned
+	 * an empty array (when the include string was blank or '*') or sometimes it returned
+	 * array('*') (when you provided a model and a model of that kind was found).
+	 * Parses the $include_string so we fetch all the field names relating to THIS model
+	 * (ie have NO period in them), or for the provided model (ie start with the model
+	 * name and then a period).
+	 * @param string $include_string @see Read:handle_request_get_all
+	 * @param string $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                               the fields for that model, with the model's name removed from each.
+	 *                               If $include_string was blank or '*' returns an empty array
+	 */
+	public function extract_includes_for_this_model($include_string, $model_name = null)
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return array();
+		}
+		$includes = explode(',', $include_string);
+		$extracted_fields_to_include = array();
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					//found the model name at the exact start
+					$field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include == $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			//look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (
+					strpos($field_to_include, '.') === false
+					&& ! $this->get_model_version_info()->is_model_name_in_this_version($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
 }
 
 

Spacing +36 added lines, -36 removed lines

@@ -8,7 +8,7 @@ 
 use EventEspresso\core\entities\models\JsonModelSchema;
 use EE_Datetime_Field;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -57,12 +57,12 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)~',
                 array('version', 'model')
             );
             $controller->set_requested_version($matches['version']);
             $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -99,7 +99,7 @@ 
         $controller = new Read();
         try {
             $controller->set_requested_version($version);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
                 return array();
             }
             //get the model for this version
@@ -193,9 +193,9 @@ 
     protected function _maybe_add_extra_fields_to_schema($field_name, \EE_Model_Field_Base $field, array $schema)
     {
         if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][$field_name . '_gmt'] = $field->getSchema();
+            $schema['properties'][$field_name.'_gmt'] = $field->getSchema();
             //modify the description
-            $schema['properties'][$field_name . '_gmt']['description'] = sprintf(
+            $schema['properties'][$field_name.'_gmt']['description'] = sprintf(
                 esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
                 $field->get_nicename()
             );
@@ -236,11 +236,11 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)/(.*)~',
                 array('version', 'model', 'id'));
             $controller->set_requested_version($matches['version']);
             $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -278,12 +278,12 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)/(.*)/(.*)~',
                 array('version', 'model', 'id', 'related_model')
             );
             $controller->set_requested_version($matches['version']);
             $main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -298,11 +298,11 @@ 
             $main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
             //assume the related model name is plural and try to find the model's name
             $related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
                 //so the word didn't singularize well. Maybe that's just because it's a singular word?
                 $related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
             }
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -338,7 +338,7 @@ 
     public function get_entities_from_model($model, $request)
     {
         $query_params = $this->create_model_query_params($model, $request->get_params());
-        if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
+        if ( ! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
             $model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             return new \WP_Error(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -350,7 +350,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->_set_headers_from_query_params($model, $query_params);
         }
         /** @type array $results */
@@ -380,7 +380,7 @@ 
         $context = $this->validate_context($request->get_param('caps'));
         $model = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = array();
         }
         //check if they can access the 1st model object
@@ -431,7 +431,7 @@ 
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->_set_headers_from_query_params($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -483,7 +483,7 @@ 
      */
     public function get_entities_from_relation($id, $relation, $request)
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new \EE_Error(
                 sprintf(
                     __('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
@@ -520,7 +520,7 @@ 
         $this->_set_debug_info('missing caps',
             Capabilities::get_missing_permissions_string($model, $query_params['caps']));
         //normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -554,7 +554,7 @@ 
      */
     public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
     {
-        if (! $rest_request instanceof \WP_REST_Request) {
+        if ( ! $rest_request instanceof \WP_REST_Request) {
             //ok so this was called in the old style, where the 3rd arg was
             //$include, and the 4th arg was $context
             //now setup the request just to avoid fatal errors, although we won't be able
@@ -641,7 +641,7 @@ 
                 if ($field_value instanceof \DateTime) {
                     $timezone = $field_value->getTimezone();
                     $field_value->setTimezone(new \DateTimeZone('UTC'));
-                    $result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
+                    $result[$field_name.'_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
                         $field_obj,
                         $field_value,
                         $this->get_model_version_info()->requested_version()
@@ -719,7 +719,7 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
-                $links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
+                $links[\EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->get_versioned_link_to(
                             \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
@@ -754,13 +754,13 @@ 
         $db_row = array()
     ) {
         //if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
         //if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -935,7 +935,7 @@ 
         $restricted_query_params['caps'] = $this->validate_context($request->get_param('caps'));
         $this->_set_debug_info('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty ($model_rows)) {
+        if ( ! empty ($model_rows)) {
             return $this->create_entity_from_wpdb_result(
                 $model,
                 array_shift($model_rows),
@@ -944,7 +944,7 @@ 
             //ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
             $lowercase_model_name = strtolower($model->get_this_model_name());
             $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
+            if ( ! empty($model_rows_found_sans_restrictions)) {
                 //you got shafted- it existed but we didn't want to tell you!
                 return new \WP_Error(
                     'rest_user_cannot_read',
@@ -979,7 +979,7 @@ 
      */
     public function validate_context($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = \EEM_Base::caps_read;
         }
         $valid_contexts = \EEM_Base::valid_cap_contexts();
@@ -1005,7 +1005,7 @@ 
             \EEM_Base::default_where_conditions_minimum_all,
             \EEM_Base::default_where_conditions_minimum_others,
         );
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = \EEM_Base::default_where_conditions_all;
         }
         if (
@@ -1090,14 +1090,14 @@ 
         }
         if (isset($query_parameters['limit'])) {
             //limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string)$query_parameters['limit']);
+            if ( ! is_array($query_parameters['limit'])) {
+                $limit_array = explode(',', (string) $query_parameters['limit']);
             } else {
                 $limit_array = $query_parameters['limit'];
             }
             $sanitized_limit = array();
             foreach ($limit_array as $key => $limit_part) {
-                if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->_debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new \EE_Error(
                         sprintf(
                             __('An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
@@ -1106,7 +1106,7 @@ 
                         )
                     );
                 }
-                $sanitized_limit[] = (int)$limit_part;
+                $sanitized_limit[] = (int) $limit_part;
             }
             $model_query_params['limit'] = implode(',', $sanitized_limit);
         } else {
@@ -1194,17 +1194,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             //if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 //does this item have a period?
                 if (strpos($item, '.') === false) {
                     //if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } else if (strpos($item, $prefix . '.') === 0) {
+            } else if (strpos($item, $prefix.'.') === 0) {
                 //this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } else if ($item === $prefix) {
                 //this item is JUST the prefix
@@ -1244,9 +1244,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     //found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include == $model_name) {
                     $extracted_fields_to_include[] = '*';

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

Indentation +66 added lines, -66 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api\controllers\config;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -18,74 +18,74 @@ 
 class Read
 {
 
-    /**
-     * @param \WP_REST_Request $request
-     * @return \EE_Config|\WP_Error
-     */
-    public static function handle_request(\WP_REST_Request $request)
-    {
-        $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
+	 * @return \EE_Config|\WP_Error
+	 */
+	public static function handle_request(\WP_REST_Request $request)
+	{
+		$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
-     * @return \EE_Config|\WP_Error
-     */
-    public static function handle_request_site_info(\WP_REST_Request $request)
-    {
-        global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
-        $insecure_usage_of_basic_auth = apply_filters(
-            'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
-            $wp_json_basic_auth_success && ! is_ssl(),
-            $request
-        );
-        if ($insecure_usage_of_basic_auth) {
-            $warning = sprintf(
-                esc_html__('Your data is not secured with SSL. %1$sPlease see our recommendations.%2$s',
-                    'event_espresso'),
-                '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
-                '</a>'
-            );
-        } else {
-            $warning = '';
-        }
-        return 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
+	 * @return \EE_Config|\WP_Error
+	 */
+	public static function handle_request_site_info(\WP_REST_Request $request)
+	{
+		global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
+		$insecure_usage_of_basic_auth = apply_filters(
+			'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
+			$wp_json_basic_auth_success && ! is_ssl(),
+			$request
+		);
+		if ($insecure_usage_of_basic_auth) {
+			$warning = sprintf(
+				esc_html__('Your data is not secured with SSL. %1$sPlease see our recommendations.%2$s',
+					'event_espresso'),
+				'<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
+				'</a>'
+			);
+		} else {
+			$warning = '';
+		}
+		return 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
\ No newline at end of file

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace EventEspresso\core\libraries\rest_api\controllers\config;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -80,8 +80,8 @@ 
             ),
             '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,
+                'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
+                'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
                 'warning'                      => $warning
             )
         );

core/libraries/rest_api/changes/Changes_In_4_8_33.php

Indentation +49 added lines, -49 removed lines

@@ -7,60 +7,60 @@
 class Changes_In_4_8_33 extends Changes_In_Base
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function set_hooks()
-    {
-        //set a hook to remove the checkout/checkout endpoints if the request 
-        //is for lower than 4.8.33
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            array($this, 'remove_checkin_routes_earlier_than_4_8_33'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            array($this, 'dont_add_headers_from_ee_notices'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function set_hooks()
+	{
+		//set a hook to remove the checkout/checkout endpoints if the request 
+		//is for lower than 4.8.33
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			array($this, 'remove_checkin_routes_earlier_than_4_8_33'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			array($this, 'dont_add_headers_from_ee_notices'),
+			10,
+			2
+		);
+	}
 
 
 
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $routes_on_this_version
-     * @param string $version
-     * @return array like $routes_on_this_version
-     */
-    public function remove_checkin_routes_earlier_than_4_8_33($routes_on_this_version, $version)
-    {
-        if ($this->applies_to_version($version)) {
-            unset($routes_on_this_version['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)']);
-        }
-        return $routes_on_this_version;
-    }
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $routes_on_this_version
+	 * @param string $version
+	 * @return array like $routes_on_this_version
+	 */
+	public function remove_checkin_routes_earlier_than_4_8_33($routes_on_this_version, $version)
+	{
+		if ($this->applies_to_version($version)) {
+			unset($routes_on_this_version['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)']);
+		}
+		return $routes_on_this_version;
+	}
 
 
 
-    /**
-     * We just added headers for notices in this version
-     *
-     * @param array  $headers_from_ee_notices
-     * @param string $requested_version
-     * @return array
-     */
-    public function dont_add_headers_from_ee_notices($headers_from_ee_notices, $requested_version)
-    {
-        if ($this->applies_to_version($requested_version)) {
-            return array();
-        }
-        return $headers_from_ee_notices;
-    }
+	/**
+	 * We just added headers for notices in this version
+	 *
+	 * @param array  $headers_from_ee_notices
+	 * @param string $requested_version
+	 * @return array
+	 */
+	public function dont_add_headers_from_ee_notices($headers_from_ee_notices, $requested_version)
+	{
+		if ($this->applies_to_version($requested_version)) {
+			return array();
+		}
+		return $headers_from_ee_notices;
+	}
 }
 

modules/ticket_selector/TicketSelectorRowStandard.php

Indentation +398 added lines, -398 removed lines

@@ -19,404 +19,404 @@
 class TicketSelectorRowStandard extends TicketSelectorRow
 {
 
-    /**
-     * @var TicketDetails $ticket_details
-     */
-    protected $ticket_details;
-
-    /**
-     * @var \EE_Ticket_Selector_Config $template_settings
-     */
-    protected $template_settings;
-
-    /**
-     * @var \EE_Tax_Config $tax_settings
-     */
-    protected $tax_settings;
-
-    /**
-     * @var boolean $prices_displayed_including_taxes
-     */
-    protected $prices_displayed_including_taxes;
-
-    /**
-     * @var int $row
-     */
-    protected $row;
-
-    /**
-     * @var int $cols
-     */
-    protected $cols;
-
-    /**
-     * @var boolean $hidden_input_qty
-     */
-    protected $hidden_input_qty;
-
-    /**
-     * @var string $ticket_datetime_classes
-     */
-    protected $ticket_datetime_classes;
-
-
-
-    /**
-     * TicketDetails constructor.
-     *
-     * @param TicketDetails  $ticket_details
-     * @param \EE_Tax_Config $tax_settings
-     * @param int            $total_tickets
-     * @param int            $max_atndz
-     * @param int            $row
-     * @param int            $cols
-     * @param boolean        $required_ticket_sold_out
-     * @param string         $event_status
-     * @param string         $ticket_datetime_classes
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function __construct(
-        TicketDetails $ticket_details,
-        \EE_Tax_Config $tax_settings,
-        $total_tickets,
-        $max_atndz,
-        $row,
-        $cols,
-        $required_ticket_sold_out,
-        $event_status,
-        $ticket_datetime_classes
-    ) {
-        $this->ticket = $ticket_details->getTicket();
-        $this->ticket_details = $ticket_details;
-        $this->template_settings = $ticket_details->getTemplateSettings();
-        $this->tax_settings = $tax_settings;
-        $this->total_tickets = $total_tickets;
-        $this->max_atndz = $max_atndz;
-        $this->row = $row;
-        $this->cols = $cols;
-        $this->date_format = $ticket_details->getDateFormat();
-        $this->ticket_datetime_classes = $ticket_datetime_classes;
-        parent::__construct($this->ticket, $max_atndz, $this->date_format, $event_status, $required_ticket_sold_out);
-    }
-
-
-
-    /**
-     * other ticket rows will need to know if a required ticket is sold out,
-     * so that they are not offered for sale
-     *
-     * @return boolean
-     */
-    public function getRequiredTicketSoldOut()
-    {
-        return $this->required_ticket_sold_out;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getCols()
-    {
-        return $this->cols;
-    }
-
-
-
-    /**
-     * getHtml
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function getHtml()
-    {
-        $min = 0;
-        $max = $this->ticket->max();
-        $remaining = $this->ticket->remaining();
-        if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
-            list($min, $max) = $this->setTicketMinAndMax($remaining);
-        } else {
-            // set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
-            $this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
-                ? $this->ticket->start_date()
-                : $this->required_ticket_sold_out;
-        }
-        list($ticket_price, $ticket_bundle) = $this->getTicketPriceDetails();
-        list($tkt_status, $ticket_status, $status_class) = $this->getTicketStatusClasses($remaining);
-        /**
-         * Allow plugins to hook in and abort the generation and display of this row to do
-         * something else if they want.
-         * For an addon to abort things, all they have to do is register a filter with this hook, and
-         * return a value that is NOT false.  Whatever is returned gets echoed instead of the
-         * current row.
-         *
-         * @var string|bool
-         */
-        $ticket_selector_row_html = apply_filters(
-            'FHEE__ticket_selector_chart_template__do_ticket_entire_row',
-            false,
-            $this->ticket,
-            $max,
-            $min,
-            $this->required_ticket_sold_out,
-            $ticket_price,
-            $ticket_bundle,
-            $ticket_status,
-            $status_class
-        );
-        if ($ticket_selector_row_html !== false) {
-            return $ticket_selector_row_html;
-        }
-        $ticket_selector_row_html = \EEH_HTML::tr(
-            '', '',
-            "tckt-slctr-tbl-tr {$status_class}{$this->ticket_datetime_classes} " . espresso_get_object_css_class($this->ticket)
-        );
-        /**
-         * Allow plugins to hook in and abort the generation and display of the contents of this
-         * row to do something else if they want.
-         * For an addon to abort things, all they have to do is register a filter with this hook, and
-         * return a value that is NOT false.  Whatever is returned gets echoed instead of the
-         * current row.
-         *
-         * @var string|bool
-         */
-        $new_row_cells_content = apply_filters(
-            'FHEE__ticket_selector_chart_template__do_ticket_inside_row',
-            false,
-            $this->ticket,
-            $max,
-            $min,
-            $this->required_ticket_sold_out,
-            $ticket_price,
-            $ticket_bundle,
-            $ticket_status,
-            $status_class
-        );
-        if ($new_row_cells_content !== false && $this->max_atndz === 1) {
-            return $ticket_selector_row_html
-                   . $new_row_cells_content
-                   . $this->ticketQtyAndIdHiddenInputs()
-                   . \EEH_HTML::trx();
-        }
-        if ($new_row_cells_content !== false) {
-            return $ticket_selector_row_html
-                   . $new_row_cells_content
-                   . \EEH_HTML::trx();
-        }
-        $this->hidden_input_qty = $this->max_atndz > 1 ? true : false;
-
-        $ticket_selector_row_html .= $this->ticketNameTableCell();
-        $ticket_selector_row_html .= $this->ticketPriceTableCell($ticket_price, $ticket_bundle);
-        $ticket_selector_row_html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-qty cntr');
-        $this->setTicketStatusDisplay($tkt_status, $ticket_status, $remaining);
-        if (empty($this->ticket_status_display)) {
-            if ($this->max_atndz === 1) {
-                // only ONE attendee is allowed to register at a time
-                $ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
-            } else if ($max > 0) {
-                $ticket_selector_row_html .= $this->ticketQuantitySelector($min, $max);
-            }
-        }
-        $ticket_selector_row_html .= $this->ticket_status_display;
-        $ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
-        $ticket_selector_row_html .= $this->ticket_details->display($ticket_price, $remaining, $this->cols);
-        $ticket_selector_row_html .= \EEH_HTML::tdx();
-        $ticket_selector_row_html .= \EEH_HTML::trx();
-
-
-        $this->row++;
-        return $ticket_selector_row_html;
-    }
-
-
-
-    /**
-     * setTicketMinAndMax
-     *
-     * @param int $remaining
-     * @return array
-     * @throws EE_Error
-     */
-    protected function setTicketMinAndMax($remaining)
-    {
-        // offer the number of $tickets_remaining or $this->max_atndz, whichever is smaller
-        $max = min($remaining, $this->max_atndz);
-        // but... we also want to restrict the number of tickets by the ticket max setting,
-        // however, the max still can't be higher than what was just set above
-        $max = $this->ticket->max() > 0 ? min($this->ticket->max(), $max) : $max;
-        // and we also want to restrict the minimum number of tickets by the ticket min setting
-        $min = $this->ticket->min() > 0 ? $this->ticket->min() : 0;
-        // and if the ticket is required, then make sure that min qty is at least 1
-        $min = $this->ticket->required() ? max($min, 1) : $min;
-        return array($min, $max);
-    }
-
-
-
-    /**
-     * getTicketPriceDetails
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function getTicketPriceDetails()
-    {
-        $ticket_price = $this->tax_settings->prices_displayed_including_taxes
-            ? $this->ticket->get_ticket_total_with_taxes()
-            : $this->ticket->get_ticket_subtotal();
-        $ticket_bundle = false;
-        $ticket_min = $this->ticket->min();
-        // for ticket bundles, set min and max qty the same
-        if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
-            $ticket_price *= $ticket_min;
-            $ticket_bundle = true;
-        }
-        $ticket_price = apply_filters(
-            'FHEE__ticket_selector_chart_template__ticket_price',
-            $ticket_price,
-            $this->ticket
-        );
-        return array($ticket_price, $ticket_bundle);
-    }
-
-
-
-
-    /**
-     * ticketNameTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketNameTableCell()
-    {
-        $html = \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-name');
-        $html .= \EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
-        $html .= $this->ticket_details->getShowHideLinks();
-        if ($this->ticket->required()) {
-            $html .= \EEH_HTML::p(
-                    apply_filters(
-                            'FHEE__ticket_selector_chart_template__ticket_required_message',
-                            esc_html__('This ticket is required and must be purchased.', 'event_espresso')
-                    ),
-                    '', 'ticket-required-pg'
-            );
-        }
-        $html .= \EEH_HTML::tdx();
-        return $html;
-    }
-
-
-
-    /**
-     * ticketPriceTableCell
-     *
-     * @param float $ticket_price
-     * @param bool  $ticket_bundle
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketPriceTableCell($ticket_price, $ticket_bundle)
-    {
-        $html = '';
-        if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
-            $html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-price jst-rght');
-            $html .= \EEH_Template::format_currency($ticket_price);
-            $html .= $this->ticket->taxable()
-                ? \EEH_HTML::span( '*', '', 'taxable-tickets-asterisk grey-text' )
-                : '';
-            $html .= ' ';
-            $html .= \EEH_HTML::span(
-                $ticket_bundle
-                    ? apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
-                        __(' / bundle', 'event_espresso')
-                    )
-                    : apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_text',
-                        __('', 'event_espresso')
-                    ),
-                '', 'smaller-text no-bold'
-            );
-            $html .= ' ';
-            $html .= \EEH_HTML::tdx();
-            $this->cols++;
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * onlyOneAttendeeCanRegister
-     *
-     * @return string
-     */
-    protected function onlyOneAttendeeCanRegister()
-    {
-        // display submit button since we have tickets available
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        $this->hidden_input_qty = false;
-        $html = '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
-        $html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
-        $html .= ' title=""/>';
-        return $html;
-    }
-
-
-
-    /**
-     * ticketQuantitySelector
-     *
-     * @param int $min
-     * @param int $max
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketQuantitySelector($min = 0, $max = 0)
-    {
-        // display submit button since we have tickets available
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        $this->hidden_input_qty = false;
-        $html = '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct">';
-        // this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
-        if ($min !== 0 && ! $this->ticket->required()) {
-            $html .= '<option value="0">&nbsp;0&nbsp;</option>';
-        }
-        // offer ticket quantities from the min to the max
-        for ($i = $min; $i <= $max; $i++) {
-            $html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
-        }
-        $html .= '</select>';
-        return $html;
-    }
-
-
-
-    /**
-     * getHiddenInputs
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketQtyAndIdHiddenInputs()
-    {
-        $html = '';
-        // depending on group reg we need to change the format for qty
-        if ($this->hidden_input_qty) {
-            $html .= '<input type="hidden" name="tkt-slctr-qty-' . $this->EVT_ID . '[]" value="0"/>';
-        }
-        $html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
-        $html .= ' value="' . $this->ticket->ID() . '"/>';
-        return $html;
-    }
+	/**
+	 * @var TicketDetails $ticket_details
+	 */
+	protected $ticket_details;
+
+	/**
+	 * @var \EE_Ticket_Selector_Config $template_settings
+	 */
+	protected $template_settings;
+
+	/**
+	 * @var \EE_Tax_Config $tax_settings
+	 */
+	protected $tax_settings;
+
+	/**
+	 * @var boolean $prices_displayed_including_taxes
+	 */
+	protected $prices_displayed_including_taxes;
+
+	/**
+	 * @var int $row
+	 */
+	protected $row;
+
+	/**
+	 * @var int $cols
+	 */
+	protected $cols;
+
+	/**
+	 * @var boolean $hidden_input_qty
+	 */
+	protected $hidden_input_qty;
+
+	/**
+	 * @var string $ticket_datetime_classes
+	 */
+	protected $ticket_datetime_classes;
+
+
+
+	/**
+	 * TicketDetails constructor.
+	 *
+	 * @param TicketDetails  $ticket_details
+	 * @param \EE_Tax_Config $tax_settings
+	 * @param int            $total_tickets
+	 * @param int            $max_atndz
+	 * @param int            $row
+	 * @param int            $cols
+	 * @param boolean        $required_ticket_sold_out
+	 * @param string         $event_status
+	 * @param string         $ticket_datetime_classes
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function __construct(
+		TicketDetails $ticket_details,
+		\EE_Tax_Config $tax_settings,
+		$total_tickets,
+		$max_atndz,
+		$row,
+		$cols,
+		$required_ticket_sold_out,
+		$event_status,
+		$ticket_datetime_classes
+	) {
+		$this->ticket = $ticket_details->getTicket();
+		$this->ticket_details = $ticket_details;
+		$this->template_settings = $ticket_details->getTemplateSettings();
+		$this->tax_settings = $tax_settings;
+		$this->total_tickets = $total_tickets;
+		$this->max_atndz = $max_atndz;
+		$this->row = $row;
+		$this->cols = $cols;
+		$this->date_format = $ticket_details->getDateFormat();
+		$this->ticket_datetime_classes = $ticket_datetime_classes;
+		parent::__construct($this->ticket, $max_atndz, $this->date_format, $event_status, $required_ticket_sold_out);
+	}
+
+
+
+	/**
+	 * other ticket rows will need to know if a required ticket is sold out,
+	 * so that they are not offered for sale
+	 *
+	 * @return boolean
+	 */
+	public function getRequiredTicketSoldOut()
+	{
+		return $this->required_ticket_sold_out;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getCols()
+	{
+		return $this->cols;
+	}
+
+
+
+	/**
+	 * getHtml
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getHtml()
+	{
+		$min = 0;
+		$max = $this->ticket->max();
+		$remaining = $this->ticket->remaining();
+		if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
+			list($min, $max) = $this->setTicketMinAndMax($remaining);
+		} else {
+			// set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
+			$this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
+				? $this->ticket->start_date()
+				: $this->required_ticket_sold_out;
+		}
+		list($ticket_price, $ticket_bundle) = $this->getTicketPriceDetails();
+		list($tkt_status, $ticket_status, $status_class) = $this->getTicketStatusClasses($remaining);
+		/**
+		 * Allow plugins to hook in and abort the generation and display of this row to do
+		 * something else if they want.
+		 * For an addon to abort things, all they have to do is register a filter with this hook, and
+		 * return a value that is NOT false.  Whatever is returned gets echoed instead of the
+		 * current row.
+		 *
+		 * @var string|bool
+		 */
+		$ticket_selector_row_html = apply_filters(
+			'FHEE__ticket_selector_chart_template__do_ticket_entire_row',
+			false,
+			$this->ticket,
+			$max,
+			$min,
+			$this->required_ticket_sold_out,
+			$ticket_price,
+			$ticket_bundle,
+			$ticket_status,
+			$status_class
+		);
+		if ($ticket_selector_row_html !== false) {
+			return $ticket_selector_row_html;
+		}
+		$ticket_selector_row_html = \EEH_HTML::tr(
+			'', '',
+			"tckt-slctr-tbl-tr {$status_class}{$this->ticket_datetime_classes} " . espresso_get_object_css_class($this->ticket)
+		);
+		/**
+		 * Allow plugins to hook in and abort the generation and display of the contents of this
+		 * row to do something else if they want.
+		 * For an addon to abort things, all they have to do is register a filter with this hook, and
+		 * return a value that is NOT false.  Whatever is returned gets echoed instead of the
+		 * current row.
+		 *
+		 * @var string|bool
+		 */
+		$new_row_cells_content = apply_filters(
+			'FHEE__ticket_selector_chart_template__do_ticket_inside_row',
+			false,
+			$this->ticket,
+			$max,
+			$min,
+			$this->required_ticket_sold_out,
+			$ticket_price,
+			$ticket_bundle,
+			$ticket_status,
+			$status_class
+		);
+		if ($new_row_cells_content !== false && $this->max_atndz === 1) {
+			return $ticket_selector_row_html
+				   . $new_row_cells_content
+				   . $this->ticketQtyAndIdHiddenInputs()
+				   . \EEH_HTML::trx();
+		}
+		if ($new_row_cells_content !== false) {
+			return $ticket_selector_row_html
+				   . $new_row_cells_content
+				   . \EEH_HTML::trx();
+		}
+		$this->hidden_input_qty = $this->max_atndz > 1 ? true : false;
+
+		$ticket_selector_row_html .= $this->ticketNameTableCell();
+		$ticket_selector_row_html .= $this->ticketPriceTableCell($ticket_price, $ticket_bundle);
+		$ticket_selector_row_html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-qty cntr');
+		$this->setTicketStatusDisplay($tkt_status, $ticket_status, $remaining);
+		if (empty($this->ticket_status_display)) {
+			if ($this->max_atndz === 1) {
+				// only ONE attendee is allowed to register at a time
+				$ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
+			} else if ($max > 0) {
+				$ticket_selector_row_html .= $this->ticketQuantitySelector($min, $max);
+			}
+		}
+		$ticket_selector_row_html .= $this->ticket_status_display;
+		$ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
+		$ticket_selector_row_html .= $this->ticket_details->display($ticket_price, $remaining, $this->cols);
+		$ticket_selector_row_html .= \EEH_HTML::tdx();
+		$ticket_selector_row_html .= \EEH_HTML::trx();
+
+
+		$this->row++;
+		return $ticket_selector_row_html;
+	}
+
+
+
+	/**
+	 * setTicketMinAndMax
+	 *
+	 * @param int $remaining
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function setTicketMinAndMax($remaining)
+	{
+		// offer the number of $tickets_remaining or $this->max_atndz, whichever is smaller
+		$max = min($remaining, $this->max_atndz);
+		// but... we also want to restrict the number of tickets by the ticket max setting,
+		// however, the max still can't be higher than what was just set above
+		$max = $this->ticket->max() > 0 ? min($this->ticket->max(), $max) : $max;
+		// and we also want to restrict the minimum number of tickets by the ticket min setting
+		$min = $this->ticket->min() > 0 ? $this->ticket->min() : 0;
+		// and if the ticket is required, then make sure that min qty is at least 1
+		$min = $this->ticket->required() ? max($min, 1) : $min;
+		return array($min, $max);
+	}
+
+
+
+	/**
+	 * getTicketPriceDetails
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function getTicketPriceDetails()
+	{
+		$ticket_price = $this->tax_settings->prices_displayed_including_taxes
+			? $this->ticket->get_ticket_total_with_taxes()
+			: $this->ticket->get_ticket_subtotal();
+		$ticket_bundle = false;
+		$ticket_min = $this->ticket->min();
+		// for ticket bundles, set min and max qty the same
+		if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
+			$ticket_price *= $ticket_min;
+			$ticket_bundle = true;
+		}
+		$ticket_price = apply_filters(
+			'FHEE__ticket_selector_chart_template__ticket_price',
+			$ticket_price,
+			$this->ticket
+		);
+		return array($ticket_price, $ticket_bundle);
+	}
+
+
+
+
+	/**
+	 * ticketNameTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketNameTableCell()
+	{
+		$html = \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-name');
+		$html .= \EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
+		$html .= $this->ticket_details->getShowHideLinks();
+		if ($this->ticket->required()) {
+			$html .= \EEH_HTML::p(
+					apply_filters(
+							'FHEE__ticket_selector_chart_template__ticket_required_message',
+							esc_html__('This ticket is required and must be purchased.', 'event_espresso')
+					),
+					'', 'ticket-required-pg'
+			);
+		}
+		$html .= \EEH_HTML::tdx();
+		return $html;
+	}
+
+
+
+	/**
+	 * ticketPriceTableCell
+	 *
+	 * @param float $ticket_price
+	 * @param bool  $ticket_bundle
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketPriceTableCell($ticket_price, $ticket_bundle)
+	{
+		$html = '';
+		if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
+			$html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-price jst-rght');
+			$html .= \EEH_Template::format_currency($ticket_price);
+			$html .= $this->ticket->taxable()
+				? \EEH_HTML::span( '*', '', 'taxable-tickets-asterisk grey-text' )
+				: '';
+			$html .= '&nbsp;';
+			$html .= \EEH_HTML::span(
+				$ticket_bundle
+					? apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
+						__(' / bundle', 'event_espresso')
+					)
+					: apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_text',
+						__('', 'event_espresso')
+					),
+				'', 'smaller-text no-bold'
+			);
+			$html .= '&nbsp;';
+			$html .= \EEH_HTML::tdx();
+			$this->cols++;
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * onlyOneAttendeeCanRegister
+	 *
+	 * @return string
+	 */
+	protected function onlyOneAttendeeCanRegister()
+	{
+		// display submit button since we have tickets available
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		$this->hidden_input_qty = false;
+		$html = '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
+		$html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
+		$html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
+		$html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
+		$html .= ' title=""/>';
+		return $html;
+	}
+
+
+
+	/**
+	 * ticketQuantitySelector
+	 *
+	 * @param int $min
+	 * @param int $max
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketQuantitySelector($min = 0, $max = 0)
+	{
+		// display submit button since we have tickets available
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		$this->hidden_input_qty = false;
+		$html = '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
+		$html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
+		$html .= ' class="ticket-selector-tbl-qty-slct">';
+		// this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
+		if ($min !== 0 && ! $this->ticket->required()) {
+			$html .= '<option value="0">&nbsp;0&nbsp;</option>';
+		}
+		// offer ticket quantities from the min to the max
+		for ($i = $min; $i <= $max; $i++) {
+			$html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
+		}
+		$html .= '</select>';
+		return $html;
+	}
+
+
+
+	/**
+	 * getHiddenInputs
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketQtyAndIdHiddenInputs()
+	{
+		$html = '';
+		// depending on group reg we need to change the format for qty
+		if ($this->hidden_input_qty) {
+			$html .= '<input type="hidden" name="tkt-slctr-qty-' . $this->EVT_ID . '[]" value="0"/>';
+		}
+		$html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
+		$html .= ' value="' . $this->ticket->ID() . '"/>';
+		return $html;
+	}
 
 }
 // End of file TicketSelectorRowStandard.php

core/libraries/rest_api/controllers/rpc/Checkin.php

Indentation +110 added lines, -110 removed lines

@@ -14,7 +14,7 @@ 
 use EventEspresso\core\libraries\rest_api\controllers\model\Read;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -31,116 +31,116 @@ 
 class Checkin extends Base
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @return WP_Error|WP_REST_Response
-     */
-    public static function handle_request_toggle_checkin(WP_REST_Request $request)
-    {
-        $controller = new Checkin();
-        return $controller->_create_checkin_checkout_object($request);
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @return WP_Error|WP_REST_Response
+	 */
+	public static function handle_request_toggle_checkin(WP_REST_Request $request)
+	{
+		$controller = new Checkin();
+		return $controller->_create_checkin_checkout_object($request);
+	}
 
 
 
-    /**
-     * Toggles whether the user is checked in or not.
-     *
-     * @param WP_REST_Request $request
-     * @return WP_Error|WP_REST_Response
-     */
-    protected function _create_checkin_checkout_object(WP_REST_Request $request)
-    {
-        $reg_id = $request->get_param('REG_ID');
-        $dtt_id = $request->get_param('DTT_ID');
-        $force = $request->get_param('force');
-        if ($force == 'true') {
-            $force = true;
-        } else {
-            $force = false;
-        }
-        $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
-            return $this->send_response(
-                new WP_Error(
-                    'rest_registration_toggle_checkin_invalid_id',
-                    sprintf(
-                        __('You cannot checkin registration with ID %1$s because it doesn\'t exist.',
-                            'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 422)
-                )
-            );
-        }
-        if (! EE_Capabilities::instance()
-                             ->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)
-        ) {
-            return $this->send_response(
-                new WP_Error(
-                    'rest_user_cannot_toggle_checkin',
-                    sprintf(
-                        __('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 403)
-                )
-            );
-        }
-        $success = $reg->toggle_checkin_status($dtt_id, ! $force);
-        if ($success === false) {
-            //check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
-                //rely on EE_Error::add_error messages to have been added to give more data about why it failed
-                return $this->send_response(
-                    new WP_Error(
-                        'rest_toggle_checkin_failed',
-                        __('Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
-                            'event_espresso')
-                    )
-                );
-            }
-            return $this->send_response(
-                new WP_Error(
-                    'rest_toggle_checkin_failed_not_forceable',
-                    __('Registration checkin failed. Please see additional error data.', 'event_espresso')
-                )
-            );
-        }
-        $checkin = EEM_Checkin::instance()->get_one(
-            array(
-                array(
-                    'REG_ID' => $reg_id,
-                    'DTT_ID' => $dtt_id,
-                ),
-                'order_by' => array(
-                    'CHK_timestamp' => 'DESC',
-                ),
-            )
-        );
-        if (! $checkin instanceof EE_Checkin) {
-            return $this->send_response(
-                new WP_Error(
-                    'rest_toggle_checkin_error',
-                    sprintf(
-                        __('Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
-                            'event_espresso'),
-                        $reg_id,
-                        $dtt_id
-                    )
-                )
-            );
-        }
-        $requested_version = $this->get_requested_version($request->get_route());
-        $get_request = new WP_REST_Request(
-            'GET',
-            EED_Core_Rest_Api::ee_api_namespace . $requested_version . '/checkins/' . $checkin->ID()
-        );
-        $get_request->set_url_params(
-            array(
-                'id' => $checkin->ID(),
-            )
-        );
-        return Read::handle_request_get_one($get_request);
-    }
+	/**
+	 * Toggles whether the user is checked in or not.
+	 *
+	 * @param WP_REST_Request $request
+	 * @return WP_Error|WP_REST_Response
+	 */
+	protected function _create_checkin_checkout_object(WP_REST_Request $request)
+	{
+		$reg_id = $request->get_param('REG_ID');
+		$dtt_id = $request->get_param('DTT_ID');
+		$force = $request->get_param('force');
+		if ($force == 'true') {
+			$force = true;
+		} else {
+			$force = false;
+		}
+		$reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $reg instanceof EE_Registration) {
+			return $this->send_response(
+				new WP_Error(
+					'rest_registration_toggle_checkin_invalid_id',
+					sprintf(
+						__('You cannot checkin registration with ID %1$s because it doesn\'t exist.',
+							'event_espresso'),
+						$reg_id
+					),
+					array('status' => 422)
+				)
+			);
+		}
+		if (! EE_Capabilities::instance()
+							 ->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)
+		) {
+			return $this->send_response(
+				new WP_Error(
+					'rest_user_cannot_toggle_checkin',
+					sprintf(
+						__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
+						$reg_id
+					),
+					array('status' => 403)
+				)
+			);
+		}
+		$success = $reg->toggle_checkin_status($dtt_id, ! $force);
+		if ($success === false) {
+			//check if we know they can't check in because they're not approved and we aren't forcing
+			if (! $reg->is_approved() && ! $force) {
+				//rely on EE_Error::add_error messages to have been added to give more data about why it failed
+				return $this->send_response(
+					new WP_Error(
+						'rest_toggle_checkin_failed',
+						__('Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
+							'event_espresso')
+					)
+				);
+			}
+			return $this->send_response(
+				new WP_Error(
+					'rest_toggle_checkin_failed_not_forceable',
+					__('Registration checkin failed. Please see additional error data.', 'event_espresso')
+				)
+			);
+		}
+		$checkin = EEM_Checkin::instance()->get_one(
+			array(
+				array(
+					'REG_ID' => $reg_id,
+					'DTT_ID' => $dtt_id,
+				),
+				'order_by' => array(
+					'CHK_timestamp' => 'DESC',
+				),
+			)
+		);
+		if (! $checkin instanceof EE_Checkin) {
+			return $this->send_response(
+				new WP_Error(
+					'rest_toggle_checkin_error',
+					sprintf(
+						__('Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
+							'event_espresso'),
+						$reg_id,
+						$dtt_id
+					)
+				)
+			);
+		}
+		$requested_version = $this->get_requested_version($request->get_route());
+		$get_request = new WP_REST_Request(
+			'GET',
+			EED_Core_Rest_Api::ee_api_namespace . $requested_version . '/checkins/' . $checkin->ID()
+		);
+		$get_request->set_url_params(
+			array(
+				'id' => $checkin->ID(),
+			)
+		);
+		return Read::handle_request_get_one($get_request);
+	}
 }
\ No newline at end of file

Spacing +6 added lines, -6 removed lines

@@ -13,7 +13,7 @@ 
 use EventEspresso\core\libraries\rest_api\controllers\Base as Base;
 use EventEspresso\core\libraries\rest_api\controllers\model\Read;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -60,7 +60,7 @@ 
             $force = false;
         }
         $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
+        if ( ! $reg instanceof EE_Registration) {
             return $this->send_response(
                 new WP_Error(
                     'rest_registration_toggle_checkin_invalid_id',
@@ -73,7 +73,7 @@ 
                 )
             );
         }
-        if (! EE_Capabilities::instance()
+        if ( ! EE_Capabilities::instance()
                              ->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)
         ) {
             return $this->send_response(
@@ -90,7 +90,7 @@ 
         $success = $reg->toggle_checkin_status($dtt_id, ! $force);
         if ($success === false) {
             //check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
+            if ( ! $reg->is_approved() && ! $force) {
                 //rely on EE_Error::add_error messages to have been added to give more data about why it failed
                 return $this->send_response(
                     new WP_Error(
@@ -118,7 +118,7 @@ 
                 ),
             )
         );
-        if (! $checkin instanceof EE_Checkin) {
+        if ( ! $checkin instanceof EE_Checkin) {
             return $this->send_response(
                 new WP_Error(
                     'rest_toggle_checkin_error',
@@ -134,7 +134,7 @@ 
         $requested_version = $this->get_requested_version($request->get_route());
         $get_request = new WP_REST_Request(
             'GET',
-            EED_Core_Rest_Api::ee_api_namespace . $requested_version . '/checkins/' . $checkin->ID()
+            EED_Core_Rest_Api::ee_api_namespace.$requested_version.'/checkins/'.$checkin->ID()
         );
         $get_request->set_url_params(
             array(

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Indentation +608 added lines, -608 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -28,616 +28,616 @@ 
 class EE_Transaction_Shortcodes extends EE_Shortcodes
 {
 
-    /**
-     * @var EE_Payment_Method $_invoice_pm the invoiec payment method for use in invoices etc
-     */
-    protected $_invoice_pm;
-
-
-
-    /**
-     * EE_Transaction_Shortcodes constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
-            '[PAYMENT_URL]'                     => esc_html__('This is a link to make a payment for the event',
-                'event_espresso'),
-            '[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__('This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
-                    'event_espresso')
-                                                   . '<ul>'
-                                                   . '<li>'
-                                                   . sprintf(esc_html__('%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
-                    'event_espresso'), '<strong>', '</strong>')
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(esc_html__('%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
-                    'event_espresso'), '<strong>', '</strong>')
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(esc_html__('%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
-                    'event_espresso'), '<strong>', '</strong>')
-                                                   . '</li>'
-                                                   . '</ul>',
-            '[PAYMENT_DUE_DATE_*]'              => esc_html__('This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
-                    'event_espresso')
-                                                   . '<ul>'
-                                                   . '<li>'
-                                                   . sprintf(esc_html__('%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
-                    'event_espresso'), '<strong>', '</strong>')
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(esc_html__('%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
-                    'event_espresso'), '<strong>', '</strong>')
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(esc_html__('%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
-                    'event_espresso'), '<strong>', '</strong>')
-                                                   . '</li>',
-            '[INVOICE_LINK]'                    => esc_html__('This is a full html link to the invoice',
-                'event_espresso'),
-            '[INVOICE_URL]'                     => esc_html__('This is just the url for the invoice', 'event_espresso'),
-            '[INVOICE_LOGO_URL]'                => esc_html__('This returns the url for the logo uploaded via the invoice settings page.',
-                'event_espresso'),
-            '[INVOICE_LOGO]'                    => esc_html__('This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
-                'event_espresso'),
-            '[INVOICE_PAYEE_NAME]'              => esc_html__('This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'),
-            '[INVOICE_PAYEE_ADDRESS]'           => esc_html__('This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'),
-            '[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__('This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
-                'event_espresso'),
-            '[INVOICE_PAYEE_EMAIL]'             => esc_html__('This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'),
-            '[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(esc_html__('This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
-                'event_espresso'), '<code>', '</code>'),
-            '[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
-            '[TXN_STATUS]'                      => esc_html__('The transaction status for the transaction.',
-                'event_espresso'),
-            '[TXN_STATUS_ID]'                   => esc_html__('The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
-                'event_espresso'),
-            '[PAYMENT_STATUS]'                  => esc_html__('The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
-                'event_espresso'),
-            '[PAYMENT_GATEWAY]'                 => esc_html__('The payment gateway used for the transaction',
-                'event_espresso'),
-            '[AMOUNT_PAID]'                     => esc_html__('The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
-                'event_espresso'),
-            '[LAST_AMOUNT_PAID]'                => esc_html__('This is the last payment or refund made on the transaction related to the message being generated.',
-                'event_espresso'),
-            '[TOTAL_AMOUNT_PAID]'               => esc_html__('This parses to the total amount paid over all payments',
-                'event_espresso'),
-            '[TOTAL_OWING]'                     => esc_html__('The total owing on a transaction with no attributes.',
-                'event_espresso'),
-            '[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
-            '[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
-            '[OWING_STATUS_MESSAGE_*]'          => esc_html__('A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
-                    'event_espresso')
-                                                   . '<p></ul>'
-                                                   .
-                                                   '<li><strong>still_owing</strong>:'
-                                                   . esc_html__('If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
-                    'event_espresso')
-                                                   . sprintf(esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                    '<a href="[PAYMENT_URL]" class="noPrint">', '</a>')
-                                                   . '</li>'
-                                                   .
-                                                   '<li><strong>none_owing</strong>:'
-                                                   . esc_html__('If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
-                    'event_espresso')
-                                                   . '</li></ul></p>',
-            '[TXN_TOTAL_TICKETS]'               => esc_html__('The total number of all tickets purchased in a transaction',
-                'event_espresso'),
-            '[TKT_QTY_PURCHASED]'               => sprintf(esc_html__('The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
-                'event_espresso'), '<strong>', '</strong>'),
-            '[TRANSACTION_ADMIN_URL]'           => esc_html__('The url to the admin page for this transaction',
-                'event_espresso'),
-            '[RECEIPT_URL]'                     => esc_html__('This parses to the generated url for retrieving the receipt for the transaction',
-                'event_espresso'),
-            '[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__('This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
-                'event_espresso'),
-            '[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(esc_html__('The same as %1$s[INVOICE_RECEIPT_SWITCHER_URL]%2$s except this returns the html for a button linked to the invoice or receipt.',
-                'event_espresso'), '<code>', '</code>'),
-        );
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     */
-    protected function _parser($shortcode)
-    {
-        //attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the _extra_data for the transaction.
-        $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-        $transaction = ! $transaction instanceof EE_Transaction
-                       && is_array($this->_extra_data)
-                       && isset($this->_extra_data['data'])
-                       && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->txn
-            : $transaction;
-        //payment
-        $payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
-        $payment = ! $payment instanceof EE_Payment
-                   && is_array($this->_extra_data)
-                   && isset($this->_extra_data['data'])
-                   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
-            : $payment;
-        if (! $transaction instanceof EE_Transaction) {
-            return '';
-        }
-        switch ($shortcode) {
-            case '[TXN_ID]' :
-                return $transaction->ID();
-                break;
-            case '[PAYMENT_URL]' :
-                $payment_url = $transaction->payment_overview_url();
-                return empty($payment_url) ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
-                    : $payment_url;
-                break;
-            case '[INVOICE_LINK]' :
-                $invoice_url = $transaction->invoice_url();
-                $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                return sprintf(esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">', '</a>');
-                break; /**/
-            case '[INVOICE_URL]' :
-                $invoice_url = $transaction->invoice_url();
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                break;
-            case '[INVOICE_LOGO_URL]' :
-                return $this->_get_invoice_logo();
-                break;
-            case '[INVOICE_LOGO]' :
-                return $this->_get_invoice_logo(true);
-                break;
-            case '[INVOICE_PAYEE_NAME]' :
-                return $this->_get_invoice_payee_name();
-                break;
-            case '[INVOICE_PAYEE_ADDRESS]' :
-                return $this->_get_invoice_payee_address();
-                break;
-            case '[INVOICE_PAYMENT_INSTRUCTIONS]' :
-                return $this->_get_invoice_payment_instructions();
-                break;
-            case '[INVOICE_PAYEE_EMAIL]' :
-                return $this->_get_invoice_payee_email();
-                break;
-            case '[TOTAL_COST]' :
-                $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total) : '';
-                break;
-            case '[PAYMENT_STATUS]' :
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break; /**/
-            // note the [payment_status] shortcode is kind of misleading because payment status might be different from txn status so I'm adding this here for clarity.
-            case '[TXN_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break;
-            case '[TXN_STATUS_ID]' :
-                return $transaction->status_ID();
-                break;
-            case '[PAYMENT_GATEWAY]' :
-                return $this->_get_payment_gateway($transaction);
-                break;
-            case '[AMOUNT_PAID]' :
-                return $payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($payment->amount())
-                    : EEH_Template::format_currency(0);
-                break;
-            case '[LAST_AMOUNT_PAID]' :
-                $last_payment = $transaction->last_payment();
-                return $last_payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($last_payment->amount())
-                    : EEH_Template::format_currency(0);
-            case '[TOTAL_AMOUNT_PAID]' :
-                return EEH_Template::format_currency($transaction->paid());
-                break;
-            case '[TOTAL_OWING]' :
-                $total_owing = $transaction->remaining();
-                return EEH_Template::format_currency($total_owing);
-                break;
-            case '[TXN_SUBTOTAL]' :
-                return EEH_Template::format_currency($this->_get_subtotal());
-                break;
-            case '[TXN_TAX_SUBTOTAL]' :
-                return EEH_Template::format_currency($this->_get_subtotal(true));
-                break;
-            case '[TKT_QTY_PURCHASED]' :
-            case '[TXN_TOTAL_TICKETS]' :
-                return $this->_data->total_ticket_count;
-                break;
-            case '[TRANSACTION_ADMIN_URL]' :
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-                $query_args = array(
-                    'page'   => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $transaction->ID(),
-                );
-                $url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
-                return $url;
-                break;
-            case '[RECEIPT_URL]' :
-                //get primary_registration
-                $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
-                    return '';
-                }
-                return $reg->receipt_url();
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_URL]' :
-                return $this->_get_invoice_receipt_switcher(false);
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_BUTTON]' :
-                return $this->_get_invoice_receipt_switcher();
-                break;
-        }
-        if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
-            return $this->_get_custom_total_owing($shortcode);
-        }
-        if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
-            return $this->_get_invoice_payee_tax_number($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
-            return $this->_get_payment_link_if_needed($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
-            return $this->_get_payment_due_date($shortcode, $transaction);
-        }
-        return '';
-    }
-
-
-
-    /**
-     * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     */
-    private function _get_custom_total_owing($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        //ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $owing_content = ! empty($attrs['still_owing'])
-                ? $attrs['still_owing']
-                : sprintf(esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                    '<a href="[PAYMENT_URL]" class="noPrint">', '</a>');
-            $owing_content = $this->_shortcode_helper->parse_message_template($owing_content, $addressee,
-                $valid_shortcodes, $this->_message_type, $this->_messenger, $this->_message);
-        } else {
-            $owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
-        }
-        return $owing_content;
-    }
-
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return string
-     */
-    private function _get_payment_gateway($transaction)
-    {
-        if($transaction instanceof EE_Transaction){
-            $pm = $transaction->payment_method();
-        } else {
-            $pm = null;
-        }
-        return $pm instanceof EE_Payment_Method ? $pm->name() : '';
-    }
-
-
-
-    /**
-     * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
-     * not present then the organization logo is used if its found (set on the organization settings page).
-     *
-     * @since 4.5.0
-     * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
-     * @return string url or html
-     */
-    private function _get_invoice_logo($img_tags = false)
-    {
-        //try to get the invoice payment method's logo for this transaction image first
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
-        } else {
-            $invoice_logo_url = null;
-        }
-        if (empty($invoice_logo_url)) {
-            $invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
-        }
-        if (empty($invoice_logo_url)) {
-            return '';
-        }
-        if (! $img_tags) {
-            return $invoice_logo_url;
-        }
-        //image tags have been requested.
-        $image_size = getimagesize($invoice_logo_url);
-        //if image is wider than 300px, set the width to 300
-        if ($image_size[0] > 300) {
-            $image_width = 300;
-        } else {
-            $image_width = $image_size[0];
-        }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
-    }
-
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    private function _get_invoice_payee_name()
-    {
-        $payee_name = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_name = $pm->get_extra_meta('pdf_payee_name', true);
-        }
-        $payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
-        return $payee_name;
-    }
-
-
-
-    /**
-     * gets the default invoice payment method, but has a filter so it can be overridden
-     *
-     * @return \EE_Payment_Method|null
-     */
-    private function _get_invoice_payment_method()
-    {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
-            $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-            $transaction = ! $transaction instanceof EE_Transaction
-                           && is_array($this->_extra_data)
-                           && isset($this->_extra_data['data'])
-                           && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->txn : $transaction;
-            //get the invoice payment method, and remember it for the next call too
-            $this->_invoice_pm = apply_filters('FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
-                EEM_Payment_Method::instance()->get_one_of_type('Invoice'), $transaction);
-        }
-        return $this->_invoice_pm;
-    }
-
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee email shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    private function _get_invoice_payee_email()
-    {
-        $payee_email = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_email = $pm->get_extra_meta('pdf_payee_email', true);
-        }
-        $payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
-            : $payee_email;
-        return $payee_email;
-    }
-
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee tax number shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode
-     * @return string
-     */
-    private function _get_invoice_payee_tax_number($shortcode)
-    {
-        $payee_tax_number = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
-        }
-        $payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
-            : $payee_tax_number;
-        if (empty($payee_tax_number)) {
-            return '';
-        }
-        //any attributes?
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        //prefix?
-        $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
-    }
-
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee address shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    private function _get_invoice_payee_address()
-    {
-        $payee_address = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_address = $pm->get_extra_meta('pdf_payee_address', true);
-        }
-        if (empty($payee_address)) {
-            $organization = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
-            $payee_address .= ! empty($organization->address_2) ? $organization->get_pretty('address_2') . '<br>' : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
-            //state
-            $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
-            $payee_address .= $state instanceof EE_State ? $state->name() : '';
-            //Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
-            $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
-        }
-        return $payee_address;
-    }
-
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    private function _get_invoice_payment_instructions()
-    {
-        $instructions = null;
-        $pm = $this->_get_invoice_payment_method();
-        return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
-    }
-
-
-
-    /**
-     * get invoice/receipt switch button or url.
-     *
-     * @param bool $button true (default) returns the html for a button, false just returns the url.
-     * @return string
-     */
-    protected function _get_invoice_receipt_switcher($button = true)
-    {
-        $reg = $this->_data->primary_reg_obj;
-        $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
-            return '';
-        }
-        $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
-        $switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
-            ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
-        $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
-        $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
-            return $switch_to_url;
-        }
-        if (! empty($switch_to_url)) {
-            return '
+	/**
+	 * @var EE_Payment_Method $_invoice_pm the invoiec payment method for use in invoices etc
+	 */
+	protected $_invoice_pm;
+
+
+
+	/**
+	 * EE_Transaction_Shortcodes constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
+			'[PAYMENT_URL]'                     => esc_html__('This is a link to make a payment for the event',
+				'event_espresso'),
+			'[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__('This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
+					'event_espresso')
+												   . '<ul>'
+												   . '<li>'
+												   . sprintf(esc_html__('%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
+					'event_espresso'), '<strong>', '</strong>')
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(esc_html__('%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
+					'event_espresso'), '<strong>', '</strong>')
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(esc_html__('%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
+					'event_espresso'), '<strong>', '</strong>')
+												   . '</li>'
+												   . '</ul>',
+			'[PAYMENT_DUE_DATE_*]'              => esc_html__('This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
+					'event_espresso')
+												   . '<ul>'
+												   . '<li>'
+												   . sprintf(esc_html__('%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
+					'event_espresso'), '<strong>', '</strong>')
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(esc_html__('%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
+					'event_espresso'), '<strong>', '</strong>')
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(esc_html__('%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
+					'event_espresso'), '<strong>', '</strong>')
+												   . '</li>',
+			'[INVOICE_LINK]'                    => esc_html__('This is a full html link to the invoice',
+				'event_espresso'),
+			'[INVOICE_URL]'                     => esc_html__('This is just the url for the invoice', 'event_espresso'),
+			'[INVOICE_LOGO_URL]'                => esc_html__('This returns the url for the logo uploaded via the invoice settings page.',
+				'event_espresso'),
+			'[INVOICE_LOGO]'                    => esc_html__('This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
+				'event_espresso'),
+			'[INVOICE_PAYEE_NAME]'              => esc_html__('This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'),
+			'[INVOICE_PAYEE_ADDRESS]'           => esc_html__('This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'),
+			'[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__('This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
+				'event_espresso'),
+			'[INVOICE_PAYEE_EMAIL]'             => esc_html__('This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'),
+			'[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(esc_html__('This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
+				'event_espresso'), '<code>', '</code>'),
+			'[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
+			'[TXN_STATUS]'                      => esc_html__('The transaction status for the transaction.',
+				'event_espresso'),
+			'[TXN_STATUS_ID]'                   => esc_html__('The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
+				'event_espresso'),
+			'[PAYMENT_STATUS]'                  => esc_html__('The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
+				'event_espresso'),
+			'[PAYMENT_GATEWAY]'                 => esc_html__('The payment gateway used for the transaction',
+				'event_espresso'),
+			'[AMOUNT_PAID]'                     => esc_html__('The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
+				'event_espresso'),
+			'[LAST_AMOUNT_PAID]'                => esc_html__('This is the last payment or refund made on the transaction related to the message being generated.',
+				'event_espresso'),
+			'[TOTAL_AMOUNT_PAID]'               => esc_html__('This parses to the total amount paid over all payments',
+				'event_espresso'),
+			'[TOTAL_OWING]'                     => esc_html__('The total owing on a transaction with no attributes.',
+				'event_espresso'),
+			'[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
+			'[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
+			'[OWING_STATUS_MESSAGE_*]'          => esc_html__('A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
+					'event_espresso')
+												   . '<p></ul>'
+												   .
+												   '<li><strong>still_owing</strong>:'
+												   . esc_html__('If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
+					'event_espresso')
+												   . sprintf(esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+					'<a href="[PAYMENT_URL]" class="noPrint">', '</a>')
+												   . '</li>'
+												   .
+												   '<li><strong>none_owing</strong>:'
+												   . esc_html__('If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
+					'event_espresso')
+												   . '</li></ul></p>',
+			'[TXN_TOTAL_TICKETS]'               => esc_html__('The total number of all tickets purchased in a transaction',
+				'event_espresso'),
+			'[TKT_QTY_PURCHASED]'               => sprintf(esc_html__('The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
+				'event_espresso'), '<strong>', '</strong>'),
+			'[TRANSACTION_ADMIN_URL]'           => esc_html__('The url to the admin page for this transaction',
+				'event_espresso'),
+			'[RECEIPT_URL]'                     => esc_html__('This parses to the generated url for retrieving the receipt for the transaction',
+				'event_espresso'),
+			'[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__('This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
+				'event_espresso'),
+			'[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(esc_html__('The same as %1$s[INVOICE_RECEIPT_SWITCHER_URL]%2$s except this returns the html for a button linked to the invoice or receipt.',
+				'event_espresso'), '<code>', '</code>'),
+		);
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 */
+	protected function _parser($shortcode)
+	{
+		//attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the _extra_data for the transaction.
+		$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+		$transaction = ! $transaction instanceof EE_Transaction
+					   && is_array($this->_extra_data)
+					   && isset($this->_extra_data['data'])
+					   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->txn
+			: $transaction;
+		//payment
+		$payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
+		$payment = ! $payment instanceof EE_Payment
+				   && is_array($this->_extra_data)
+				   && isset($this->_extra_data['data'])
+				   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
+			: $payment;
+		if (! $transaction instanceof EE_Transaction) {
+			return '';
+		}
+		switch ($shortcode) {
+			case '[TXN_ID]' :
+				return $transaction->ID();
+				break;
+			case '[PAYMENT_URL]' :
+				$payment_url = $transaction->payment_overview_url();
+				return empty($payment_url) ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
+					: $payment_url;
+				break;
+			case '[INVOICE_LINK]' :
+				$invoice_url = $transaction->invoice_url();
+				$invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				return sprintf(esc_html__('%sClick here for Invoice%s', 'event_espresso'),
+					'<a href="' . $invoice_url . '">', '</a>');
+				break; /**/
+			case '[INVOICE_URL]' :
+				$invoice_url = $transaction->invoice_url();
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				break;
+			case '[INVOICE_LOGO_URL]' :
+				return $this->_get_invoice_logo();
+				break;
+			case '[INVOICE_LOGO]' :
+				return $this->_get_invoice_logo(true);
+				break;
+			case '[INVOICE_PAYEE_NAME]' :
+				return $this->_get_invoice_payee_name();
+				break;
+			case '[INVOICE_PAYEE_ADDRESS]' :
+				return $this->_get_invoice_payee_address();
+				break;
+			case '[INVOICE_PAYMENT_INSTRUCTIONS]' :
+				return $this->_get_invoice_payment_instructions();
+				break;
+			case '[INVOICE_PAYEE_EMAIL]' :
+				return $this->_get_invoice_payee_email();
+				break;
+			case '[TOTAL_COST]' :
+				$total = $transaction->total();
+				return ! empty($total) ? EEH_Template::format_currency($total) : '';
+				break;
+			case '[PAYMENT_STATUS]' :
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break; /**/
+			// note the [payment_status] shortcode is kind of misleading because payment status might be different from txn status so I'm adding this here for clarity.
+			case '[TXN_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break;
+			case '[TXN_STATUS_ID]' :
+				return $transaction->status_ID();
+				break;
+			case '[PAYMENT_GATEWAY]' :
+				return $this->_get_payment_gateway($transaction);
+				break;
+			case '[AMOUNT_PAID]' :
+				return $payment instanceof EE_Payment
+					? EEH_Template::format_currency($payment->amount())
+					: EEH_Template::format_currency(0);
+				break;
+			case '[LAST_AMOUNT_PAID]' :
+				$last_payment = $transaction->last_payment();
+				return $last_payment instanceof EE_Payment
+					? EEH_Template::format_currency($last_payment->amount())
+					: EEH_Template::format_currency(0);
+			case '[TOTAL_AMOUNT_PAID]' :
+				return EEH_Template::format_currency($transaction->paid());
+				break;
+			case '[TOTAL_OWING]' :
+				$total_owing = $transaction->remaining();
+				return EEH_Template::format_currency($total_owing);
+				break;
+			case '[TXN_SUBTOTAL]' :
+				return EEH_Template::format_currency($this->_get_subtotal());
+				break;
+			case '[TXN_TAX_SUBTOTAL]' :
+				return EEH_Template::format_currency($this->_get_subtotal(true));
+				break;
+			case '[TKT_QTY_PURCHASED]' :
+			case '[TXN_TOTAL_TICKETS]' :
+				return $this->_data->total_ticket_count;
+				break;
+			case '[TRANSACTION_ADMIN_URL]' :
+				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+				$query_args = array(
+					'page'   => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $transaction->ID(),
+				);
+				$url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
+				return $url;
+				break;
+			case '[RECEIPT_URL]' :
+				//get primary_registration
+				$reg = $this->_data->primary_reg_obj;
+				if (! $reg instanceof EE_Registration) {
+					return '';
+				}
+				return $reg->receipt_url();
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_URL]' :
+				return $this->_get_invoice_receipt_switcher(false);
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_BUTTON]' :
+				return $this->_get_invoice_receipt_switcher();
+				break;
+		}
+		if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
+			return $this->_get_custom_total_owing($shortcode);
+		}
+		if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
+			return $this->_get_invoice_payee_tax_number($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
+			return $this->_get_payment_link_if_needed($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
+			return $this->_get_payment_due_date($shortcode, $transaction);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 */
+	private function _get_custom_total_owing($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		//ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$owing_content = ! empty($attrs['still_owing'])
+				? $attrs['still_owing']
+				: sprintf(esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+					'<a href="[PAYMENT_URL]" class="noPrint">', '</a>');
+			$owing_content = $this->_shortcode_helper->parse_message_template($owing_content, $addressee,
+				$valid_shortcodes, $this->_message_type, $this->_messenger, $this->_message);
+		} else {
+			$owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
+		}
+		return $owing_content;
+	}
+
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 */
+	private function _get_payment_gateway($transaction)
+	{
+		if($transaction instanceof EE_Transaction){
+			$pm = $transaction->payment_method();
+		} else {
+			$pm = null;
+		}
+		return $pm instanceof EE_Payment_Method ? $pm->name() : '';
+	}
+
+
+
+	/**
+	 * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
+	 * not present then the organization logo is used if its found (set on the organization settings page).
+	 *
+	 * @since 4.5.0
+	 * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
+	 * @return string url or html
+	 */
+	private function _get_invoice_logo($img_tags = false)
+	{
+		//try to get the invoice payment method's logo for this transaction image first
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
+		} else {
+			$invoice_logo_url = null;
+		}
+		if (empty($invoice_logo_url)) {
+			$invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
+		}
+		if (empty($invoice_logo_url)) {
+			return '';
+		}
+		if (! $img_tags) {
+			return $invoice_logo_url;
+		}
+		//image tags have been requested.
+		$image_size = getimagesize($invoice_logo_url);
+		//if image is wider than 300px, set the width to 300
+		if ($image_size[0] > 300) {
+			$image_width = 300;
+		} else {
+			$image_width = $image_size[0];
+		}
+		return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+	}
+
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	private function _get_invoice_payee_name()
+	{
+		$payee_name = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_name = $pm->get_extra_meta('pdf_payee_name', true);
+		}
+		$payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
+		return $payee_name;
+	}
+
+
+
+	/**
+	 * gets the default invoice payment method, but has a filter so it can be overridden
+	 *
+	 * @return \EE_Payment_Method|null
+	 */
+	private function _get_invoice_payment_method()
+	{
+		if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+			$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+			$transaction = ! $transaction instanceof EE_Transaction
+						   && is_array($this->_extra_data)
+						   && isset($this->_extra_data['data'])
+						   && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->txn : $transaction;
+			//get the invoice payment method, and remember it for the next call too
+			$this->_invoice_pm = apply_filters('FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
+				EEM_Payment_Method::instance()->get_one_of_type('Invoice'), $transaction);
+		}
+		return $this->_invoice_pm;
+	}
+
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee email shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	private function _get_invoice_payee_email()
+	{
+		$payee_email = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_email = $pm->get_extra_meta('pdf_payee_email', true);
+		}
+		$payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
+			: $payee_email;
+		return $payee_email;
+	}
+
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee tax number shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode
+	 * @return string
+	 */
+	private function _get_invoice_payee_tax_number($shortcode)
+	{
+		$payee_tax_number = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
+		}
+		$payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
+			: $payee_tax_number;
+		if (empty($payee_tax_number)) {
+			return '';
+		}
+		//any attributes?
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		//prefix?
+		$prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
+		return $prefix . $payee_tax_number;
+	}
+
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee address shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	private function _get_invoice_payee_address()
+	{
+		$payee_address = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_address = $pm->get_extra_meta('pdf_payee_address', true);
+		}
+		if (empty($payee_address)) {
+			$organization = EE_Registry::instance()->CFG->organization;
+			$payee_address = $organization->get_pretty('address_1') . '<br>';
+			$payee_address .= ! empty($organization->address_2) ? $organization->get_pretty('address_2') . '<br>' : '';
+			$payee_address .= $organization->get_pretty('city') . '<br>';
+			//state
+			$state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+			$payee_address .= $state instanceof EE_State ? $state->name() : '';
+			//Country
+			$payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+			$payee_address .= ! empty($organization->zip) ? $organization->zip : '';
+		}
+		return $payee_address;
+	}
+
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	private function _get_invoice_payment_instructions()
+	{
+		$instructions = null;
+		$pm = $this->_get_invoice_payment_method();
+		return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
+	}
+
+
+
+	/**
+	 * get invoice/receipt switch button or url.
+	 *
+	 * @param bool $button true (default) returns the html for a button, false just returns the url.
+	 * @return string
+	 */
+	protected function _get_invoice_receipt_switcher($button = true)
+	{
+		$reg = $this->_data->primary_reg_obj;
+		$message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
+		if (! $reg instanceof EE_Registration || empty($message_type)) {
+			return '';
+		}
+		$switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
+		$switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
+			? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
+		$switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
+		$switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
+		if (! $button) {
+			return $switch_to_url;
+		}
+		if (! empty($switch_to_url)) {
+			return '
 	<form method="post" action="' . $switch_to_url . '" >
 		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
 	</form>
 			';
-        }
-        return '';
-    }
-
-
-
-    /**
-     * This returns a subtotal.
-     *
-     * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
-     * @return int
-     */
-    private function _get_subtotal($tax = false)
-    {
-        $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
-        if (! $grand_total instanceof EE_Line_Item) {
-            return 0;
-        }
-        return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
-    }
-
-
-
-    /**
-     * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
-     *
-     * @since 4.7.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     */
-    private function _get_payment_link_if_needed($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        //ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
-            $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
-            $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
-            $opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
-            $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
-            //we need to re run this string through the parser to catch any shortcodes that are in it.
-            $owing_content = $this->_shortcode_helper->parse_message_template($content, $addressee, $valid_shortcodes,
-                $this->_message_type, $this->_messenger, $this->_message);
-        } else {
-            return '';
-        }
-        return $owing_content;
-    }
-
-
-
-    /**
-     * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
-     *
-     * @since 4.8.28.rc.011
-     * @param string         $shortcode The shortcode being parsed.
-     * @param EE_Transaction $transaction
-     * @return string
-     */
-    protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
-    {
-        //if transaction is paid in full then we can just return an empty string
-        if ($transaction->remaining() === 0) {
-            return '';
-        }
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
-        $days_until_due = isset($attrs['days_until_due']) ? (int)$attrs['days_until_due'] : 30;
-        $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
-            : esc_html__('Payment in full due by: ', 'event_espresso');
-        $transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
-        //setup date due:
-        try {
-            if ($transaction_created instanceof DateTime) {
-                $date_due = $transaction_created->add(new DateInterval('P' . $days_until_due . 'D'))->format($format);
-            } else {
-                throw new Exception();
-            }
-        } catch (Exception $e) {
-            //format was likely invalid.
-            $date_due = 'Unable to calculate date due, likely the format string is invalid.';
-        }
-        return $prefix_text . $date_due;
-    }
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * This returns a subtotal.
+	 *
+	 * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
+	 * @return int
+	 */
+	private function _get_subtotal($tax = false)
+	{
+		$grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
+		if (! $grand_total instanceof EE_Line_Item) {
+			return 0;
+		}
+		return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
+	}
+
+
+
+	/**
+	 * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
+	 *
+	 * @since 4.7.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 */
+	private function _get_payment_link_if_needed($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		//ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$class = isset($attrs['class']) ? $attrs['class'] : 'callout';
+			$custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
+			$container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
+			$opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
+			$opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+			$opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
+			$closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
+			$content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+			//we need to re run this string through the parser to catch any shortcodes that are in it.
+			$owing_content = $this->_shortcode_helper->parse_message_template($content, $addressee, $valid_shortcodes,
+				$this->_message_type, $this->_messenger, $this->_message);
+		} else {
+			return '';
+		}
+		return $owing_content;
+	}
+
+
+
+	/**
+	 * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
+	 *
+	 * @since 4.8.28.rc.011
+	 * @param string         $shortcode The shortcode being parsed.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 */
+	protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
+	{
+		//if transaction is paid in full then we can just return an empty string
+		if ($transaction->remaining() === 0) {
+			return '';
+		}
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		$format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
+		$days_until_due = isset($attrs['days_until_due']) ? (int)$attrs['days_until_due'] : 30;
+		$prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
+			: esc_html__('Payment in full due by: ', 'event_espresso');
+		$transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
+		//setup date due:
+		try {
+			if ($transaction_created instanceof DateTime) {
+				$date_due = $transaction_created->add(new DateInterval('P' . $days_until_due . 'D'))->format($format);
+			} else {
+				throw new Exception();
+			}
+		} catch (Exception $e) {
+			//format was likely invalid.
+			$date_due = 'Unable to calculate date due, likely the format string is invalid.';
+		}
+		return $prefix_text . $date_due;
+	}
 
 } //end EE_Transaction Shortcodes library

Spacing +27 added lines, -27 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -173,7 +173,7 @@ 
                    && isset($this->_extra_data['data'])
                    && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
             : $payment;
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return '';
         }
         switch ($shortcode) {
@@ -189,7 +189,7 @@ 
                 $invoice_url = $transaction->invoice_url();
                 $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
                 return sprintf(esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">', '</a>');
+                    '<a href="'.$invoice_url.'">', '</a>');
                 break; /**/
             case '[INVOICE_URL]' :
                 $invoice_url = $transaction->invoice_url();
@@ -260,7 +260,7 @@ 
                 return $this->_data->total_ticket_count;
                 break;
             case '[TRANSACTION_ADMIN_URL]' :
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+                require_once EE_CORE.'admin/EE_Admin_Page.core.php';
                 $query_args = array(
                     'page'   => 'espresso_transactions',
                     'action' => 'view_transaction',
@@ -272,7 +272,7 @@ 
             case '[RECEIPT_URL]' :
                 //get primary_registration
                 $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
+                if ( ! $reg instanceof EE_Registration) {
                     return '';
                 }
                 return $reg->receipt_url();
@@ -337,7 +337,7 @@ 
      */
     private function _get_payment_gateway($transaction)
     {
-        if($transaction instanceof EE_Transaction){
+        if ($transaction instanceof EE_Transaction) {
             $pm = $transaction->payment_method();
         } else {
             $pm = null;
@@ -370,7 +370,7 @@ 
         if (empty($invoice_logo_url)) {
             return '';
         }
-        if (! $img_tags) {
+        if ( ! $img_tags) {
             return $invoice_logo_url;
         }
         //image tags have been requested.
@@ -381,7 +381,7 @@ 
         } else {
             $image_width = $image_size[0];
         }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+        return '<img class="logo screen" src="'.$invoice_logo_url.'" width="'.$image_width.'" alt="logo" />';
     }
 
 
@@ -412,7 +412,7 @@ 
      */
     private function _get_invoice_payment_method()
     {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+        if ( ! $this->_invoice_pm instanceof EE_Payment_Method) {
             $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
             $transaction = ! $transaction instanceof EE_Transaction
                            && is_array($this->_extra_data)
@@ -471,7 +471,7 @@ 
         $attrs = $this->_get_shortcode_attrs($shortcode);
         //prefix?
         $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
+        return $prefix.$payee_tax_number;
     }
 
 
@@ -491,14 +491,14 @@ 
         }
         if (empty($payee_address)) {
             $organization = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
-            $payee_address .= ! empty($organization->address_2) ? $organization->get_pretty('address_2') . '<br>' : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
+            $payee_address = $organization->get_pretty('address_1').'<br>';
+            $payee_address .= ! empty($organization->address_2) ? $organization->get_pretty('address_2').'<br>' : '';
+            $payee_address .= $organization->get_pretty('city').'<br>';
             //state
             $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
             $payee_address .= $state instanceof EE_State ? $state->name() : '';
             //Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+            $payee_address .= ! empty($organization->CNT_ISO) ? ', '.$organization->CNT_ISO.'<br>' : '';
             $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
         }
         return $payee_address;
@@ -531,7 +531,7 @@ 
     {
         $reg = $this->_data->primary_reg_obj;
         $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
+        if ( ! $reg instanceof EE_Registration || empty($message_type)) {
             return '';
         }
         $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
@@ -539,13 +539,13 @@ 
             ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
         $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
         $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
+        if ( ! $button) {
             return $switch_to_url;
         }
-        if (! empty($switch_to_url)) {
+        if ( ! empty($switch_to_url)) {
             return '
-	<form method="post" action="' . $switch_to_url . '" >
-		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
+	<form method="post" action="' . $switch_to_url.'" >
+		<input class="print_button" type="submit" value="' . $switch_to_label.'" />
 	</form>
 			';
         }
@@ -563,7 +563,7 @@ 
     private function _get_subtotal($tax = false)
     {
         $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
-        if (! $grand_total instanceof EE_Line_Item) {
+        if ( ! $grand_total instanceof EE_Line_Item) {
             return 0;
         }
         return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
@@ -590,11 +590,11 @@ 
             $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
             $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
             $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
-            $opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+            $opening_tag = ! empty($container_tag) ? '<'.$container_tag : '';
+            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="'.$class.'"' : $opening_tag;
             $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+            $closing_tag = ! empty($container_tag) ? '</'.$container_tag.'>' : '';
+            $content = $opening_tag.sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>').$closing_tag;
             //we need to re run this string through the parser to catch any shortcodes that are in it.
             $owing_content = $this->_shortcode_helper->parse_message_template($content, $addressee, $valid_shortcodes,
                 $this->_message_type, $this->_messenger, $this->_message);
@@ -622,14 +622,14 @@ 
         }
         $attrs = $this->_get_shortcode_attrs($shortcode);
         $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
-        $days_until_due = isset($attrs['days_until_due']) ? (int)$attrs['days_until_due'] : 30;
+        $days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
         $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
             : esc_html__('Payment in full due by: ', 'event_espresso');
         $transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
         //setup date due:
         try {
             if ($transaction_created instanceof DateTime) {
-                $date_due = $transaction_created->add(new DateInterval('P' . $days_until_due . 'D'))->format($format);
+                $date_due = $transaction_created->add(new DateInterval('P'.$days_until_due.'D'))->format($format);
             } else {
                 throw new Exception();
             }
@@ -637,7 +637,7 @@ 
             //format was likely invalid.
             $date_due = 'Unable to calculate date due, likely the format string is invalid.';
         }
-        return $prefix_text . $date_due;
+        return $prefix_text.$date_due;
     }
 
 } //end EE_Transaction Shortcodes library

espresso.php

Indentation +219 added lines, -219 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('ABSPATH')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@ 
  * @since            4.0
  */
 if (function_exists('espresso_version')) {
-    /**
-     *    espresso_duplicate_plugin_error
-     *    displays if more than one version of EE is activated at the same time
-     */
-    function espresso_duplicate_plugin_error()
-    {
-        ?>
+	/**
+	 *    espresso_duplicate_plugin_error
+	 *    displays if more than one version of EE is activated at the same time
+	 */
+	function espresso_duplicate_plugin_error()
+	{
+		?>
         <div class="error">
             <p>
                 <?php echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                ); ?>
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+				); ?>
             </p>
         </div>
         <?php
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
-    }
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
+	}
 
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                            esc_html__(
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                    'event_espresso'
-                            ),
-                            EE_MIN_PHP_VER_REQUIRED,
-                            PHP_VERSION,
-                            '<br/>',
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+							esc_html__(
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+									'event_espresso'
+							),
+							EE_MIN_PHP_VER_REQUIRED,
+							PHP_VERSION,
+							'<br/>',
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.35.rc.009');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.35.rc.009');
+		}
 
-        // define versions
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-        if ( ! defined('DS')) {
-            define('DS', '/');
-        }
-        if ( ! defined('PS')) {
-            define('PS', PATH_SEPARATOR);
-        }
-        if ( ! defined('SP')) {
-            define('SP', ' ');
-        }
-        if ( ! defined('EENL')) {
-            define('EENL', "\n");
-        }
-        define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
-        // define the plugin directory and URL
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
-        // main root folder paths
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
-        // core system paths
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
-        // gateways
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
-        // asset URL paths
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
-        // define upload paths
-        $uploads = wp_upload_dir();
-        // define the uploads directory and URL
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
-        // define the templates directory and URL
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
-        // define the gateway directory and URL
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
-        // languages folder/path
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
-        //check for dompdf fonts in uploads
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
-        }
-        //ajax constants
-        define(
-                'EE_FRONT_AJAX',
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
-        );
-        define(
-                'EE_ADMIN_AJAX',
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
-        );
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
-        //you're better to use this than its straight value (currently -1) in case you ever
-        //want to change its default value! or find when -1 means infinity
-        define('EE_INF_IN_DB', -1);
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
-        define('EE_DEBUG', false);
-        // for older WP versions
-        if ( ! defined('MONTH_IN_SECONDS')) {
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
-        }
-        /**
-         *    espresso_plugin_activation
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		// define versions
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
+		if ( ! defined('DS')) {
+			define('DS', '/');
+		}
+		if ( ! defined('PS')) {
+			define('PS', PATH_SEPARATOR);
+		}
+		if ( ! defined('SP')) {
+			define('SP', ' ');
+		}
+		if ( ! defined('EENL')) {
+			define('EENL', "\n");
+		}
+		define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
+		// define the plugin directory and URL
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
+		// main root folder paths
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+		// core system paths
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+		// gateways
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+		// asset URL paths
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+		// define upload paths
+		$uploads = wp_upload_dir();
+		// define the uploads directory and URL
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+		// define the templates directory and URL
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+		// define the gateway directory and URL
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+		// languages folder/path
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+		//check for dompdf fonts in uploads
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+		}
+		//ajax constants
+		define(
+				'EE_FRONT_AJAX',
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
+		);
+		define(
+				'EE_ADMIN_AJAX',
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
+		);
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
+		//you're better to use this than its straight value (currently -1) in case you ever
+		//want to change its default value! or find when -1 means infinity
+		define('EE_INF_IN_DB', -1);
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
+		define('EE_DEBUG', false);
+		// for older WP versions
+		if ( ! defined('MONTH_IN_SECONDS')) {
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+		}
+		/**
+		 *    espresso_plugin_activation
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
-                EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once(EE_CORE . 'EE_Error.core.php');
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
+				EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once(EE_CORE . 'EE_Error.core.php');
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            static $error_handling_loaded = false;
-            if ( ! $error_handling_loaded) {
-                espresso_load_error_handling();
-                $error_handling_loaded = true;
-            }
-            if (is_readable($full_path_to_file)) {
-                require_once($full_path_to_file);
-            } else {
-                throw new EE_Error (
-                        sprintf(
-                                esc_html__(
-                                        'The %s class file could not be located or is not readable due to file permissions.',
-                                        'event_espresso'
-                                ),
-                                $classname
-                        )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			static $error_handling_loaded = false;
+			if ( ! $error_handling_loaded) {
+				espresso_load_error_handling();
+				$error_handling_loaded = true;
+			}
+			if (is_readable($full_path_to_file)) {
+				require_once($full_path_to_file);
+			} else {
+				throw new EE_Error (
+						sprintf(
+								esc_html__(
+										'The %s class file could not be located or is not readable due to file permissions.',
+										'event_espresso'
+								),
+								$classname
+						)
+				);
+			}
+		}
 
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        new EE_Bootstrap();
-    }
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		new EE_Bootstrap();
+	}
 }
 if ( ! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if ( ! function_exists('deactivate_plugins')) {
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file