EventEspresso\core\CPTs\CptQueryModifier

Complexity

Total Complexity

63

Size/Duplication

Total Lines	569
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	postType()	0	4	1
A	setPostType()	0	4	1
A	cptDetails()	0	4	1
A	setCptDetails()	0	4	1
A	modelTables()	0	4	1
A	setModelTables()	0	4	1
A	taxonomies()	0	7	2
A	setTaxonomies()	0	4	1
A	metaTable()	0	4	1
A	setMetaTable()	0	4	1
A	model()	0	4	1
A	setModel()	0	4	1
A	request()	0	4	1
A	WpQuery()	0	4	1
A	setWpQuery()	0	4	1
B	initializeTaxonomies()	0	27	5
B	init()	0	34	2
B	setAdditionalCptDetails()	0	18	5
B	setRequestVarsIfCpt()	0	15	6
B	setupModelsAndTables()	0	28	5
A	cptStrategyClass()	0	17	2
A	postsFields()	0	10	2
A	postsJoin()	0	19	2
B	thePosts()	0	14	5
B	getEditPostLink()	0	25	5
A	addTemplateFilters()	0	8	3
A	singleCptTemplate()	0	15	4

<?php

namespace EventEspresso\core\CPTs;

use EE_Config;
use EE_Error;
use EE_Request_Handler;
use EE_Secondary_Table;
use EE_Table_Base;
use EEM_Base;
use EEM_CPT_Base;
use EventEspresso\core\exceptions\InvalidDataTypeException;
use EventEspresso\core\exceptions\InvalidInterfaceException;
use EventEspresso\core\services\loaders\LoaderInterface;
use EventEspresso\core\services\request\RequestInterface;
use InvalidArgumentException;
use WP_Post;
use WP_Query;

/**
 * Class CptQueryModifier
 * Description
 *
 * @package       Event Espresso
 * @subpackage    core
 * @author        Brent Christensen
 */
class CptQueryModifier
{

    /**
     * @var string $post_type
     */
    protected $post_type = '';

    /**
     * CPT details from CustomPostTypeDefinitions for specific post type
     *
     * @var array $cpt_details
     */
    protected $cpt_details = array();

    /**
     * @var EE_Table_Base[] $model_tables
     */
    protected $model_tables = array();

    /**
     * @var array $taxonomies
     */
    protected $taxonomies = array();

    /**
     * meta table for the related CPT
     *
     * @var EE_Secondary_Table $meta_table
     */
    protected $meta_table;

    /**
     * EEM_CPT_Base model for the related CPT
     *
     * @var EEM_CPT_Base $model
     */
    protected $model;

    /**
     * @var EE_Request_Handler $request_handler
     */
    protected $request_handler;

    /**
     * @var WP_Query $wp_query
     */
    protected $wp_query;

    /**
     * @var LoaderInterface $loader
     */
    protected $loader;

    /**
     * @var RequestInterface $request
     */
    protected $request;


    /**
     * CptQueryModifier constructor
     *
     * @param string             $post_type
     * @param array              $cpt_details
     * @param WP_Query           $WP_Query
     * @param EE_Request_Handler $request_handler
     * @param RequestInterface   $request
     * @param LoaderInterface    $loader
     * @throws EE_Error
     */
    public function __construct(
        $post_type,
        array $cpt_details,
        WP_Query $WP_Query,
        EE_Request_Handler $request_handler,
        RequestInterface $request,
        LoaderInterface $loader
    ) {
        $this->loader = $loader;
        $this->request = $request;
        $this->request_handler = $request_handler;
        $this->setWpQuery($WP_Query);
        $this->setPostType($post_type);
        $this->setCptDetails($cpt_details);
        $this->init();
    }


    /**
     * @return string
     */
    public function postType()
    {
        return $this->post_type;
    }


    /**
     * @param string $post_type
     */
    protected function setPostType($post_type)
    {
        $this->post_type = $post_type;
    }


    /**
     * @return array
     */
    public function cptDetails()
    {
        return $this->cpt_details;
    }


    /**
     * @param array $cpt_details
     */
    protected function setCptDetails($cpt_details)
    {
        $this->cpt_details = $cpt_details;
    }


    /**
     * @return EE_Table_Base[]
     */
    public function modelTables()
    {
        return $this->model_tables;
    }


    /**
     * @param EE_Table_Base[] $model_tables
     */
    protected function setModelTables($model_tables)
    {
        $this->model_tables = $model_tables;
    }


    /**
     * @return array
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function taxonomies()
    {
        if (empty($this->taxonomies)) {
            $this->initializeTaxonomies();
        }
        return $this->taxonomies;
    }


    /**
     * @param array $taxonomies
     */
    protected function setTaxonomies(array $taxonomies)
    {
        $this->taxonomies = $taxonomies;
    }


