eventespresso / event-espresso-core

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

Doc Comments +1 added lines, -1 removed lines

@@ -1306,7 +1306,7 @@
      *
      * @param EEM_Base        $model
      * @param WP_REST_Request $request
-     * @param null            $context
+     * @param string            $context
      * @return array|WP_Error
      */
     public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)

Indentation +1319 added lines, -1319 removed lines

@@ -35,1323 +35,1323 @@
 {
 
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->fields_calculator = new CalculatedModelFields();
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version    The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     */
-    public static function handleSchemaRequest($version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return array();
-            }
-            // get the model for this version
-            $model = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema($model);
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($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 customizeSchemaForRestResponse(EEM_Base $model, array $schema)
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($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
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function translateDefaultsForRestResponse($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 ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        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 maybeAddExtraFieldsToSchema($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'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest()
-    {
-        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
-     * @param string          $version
-     * @param string          $model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($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
-     * @param string          $version
-     * @param string          $model_name
-     * @param string          $related_model_name
-     * @return \WP_REST_Response|WP_Error
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        $version,
-        $model_name,
-        $related_model_name
-    ) {
-        $controller = new Read();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $related_model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($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 getEntitiesFromModel($model, $request)
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($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::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        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 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
-     * @throws RestException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validateContext($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->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
-            Capabilities::currentUserHasPartialAccessTo($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::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->createModelQueryParams($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->setHeadersFromQueryParams($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->createEntityFromWpdbResult(
-                $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->createEntityFromWpdbResult(
-                    $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 getEntitiesFromRelation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            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 setHeadersFromQueryParams($model, $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($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->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('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 createEntityFromWpdbResult($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->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->getEntityCalculations($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->includeRequestedModels($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::filterOutInaccessibleEntityFields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->getModelVersionInfo(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->setDebugInfo(
-            '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 createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof \EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                $timezone = $field_value->getTimezone();
-                EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                $result[ $field_name . '_gmt' ] = ModelDataTranslator::prepareFieldValuesForJson(
-                    $field_obj,
-                    $field_value,
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-                EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                $result[ $field_name ] = ModelDataTranslator::prepareFieldValuesForJson(
-                    $field_obj,
-                    $field_value,
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return mixed
-     * @throws ObjectDetectedException if $value contains a PHP object
-     */
-    protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
-    {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * 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 addExtraFields(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 getEntityLinks($model, $db_row, $entity_array)
-    {
-        // add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
-                    array(
-                        'href'   => $this->getVersionedLinkTo(
-                            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 includeRequestedModels(
-        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->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($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->explodeAndGetItemsPrefixedWith($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->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $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->getEntitiesFromRelationUsingModelQueryParams(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[ Read::getRelatedEntityName($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 removeModelNamesFromArray($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
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function getEntityCalculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $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 = ModelDataTranslator::prepareFieldValueForJson(
-                    null,
-                    $this->fields_calculator->retrieveCalculatedFieldValue(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $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 getVersionedLinkTo($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * 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 getRelatedEntityName($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 getEntityFromModel($model, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * 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 validateContext($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 validateDefaultQueryParams($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
-     * @throws RestException
-     */
-    public function createModelQueryParams($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        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 = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($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 = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        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(
-                            __(
-                            // @codingStandardsIgnoreStart
-                                '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.',
-                                // @codingStandardsIgnoreEnd
-                                '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->validateContext($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->validateDefaultQueryParams(
-                $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 prepareRestQueryParamsKeyForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($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, blah, blah" 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 explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (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;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($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 extractIncludesForThisModel($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->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param null            $context
-     * @return array|WP_Error
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
-    {
-        $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'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $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_' . $context,
-                    sprintf(
-                        __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                        $context,
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::getMissingPermissionsString(
-                            $model,
-                            $context
-                        )
-                    ),
-                    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)
-                );
-            }
-        }
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->fields_calculator = new CalculatedModelFields();
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version    The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 */
+	public static function handleSchemaRequest($version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return array();
+			}
+			// get the model for this version
+			$model = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema($model);
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($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 customizeSchemaForRestResponse(EEM_Base $model, array $schema)
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($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
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function translateDefaultsForRestResponse($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 ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		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 maybeAddExtraFieldsToSchema($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'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest()
+	{
+		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
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($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
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @param string          $related_model_name
+	 * @return \WP_REST_Response|WP_Error
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		$version,
+		$model_name,
+		$related_model_name
+	) {
+		$controller = new Read();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			$main_model = $controller->getModelVersionInfo()->loadModel($model_name);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$related_model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($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 getEntitiesFromModel($model, $request)
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($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::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		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 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
+	 * @throws RestException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validateContext($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->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		if (! (
+			Capabilities::currentUserHasPartialAccessTo($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::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->createModelQueryParams($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->setHeadersFromQueryParams($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->createEntityFromWpdbResult(
+				$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->createEntityFromWpdbResult(
+					$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 getEntitiesFromRelation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			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 setHeadersFromQueryParams($model, $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($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->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('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 createEntityFromWpdbResult($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->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->getEntityCalculations($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->includeRequestedModels($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::filterOutInaccessibleEntityFields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->getModelVersionInfo(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->setDebugInfo(
+			'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 createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof \EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof \WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = \EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				$timezone = $field_value->getTimezone();
+				EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+				$result[ $field_name . '_gmt' ] = ModelDataTranslator::prepareFieldValuesForJson(
+					$field_obj,
+					$field_value,
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+				EEH_DTT_Helper::setTimezone($field_value, $timezone);
+				$result[ $field_name ] = ModelDataTranslator::prepareFieldValuesForJson(
+					$field_obj,
+					$field_value,
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return mixed
+	 * @throws ObjectDetectedException if $value contains a PHP object
+	 */
+	protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
+	{
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * 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 addExtraFields(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 getEntityLinks($model, $db_row, $entity_array)
+	{
+		// add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+					array(
+						'href'   => $this->getVersionedLinkTo(
+							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 includeRequestedModels(
+		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->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($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->explodeAndGetItemsPrefixedWith($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->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$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->getEntitiesFromRelationUsingModelQueryParams(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[ Read::getRelatedEntityName($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 removeModelNamesFromArray($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
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function getEntityCalculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$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 = ModelDataTranslator::prepareFieldValueForJson(
+					null,
+					$this->fields_calculator->retrieveCalculatedFieldValue(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $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 getVersionedLinkTo($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * 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 getRelatedEntityName($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 getEntityFromModel($model, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * 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 validateContext($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 validateDefaultQueryParams($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
+	 * @throws RestException
+	 */
+	public function createModelQueryParams($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		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 = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($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 = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		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(
+							__(
+							// @codingStandardsIgnoreStart
+								'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.',
+								// @codingStandardsIgnoreEnd
+								'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->validateContext($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->validateDefaultQueryParams(
+				$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 prepareRestQueryParamsKeyForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($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, blah, blah" 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 explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (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;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($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 extractIncludesForThisModel($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->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param null            $context
+	 * @return array|WP_Error
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
+	{
+		$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'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$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_' . $context,
+					sprintf(
+						__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+						$context,
+						strtolower($model->get_this_model_name()),
+						Capabilities::getMissingPermissionsString(
+							$model,
+							$context
+						)
+					),
+					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)
+				);
+			}
+		}
+	}
 }

Spacing +55 added lines, -55 removed lines

@@ -64,7 +64,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -102,7 +102,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return array();
             }
             // get the model for this version
@@ -159,11 +159,11 @@ 
      */
     protected function translateDefaultsForRestResponse($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 (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 ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -172,9 +172,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -196,9 +196,9 @@ 
     protected function maybeAddExtraFieldsToSchema($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'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -238,7 +238,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -283,7 +283,7 @@ 
         $controller = new Read();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -298,7 +298,7 @@ 
                 );
             }
             $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -335,7 +335,7 @@ 
     public function getEntitiesFromModel($model, $request)
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($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),
@@ -347,7 +347,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
@@ -382,7 +382,7 @@ 
         $context = $this->validateContext($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
@@ -399,7 +399,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('main model query params', $restricted_query_params);
         $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
+        if ( ! (
             Capabilities::currentUserHasPartialAccessTo($related_model, $context)
             && $model->exists($restricted_query_params)
         )
@@ -432,13 +432,13 @@ 
         }
         $query_params = $this->createModelQueryParams($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()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $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->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -489,7 +489,7 @@ 
      */
     public function getEntitiesFromRelation($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(
                     __(
@@ -531,7 +531,7 @@ 
             Capabilities::getMissingPermissionsString($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'])) {
@@ -564,7 +564,7 @@ 
      */
     public function createEntityFromWpdbResult($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
@@ -645,8 +645,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
+            $post = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof \WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -656,7 +656,7 @@ 
                     )
                 );
             }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
+            $model_object_classname = 'EE_'.$model->get_this_model_name();
             $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
                 $model_object_classname,
                 $result,
@@ -667,13 +667,13 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif ($this->isSubclassOfOne(
                 $field_obj,
                 $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -682,7 +682,7 @@ 
                 $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -690,19 +690,19 @@ 
                 $field_value = $field_obj->prepare_for_set_from_db($field_value);
                 $timezone = $field_value->getTimezone();
                 EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                $result[ $field_name . '_gmt' ] = ModelDataTranslator::prepareFieldValuesForJson(
+                $result[$field_name.'_gmt'] = ModelDataTranslator::prepareFieldValuesForJson(
                     $field_obj,
                     $field_value,
                     $this->getModelVersionInfo()->requestedVersion()
                 );
                 EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                $result[ $field_name ] = ModelDataTranslator::prepareFieldValuesForJson(
+                $result[$field_name] = ModelDataTranslator::prepareFieldValuesForJson(
                     $field_obj,
                     $field_value,
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -754,7 +754,7 @@ 
     protected function addExtraFields(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() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -779,7 +779,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ),
             );
@@ -795,12 +795,12 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::getRelatedEntityName($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->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -829,13 +829,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->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->removeModelNamesFromArray($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()) {
@@ -881,7 +881,7 @@ 
                     $relation_obj,
                     $pretend_related_request
                 );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results
                                                                                              instanceof
                                                                                              WP_Error
                     ? null
@@ -1013,7 +1013,7 @@ 
      */
     public function validateContext($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1038,7 +1038,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 (in_array(
@@ -1121,14 +1121,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'])) {
+            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(
                             __(
@@ -1174,9 +1174,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsKeyForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1194,9 +1194,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1228,17 +1228,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;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (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.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1277,9 +1277,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[] = '*';
@@ -1319,7 +1319,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('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->createEntityFromWpdbResult(
                 $model,
                 array_shift($model_rows),
@@ -1329,10 +1329,10 @@ 
             // 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_' . $context,
+                    'rest_user_cannot_'.$context,
                     sprintf(
                         __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                         $context,

core/Psr4Autoloader.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
      * Loads the class file for a given class name.
      *
      * @param string $class The fully-qualified class name.
-     * @return mixed The mapped file name on success, or boolean false on
+     * @return string|false The mapped file name on success, or boolean false on
      *                      failure.
      */
     public function loadClass($class)
@@ -153,7 +153,7 @@ 
      *
      * @param string $prefix         The namespace prefix.
      * @param string $relative_class The relative class name.
-     * @return mixed Boolean false if no mapped file can be loaded, or the
+     * @return string|false Boolean false if no mapped file can be loaded, or the
      *                               name of the mapped file that was loaded.
      */
     protected function loadMappedFile($prefix, $relative_class)

Indentation +146 added lines, -146 removed lines

@@ -45,150 +45,150 @@
 class Psr4Autoloader
 {
 
-    /**
-     * namespace separator
-     */
-    const NS = '\\';
-
-    /**
-     * An associative array where the key is a namespace prefix and the value
-     * is an array of base directories for classes in that namespace.
-     *
-     * @var array
-     */
-    protected $prefixes = array();
-
-
-    /**
-     * returns an array of registered namespace prefixes
-     *
-     * @param string $prefix
-     * @return array
-     */
-    public function prefixes($prefix = '')
-    {
-        if (! empty($prefix)) {
-            // are there any base directories for this namespace prefix?
-            return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : array();
-        }
-        return $this->prefixes;
-    }
-
-
-    /**
-     * Register loader with SPL autoloader stack.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        spl_autoload_register(array($this, 'loadClass'));
-    }
-
-
-    /**
-     * Adds a base directory for a namespace prefix.
-     *
-     * @param string $prefix   The namespace prefix.
-     * @param string $base_dir A base directory for class files in the
-     *                         namespace.
-     * @param bool   $prepend  If true, prepend the base directory to the stack
-     *                         instead of appending it; this causes it to be searched first rather
-     *                         than last.
-     * @return void
-     */
-    public function addNamespace($prefix, $base_dir, $prepend = false)
-    {
-        // normalize namespace prefix
-        $prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
-        // normalize the base directory with a trailing separator
-        $base_dir = \EEH_File::standardise_and_end_with_directory_separator($base_dir);
-        // initialize the namespace prefix array
-        if (isset($this->prefixes[ $prefix ]) === false) {
-            $this->prefixes[ $prefix ] = array();
-        }
-        // retain the base directory for the namespace prefix
-        if ($prepend) {
-            array_unshift($this->prefixes[ $prefix ], $base_dir);
-        } else {
-            $this->prefixes[ $prefix ][] = $base_dir;
-        }
-    }
-
-
-    /**
-     * Loads the class file for a given class name.
-     *
-     * @param string $class The fully-qualified class name.
-     * @return mixed The mapped file name on success, or boolean false on
-     *                      failure.
-     */
-    public function loadClass($class)
-    {
-        // the current namespace prefix
-        $prefix = $class;
-        // work backwards through the namespace names of the fully-qualified
-        // class name to find a mapped file name
-        while (false !== $pos = strrpos($prefix, Psr4Autoloader::NS)) {
-            // retain the trailing namespace separator in the prefix
-            $prefix = substr($class, 0, $pos + 1);
-            // the rest is the relative class name
-            $relative_class = substr($class, $pos + 1);
-            // try to load a mapped file for the prefix and relative class
-            $mapped_file = $this->loadMappedFile($prefix, $relative_class);
-            if ($mapped_file) {
-                return $mapped_file;
-            }
-            // remove the trailing namespace separator for the next iteration
-            // of strrpos()
-            $prefix = rtrim($prefix, Psr4Autoloader::NS);
-        }
-        // never found a mapped file
-        return false;
-    }
-
-
-    /**
-     * Load the mapped file for a namespace prefix and relative class.
-     *
-     * @param string $prefix         The namespace prefix.
-     * @param string $relative_class The relative class name.
-     * @return mixed Boolean false if no mapped file can be loaded, or the
-     *                               name of the mapped file that was loaded.
-     */
-    protected function loadMappedFile($prefix, $relative_class)
-    {
-        // look through base directories for this namespace prefix
-        foreach ($this->prefixes($prefix) as $base_dir) {
-            // replace the namespace prefix with the base directory,
-            // replace namespace separators with directory separators
-            // in the relative class name, append with .php
-            $file = $base_dir
-                    . str_replace(Psr4Autoloader::NS, DS, $relative_class)
-                    . '.php';
-            // if the mapped file exists, require it
-            if ($this->requireFile($file)) {
-                // yes, we're done
-                return $file;
-            }
-        }
-        // never found it
-        return false;
-    }
-
-
-    /**
-     * If a file exists, require it from the file system.
-     *
-     * @param string $file The file to require.
-     * @return bool True if the file exists, false if not.
-     */
-    protected function requireFile($file)
-    {
-        if (file_exists($file)) {
-            require $file;
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * namespace separator
+	 */
+	const NS = '\\';
+
+	/**
+	 * An associative array where the key is a namespace prefix and the value
+	 * is an array of base directories for classes in that namespace.
+	 *
+	 * @var array
+	 */
+	protected $prefixes = array();
+
+
+	/**
+	 * returns an array of registered namespace prefixes
+	 *
+	 * @param string $prefix
+	 * @return array
+	 */
+	public function prefixes($prefix = '')
+	{
+		if (! empty($prefix)) {
+			// are there any base directories for this namespace prefix?
+			return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : array();
+		}
+		return $this->prefixes;
+	}
+
+
+	/**
+	 * Register loader with SPL autoloader stack.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		spl_autoload_register(array($this, 'loadClass'));
+	}
+
+
+	/**
+	 * Adds a base directory for a namespace prefix.
+	 *
+	 * @param string $prefix   The namespace prefix.
+	 * @param string $base_dir A base directory for class files in the
+	 *                         namespace.
+	 * @param bool   $prepend  If true, prepend the base directory to the stack
+	 *                         instead of appending it; this causes it to be searched first rather
+	 *                         than last.
+	 * @return void
+	 */
+	public function addNamespace($prefix, $base_dir, $prepend = false)
+	{
+		// normalize namespace prefix
+		$prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
+		// normalize the base directory with a trailing separator
+		$base_dir = \EEH_File::standardise_and_end_with_directory_separator($base_dir);
+		// initialize the namespace prefix array
+		if (isset($this->prefixes[ $prefix ]) === false) {
+			$this->prefixes[ $prefix ] = array();
+		}
+		// retain the base directory for the namespace prefix
+		if ($prepend) {
+			array_unshift($this->prefixes[ $prefix ], $base_dir);
+		} else {
+			$this->prefixes[ $prefix ][] = $base_dir;
+		}
+	}
+
+
+	/**
+	 * Loads the class file for a given class name.
+	 *
+	 * @param string $class The fully-qualified class name.
+	 * @return mixed The mapped file name on success, or boolean false on
+	 *                      failure.
+	 */
+	public function loadClass($class)
+	{
+		// the current namespace prefix
+		$prefix = $class;
+		// work backwards through the namespace names of the fully-qualified
+		// class name to find a mapped file name
+		while (false !== $pos = strrpos($prefix, Psr4Autoloader::NS)) {
+			// retain the trailing namespace separator in the prefix
+			$prefix = substr($class, 0, $pos + 1);
+			// the rest is the relative class name
+			$relative_class = substr($class, $pos + 1);
+			// try to load a mapped file for the prefix and relative class
+			$mapped_file = $this->loadMappedFile($prefix, $relative_class);
+			if ($mapped_file) {
+				return $mapped_file;
+			}
+			// remove the trailing namespace separator for the next iteration
+			// of strrpos()
+			$prefix = rtrim($prefix, Psr4Autoloader::NS);
+		}
+		// never found a mapped file
+		return false;
+	}
+
+
+	/**
+	 * Load the mapped file for a namespace prefix and relative class.
+	 *
+	 * @param string $prefix         The namespace prefix.
+	 * @param string $relative_class The relative class name.
+	 * @return mixed Boolean false if no mapped file can be loaded, or the
+	 *                               name of the mapped file that was loaded.
+	 */
+	protected function loadMappedFile($prefix, $relative_class)
+	{
+		// look through base directories for this namespace prefix
+		foreach ($this->prefixes($prefix) as $base_dir) {
+			// replace the namespace prefix with the base directory,
+			// replace namespace separators with directory separators
+			// in the relative class name, append with .php
+			$file = $base_dir
+					. str_replace(Psr4Autoloader::NS, DS, $relative_class)
+					. '.php';
+			// if the mapped file exists, require it
+			if ($this->requireFile($file)) {
+				// yes, we're done
+				return $file;
+			}
+		}
+		// never found it
+		return false;
+	}
+
+
+	/**
+	 * If a file exists, require it from the file system.
+	 *
+	 * @param string $file The file to require.
+	 * @return bool True if the file exists, false if not.
+	 */
+	protected function requireFile($file)
+	{
+		if (file_exists($file)) {
+			require $file;
+			return true;
+		}
+		return false;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -67,9 +67,9 @@ 
      */
     public function prefixes($prefix = '')
     {
-        if (! empty($prefix)) {
+        if ( ! empty($prefix)) {
             // are there any base directories for this namespace prefix?
-            return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : array();
+            return isset($this->prefixes[$prefix]) ? $this->prefixes[$prefix] : array();
         }
         return $this->prefixes;
     }
@@ -100,18 +100,18 @@ 
     public function addNamespace($prefix, $base_dir, $prepend = false)
     {
         // normalize namespace prefix
-        $prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
+        $prefix = trim($prefix, Psr4Autoloader::NS).Psr4Autoloader::NS;
         // normalize the base directory with a trailing separator
         $base_dir = \EEH_File::standardise_and_end_with_directory_separator($base_dir);
         // initialize the namespace prefix array
-        if (isset($this->prefixes[ $prefix ]) === false) {
-            $this->prefixes[ $prefix ] = array();
+        if (isset($this->prefixes[$prefix]) === false) {
+            $this->prefixes[$prefix] = array();
         }
         // retain the base directory for the namespace prefix
         if ($prepend) {
-            array_unshift($this->prefixes[ $prefix ], $base_dir);
+            array_unshift($this->prefixes[$prefix], $base_dir);
         } else {
-            $this->prefixes[ $prefix ][] = $base_dir;
+            $this->prefixes[$prefix][] = $base_dir;
         }
     }
 

core/services/container/SharedCoffeeMaker.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
     /**
      * @param RecipeInterface $recipe
      * @param array           $arguments
-     * @return mixed
+     * @return boolean
      */
     public function brew(RecipeInterface $recipe, $arguments = array())
     {

Indentation +37 added lines, -37 removed lines

@@ -18,43 +18,43 @@
 {
 
 
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return CoffeeMaker::BREW_SHARED;
-    }
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return CoffeeMaker::BREW_SHARED;
+	}
 
 
-    /**
-     * @param RecipeInterface $recipe
-     * @param array           $arguments
-     * @return mixed
-     */
-    public function brew(RecipeInterface $recipe, $arguments = array())
-    {
-        $this->resolveClassAndFilepath($recipe);
-        $reflector = $this->injector()->getReflectionClass($recipe->fqcn());
-        $method = $this->resolveInstantiationMethod($reflector);
-        switch ($method) {
-            case 'instance':
-            case 'new_instance':
-            case 'new_instance_from_db':
-                $service = call_user_func_array(
-                    array($reflector->getName(), $method),
-                    $this->injector()->resolveDependencies($recipe, $reflector, $arguments)
-                );
-                break;
-            case 'newInstance':
-                $service = $reflector->newInstance();
-                break;
-            case 'newInstanceArgs':
-            default:
-                $service = $reflector->newInstanceArgs(
-                    $this->injector()->resolveDependencies($recipe, $reflector, $arguments)
-                );
-        }
-        return $this->coffeePot()->addService($recipe->identifier(), $service);
-    }
+	/**
+	 * @param RecipeInterface $recipe
+	 * @param array           $arguments
+	 * @return mixed
+	 */
+	public function brew(RecipeInterface $recipe, $arguments = array())
+	{
+		$this->resolveClassAndFilepath($recipe);
+		$reflector = $this->injector()->getReflectionClass($recipe->fqcn());
+		$method = $this->resolveInstantiationMethod($reflector);
+		switch ($method) {
+			case 'instance':
+			case 'new_instance':
+			case 'new_instance_from_db':
+				$service = call_user_func_array(
+					array($reflector->getName(), $method),
+					$this->injector()->resolveDependencies($recipe, $reflector, $arguments)
+				);
+				break;
+			case 'newInstance':
+				$service = $reflector->newInstance();
+				break;
+			case 'newInstanceArgs':
+			default:
+				$service = $reflector->newInstanceArgs(
+					$this->injector()->resolveDependencies($recipe, $reflector, $arguments)
+				);
+		}
+		return $this->coffeePot()->addService($recipe->identifier(), $service);
+	}
 }

core/services/formatters/AsciiOnly.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     /**
      * Taken from https://gist.github.com/jaywilliams/119517
      *
-     * @param $string
+     * @param string $string
      * @return string
      */
     protected function convertAscii($string)

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace EventEspresso\core\services\formatters;
 
-use EventEspresso\core\exceptions\InvalidDataTypeException;
-
 /**
  * Class AsciiOnly
  * Removes all non-ascii characters from the string

Indentation +52 added lines, -52 removed lines

@@ -15,58 +15,58 @@
 class AsciiOnly extends FormatterBase
 {
 
-    /**
-     * Removes all non Ascii characters from string
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input)
-    {
-        // in case an int or float etc was passed in
-        $input = (string) $input;
-        $input = $this->convertAscii($input);
-        return $input;
-    }
+	/**
+	 * Removes all non Ascii characters from string
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input)
+	{
+		// in case an int or float etc was passed in
+		$input = (string) $input;
+		$input = $this->convertAscii($input);
+		return $input;
+	}
 
 
-    /**
-     * Taken from https://gist.github.com/jaywilliams/119517
-     *
-     * @param $string
-     * @return string
-     */
-    protected function convertAscii($string)
-    {
-        // Replace Single Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(152);
-        $replace[] = "'";
-        $search[] = chr(226) . chr(128) . chr(153);
-        $replace[] = "'";
-        // Replace Smart Double Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(156);
-        $replace[] = '"';
-        $search[] = chr(226) . chr(128) . chr(157);
-        $replace[] = '"';
-        // Replace En Dash
-        $search[] = chr(226) . chr(128) . chr(147);
-        $replace[] = '--';
-        // Replace Em Dash
-        $search[] = chr(226) . chr(128) . chr(148);
-        $replace[] = '---';
-        // Replace Bullet
-        $search[] = chr(226) . chr(128) . chr(162);
-        $replace[] = '*';
-        // Replace Middle Dot
-        $search[] = chr(194) . chr(183);
-        $replace[] = '*';
-        // Replace Ellipsis with three consecutive dots
-        $search[] = chr(226) . chr(128) . chr(166);
-        $replace[] = '...';
-        // Apply Replacements
-        $string = str_replace($search, $replace, $string);
-        // Remove any non-ASCII Characters
-        $string = preg_replace("/[^\x01-\x7F]/", "", $string);
-        return $string;
-    }
+	/**
+	 * Taken from https://gist.github.com/jaywilliams/119517
+	 *
+	 * @param $string
+	 * @return string
+	 */
+	protected function convertAscii($string)
+	{
+		// Replace Single Curly Quotes
+		$search[] = chr(226) . chr(128) . chr(152);
+		$replace[] = "'";
+		$search[] = chr(226) . chr(128) . chr(153);
+		$replace[] = "'";
+		// Replace Smart Double Curly Quotes
+		$search[] = chr(226) . chr(128) . chr(156);
+		$replace[] = '"';
+		$search[] = chr(226) . chr(128) . chr(157);
+		$replace[] = '"';
+		// Replace En Dash
+		$search[] = chr(226) . chr(128) . chr(147);
+		$replace[] = '--';
+		// Replace Em Dash
+		$search[] = chr(226) . chr(128) . chr(148);
+		$replace[] = '---';
+		// Replace Bullet
+		$search[] = chr(226) . chr(128) . chr(162);
+		$replace[] = '*';
+		// Replace Middle Dot
+		$search[] = chr(194) . chr(183);
+		$replace[] = '*';
+		// Replace Ellipsis with three consecutive dots
+		$search[] = chr(226) . chr(128) . chr(166);
+		$replace[] = '...';
+		// Apply Replacements
+		$string = str_replace($search, $replace, $string);
+		// Remove any non-ASCII Characters
+		$string = preg_replace("/[^\x01-\x7F]/", "", $string);
+		return $string;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -39,29 +39,29 @@
     protected function convertAscii($string)
     {
         // Replace Single Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(152);
+        $search[] = chr(226).chr(128).chr(152);
         $replace[] = "'";
-        $search[] = chr(226) . chr(128) . chr(153);
+        $search[] = chr(226).chr(128).chr(153);
         $replace[] = "'";
         // Replace Smart Double Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(156);
+        $search[] = chr(226).chr(128).chr(156);
         $replace[] = '"';
-        $search[] = chr(226) . chr(128) . chr(157);
+        $search[] = chr(226).chr(128).chr(157);
         $replace[] = '"';
         // Replace En Dash
-        $search[] = chr(226) . chr(128) . chr(147);
+        $search[] = chr(226).chr(128).chr(147);
         $replace[] = '--';
         // Replace Em Dash
-        $search[] = chr(226) . chr(128) . chr(148);
+        $search[] = chr(226).chr(128).chr(148);
         $replace[] = '---';
         // Replace Bullet
-        $search[] = chr(226) . chr(128) . chr(162);
+        $search[] = chr(226).chr(128).chr(162);
         $replace[] = '*';
         // Replace Middle Dot
-        $search[] = chr(194) . chr(183);
+        $search[] = chr(194).chr(183);
         $replace[] = '*';
         // Replace Ellipsis with three consecutive dots
-        $search[] = chr(226) . chr(128) . chr(166);
+        $search[] = chr(226).chr(128).chr(166);
         $replace[] = '...';
         // Apply Replacements
         $string = str_replace($search, $replace, $string);

core/services/locators/FqcnLocator.php

Doc Comments +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
      * given a valid namespace, will find all files that match the provided mask
      *
      * @access public
-     * @param string|array $namespaces
+     * @param string $namespaces
      * @return FilesystemIterator
      * @throws \EventEspresso\core\exceptions\InvalidClassException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException

Indentation +143 added lines, -143 removed lines

@@ -17,147 +17,147 @@
 class FqcnLocator extends Locator
 {
 
-    /**
-     * @var array $FQCNs
-     */
-    protected $FQCNs = array();
-
-    /**
-     * @var array $namespaces
-     */
-    protected $namespaces = array();
-
-
-    /**
-     * @access protected
-     * @param string $namespace
-     * @param string $namespace_base_dir
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setNamespace($namespace, $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFQCNs()
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @access public
-     * @param string|array $namespaces
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($namespaces)
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @access protected
-     * @param array $partial_namespace
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function FindFQCNsByNamespace($partial_namespace)
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        if (iterator_count($iterator) === 0) {
-            return array();
-        }
-        foreach ($iterator as $file) {
-            $file = \EEH_File::standardise_directory_separators($file);
-            foreach ($this->namespaces as $namespace => $base_dir) {
-                $namespace .= Psr4Autoloader::NS;
-                if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                        array($base_dir, DS, '.php'),
-                        array($namespace, Psr4Autoloader::NS, ''),
-                        $file
-                    );
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @access protected
-     * @param  string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getDirectoryFromPartialNamespace($partial_namespace)
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments then loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        // we're only interested in the first element, so pull that from the array
-        $namespace = array_shift($namespace_segments);
-        // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-        // nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
-    }
+	/**
+	 * @var array $FQCNs
+	 */
+	protected $FQCNs = array();
+
+	/**
+	 * @var array $namespaces
+	 */
+	protected $namespaces = array();
+
+
+	/**
+	 * @access protected
+	 * @param string $namespace
+	 * @param string $namespace_base_dir
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setNamespace($namespace, $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFQCNs()
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param string|array $namespaces
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($namespaces)
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @access protected
+	 * @param array $partial_namespace
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function FindFQCNsByNamespace($partial_namespace)
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		if (iterator_count($iterator) === 0) {
+			return array();
+		}
+		foreach ($iterator as $file) {
+			$file = \EEH_File::standardise_directory_separators($file);
+			foreach ($this->namespaces as $namespace => $base_dir) {
+				$namespace .= Psr4Autoloader::NS;
+				if (strpos($file, $base_dir) === 0) {
+					$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+						array($base_dir, DS, '.php'),
+						array($namespace, Psr4Autoloader::NS, ''),
+						$file
+					);
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @access protected
+	 * @param  string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getDirectoryFromPartialNamespace($partial_namespace)
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments then loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		// we're only interested in the first element, so pull that from the array
+		$namespace = array_shift($namespace_segments);
+		// check if there's a base directory registered for that namespace
+		$prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+		// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode(DS, $namespace_segments) . DS;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -36,13 +36,13 @@ 
      */
     protected function setNamespace($namespace, $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -77,12 +77,12 @@ 
      */
     public function locate($namespaces)
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -118,7 +118,7 @@ 
             foreach ($this->namespaces as $namespace => $base_dir) {
                 $namespace .= Psr4Autoloader::NS;
                 if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                    $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                         array($base_dir, DS, '.php'),
                         array($namespace, Psr4Autoloader::NS, ''),
                         $file
@@ -151,13 +151,13 @@ 
         // we're only interested in the first element, so pull that from the array
         $namespace = array_shift($namespace_segments);
         // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+        $prefix = $psr4_loader->prefixes($namespace.Psr4Autoloader::NS);
         // nope? then the incoming namespace is invalid
         if (empty($prefix) || empty($prefix[0])) {
             throw new InvalidClassException($partial_namespace);
         }
         $this->setNamespace($namespace, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
+        return $prefix[0].implode(DS, $namespace_segments).DS;
     }
 }

modules/ticket_selector/ProcessTicketSelector.php

Doc Comments +1 added lines, -1 removed lines

@@ -473,7 +473,7 @@
      *
      * @param EE_Ticket $ticket
      * @param int       $qty
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException

Indentation +497 added lines, -497 removed lines

@@ -33,526 +33,526 @@
 class ProcessTicketSelector
 {
 
-    /**
-     * @var EE_Cart $cart
-     */
-    private $cart;
+	/**
+	 * @var EE_Cart $cart
+	 */
+	private $cart;
 
-    /**
-     * @var EE_Core_Config $core_config
-     */
-    private $core_config;
+	/**
+	 * @var EE_Core_Config $core_config
+	 */
+	private $core_config;
 
-    /**
-     * @var Request $request
-     */
-    private $request;
+	/**
+	 * @var Request $request
+	 */
+	private $request;
 
-    /**
-     * @var EE_Session $session
-     */
-    private $session;
+	/**
+	 * @var EE_Session $session
+	 */
+	private $session;
 
-    /**
-     * @var EEM_Ticket $ticket_model
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket $ticket_model
+	 */
+	private $ticket_model;
 
-    /**
-     * @var TicketDatetimeAvailabilityTracker $tracker
-     */
-    private $tracker;
+	/**
+	 * @var TicketDatetimeAvailabilityTracker $tracker
+	 */
+	private $tracker;
 
 
-    /**
-     * ProcessTicketSelector constructor.
-     * NOTE: PLZ use the Loader to instantiate this class if need be
-     * so that all dependencies get injected correctly (which will happen automatically)
-     * Null values for parameters are only for backwards compatibility but will be removed later on.
-     *
-     * @param EE_Core_Config                    $core_config
-     * @param Request                           $request
-     * @param EE_Session                        $session
-     * @param EEM_Ticket                        $ticket_model
-     * @param TicketDatetimeAvailabilityTracker $tracker
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(
-        EE_Core_Config $core_config = null,
-        Request $request = null,
-        EE_Session $session = null,
-        EEM_Ticket $ticket_model = null,
-        TicketDatetimeAvailabilityTracker $tracker = null
-    ) {
-        /** @var LoaderInterface $loader */
-        $loader = LoaderFactory::getLoader();
-        $this->core_config = $core_config instanceof EE_Core_Config
-            ? $core_config
-            : $loader->getShared('EE_Core_Config');
-        $this->request = $request instanceof Request
-            ? $request
-            : $loader->getShared('EventEspresso\core\services\request\Request');
-        $this->session = $session instanceof EE_Session
-            ? $session
-            : $loader->getShared('EE_Session');
-        $this->ticket_model = $ticket_model instanceof EEM_Ticket
-            ? $ticket_model
-            : $loader->getShared('EEM_Ticket');
-        $this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
-            ? $tracker
-            : $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
-    }
+	/**
+	 * ProcessTicketSelector constructor.
+	 * NOTE: PLZ use the Loader to instantiate this class if need be
+	 * so that all dependencies get injected correctly (which will happen automatically)
+	 * Null values for parameters are only for backwards compatibility but will be removed later on.
+	 *
+	 * @param EE_Core_Config                    $core_config
+	 * @param Request                           $request
+	 * @param EE_Session                        $session
+	 * @param EEM_Ticket                        $ticket_model
+	 * @param TicketDatetimeAvailabilityTracker $tracker
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(
+		EE_Core_Config $core_config = null,
+		Request $request = null,
+		EE_Session $session = null,
+		EEM_Ticket $ticket_model = null,
+		TicketDatetimeAvailabilityTracker $tracker = null
+	) {
+		/** @var LoaderInterface $loader */
+		$loader = LoaderFactory::getLoader();
+		$this->core_config = $core_config instanceof EE_Core_Config
+			? $core_config
+			: $loader->getShared('EE_Core_Config');
+		$this->request = $request instanceof Request
+			? $request
+			: $loader->getShared('EventEspresso\core\services\request\Request');
+		$this->session = $session instanceof EE_Session
+			? $session
+			: $loader->getShared('EE_Session');
+		$this->ticket_model = $ticket_model instanceof EEM_Ticket
+			? $ticket_model
+			: $loader->getShared('EEM_Ticket');
+		$this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
+			? $tracker
+			: $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
+	}
 
 
-    /**
-     * cancelTicketSelections
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function cancelTicketSelections()
-    {
-        // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
-            return false;
-        }
-        $this->session->clear_session(__CLASS__, __FUNCTION__);
-        if ($this->request->requestParamIsSet('event_id')) {
-            EEH_URL::safeRedirectAndExit(
-                EEH_Event_View::event_link_url(
-                    $this->request->getRequestParam('event_id')
-                )
-            );
-        }
-        EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
-        );
-        return true;
-    }
+	/**
+	 * cancelTicketSelections
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function cancelTicketSelections()
+	{
+		// check nonce
+		if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+			return false;
+		}
+		$this->session->clear_session(__CLASS__, __FUNCTION__);
+		if ($this->request->requestParamIsSet('event_id')) {
+			EEH_URL::safeRedirectAndExit(
+				EEH_Event_View::event_link_url(
+					$this->request->getRequestParam('event_id')
+				)
+			);
+		}
+		EEH_URL::safeRedirectAndExit(
+			site_url('/' . $this->core_config->event_cpt_slug . '/')
+		);
+		return true;
+	}
 
 
-    /**
-     * processTicketSelectorNonce
-     *
-     * @param  string $nonce_name
-     * @param string  $id
-     * @return bool
-     */
-    private function processTicketSelectorNonce($nonce_name, $id = '')
-    {
-        $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (! $this->request->isAdmin()
-            && (
-                ! $this->request->is_set($nonce_name_with_id)
-                || ! wp_verify_nonce(
-                    $this->request->get($nonce_name_with_id),
-                    $nonce_name
-                )
-            )
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * processTicketSelectorNonce
+	 *
+	 * @param  string $nonce_name
+	 * @param string  $id
+	 * @return bool
+	 */
+	private function processTicketSelectorNonce($nonce_name, $id = '')
+	{
+		$nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
+		if (! $this->request->isAdmin()
+			&& (
+				! $this->request->is_set($nonce_name_with_id)
+				|| ! wp_verify_nonce(
+					$this->request->get($nonce_name_with_id),
+					$nonce_name
+				)
+			)
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * process_ticket_selections
-     *
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function processTicketSelections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        if ($this->request->isBot()) {
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
-                    site_url()
-                )
-            );
-        }
-        // do we have an event id?
-        $id = $this->getEventId();
-        // we should really only have 1 registration in the works now
-        // (ie, no MER) so unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            $this->session->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // validate/sanitize/filter data
-        $valid = apply_filters(
-            'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
-            $this->validatePostData($id)
-        );
-        // check total tickets ordered vs max number of attendees that can register
-        if ($valid['total_tickets'] > $valid['max_atndz']) {
-            $this->maxAttendeesViolation($valid);
-        } else {
-            // all data appears to be valid
-            if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
-                return true;
-            }
-        }
-        // die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-            return false;
-        }
-        if ($valid['return_url']) {
-            EEH_URL::safeRedirectAndExit($valid['return_url']);
-        }
-        if ($id) {
-            EEH_URL::safeRedirectAndExit(get_permalink($id));
-        }
-        echo EE_Error::get_notices();
-        return false;
-    }
+	/**
+	 * process_ticket_selections
+	 *
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processTicketSelections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		if ($this->request->isBot()) {
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
+					site_url()
+				)
+			);
+		}
+		// do we have an event id?
+		$id = $this->getEventId();
+		// we should really only have 1 registration in the works now
+		// (ie, no MER) so unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			$this->session->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// validate/sanitize/filter data
+		$valid = apply_filters(
+			'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
+			$this->validatePostData($id)
+		);
+		// check total tickets ordered vs max number of attendees that can register
+		if ($valid['total_tickets'] > $valid['max_atndz']) {
+			$this->maxAttendeesViolation($valid);
+		} else {
+			// all data appears to be valid
+			if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
+				return true;
+			}
+		}
+		// die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+			return false;
+		}
+		if ($valid['return_url']) {
+			EEH_URL::safeRedirectAndExit($valid['return_url']);
+		}
+		if ($id) {
+			EEH_URL::safeRedirectAndExit(get_permalink($id));
+		}
+		echo EE_Error::get_notices();
+		return false;
+	}
 
 
-    /**
-     * @return int
-     */
-    private function getEventId()
-    {
-        // do we have an event id?
-        if (! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
-            // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // if event id is valid
-        return absint($this->request->getRequestParam('tkt-slctr-event-id'));
-    }
+	/**
+	 * @return int
+	 */
+	private function getEventId()
+	{
+		// do we have an event id?
+		if (! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
+			// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// if event id is valid
+		return absint($this->request->getRequestParam('tkt-slctr-event-id'));
+	}
 
 
-    /**
-     * validate_post_data
-     *
-     * @param int $id
-     * @return array|FALSE
-     */
-    private function validatePostData($id = 0)
-    {
-        if (! $id) {
-            EE_Error::add_error(
-                esc_html__('The event id provided was not valid.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // start with an empty array()
-        $valid_data = array();
-        // grab valid id
-        $valid_data['id'] = $id;
-        // array of other form names
-        $inputs_to_clean = array(
-            'event_id'   => 'tkt-slctr-event-id',
-            'max_atndz'  => 'tkt-slctr-max-atndz-',
-            'rows'       => 'tkt-slctr-rows-',
-            'qty'        => 'tkt-slctr-qty-',
-            'ticket_id'  => 'tkt-slctr-ticket-id-',
-            'return_url' => 'tkt-slctr-return-url-',
-        );
-        // let's track the total number of tickets ordered.'
-        $valid_data['total_tickets'] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($inputs_to_clean as $what => $input_to_clean) {
-            // check for POST data
-            if ($this->request->requestParamIsSet($input_to_clean . $id)) {
-                // grab value
-                $input_value = $this->request->getRequestParam($input_to_clean . $id);
-                switch ($what) {
-                    // integers
-                    case 'event_id':
-                        $valid_data[ $what ] = absint($input_value);
-                        // get event via the event id we put in the form
-                        break;
-                    case 'rows':
-                    case 'max_atndz':
-                        $valid_data[ $what ] = absint($input_value);
-                        break;
-                    // arrays of integers
-                    case 'qty':
-                        /** @var array $row_qty */
-                        $row_qty = $input_value;
-                        // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
-                            /** @var string $row_qty */
-                            // get number of rows
-                            $rows = $this->request->requestParamIsSet('tkt-slctr-rows-' . $id)
-                                ? absint($this->request->getRequestParam('tkt-slctr-rows-' . $id))
-                                : 1;
-                            // explode integers by the dash
-                            $row_qty = explode('-', $row_qty);
-                            $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
-                            $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
-                            $row_qty = array($row => $qty);
-                            for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
-                                }
-                            }
-                        }
-                        ksort($row_qty);
-                        // cycle thru values
-                        foreach ($row_qty as $qty) {
-                            $qty = absint($qty);
-                            // sanitize as integers
-                            $valid_data[ $what ][] = $qty;
-                            $valid_data['total_tickets'] += $qty;
-                        }
-                        break;
-                    // array of integers
-                    case 'ticket_id':
-                        // cycle thru values
-                        foreach ((array) $input_value as $key => $value) {
-                            // allow only integers
-                            $valid_data[ $what ][ $key ] = absint($value);
-                        }
-                        break;
-                    case 'return_url':
-                        // grab and sanitize return-url
-                        $input_value = esc_url_raw($input_value);
-                        // was the request coming from an iframe ? if so, then:
-                        if (strpos($input_value, 'event_list=iframe')) {
-                            // get anchor fragment
-                            $input_value = explode('#', $input_value);
-                            $input_value = end($input_value);
-                            // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
-                        }
-                        $valid_data[ $what ] = $input_value;
-                        break;
-                }    // end switch $what
-            }
-        }    // end foreach $inputs_to_clean
-        return $valid_data;
-    }
+	/**
+	 * validate_post_data
+	 *
+	 * @param int $id
+	 * @return array|FALSE
+	 */
+	private function validatePostData($id = 0)
+	{
+		if (! $id) {
+			EE_Error::add_error(
+				esc_html__('The event id provided was not valid.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// start with an empty array()
+		$valid_data = array();
+		// grab valid id
+		$valid_data['id'] = $id;
+		// array of other form names
+		$inputs_to_clean = array(
+			'event_id'   => 'tkt-slctr-event-id',
+			'max_atndz'  => 'tkt-slctr-max-atndz-',
+			'rows'       => 'tkt-slctr-rows-',
+			'qty'        => 'tkt-slctr-qty-',
+			'ticket_id'  => 'tkt-slctr-ticket-id-',
+			'return_url' => 'tkt-slctr-return-url-',
+		);
+		// let's track the total number of tickets ordered.'
+		$valid_data['total_tickets'] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($inputs_to_clean as $what => $input_to_clean) {
+			// check for POST data
+			if ($this->request->requestParamIsSet($input_to_clean . $id)) {
+				// grab value
+				$input_value = $this->request->getRequestParam($input_to_clean . $id);
+				switch ($what) {
+					// integers
+					case 'event_id':
+						$valid_data[ $what ] = absint($input_value);
+						// get event via the event id we put in the form
+						break;
+					case 'rows':
+					case 'max_atndz':
+						$valid_data[ $what ] = absint($input_value);
+						break;
+					// arrays of integers
+					case 'qty':
+						/** @var array $row_qty */
+						$row_qty = $input_value;
+						// if qty is coming from a radio button input, then we need to assemble an array of rows
+						if (! is_array($row_qty)) {
+							/** @var string $row_qty */
+							// get number of rows
+							$rows = $this->request->requestParamIsSet('tkt-slctr-rows-' . $id)
+								? absint($this->request->getRequestParam('tkt-slctr-rows-' . $id))
+								: 1;
+							// explode integers by the dash
+							$row_qty = explode('-', $row_qty);
+							$row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
+							$qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
+							$row_qty = array($row => $qty);
+							for ($x = 1; $x <= $rows; $x++) {
+								if (! isset($row_qty[ $x ])) {
+									$row_qty[ $x ] = 0;
+								}
+							}
+						}
+						ksort($row_qty);
+						// cycle thru values
+						foreach ($row_qty as $qty) {
+							$qty = absint($qty);
+							// sanitize as integers
+							$valid_data[ $what ][] = $qty;
+							$valid_data['total_tickets'] += $qty;
+						}
+						break;
+					// array of integers
+					case 'ticket_id':
+						// cycle thru values
+						foreach ((array) $input_value as $key => $value) {
+							// allow only integers
+							$valid_data[ $what ][ $key ] = absint($value);
+						}
+						break;
+					case 'return_url':
+						// grab and sanitize return-url
+						$input_value = esc_url_raw($input_value);
+						// was the request coming from an iframe ? if so, then:
+						if (strpos($input_value, 'event_list=iframe')) {
+							// get anchor fragment
+							$input_value = explode('#', $input_value);
+							$input_value = end($input_value);
+							// use event list url instead, but append anchor
+							$input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+						}
+						$valid_data[ $what ] = $input_value;
+						break;
+				}    // end switch $what
+			}
+		}    // end foreach $inputs_to_clean
+		return $valid_data;
+	}
 
 
-    /**
-     * @param array $valid
-     */
-    private function maxAttendeesViolation(array $valid)
-    {
-        // ordering too many tickets !!!
-        $total_tickets_string = esc_html(
-            _n(
-                'You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.',
-                $valid['total_tickets'],
-                'event_espresso'
-            )
-        );
-        $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
-        // dev only message
-        $max_attendees_string = esc_html(
-            _n(
-                'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'],
-                'event_espresso'
-            )
-        );
-        $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * @param array $valid
+	 */
+	private function maxAttendeesViolation(array $valid)
+	{
+		// ordering too many tickets !!!
+		$total_tickets_string = esc_html(
+			_n(
+				'You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.',
+				$valid['total_tickets'],
+				'event_espresso'
+			)
+		);
+		$limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
+		// dev only message
+		$max_attendees_string = esc_html(
+			_n(
+				'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'],
+				'event_espresso'
+			)
+		);
+		$limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
+		EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+	}
 
 
-    /**
-     * @param array $valid
-     * @return int|TRUE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function addTicketsToCart(array $valid)
-    {
-        $tickets_added = 0;
-        $tickets_selected = false;
-        if ($valid['total_tickets'] > 0) {
-            // load cart using factory because we don't want to do so until actually needed
-            $this->cart = CartFactory::getCart();
-            // cycle thru the number of data rows sent from the event listing
-            for ($x = 0; $x < $valid['rows']; $x++) {
-                // does this row actually contain a ticket quantity?
-                if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
-                    // YES we have a ticket quantity
-                    $tickets_selected = true;
-                    $valid_ticket = false;
-                    // \EEH_Debug_Tools::printr(
-                    //     $valid['ticket_id'][ $x ],
-                    //     '$valid[\'ticket_id\'][ $x ]',
-                    //     __FILE__, __LINE__
-                    // );
-                    if (isset($valid['ticket_id'][ $x ])) {
-                        // get ticket via the ticket id we put in the form
-                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
-                        if ($ticket instanceof EE_Ticket) {
-                            $valid_ticket = true;
-                            $tickets_added += $this->addTicketToCart(
-                                $ticket,
-                                $valid['qty'][ $x ]
-                            );
-                        }
-                    }
-                    if ($valid_ticket !== true) {
-                        // nothing added to cart retrieved
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                    'event_espresso'
-                                ),
-                                '<br/>'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    if (EE_Error::has_error()) {
-                        break;
-                    }
-                }
-            }
-        }
-        do_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            $this->cart,
-            $this
-        );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
-            // no ticket quantities were selected
-            EE_Error::add_error(
-                esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $tickets_added;
-    }
+	/**
+	 * @param array $valid
+	 * @return int|TRUE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function addTicketsToCart(array $valid)
+	{
+		$tickets_added = 0;
+		$tickets_selected = false;
+		if ($valid['total_tickets'] > 0) {
+			// load cart using factory because we don't want to do so until actually needed
+			$this->cart = CartFactory::getCart();
+			// cycle thru the number of data rows sent from the event listing
+			for ($x = 0; $x < $valid['rows']; $x++) {
+				// does this row actually contain a ticket quantity?
+				if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+					// YES we have a ticket quantity
+					$tickets_selected = true;
+					$valid_ticket = false;
+					// \EEH_Debug_Tools::printr(
+					//     $valid['ticket_id'][ $x ],
+					//     '$valid[\'ticket_id\'][ $x ]',
+					//     __FILE__, __LINE__
+					// );
+					if (isset($valid['ticket_id'][ $x ])) {
+						// get ticket via the ticket id we put in the form
+						$ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
+						if ($ticket instanceof EE_Ticket) {
+							$valid_ticket = true;
+							$tickets_added += $this->addTicketToCart(
+								$ticket,
+								$valid['qty'][ $x ]
+							);
+						}
+					}
+					if ($valid_ticket !== true) {
+						// nothing added to cart retrieved
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+									'event_espresso'
+								),
+								'<br/>'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					if (EE_Error::has_error()) {
+						break;
+					}
+				}
+			}
+		}
+		do_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			$this->cart,
+			$this
+		);
+		if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+			// no ticket quantities were selected
+			EE_Error::add_error(
+				esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $tickets_added;
+	}
 
 
-    /**
-     * adds a ticket to the cart
-     *
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
-    {
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if (! apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
-                $this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
-                return true;
-            }
-            return false;
-        }
-        $this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
-        return false;
-    }
+	/**
+	 * adds a ticket to the cart
+	 *
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
+	{
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if (! apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
+				$this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
+				return true;
+			}
+			return false;
+		}
+		$this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
+		return false;
+	}
 
 
-    /**
-     * @param $tickets_added
-     * @return bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    private function processSuccessfulCart($tickets_added)
-    {
-        // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-        if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-            // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
-                $this->cart = CartFactory::getCart();
-            }
-            do_action(
-                'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                $this->cart,
-                $this
-            );
-            $this->cart->recalculate_all_cart_totals();
-            $this->cart->save_cart(false);
-            // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
-            // just return TRUE for registrations being made from admin
-            if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-                return true;
-            }
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                    $this->core_config->reg_page_url()
-                )
-            );
-        }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
-            // nothing added to cart
-            EE_Error::add_attention(
-                esc_html__('No tickets were added for the event', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
+	/**
+	 * @param $tickets_added
+	 * @return bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	private function processSuccessfulCart($tickets_added)
+	{
+		// exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+		if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+			// make sure cart is loaded
+			if (! $this->cart instanceof EE_Cart) {
+				$this->cart = CartFactory::getCart();
+			}
+			do_action(
+				'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+				$this->cart,
+				$this
+			);
+			$this->cart->recalculate_all_cart_totals();
+			$this->cart->save_cart(false);
+			// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
+			// just return TRUE for registrations being made from admin
+			if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+				return true;
+			}
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+					$this->core_config->reg_page_url()
+				)
+			);
+		}
+		if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+			// nothing added to cart
+			EE_Error::add_attention(
+				esc_html__('No tickets were added for the event', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -118,7 +118,7 @@ 
     public function cancelTicketSelections()
     {
         // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+        if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
             return false;
         }
         $this->session->clear_session(__CLASS__, __FUNCTION__);
@@ -130,7 +130,7 @@ 
             );
         }
         EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
+            site_url('/'.$this->core_config->event_cpt_slug.'/')
         );
         return true;
     }
@@ -146,7 +146,7 @@ 
     private function processTicketSelectorNonce($nonce_name, $id = '')
     {
         $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (! $this->request->isAdmin()
+        if ( ! $this->request->isAdmin()
             && (
                 ! $this->request->is_set($nonce_name_with_id)
                 || ! wp_verify_nonce(
@@ -236,7 +236,7 @@ 
     private function getEventId()
     {
         // do we have an event id?
-        if (! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
+        if ( ! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
             // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
             EE_Error::add_error(
                 sprintf(
@@ -264,7 +264,7 @@ 
      */
     private function validatePostData($id = 0)
     {
-        if (! $id) {
+        if ( ! $id) {
             EE_Error::add_error(
                 esc_html__('The event id provided was not valid.', 'event_espresso'),
                 __FILE__,
@@ -291,29 +291,29 @@ 
         // cycle through $inputs_to_clean array
         foreach ($inputs_to_clean as $what => $input_to_clean) {
             // check for POST data
-            if ($this->request->requestParamIsSet($input_to_clean . $id)) {
+            if ($this->request->requestParamIsSet($input_to_clean.$id)) {
                 // grab value
-                $input_value = $this->request->getRequestParam($input_to_clean . $id);
+                $input_value = $this->request->getRequestParam($input_to_clean.$id);
                 switch ($what) {
                     // integers
                     case 'event_id':
-                        $valid_data[ $what ] = absint($input_value);
+                        $valid_data[$what] = absint($input_value);
                         // get event via the event id we put in the form
                         break;
                     case 'rows':
                     case 'max_atndz':
-                        $valid_data[ $what ] = absint($input_value);
+                        $valid_data[$what] = absint($input_value);
                         break;
                     // arrays of integers
                     case 'qty':
                         /** @var array $row_qty */
                         $row_qty = $input_value;
                         // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
+                        if ( ! is_array($row_qty)) {
                             /** @var string $row_qty */
                             // get number of rows
-                            $rows = $this->request->requestParamIsSet('tkt-slctr-rows-' . $id)
-                                ? absint($this->request->getRequestParam('tkt-slctr-rows-' . $id))
+                            $rows = $this->request->requestParamIsSet('tkt-slctr-rows-'.$id)
+                                ? absint($this->request->getRequestParam('tkt-slctr-rows-'.$id))
                                 : 1;
                             // explode integers by the dash
                             $row_qty = explode('-', $row_qty);
@@ -321,8 +321,8 @@ 
                             $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
                             $row_qty = array($row => $qty);
                             for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
+                                if ( ! isset($row_qty[$x])) {
+                                    $row_qty[$x] = 0;
                                 }
                             }
                         }
@@ -331,7 +331,7 @@ 
                         foreach ($row_qty as $qty) {
                             $qty = absint($qty);
                             // sanitize as integers
-                            $valid_data[ $what ][] = $qty;
+                            $valid_data[$what][] = $qty;
                             $valid_data['total_tickets'] += $qty;
                         }
                         break;
@@ -340,7 +340,7 @@ 
                         // cycle thru values
                         foreach ((array) $input_value as $key => $value) {
                             // allow only integers
-                            $valid_data[ $what ][ $key ] = absint($value);
+                            $valid_data[$what][$key] = absint($value);
                         }
                         break;
                     case 'return_url':
@@ -352,9 +352,9 @@ 
                             $input_value = explode('#', $input_value);
                             $input_value = end($input_value);
                             // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+                            $input_value = EEH_Event_View::event_archive_url().'#'.$input_value;
                         }
-                        $valid_data[ $what ] = $input_value;
+                        $valid_data[$what] = $input_value;
                         break;
                 }    // end switch $what
             }
@@ -388,7 +388,7 @@ 
             )
         );
         $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+        EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
     }
 
 
@@ -410,7 +410,7 @@ 
             // cycle thru the number of data rows sent from the event listing
             for ($x = 0; $x < $valid['rows']; $x++) {
                 // does this row actually contain a ticket quantity?
-                if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+                if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
                     // YES we have a ticket quantity
                     $tickets_selected = true;
                     $valid_ticket = false;
@@ -419,14 +419,14 @@ 
                     //     '$valid[\'ticket_id\'][ $x ]',
                     //     __FILE__, __LINE__
                     // );
-                    if (isset($valid['ticket_id'][ $x ])) {
+                    if (isset($valid['ticket_id'][$x])) {
                         // get ticket via the ticket id we put in the form
-                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
+                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][$x]);
                         if ($ticket instanceof EE_Ticket) {
                             $valid_ticket = true;
                             $tickets_added += $this->addTicketToCart(
                                 $ticket,
-                                $valid['qty'][ $x ]
+                                $valid['qty'][$x]
                             );
                         }
                     }
@@ -456,7 +456,7 @@ 
             $this->cart,
             $this
         );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+        if ( ! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
             // no ticket quantities were selected
             EE_Error::add_error(
                 esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
@@ -487,7 +487,7 @@ 
         // compare available spaces against the number of tickets being purchased
         if ($available_spaces >= $qty) {
             // allow addons to prevent a ticket from being added to cart
-            if (! apply_filters(
+            if ( ! apply_filters(
                 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
                 true,
                 $ticket,
@@ -522,7 +522,7 @@ 
         // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
         if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
             // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
+            if ( ! $this->cart instanceof EE_Cart) {
                 $this->cart = CartFactory::getCart();
             }
             do_action(
@@ -544,7 +544,7 @@ 
                 )
             );
         }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+        if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
             // nothing added to cart
             EE_Error::add_attention(
                 esc_html__('No tickets were added for the event', 'event_espresso'),

widgets/EspressoWidget.php

Indentation +22 added lines, -22 removed lines

@@ -13,28 +13,28 @@
 {
 
 
-    /**
-     * @param string $name
-     * @param array  $widget_options
-     * @param array  $control_options
-     */
-    public function __construct($name = '', array $widget_options = array(), array $control_options = array())
-    {
-        $id_base = EspressoWidget::getIdBase(get_class($this));
-        $control_options['id_base'] = $id_base;
-        $control_options['height'] = isset($control_options['height']) ? $control_options['height'] : 300;
-        $control_options['width'] = isset($control_options['width']) ? $control_options['width'] : 350;
-        // Register widget with WordPress
-        parent::__construct($id_base, $name, $widget_options, $control_options);
-    }
+	/**
+	 * @param string $name
+	 * @param array  $widget_options
+	 * @param array  $control_options
+	 */
+	public function __construct($name = '', array $widget_options = array(), array $control_options = array())
+	{
+		$id_base = EspressoWidget::getIdBase(get_class($this));
+		$control_options['id_base'] = $id_base;
+		$control_options['height'] = isset($control_options['height']) ? $control_options['height'] : 300;
+		$control_options['width'] = isset($control_options['width']) ? $control_options['width'] : 350;
+		// Register widget with WordPress
+		parent::__construct($id_base, $name, $widget_options, $control_options);
+	}
 
 
-    /**
-     * @param string $widget_class
-     * @return string
-     */
-    public static function getIdBase($widget_class)
-    {
-        return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget';
-    }
+	/**
+	 * @param string $widget_class
+	 * @return string
+	 */
+	public static function getIdBase($widget_class)
+	{
+		return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget';
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -35,6 +35,6 @@
      */
     public static function getIdBase($widget_class)
     {
-        return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget';
+        return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)).'-widget';
     }
 }

modules/ticket_selector/TicketSelectorRowStandard.php

Indentation +355 added lines, -355 removed lines

@@ -17,359 +17,359 @@
 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_attendees
-     * @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_attendees,
-        $row,
-        $cols,
-        $required_ticket_sold_out,
-        $event_status,
-        $ticket_datetime_classes
-    ) {
-        $this->ticket_details = $ticket_details;
-        $this->template_settings = $ticket_details->getTemplateSettings();
-        $this->tax_settings = $tax_settings;
-        $this->row = $row;
-        $this->cols = $cols;
-        $this->ticket_datetime_classes = $ticket_datetime_classes;
-        parent::__construct(
-            $ticket_details->getTicket(),
-            $max_attendees,
-            $ticket_details->getDateFormat(),
-            $event_status,
-            $required_ticket_sold_out,
-            $total_tickets
-        );
-    }
-
-
-    /**
-     * 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()
-    {
-        $this->min = 0;
-        $this->max = $this->ticket->max();
-        $remaining = $this->ticket->remaining();
-        if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
-            $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;
-        }
-        $this->setTicketPriceDetails();
-        $this->setTicketStatusClasses($remaining);
-        $filtered_row_html = $this->getFilteredRowHtml();
-        if ($filtered_row_html !== false) {
-            return $filtered_row_html;
-        }
-        $ticket_selector_row_html = EEH_HTML::tr(
-            '',
-            '',
-            "tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
-            . espresso_get_object_css_class($this->ticket)
-        );
-        $filtered_row_content = $this->getFilteredRowContents();
-        if ($filtered_row_content !== false && $this->max_attendees === 1) {
-            return $ticket_selector_row_html
-                   . $filtered_row_content
-                   . $this->ticketQtyAndIdHiddenInputs()
-                   . EEH_HTML::trx();
-        }
-        if ($filtered_row_content !== false) {
-            return $ticket_selector_row_html
-                   . $filtered_row_content
-                   . EEH_HTML::trx();
-        }
-        $this->hidden_input_qty = $this->max_attendees > 1;
-
-        $ticket_selector_row_html .= $this->ticketNameTableCell();
-        $ticket_selector_row_html .= $this->ticketPriceTableCell();
-        $ticket_selector_row_html .= EEH_HTML::td(
-            '',
-            '',
-            'tckt-slctr-tbl-td-qty cntr',
-            '',
-            'headers="quantity-' . $this->EVT_ID . '"'
-        );
-        $this->setTicketStatusDisplay($remaining);
-        if (empty($this->ticket_status_display)) {
-            if ($this->max_attendees === 1) {
-                // only ONE attendee is allowed to register at a time
-                $ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
-            } elseif ($this->max > 0) {
-                $ticket_selector_row_html .= $this->ticketQuantitySelector();
-            }
-        }
-        $ticket_selector_row_html .= $this->ticket_status_display;
-        $ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
-        $ticket_selector_row_html .= $this->ticket_details->display(
-            $this->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;
-    }
-
-
-    /**
-     * getTicketPriceDetails
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function setTicketPriceDetails()
-    {
-        $this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
-            ? $this->ticket->get_ticket_total_with_taxes()
-            : $this->ticket->get_ticket_subtotal();
-        $this->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()) {
-            $this->ticket_price *= $ticket_min;
-            $this->ticket_bundle = true;
-        }
-        $this->ticket_price = apply_filters(
-            'FHEE__ticket_selector_chart_template__ticket_price',
-            $this->ticket_price,
-            $this->ticket
-        );
-    }
-
-
-    /**
-     * ticketNameTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketNameTableCell()
-    {
-        $html = EEH_HTML::td(
-            '',
-            '',
-            'tckt-slctr-tbl-td-name',
-            '',
-            'headers="details-' . $this->EVT_ID . '"'
-        );
-        $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
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketPriceTableCell()
-    {
-        $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',
-                '',
-                'headers="price-' . $this->EVT_ID . '"'
-            );
-            $html .= \EEH_Template::format_currency($this->ticket_price);
-            $html .= $this->ticket->taxable()
-                ? EEH_HTML::span('*', '', 'taxable-tickets-asterisk grey-text')
-                : '';
-            $html .= ' ';
-            // phpcs:disable WordPress.WP.I18n.NoEmptyStrings
-            $html .= EEH_HTML::span(
-                $this->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;
-        $id = 'ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row;
-        $html = '<label class="ee-a11y-screen-reader-text" for="' . $id . '">';
-        $html .= esc_html__('Select this ticket', 'event_espresso') . '</label>';
-        $html .= '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
-        $html .= ' id="' . $id . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
-        $html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
-        $html .= ' title=""/>';
-        return $html;
-    }
-
-
-    /**
-     * ticketQuantitySelector
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketQuantitySelector()
-    {
-        // 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;
-        $id = 'ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row;
-        $html = '<label class="ee-a11y-screen-reader-text" for="' . $id . '">';
-        $html .= esc_html__('Quantity', 'event_espresso') . '</label>';
-        $html .= '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
-        $html .= ' id="' . $id . '"';
-        $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 ($this->min !== 0 && ! $this->ticket->required()) {
-            $html .= '<option value="0">&nbsp;0&nbsp;</option>';
-        }
-        // offer ticket quantities from the min to the max
-        for ($i = $this->min; $i <= $this->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_attendees
+	 * @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_attendees,
+		$row,
+		$cols,
+		$required_ticket_sold_out,
+		$event_status,
+		$ticket_datetime_classes
+	) {
+		$this->ticket_details = $ticket_details;
+		$this->template_settings = $ticket_details->getTemplateSettings();
+		$this->tax_settings = $tax_settings;
+		$this->row = $row;
+		$this->cols = $cols;
+		$this->ticket_datetime_classes = $ticket_datetime_classes;
+		parent::__construct(
+			$ticket_details->getTicket(),
+			$max_attendees,
+			$ticket_details->getDateFormat(),
+			$event_status,
+			$required_ticket_sold_out,
+			$total_tickets
+		);
+	}
+
+
+	/**
+	 * 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()
+	{
+		$this->min = 0;
+		$this->max = $this->ticket->max();
+		$remaining = $this->ticket->remaining();
+		if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
+			$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;
+		}
+		$this->setTicketPriceDetails();
+		$this->setTicketStatusClasses($remaining);
+		$filtered_row_html = $this->getFilteredRowHtml();
+		if ($filtered_row_html !== false) {
+			return $filtered_row_html;
+		}
+		$ticket_selector_row_html = EEH_HTML::tr(
+			'',
+			'',
+			"tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
+			. espresso_get_object_css_class($this->ticket)
+		);
+		$filtered_row_content = $this->getFilteredRowContents();
+		if ($filtered_row_content !== false && $this->max_attendees === 1) {
+			return $ticket_selector_row_html
+				   . $filtered_row_content
+				   . $this->ticketQtyAndIdHiddenInputs()
+				   . EEH_HTML::trx();
+		}
+		if ($filtered_row_content !== false) {
+			return $ticket_selector_row_html
+				   . $filtered_row_content
+				   . EEH_HTML::trx();
+		}
+		$this->hidden_input_qty = $this->max_attendees > 1;
+
+		$ticket_selector_row_html .= $this->ticketNameTableCell();
+		$ticket_selector_row_html .= $this->ticketPriceTableCell();
+		$ticket_selector_row_html .= EEH_HTML::td(
+			'',
+			'',
+			'tckt-slctr-tbl-td-qty cntr',
+			'',
+			'headers="quantity-' . $this->EVT_ID . '"'
+		);
+		$this->setTicketStatusDisplay($remaining);
+		if (empty($this->ticket_status_display)) {
+			if ($this->max_attendees === 1) {
+				// only ONE attendee is allowed to register at a time
+				$ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
+			} elseif ($this->max > 0) {
+				$ticket_selector_row_html .= $this->ticketQuantitySelector();
+			}
+		}
+		$ticket_selector_row_html .= $this->ticket_status_display;
+		$ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
+		$ticket_selector_row_html .= $this->ticket_details->display(
+			$this->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;
+	}
+
+
+	/**
+	 * getTicketPriceDetails
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function setTicketPriceDetails()
+	{
+		$this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
+			? $this->ticket->get_ticket_total_with_taxes()
+			: $this->ticket->get_ticket_subtotal();
+		$this->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()) {
+			$this->ticket_price *= $ticket_min;
+			$this->ticket_bundle = true;
+		}
+		$this->ticket_price = apply_filters(
+			'FHEE__ticket_selector_chart_template__ticket_price',
+			$this->ticket_price,
+			$this->ticket
+		);
+	}
+
+
+	/**
+	 * ticketNameTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketNameTableCell()
+	{
+		$html = EEH_HTML::td(
+			'',
+			'',
+			'tckt-slctr-tbl-td-name',
+			'',
+			'headers="details-' . $this->EVT_ID . '"'
+		);
+		$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
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketPriceTableCell()
+	{
+		$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',
+				'',
+				'headers="price-' . $this->EVT_ID . '"'
+			);
+			$html .= \EEH_Template::format_currency($this->ticket_price);
+			$html .= $this->ticket->taxable()
+				? EEH_HTML::span('*', '', 'taxable-tickets-asterisk grey-text')
+				: '';
+			$html .= '&nbsp;';
+			// phpcs:disable WordPress.WP.I18n.NoEmptyStrings
+			$html .= EEH_HTML::span(
+				$this->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;
+		$id = 'ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row;
+		$html = '<label class="ee-a11y-screen-reader-text" for="' . $id . '">';
+		$html .= esc_html__('Select this ticket', 'event_espresso') . '</label>';
+		$html .= '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
+		$html .= ' id="' . $id . '"';
+		$html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
+		$html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
+		$html .= ' title=""/>';
+		return $html;
+	}
+
+
+	/**
+	 * ticketQuantitySelector
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketQuantitySelector()
+	{
+		// 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;
+		$id = 'ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row;
+		$html = '<label class="ee-a11y-screen-reader-text" for="' . $id . '">';
+		$html .= esc_html__('Quantity', 'event_espresso') . '</label>';
+		$html .= '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
+		$html .= ' id="' . $id . '"';
+		$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 ($this->min !== 0 && ! $this->ticket->required()) {
+			$html .= '<option value="0">&nbsp;0&nbsp;</option>';
+		}
+		// offer ticket quantities from the min to the max
+		for ($i = $this->min; $i <= $this->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;
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -174,7 +174,7 @@ 
             '',
             'tckt-slctr-tbl-td-qty cntr',
             '',
-            'headers="quantity-' . $this->EVT_ID . '"'
+            'headers="quantity-'.$this->EVT_ID.'"'
         );
         $this->setTicketStatusDisplay($remaining);
         if (empty($this->ticket_status_display)) {
@@ -240,7 +240,7 @@ 
             '',
             'tckt-slctr-tbl-td-name',
             '',
-            'headers="details-' . $this->EVT_ID . '"'
+            'headers="details-'.$this->EVT_ID.'"'
         );
         $html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
         $html .= $this->ticket_details->getShowHideLinks();
@@ -274,7 +274,7 @@ 
                 '',
                 'tckt-slctr-tbl-td-price jst-rght',
                 '',
-                'headers="price-' . $this->EVT_ID . '"'
+                'headers="price-'.$this->EVT_ID.'"'
             );
             $html .= \EEH_Template::format_currency($this->ticket_price);
             $html .= $this->ticket->taxable()
@@ -313,12 +313,12 @@ 
         // 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;
-        $id = 'ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row;
-        $html = '<label class="ee-a11y-screen-reader-text" for="' . $id . '">';
-        $html .= esc_html__('Select this ticket', 'event_espresso') . '</label>';
-        $html .= '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
-        $html .= ' id="' . $id . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
+        $id = 'ticket-selector-tbl-qty-slct-'.$this->EVT_ID.'-'.$this->row;
+        $html = '<label class="ee-a11y-screen-reader-text" for="'.$id.'">';
+        $html .= esc_html__('Select this ticket', 'event_espresso').'</label>';
+        $html .= '<input type="radio" name="tkt-slctr-qty-'.$this->EVT_ID.'"';
+        $html .= ' id="'.$id.'"';
+        $html .= ' class="ticket-selector-tbl-qty-slct" value="'.$this->row.'-1"';
         $html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
         $html .= ' title=""/>';
         return $html;
@@ -336,11 +336,11 @@ 
         // 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;
-        $id = 'ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row;
-        $html = '<label class="ee-a11y-screen-reader-text" for="' . $id . '">';
-        $html .= esc_html__('Quantity', 'event_espresso') . '</label>';
-        $html .= '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
-        $html .= ' id="' . $id . '"';
+        $id = 'ticket-selector-tbl-qty-slct-'.$this->EVT_ID.'-'.$this->row;
+        $html = '<label class="ee-a11y-screen-reader-text" for="'.$id.'">';
+        $html .= esc_html__('Quantity', 'event_espresso').'</label>';
+        $html .= '<select name="tkt-slctr-qty-'.$this->EVT_ID.'[]"';
+        $html .= ' id="'.$id.'"';
         $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 ($this->min !== 0 && ! $this->ticket->required()) {
@@ -348,7 +348,7 @@ 
         }
         // offer ticket quantities from the min to the max
         for ($i = $this->min; $i <= $this->max; $i++) {
-            $html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
+            $html .= '<option value="'.$i.'">&nbsp;'.$i.'&nbsp;</option>';
         }
         $html .= '</select>';
         return $html;
@@ -366,10 +366,10 @@ 
         $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-qty-'.$this->EVT_ID.'[]" value="0"/>';
         }
-        $html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
-        $html .= ' value="' . $this->ticket->ID() . '"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-ticket-id-'.$this->EVT_ID.'[]"';
+        $html .= ' value="'.$this->ticket->ID().'"/>';
         return $html;
     }
 }

modules/ticket_selector/TicketSelectorIframeEmbedButton.php

Indentation +18 added lines, -18 removed lines

@@ -14,24 +14,24 @@
 class TicketSelectorIframeEmbedButton extends IframeEmbedButton
 {
 
-    /**
-     * TicketSelectorIframeEmbedButton constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'ticket_selector'
-        );
-    }
+	/**
+	 * TicketSelectorIframeEmbedButton constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'ticket_selector'
+		);
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     */
-    public function addEventEditorIframeEmbedButton()
-    {
-        // add button for iframe code to event editor.
-        $this->addEventEditorIframeEmbedButtonFilter();
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 */
+	public function addEventEditorIframeEmbedButton()
+	{
+		// add button for iframe code to event editor.
+		$this->addEventEditorIframeEmbedButtonFilter();
+	}
 }