CptQueryModifier::taxonomies() - Code Metrics - Inspection of "Daily Inspection: [touch:9961]{t:10}resolve confli..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-9961-paypal-pro-items (52e78c)

unknown

created 2016-09-27 21:00 UTC

CptQueryModifier::taxonomies() A

↳ Parent: CptQueryModifier

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php
namespace EventEspresso\core\CPTs;

if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}



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

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

	/**
	 * CPT details from \EE_Register_CPTs::get_CPTs() 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
	 */
	protected $request;

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



	/**
	 * CptQueryModifier constructor
	 *
	 * @param string $post_type
	 * @param array       $cpt_details
	 * @param \WP_Query           $WP_Query
	 * @param \EE_Request_Handler $request
	 */
	public function __construct(
		$post_type,
		array $cpt_details,
		\WP_Query $WP_Query,
		\EE_Request_Handler $request
	) {
		$this->setRequest( $request );
		$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
	 */
	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;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
	}



	/**
	 * @return \EE_Request_Handler
	 */
	public function request() {
		return $this->request;
	}



	/**
	 * @param \EE_Request_Handler $request
	 */
	protected function setRequest( \EE_Request_Handler $request ) {
		$this->request = $request;
	}



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



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



	/**
	 * initializeTaxonomies
	 *
	 * @access protected
	 * @return void
	 */
	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'], $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
			$all_taxonomies = \EE_Register_CPTs::get_taxonomies();
			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 );
		}
	}



	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->is_espresso_page();
		// requested post name
		$this->cpt_details['post_name'] = $this->request->get( '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->set( '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->is_set( '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->set( 'ee', $this->cpt_details['plural_slug'] );
				// or does it match a single page CPT like /event/
			} else if ( is_single() && \EE_Config::get_route( $this->cpt_details['singular_slug'] ) ) {
				// ie: set "ee" to "event"
				$this->request->set( '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
		$model = \EE_Registry::instance()->load_model( $model_name );
		if ( ! $model instanceof \EEM_Base ) {
			throw new \EE_Error (
				sprintf(
					__(
						'The "%1$s" model could not be loaded.',
						'event_espresso'
					),
					$model_name
				)
			);
		}
		$this->setModel( $model );
		$this->setModelTables( $this->model->get_tables() );
		// is there a Meta Table for this CPT?
		if (
			isset( $this->cpt_details['tables'][ $model_name . '_Meta' ] )
			&& $this->cpt_details['tables'][ $model_name . '_Meta' ] instanceof \EE_Secondary_Table
		) {
			$this->setMetaTable( $this->cpt_details['tables'][ $model_name . '_Meta' ] );
		}
	}



	/**
	 * cptStrategyClass
	 *
	 * @access protected
	 * @param  string $model_name
	 * @return string
	 */
	protected function cptStrategyClass( $model_name ) {
		// creates classname like:  CPT_Event_Strategy
		$CPT_Strategy_class_name = 'CPT_' . $model_name . '_Strategy';
		// load and instantiate
		$CPT_Strategy = \EE_Registry::instance()->load_core(
			$CPT_Strategy_class_name,
			array( 'WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details )
		);
		if ( $CPT_Strategy === null ) {
			$CPT_Strategy = \EE_Registry::instance()->load_core(
				'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
if ($x instanceof DoesNotExist) {
    // Do something.
}
			|| $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 ) );
	}


}
// End of file CptQueryModifier.php
// Location: /CptQueryModifier.php

Branch — BUG-9961-paypal-pro-items (52e78c)

CptQueryModifier::taxonomies() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1			<?php
2			namespace EventEspresso\core\CPTs;
3
4			if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
5			exit( 'No direct script access allowed' );
6			}
7
8
9
10			/**
11			* Class CptQueryModifier
12			* Description
13			*
14			* @package Event Espresso
15			* @subpackage core
16			* @author Brent Christensen
17			* @since $VID:$
18			*/
19			class CptQueryModifier {
20
21			/**
22			* @var string $post_type
23			*/
24			protected $post_type = '';
25
26			/**
27			* CPT details from \EE_Register_CPTs::get_CPTs() for specific post type
28			*
29			* @var array $cpt_details
30			*/
31			protected $cpt_details = array();
32
33			/**
34			* @var \EE_Table_Base[] $model_tables
35			*/
36			protected $model_tables = array();
37
38			/**
39			* @var array $taxonomies
40			*/
41			protected $taxonomies = array();
42
43			/**
44			* meta table for the related CPT
45			*
46			* @var \EE_Secondary_Table $meta_table
47			*/
48			protected $meta_table;
49
50			/**
51			* EEM_CPT_Base model for the related CPT
52			*
53			* @var \EEM_CPT_Base $model
54			*/
55			protected $model;
56
57			/**
58			* @var \EE_Request_Handler $request
59			*/
60			protected $request;
61
62			/**
63			* @var \WP_Query $wp_query
64			*/
65			protected $wp_query;
66
67
68
69			/**
70			* CptQueryModifier constructor
71			*
72			* @param string $post_type
73			* @param array $cpt_details
74			* @param \WP_Query $WP_Query
75			* @param \EE_Request_Handler $request
76			*/
77			public function __construct(
78			$post_type,
79			array $cpt_details,
80			\WP_Query $WP_Query,
81			\EE_Request_Handler $request
82			) {
83			$this->setRequest( $request );
84			$this->setWpQuery( $WP_Query );
85			$this->setPostType( $post_type );
86			$this->setCptDetails( $cpt_details );
87			$this->init();
88			}
89
90
91
92			/**
93			* @return string
94			*/
95			public function postType() {
96			return $this->post_type;
97			}
98
99
100
101			/**
102			* @param string $post_type
103			*/
104			protected function setPostType( $post_type ) {
105			$this->post_type = $post_type;
106			}
107
108
109
110			/**
111			* @return array
112			*/
113			public function cptDetails() {
114			return $this->cpt_details;
115			}
116
117
118
119			/**
120			* @param array $cpt_details
121			*/
122			protected function setCptDetails( $cpt_details ) {
123			$this->cpt_details = $cpt_details;
124			}
125
126
127
128			/**
129			* @return \EE_Table_Base[]
130			*/
131			public function modelTables() {
132			return $this->model_tables;
133			}
134
135
136
137			/**
138			* @param \EE_Table_Base[] $model_tables
139			*/
140			protected function setModelTables( $model_tables ) {
141			$this->model_tables = $model_tables;
142			}
143
144
145
146			/**
147			* @return array
148			*/
149			public function taxonomies() {
150			if ( empty( $this->taxonomies ) ) {
151			$this->initializeTaxonomies();
152			}
153			return $this->taxonomies;
154			}
155
156
157
158			/**
159			* @param array $taxonomies
160			*/
161			protected function setTaxonomies( array $taxonomies ) {
162			$this->taxonomies = $taxonomies;
163			}
164
165
166
167			/**
168			* @return \EE_Secondary_Table
169			*/
170			public function metaTable() {
171			return $this->meta_table;
172			}
173
174
175
176			/**
177			* @param \EE_Secondary_Table $meta_table
178			*/
179			public function setMetaTable( \EE_Secondary_Table $meta_table ) {
180			$this->meta_table = $meta_table;
181			}
182
183
184
185			/**
186			* @return \EEM_Base
187			*/
188			public function model() {
189			return $this->model;
190			}
191
192
193
194			/**
195			* @param \EEM_Base $CPT_model
196			*/
197			protected function setModel( \EEM_Base $CPT_model ) {
198			$this->model = $CPT_model;
			0 ignored issues – show Documentation Bug introduced 2016-04-28 05:41 UTC by Report Bug Copy Issue Report `$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? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
199			}
200
201
202
203			/**
204			* @return \EE_Request_Handler
205			*/
206			public function request() {
207			return $this->request;
208			}
209
210
211
212			/**
213			* @param \EE_Request_Handler $request
214			*/
215			protected function setRequest( \EE_Request_Handler $request ) {
216			$this->request = $request;
217			}
218
219
220
221			/**
222			* @return \WP_Query
223			*/
224			public function WpQuery() {
225			return $this->wp_query;
226			}
227
228
229
230			/**
231			* @param \WP_Query $wp_query
232			*/
233			public function setWpQuery( \WP_Query $wp_query ) {
234			$this->wp_query = $wp_query;
235			}
236
237
238
239			/**
240			* initializeTaxonomies
241			*
242			* @access protected
243			* @return void
244			*/
245			protected function initializeTaxonomies() {
246			// check if taxonomies have already been set and that this CPT has taxonomies registered for it
247			if (
248			empty( $this->taxonomies )
249			&& isset( $this->cpt_details['args'], $this->cpt_details['args']['taxonomies'] )
250			) {
251			// if so then grab them, but we want the taxonomy name as the key
252			$taxonomies = array_flip( $this->cpt_details['args']['taxonomies'] );
253			// then grab the list of ALL taxonomies
254			$all_taxonomies = \EE_Register_CPTs::get_taxonomies();
255			foreach ( $taxonomies as $taxonomy => &$details ) {
256			// add details to our taxonomies if they exist
257			$details = isset( $all_taxonomies[ $taxonomy ] )
258			? $all_taxonomies[ $taxonomy ]
259			: array();
260			}
261			// ALWAYS unset() variables that were passed by reference
262			unset( $details );
263			$this->setTaxonomies( $taxonomies );
264			}
265			}
266
267
268
269			protected function init() {
270			$this->setAdditionalCptDetails();
271			$this->setRequestVarsIfCpt();
272			// convert post_type to model name
273			$model_name = str_replace( 'EE_', '', $this->cpt_details['class_name'] );
274			// load all tables related to CPT
275			$this->setupModelsAndTables( $model_name );
276			// load and instantiate CPT_*_Strategy
277			$CPT_Strategy = $this->cptStrategyClass( $model_name );
278			// !!!!!!!!!! IMPORTANT !!!!!!!!!!!!
279			// here's the list of available filters in the WP_Query object
280			// 'posts_where_paged'
281			// 'posts_groupby'
282			// 'posts_join_paged'
283			// 'posts_orderby'
284			// 'posts_distinct'
285			// 'post_limits'
286			// 'posts_fields'
287			// 'posts_join'
288			add_filter( 'posts_fields', array( $this, 'postsFields' ) );
289			add_filter( 'posts_join', array( $this, 'postsJoin' ) );
290			add_filter(
291			'get_' . $this->post_type . '_metadata',
292			array( $CPT_Strategy, 'get_EE_post_type_metadata' ),
293			1,
294			4
295			);
296			add_filter( 'the_posts', array( $this, 'thePosts' ), 1, 1 );
297			if ( $this->wp_query->is_main_query() ) {
298			add_filter( 'get_edit_post_link', array( $this, 'getEditPostLink' ), 10, 2 );
299			$this->addTemplateFilters();
300			}
301			}
302
303
304
305			/**
306			* sets some basic query vars that pertain to the CPT
307			*
308			* @access protected
309			* @return void
310			*/
311			protected function setAdditionalCptDetails() {
312			// the post or category or term that is triggering EE
313			$this->cpt_details['espresso_page'] = $this->request->is_espresso_page();
314			// requested post name
315			$this->cpt_details['post_name'] = $this->request->get( 'post_name' );
316			// add support for viewing 'private', 'draft', or 'pending' posts
317			if (
318			isset( $this->wp_query->query_vars['p'] )
319			&& $this->wp_query->query_vars['p'] !== 0
320			&& is_user_logged_in()
321			&& current_user_can( 'edit_post', $this->wp_query->query_vars['p'] )
322			) {
323			// we can just inject directly into the WP_Query object
324			$this->wp_query->query['post_status'] = array( 'publish', 'private', 'draft', 'pending' );
325			// now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
326			$this->request->set( 'ee', $this->cpt_details['singular_slug'] );
327			}
328			}
329
330
331
332			/**
333			* Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
334			* If so, sets the 'ee' request variable
335			* so other parts of EE can know what CPT is getting queried.
336			* To Mike's knowledge, this must be called from during or after the pre_get_posts hook
337			* in order for is_archive() and is_single() methods to work properly.
338			*
339			* @return void
340			*/
341			public function setRequestVarsIfCpt() {
342			// check if ee action var has been set
343			if ( ! $this->request->is_set( 'ee' ) ) {
344			// check that route exists for CPT archive slug
345			if ( is_archive() && \EE_Config::get_route( $this->cpt_details['plural_slug'] ) ) {
346			// ie: set "ee" to "events"
347			$this->request->set( 'ee', $this->cpt_details['plural_slug'] );
348			// or does it match a single page CPT like /event/
349			} else if ( is_single() && \EE_Config::get_route( $this->cpt_details['singular_slug'] ) ) {
350			// ie: set "ee" to "event"
351			$this->request->set( 'ee', $this->cpt_details['singular_slug'] );
352			}
353			}
354			}
355
356
357
358			/**
359			* setupModelsAndTables
360			*
361			* @access protected
362			* @param string $model_name
363			* @throws \EE_Error
364			*/
365			protected function setupModelsAndTables( $model_name ) {
366			// get CPT table data via CPT Model
367			$model = \EE_Registry::instance()->load_model( $model_name );
368			if ( ! $model instanceof \EEM_Base ) {
369			throw new \EE_Error (
370			sprintf(
371			__(
372			'The "%1$s" model could not be loaded.',
373			'event_espresso'
374			),
375			$model_name
376			)
377			);
378			}
379			$this->setModel( $model );
380			$this->setModelTables( $this->model->get_tables() );
381			// is there a Meta Table for this CPT?
382			if (
383			isset( $this->cpt_details['tables'][ $model_name . '_Meta' ] )
384			&& $this->cpt_details['tables'][ $model_name . '_Meta' ] instanceof \EE_Secondary_Table
385			) {
386			$this->setMetaTable( $this->cpt_details['tables'][ $model_name . '_Meta' ] );
387			}
388			}
389
390
391
392			/**
393			* cptStrategyClass
394			*
395			* @access protected
396			* @param string $model_name
397			* @return string
398			*/
399			protected function cptStrategyClass( $model_name ) {
400			// creates classname like: CPT_Event_Strategy
401			$CPT_Strategy_class_name = 'CPT_' . $model_name . '_Strategy';
402			// load and instantiate
403			$CPT_Strategy = \EE_Registry::instance()->load_core(
404			$CPT_Strategy_class_name,
405			array( 'WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details )
406			);
407			if ( $CPT_Strategy === null ) {
408			$CPT_Strategy = \EE_Registry::instance()->load_core(
409			'CPT_Default_Strategy',
410			array( 'WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details )
411			);
412			}
413			return $CPT_Strategy;
414			}
415
416
417
418			/**
419			* postsFields
420			*
421			* @access public
422			* @param $SQL
423			* @return string
424			*/
425			public function postsFields( $SQL ) {
426			// does this CPT have a meta table ?
427			if ( $this->meta_table instanceof \EE_Secondary_Table ) {
428			// adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
429			$SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
430			}
431			remove_filter( 'posts_fields', array( $this, 'postsFields' ) );
432			return $SQL;
433			}
434
435
436
437			/**
438			* postsJoin
439			*
440			* @access public
441			* @param $SQL
442			* @return string
443			*/
444			public function postsJoin( $SQL ) {
445			// does this CPT have a meta table ?
446			if ( $this->meta_table instanceof \EE_Secondary_Table ) {
447			global $wpdb;
448			// adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
449			$SQL .= ' LEFT JOIN '
450			. $this->meta_table->get_table_name()
451			. ' ON ( '
452			. $this->meta_table->get_table_name()
453			. '.'
454			. $this->meta_table->get_fk_on_table()
455			. ' = '
456			. $wpdb->posts
457			. '.ID ) ';
458			}
459			remove_filter( 'posts_join', array( $this, 'postsJoin' ) );
460			return $SQL;
461			}
462
463
464
465			/**
466			* thePosts
467			*
468			* @access public
469			* @param \WP_Post[] $posts
470			* @return \WP_Post[]
471			*/
472			public function thePosts( $posts ) {
473			$CPT_class = $this->cpt_details['class_name'];
474			// loop thru posts
475			if ( is_array( $posts ) && $this->model instanceof \EEM_CPT_Base ) {
476			foreach ( $posts as $key => $post ) {
477			if ( $post->post_type === $this->post_type ) {
478			$post->{$CPT_class} = $this->model->instantiate_class_from_post_object( $post );
479			}
480			}
481			}
482			remove_filter( 'the_posts', array( $this, 'thePosts' ), 1 );
483			return $posts;
484			}
485
486
487
488			/**
489			* @param $url
490			* @param $ID
491			* @return string
492			*/
493			public function getEditPostLink( $url, $ID ) {
494			// need to make sure we only edit links if our cpt
495			global $post;
496			//notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
497			//for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
498			if (
499			! $post instanceof \WP_Post
			0 ignored issues – show Bug introduced 2016-08-16 22:53 UTC by Report Bug Copy Issue Report The class `WP_Post` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
500			\|\| $post->post_type !== $this->post_type
501			\|\| (
502			isset( $this->cpt_details['args']['show_ee_ui'] )
503			&& ! $this->cpt_details['args']['show_ee_ui']
504			)
505			) {
506			return $url;
507			}
508			//k made it here so all is good.
509			return wp_nonce_url(
510			add_query_arg(
511			array( 'page' => $this->post_type, 'post' => $ID, 'action' => 'edit' ),
512			admin_url( 'admin.php' )
513			),
514			'edit',
515			'edit_nonce'
516			);
517			}
518
519
520
521			/**
522			* Execute any template filters.
523			* This method is only called if in main query.
524			*
525			* @return void
526			*/
527			public function addTemplateFilters() {
528			// if requested cpt supports page_templates and it's the main query
529			if ( ! empty( $this->cpt_details['args']['page_templates'] ) && $this->wp_query->is_main_query() ) {
530			// then let's hook into the appropriate query_template hook
531			add_filter( 'single_template', array( $this, 'singleCptTemplate' ) );
532			}
533			}
534
535
536
537			/**
538			* Callback for single_template wp filter.
539			* 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.
540			*
541			* @access public
542			* @param string $current_template Existing default template path derived for this page call.
543			* @return string the path to the full template file.
544			*/
545			public function singleCptTemplate( $current_template ) {
546			$object = get_queried_object();
547			//does this called object HAVE a page template set that is something other than the default.
548			$template = get_post_meta( $object->ID, '_wp_page_template', true );
549			//exit early if default or not set or invalid path (accounts for theme changes)
550			if (
551			$template === 'default'
552			\|\| empty( $template )
553			\|\| ! is_readable( get_stylesheet_directory() . '/' . $template )
554			) {
555			return $current_template;
556			}
557			//made it here so we SHOULD be able to just locate the template and then return it.
558			return locate_template( array( $template ) );
559			}
560
561
562			}
563			// End of file CptQueryModifier.php
564			// Location: /CptQueryModifier.php

eventespresso / event-espresso-core

Branch — BUG-9961-paypal-pro-items (52e78c)

CptQueryModifier::taxonomies() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like