    /**
     * @return EE_Secondary_Table
     */
    public function metaTable()
    {
        return $this->meta_table;
    }


    /**
     * @param EE_Secondary_Table $meta_table
     */
    public function setMetaTable(EE_Secondary_Table $meta_table)
    {
        $this->meta_table = $meta_table;
    }


    /**
     * @return EEM_Base
     */
    public function model()
    {
        return $this->model;
    }


    /**
     * @param EEM_Base $CPT_model
     */
    protected function setModel(EEM_Base $CPT_model)
    {
        $this->model = $CPT_model;

$CPT_model is of type object<EEM_Base>, but the property $model was declared to be of type object<EEM_CPT_Base>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }


    /**
     * @deprecated $VID:$
     * @return EE_Request_Handler
     */
    public function request()
    {
        return $this->request_handler;
    }



    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps


    /**
     * @return WP_Query
     */
    public function WpQuery()
    {
        return $this->wp_query;
    }
    // phpcs:enable


    /**
     * @param WP_Query $wp_query
     */
    public function setWpQuery(WP_Query $wp_query)
    {
        $this->wp_query = $wp_query;
    }


    /**
     * @return void
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @throws InvalidArgumentException
     */
    protected function initializeTaxonomies()
    {
        // check if taxonomies have already been set and that this CPT has taxonomies registered for it
        if (empty($this->taxonomies)
            && isset($this->cpt_details['args']['taxonomies'])
        ) {
            // if so then grab them, but we want the taxonomy name as the key
            $taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
            // then grab the list of ALL taxonomies
            /** @var \EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions
             * $taxonomy_definitions
             */
            $taxonomy_definitions = $this->loader->getShared(
                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
            );
            $all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
            foreach ($taxonomies as $taxonomy => &$details) {
                // add details to our taxonomies if they exist
                $details = isset($all_taxonomies[ $taxonomy ])
                    ? $all_taxonomies[ $taxonomy ]
                    : array();
            }
            // ALWAYS unset() variables that were passed by reference
            unset($details);
            $this->setTaxonomies($taxonomies);
        }
    }


    /**
     * @since $VID:$
     * @throws EE_Error
     */
    protected function init()
    {
        $this->setAdditionalCptDetails();
        $this->setRequestVarsIfCpt();
        // convert post_type to model name
        $model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
        // load all tables related to CPT
        $this->setupModelsAndTables($model_name);
        // load and instantiate CPT_*_Strategy
        $CPT_Strategy = $this->cptStrategyClass($model_name);
        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
        // here's the list of available filters in the WP_Query object
        // 'posts_where_paged'
        // 'posts_groupby'
        // 'posts_join_paged'
        // 'posts_orderby'
        // 'posts_distinct'
        // 'post_limits'
        // 'posts_fields'
        // 'posts_join'
        add_filter('posts_fields', array($this, 'postsFields'));
        add_filter('posts_join', array($this, 'postsJoin'));
        add_filter(
            'get_' . $this->post_type . '_metadata',
            array($CPT_Strategy, 'get_EE_post_type_metadata'),
            1,
            4
        );
        add_filter('the_posts', array($this, 'thePosts'), 1, 1);
        if ($this->wp_query->is_main_query()) {
            add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
            $this->addTemplateFilters();
        }
    }


    /**
     * sets some basic query vars that pertain to the CPT
     *
     * @access protected
     * @return void
     */
    protected function setAdditionalCptDetails()
    {
        // the post or category or term that is triggering EE
        $this->cpt_details['espresso_page'] = $this->request_handler->is_espresso_page();
        // requested post name
        $this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
        // add support for viewing 'private', 'draft', or 'pending' posts
        if (isset($this->wp_query->query_vars['p'])
            && $this->wp_query->query_vars['p'] !== 0
            && is_user_logged_in()
            && current_user_can('edit_post', $this->wp_query->query_vars['p'])
        ) {
            // we can just inject directly into the WP_Query object
            $this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
            // now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
            $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
        }
    }


