EventEspresso\core\libraries\rest_api\changes\ChangesIn40836

Complexity

Total Complexity

14

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	setHooks()	0	41	1
A	removeCalculateQueryParam()	0	7	2
A	removeCalculatedFieldsFromResponse()	0	12	2
A	removeHeadersNewInThisVersion()	0	19	2
A	addOldFeaturedImagePartOfCptEntities()	0	18	4
A	useNegativeOneForInfinityBeforeThisVersion()	0	14	3

<?php namespace EventEspresso\core\libraries\rest_api\changes;

use WP_REST_Request;
use EventEspresso\core\libraries\rest_api\controllers\model\Read;
use EventEspresso\core\libraries\rest_api\controllers\model\Base;
use EventEspresso\core\libraries\rest_api\controllers\Base as Controller_Base;
use EEM_Base;

/*
 * The checkin and checkout endpoints were added in 4.8.36,
 * where we just added a response headers
 */



class ChangesIn40836 extends ChangesInBase
{

    /**
     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
     */
    public function setHooks()
    {
        //set a hook to remove the "calculate" query param
        add_filter(
            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
            array($this, 'removeCalculateQueryParam'),
            10,
            3
        );
        //don't add the _calculated_fields either
        add_filter(
            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
            array($this, 'removeCalculatedFieldsFromResponse'),
            10,
            5
        );
        //and also don't add the count headers
        add_filter(
            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
            array($this, 'removeHeadersNewInThisVersion'),
            10,
            3
        );
        //remove the old featured_image part of the response...
        add_filter(
            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
            array($this, 'addOldFeaturedImagePartOfCptEntities'),
            10,
            5
        );
        //assuming ticket 9425's change gets pushed with 9406, we don't need to
        //remove it from the calculated fields on older requests (because this will
        //be the first version with calculated fields)
        //before this, infinity was -1, now it's null
        add_filter(
            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
            array($this, 'useNegativeOneForInfinityBeforeThisVersion'),
            10,
            4
        );
    }



    /**
     * Don't show "calculate" as an query param option in the index
     *
     * @param array     $query_params
     * @param EEM_Base $model
     * @param string    $version
     * @return array
     */
    public function removeCalculateQueryParam($query_params, EEM_Base $model, $version)
    {
        if ($this->appliesToVersion($version)) {
            unset($query_params['calculate']);
        }
        return $query_params;
    }



    /**
     * Removes the "_calculate_fields" part of entity responses before 4.8.36
     *
     * @param array            $entity_response_array
     * @param EEM_Base        $model
     * @param string           $request_context
     * @param WP_REST_Request $request
     * @param Read             $controller
     * @return array
     */
    public function removeCalculatedFieldsFromResponse(
        $entity_response_array,
        EEM_Base $model,
        $request_context,
        WP_REST_Request $request,
        Read $controller
    ) {
        if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) {
            unset($entity_response_array['_calculated_fields']);
        }
        return $entity_response_array;
    }



    /**
     * Removes the new headers for requests before 4.8.36
     *
     * @param array           $headers
     * @param Controller_Base $controller
     * @param string          $version
     * @return array
     */
    public function removeHeadersNewInThisVersion(
        $headers,
        Controller_Base $controller,
        $version
    ) {
        if ($this->appliesToVersion($version)) {
            $headers = array_diff_key(
                $headers,
                array_flip(
                    array(
                        Base::HEADER_PREFIX_FOR_WP . 'Total',
                        Base::HEADER_PREFIX_FOR_WP . 'TotalPages',
                        Base::HEADER_PREFIX_FOR_WP . 'PageSize',
                    )
                )
            );
        }
        return $headers;
    }



    /**
     * Puts the 'featured_image_url' back in for responses before 4.8.36.
     *
     * @param array            $entity_response_array
     * @param EEM_Base        $model
     * @param string           $request_context
     * @param WP_REST_Request $request
     * @param Read             $controller
     * @return array
     */
    public function addOldFeaturedImagePartOfCptEntities(
        $entity_response_array,
        EEM_Base $model,
        $request_context,
        WP_REST_Request $request,
        Read $controller
    ) {
        if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())
            && $model instanceof \EEM_CPT_Base
        ) {
            $attachment = wp_get_attachment_image_src(
                get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
                'full'
            );
            $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
        }
        return $entity_response_array;
    }



    /**
     * If the value was infinity, we now use null in our JSON responses,
     * but before this version we used -1.
     *
     * @param mixed                $new_value
     * @param \EE_Model_Field_Base $field_obj
     * @param mixed                $original_value
     * @param string               $requested_value
     * @return mixed
     */
    public function useNegativeOneForInfinityBeforeThisVersion(
        $new_value,
        $field_obj,
        $original_value,
        $requested_value
    ) {
        if ($this->appliesToVersion($requested_value)
            && $original_value === EE_INF
        ) {
            //return the old representation of infinity in the JSON
            return -1;
        }
        return $new_value;
    }
}