    /**
     * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
     * If so, sets the 'ee' request variable
     * so other parts of EE can know what CPT is getting queried.
     * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
     * in order for is_archive() and is_single() methods to work properly.
     *
     * @return void
     */
    public function setRequestVarsIfCpt()
    {
        // check if ee action var has been set
        if (! $this->request->requestParamIsSet('ee')) {
            // check that route exists for CPT archive slug
            if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
                // ie: set "ee" to "events"
                $this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
                // or does it match a single page CPT like /event/
            } elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
                // ie: set "ee" to "event"
                $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
            }
        }
    }


    /**
     * setupModelsAndTables
     *
     * @access protected
     * @param string $model_name
     * @throws EE_Error
     */
    protected function setupModelsAndTables($model_name)
    {
        // get CPT table data via CPT Model
        $full_model_name = strpos($model_name, 'EEM_') !== 0
            ? 'EEM_' . $model_name
            : $model_name;
        $model = $this->loader->getShared($full_model_name);
        if (! $model instanceof EEM_Base) {
            throw new EE_Error(
                sprintf(
                    __(
                        'The "%1$s" model could not be loaded.',
                        'event_espresso'
                    ),
                    $full_model_name
                )
            );
        }
        $this->setModel($model);
        $this->setModelTables($this->model->get_tables());
        $meta_model = $model_name . '_Meta';
        // is there a Meta Table for this CPT?
        if (isset($this->cpt_details['tables'][ $meta_model ])
            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
        ) {
            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
        }
    }


    /**
     * cptStrategyClass
     *
     * @access protected
     * @param  string $model_name
     * @return string
     */
    protected function cptStrategyClass($model_name)
    {
        // creates classname like:  CPT_Event_Strategy
        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
        // load and instantiate
        $CPT_Strategy = $this->loader->getShared(
            $CPT_Strategy_class_name,
            array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
        );
        if ($CPT_Strategy === null) {
            $CPT_Strategy = $this->loader->getShared(
                'EE_CPT_Default_Strategy',
                array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
            );
        }
        return $CPT_Strategy;
    }


    /**
     * postsFields
     *
     * @access public
     * @param  $SQL
     * @return string
     */
    public function postsFields($SQL)
    {
        // does this CPT have a meta table ?
        if ($this->meta_table instanceof EE_Secondary_Table) {
            // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
        }
        remove_filter('posts_fields', array($this, 'postsFields'));
        return $SQL;
    }


    /**
     * postsJoin
     *
     * @access public
     * @param  $SQL
     * @return string
     */
    public function postsJoin($SQL)
    {
        // does this CPT have a meta table ?
        if ($this->meta_table instanceof EE_Secondary_Table) {
            global $wpdb;
            // adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
            $SQL .= ' LEFT JOIN '
                    . $this->meta_table->get_table_name()
                    . ' ON ( '
                    . $this->meta_table->get_table_name()
                    . '.'
                    . $this->meta_table->get_fk_on_table()
                    . ' = '
                    . $wpdb->posts
                    . '.ID ) ';
        }
        remove_filter('posts_join', array($this, 'postsJoin'));
        return $SQL;
    }


    /**
     * thePosts
     *
     * @access public
     * @param  WP_Post[] $posts
     * @return WP_Post[]
     */
    public function thePosts($posts)
    {
        $CPT_class = $this->cpt_details['class_name'];
        // loop thru posts
        if (is_array($posts) && $this->model instanceof EEM_CPT_Base) {
            foreach ($posts as $key => $post) {
                if ($post->post_type === $this->post_type) {
                    $post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
                }
            }
        }
        remove_filter('the_posts', array($this, 'thePosts'), 1);
        return $posts;
    }


    /**
     * @param $url
     * @param $ID
     * @return string
     */
    public function getEditPostLink($url, $ID)
    {
        // need to make sure we only edit links if our cpt
        global $post;
        // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
        // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
        if (! $post instanceof WP_Post

The class WP_Post does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

            || $post->post_type !== $this->post_type
            || (
                isset($this->cpt_details['args']['show_ee_ui'])
                && ! $this->cpt_details['args']['show_ee_ui']
            )
        ) {
            return $url;
        }
        // k made it here so all is good.
        return wp_nonce_url(
            add_query_arg(
                array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
                admin_url('admin.php')
            ),
            'edit',
            'edit_nonce'
        );
    }


    /**
     * Execute any template filters.
     * This method is only called if in main query.
     *
     * @return void
     */
    public function addTemplateFilters()
    {
        // if requested cpt supports page_templates and it's the main query
        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
            // then let's hook into the appropriate query_template hook
            add_filter('single_template', array($this, 'singleCptTemplate'));
        }
    }


    /**
     * Callback for single_template wp filter.
     * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
     * hierarchy.
     *
     * @access public
     * @param string $current_template Existing default template path derived for this page call.
     * @return string the path to the full template file.
     */
    public function singleCptTemplate($current_template)
    {
        $object = get_queried_object();
        // does this called object HAVE a page template set that is something other than the default.
        $template = get_post_meta($object->ID, '_wp_page_template', true);
        // exit early if default or not set or invalid path (accounts for theme changes)
        if ($template === 'default'
            || empty($template)
            || ! is_readable(get_stylesheet_directory() . '/' . $template)
        ) {
            return $current_template;
        }
        // made it here so we SHOULD be able to just locate the template and then return it.
        return locate_template(array($template));
    }
}