Legacy_Override_Template - Code Metrics - Inspection of "Version 2.8" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1442)

by Zack

created 2020-04-17 00:24 UTC

Legacy_Override_Template A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	223
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

70.37%

Importance

Changes

Metric	Value
dl	0
loc	223
ccs	57
cts	81
cp	0.7037
rs	10
c	0
b	0
f	0
wmc	22
lcom	1
cbo	8

5 Methods

Rating	Name	Size	Complexity
A	__construct()	9	1
A	__destruct()	3	1
A	locate_template()	3	1
A	add_id_specific_templates()	21	3
D	render()	120	16

<?php
namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
	die();
}

/**
 * Load up the Gamajo Template Loader.
 *
 * @see https://github.com/GaryJones/Gamajo-Template-Loader
 */
if ( ! class_exists( '\GV\Gamajo_Template_Loader' ) ) {
	require gravityview()->plugin->dir( 'future/lib/class-gamajo-template-loader.php' );
}

/**
 * Loads legacy override templates from the theme.
 *
 * Makes sure they work by setting up context, etc.
 */
class Legacy_Override_Template extends \GV\Gamajo_Template_Loader {
	/**
	 * Prefix for filter names.
	 * @var string
	 */
	protected $filter_prefix = 'gravityview';

	/**
	 * Directory name where custom templates for this plugin should be found in the theme.
	 * @var string
	 */
	protected $theme_template_directory = 'gravityview';

	/**
	 * @var \GV\View The view we're working with.
	 */
	private $view;

	/**
	 * @var \GV\Entry The entry we're working with.
	 */
	private $entry;

	/**
	 * Catch deprecated template loads.
	 *
	 * @param \GV\View $view The View.
	 * @param \GV\Entry $entry The Entry.
	 * @param \GV\Field $field The Field.
	 * @param \GV\Request $request The request.
	 *
	 * @return void

	 */
	public function __construct( \GV\View $view, \GV\Entry $entry = null, \GV\Field $field = null, \GV\Request $request = null ) {

		add_filter( $this->filter_prefix . '_get_template_part', array( $this, 'add_id_specific_templates' ), 10, 3 );

		$this->view = $view;
		$this->entry = $entry;

		$this->plugin_directory = gravityview()->plugin->dir();
		$this->plugin_template_directory = 'templates/deprecated/';
	}

	public function __destruct() {
		remove_filter( $this->filter_prefix . '_get_template_part', array( $this, 'add_id_specific_templates' ) );
	}

	/**
	 * @inheritdoc
	 * @see Gamajo_Template_Loader::locate_template()
	 * @return null|string NULL: Template not found; String: path to template
	 */
	public function locate_template( $template_names, $load = false, $require_once = false ) {
		return parent::locate_template( $template_names, false, false );
	}

	/**
	 * Enable overrides of GravityView templates on a granular basis
	 *
	 * The loading order is:
	 *
	 * - view-[View ID]-table-footer.php
	 * - form-[Form ID]-table-footer.php
	 * - page-[ID of post or page where view is embedded]-table-footer.php
	 * - table-footer.php
	 *
	 * @see  Gamajo_Template_Loader::get_template_file_names() Where the filter is
	 * @param array $templates Existing list of templates.
	 * @param string $slug      Name of the template base, example: `table`, `list`, `datatables`, `map`
	 * @param string $name      Name of the template part, example: `body`, `footer`, `head`, `single`
	 *
	 * @return array $templates Modified template array, merged with existing $templates values
	 */
	public function add_id_specific_templates( $templates, $slug, $name ) {

		$additional = array();

		// form-19-table-body.php
		$additional[] = sprintf( 'form-%d-%s-%s.php', $this->view->form ? $this->view->form->ID : 0, $slug, $name );

		// view-3-table-body.php
		$additional[] = sprintf( 'view-%d-%s-%s.php', $this->view->ID, $slug, $name );
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		global $post;
		if ( $post ) {
			// page-19-table-body.php
			$additional[] = sprintf( 'page-%d-%s-%s.php', $post->ID, $slug, $name );
		}

		// Combine with existing table-body.php and table.php
		$templates = array_merge( $additional, $templates );

		return $templates;
	}

	/**
	 * Setup legacy rendering.
	 *
	 * @param string $slug The slug.
	 *
	 * @return string The output.
	 */
	public function render( $slug ) {
		add_action( 'gravityview/template/after', $view_id_output = function( $context ) {
			printf( '<input type="hidden" class="gravityview-view-id" value="%d">', $context->view->ID );
		} );

		ob_start();

		$request = new Mock_Request();
		$request->returns['is_view'] = $this->view;

		/**
		 * You got one shot. One opportunity. To render all the widgets you have ever wanted.
		 *
		 * Since we're overriding the singleton we need to remove the widget actions since they can only
		 *  be called once in a request (did_action/do_action mutex).
		 *
		 * Oh, and Mom's spaghetti.
		 */
		global $wp_filter;
		foreach ( array( 'gravityview_before', 'gravityview_after' ) as $hook ) {
			/** WordPress 4.6 and lower compatibility, when WP_Hook classes were still absent. */
			if ( is_array( $wp_filter[ $hook ] ) ) {
				if ( ! empty( $wp_filter[ $hook ][10] ) ) {
					foreach ( $wp_filter[ $hook ][10] as $function_key => $callback ) {
						if ( strpos( $function_key, 'render_widget_hooks' ) ) {
							unset( $wp_filter[ $hook ][10][ $function_key ] );
						}
					}
				}
			} else {
				foreach ( $wp_filter[ $hook ]->callbacks[10] as $function_key => $callback ) {
					if ( strpos( $function_key, 'render_widget_hooks' ) ) {
						unset( $wp_filter[ $hook ]->callbacks[10][ $function_key ] );
					}
				}
			}
		}
		
		/**
		 * Single entry view.
		 */
		if ( $this->entry ) {

			$request->returns['is_entry'] = $this->entry;

			global $post;

			$entries = new Entry_Collection();
			$entries->add( $this->entry );

			\GV\Mocks\Legacy_Context::push( array(
				'view' => $this->view,
				'entry' => $this->entry,
				'entries' => $entries,
				'request' => $request,
				'fields' => $this->view->fields->by_visible( $this->view ),
				'in_the_loop' => true,
			) );

			\GravityView_View::getInstance()->setTemplatePartSlug( $slug );
			\GravityView_View::getInstance()->setTemplatePartName( 'single' );

			\GravityView_View::getInstance()->_include( $this->get_template_part( $slug, 'single' ) );

			Mocks\Legacy_Context::pop();

		/**
		 * Directory view.
		 */
		} else {
			$entries = $this->view->get_entries( $request );

			/**
			 * Remove multiple sorting before calling legacy filters.
			 * This allows us to fake it till we make it.
			 */
			$parameters = $this->view->settings->as_atts();

			if ( ! empty( $parameters['sort_field'] ) && is_array( $parameters['sort_field'] ) ) {
				$has_multisort = true;
				$parameters['sort_field'] = reset( $parameters['sort_field'] );
				if ( ! empty( $parameters['sort_direction'] ) && is_array( $parameters['sort_direction'] ) ) {
					$parameters['sort_direction'] = reset( $parameters['sort_direction'] );
				}
			}

			$parameters = \GravityView_frontend::get_view_entries_parameters( $parameters, $this->view->form->ID );

			global $post;

			add_action( 'gravityview_before', array( \GravityView_View::getInstance(), 'render_widget_hooks' ) );
			add_action( 'gravityview_after', array( \GravityView_View::getInstance(), 'render_widget_hooks' ) );

			foreach ( array( 'header', 'body', 'footer' ) as $part ) {
				\GV\Mocks\Legacy_Context::push( array_merge( array(
					'view' => $this->view,
					'entries' => $entries,
					'request' => $request,
					'fields' => $this->view->fields->by_visible( $this->view ),
					'in_the_loop' => true,
				), empty( $parameters ) ? array() : array(
					'paging' => $parameters['paging'],
					'sorting' => $parameters['sorting'],
				), $post ? array(
					'post' => $post,
				) : array() ) );

				\GravityView_View::getInstance()->setTemplatePartSlug( $slug );

				\GravityView_View::getInstance()->setTemplatePartName( $part );

				\GravityView_View::getInstance()->_include( $this->get_template_part( $slug, $part ) );

				Mocks\Legacy_Context::pop();
			}
		}

		remove_action( 'gravityview/template/after', $view_id_output );

		return ob_get_clean();
	}
}


1		<?php
2		namespace GV;
3
4		/** If this file is called directly, abort. */
5		if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
6		die();
7		}
8
9		/**
10		* Load up the Gamajo Template Loader.
11		*
12		* @see https://github.com/GaryJones/Gamajo-Template-Loader
13		*/
14		if ( ! class_exists( '\GV\Gamajo_Template_Loader' ) ) {
15		require gravityview()->plugin->dir( 'future/lib/class-gamajo-template-loader.php' );
16		}
17
18		/**
19		* Loads legacy override templates from the theme.
20		*
21		* Makes sure they work by setting up context, etc.
22		*/
23		class Legacy_Override_Template extends \GV\Gamajo_Template_Loader {
24		/**
25		* Prefix for filter names.
26		* @var string
27		*/
28		protected $filter_prefix = 'gravityview';
29
30		/**
31		* Directory name where custom templates for this plugin should be found in the theme.
32		* @var string
33		*/
34		protected $theme_template_directory = 'gravityview';
35
36		/**
37		* @var \GV\View The view we're working with.
38		*/
39		private $view;
40
41		/**
42		* @var \GV\Entry The entry we're working with.
43		*/
44		private $entry;
45
46		/**
47		* Catch deprecated template loads.
48		*
49		* @param \GV\View $view The View.
50		* @param \GV\Entry $entry The Entry.
51		* @param \GV\Field $field The Field.
52		* @param \GV\Request $request The request.
53		*
54		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
55		*/
56	37	public function __construct( \GV\View $view, \GV\Entry $entry = null, \GV\Field $field = null, \GV\Request $request = null ) {
		0 ignored issues – show Unused Code introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report The parameter `$field` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
57	37	add_filter( $this->filter_prefix . '_get_template_part', array( $this, 'add_id_specific_templates' ), 10, 3 );
58
59	37	$this->view = $view;
60	37	$this->entry = $entry;
61
62	37	$this->plugin_directory = gravityview()->plugin->dir();
63	37	$this->plugin_template_directory = 'templates/deprecated/';
64	37	}
65
66	6	public function __destruct() {
67	6	remove_filter( $this->filter_prefix . '_get_template_part', array( $this, 'add_id_specific_templates' ) );
68	6	}
69
70		/**
71		* @inheritdoc
72		* @see Gamajo_Template_Loader::locate_template()
73		* @return null\|string NULL: Template not found; String: path to template
74		*/
75	37	public function locate_template( $template_names, $load = false, $require_once = false ) {
76	37	return parent::locate_template( $template_names, false, false );
77		}
78
79		/**
80		* Enable overrides of GravityView templates on a granular basis
81		*
82		* The loading order is:
83		*
84		* - view-[View ID]-table-footer.php
85		* - form-[Form ID]-table-footer.php
86		* - page-[ID of post or page where view is embedded]-table-footer.php
87		* - table-footer.php
88		*
89		* @see Gamajo_Template_Loader::get_template_file_names() Where the filter is
90		* @param array $templates Existing list of templates.
91		* @param string $slug Name of the template base, example: `table`, `list`, `datatables`, `map`
92		* @param string $name Name of the template part, example: `body`, `footer`, `head`, `single`
93		*
94		* @return array $templates Modified template array, merged with existing $templates values
95		*/
96	37	public function add_id_specific_templates( $templates, $slug, $name ) {
97
98	37	$additional = array();
99
100		// form-19-table-body.php
101	37	$additional[] = sprintf( 'form-%d-%s-%s.php', $this->view->form ? $this->view->form->ID : 0, $slug, $name );
102
103		// view-3-table-body.php
104	37	$additional[] = sprintf( 'view-%d-%s-%s.php', $this->view->ID, $slug, $name );
		0 ignored issues – show Documentation introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report The property `ID` does not exist on `object<GV\View>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
105
106	37	global $post;
107	37	if ( $post ) {
108		// page-19-table-body.php
109	15	$additional[] = sprintf( 'page-%d-%s-%s.php', $post->ID, $slug, $name );
110		}
111
112		// Combine with existing table-body.php and table.php
113	37	$templates = array_merge( $additional, $templates );
114
115	37	return $templates;
116		}
117
118		/**
119		* Setup legacy rendering.
120		*
121		* @param string $slug The slug.
122		*
123		* @return string The output.
124		*/
125	2	public function render( $slug ) {
126		add_action( 'gravityview/template/after', $view_id_output = function( $context ) {
127		printf( '<input type="hidden" class="gravityview-view-id" value="%d">', $context->view->ID );
128	2	} );
129
130	2	ob_start();
131
132	2	$request = new Mock_Request();
133	2	$request->returns['is_view'] = $this->view;
134
135		/**
136		* You got one shot. One opportunity. To render all the widgets you have ever wanted.
137		*
138		* Since we're overriding the singleton we need to remove the widget actions since they can only
139		* be called once in a request (did_action/do_action mutex).
140		*
141		* Oh, and Mom's spaghetti.
142		*/
143	2	global $wp_filter;
144	2	foreach ( array( 'gravityview_before', 'gravityview_after' ) as $hook ) {
145		/** WordPress 4.6 and lower compatibility, when WP_Hook classes were still absent. */
146	2	if ( is_array( $wp_filter[ $hook ] ) ) {
147		if ( ! empty( $wp_filter[ $hook ][10] ) ) {
148		foreach ( $wp_filter[ $hook ][10] as $function_key => $callback ) {
149		if ( strpos( $function_key, 'render_widget_hooks' ) ) {
150		unset( $wp_filter[ $hook ][10][ $function_key ] );
151		}
152		}
153		}
154		} else {
155	2	foreach ( $wp_filter[ $hook ]->callbacks[10] as $function_key => $callback ) {
156	2	if ( strpos( $function_key, 'render_widget_hooks' ) ) {
157	1	unset( $wp_filter[ $hook ]->callbacks[10][ $function_key ] );
158		}
159		}
160		}
161		}
162
163		/**
164		* Single entry view.
165		*/
166	2	if ( $this->entry ) {
167
168		$request->returns['is_entry'] = $this->entry;
169
170		global $post;
171
172		$entries = new Entry_Collection();
173		$entries->add( $this->entry );
174
175		\GV\Mocks\Legacy_Context::push( array(
176		'view' => $this->view,
177		'entry' => $this->entry,
178		'entries' => $entries,
179		'request' => $request,
180		'fields' => $this->view->fields->by_visible( $this->view ),
181		'in_the_loop' => true,
182		) );
183
184		\GravityView_View::getInstance()->setTemplatePartSlug( $slug );
185		\GravityView_View::getInstance()->setTemplatePartName( 'single' );
186
187		\GravityView_View::getInstance()->_include( $this->get_template_part( $slug, 'single' ) );
188
189		Mocks\Legacy_Context::pop();
190
191		/**
192		* Directory view.
193		*/
194		} else {
195	2	$entries = $this->view->get_entries( $request );
196
197		/**
198		* Remove multiple sorting before calling legacy filters.
199		* This allows us to fake it till we make it.
200		*/
201	2	$parameters = $this->view->settings->as_atts();
		0 ignored issues – show Deprecated Code introduced 2019-03-21 12:00 UTC by Report Bug Copy Issue Report The method `GV\View_Settings::as_atts()` has been deprecated. This method has been deprecated. Loading history...
202	2	if ( ! empty( $parameters['sort_field'] ) && is_array( $parameters['sort_field'] ) ) {
203		$has_multisort = true;
204		$parameters['sort_field'] = reset( $parameters['sort_field'] );
205		if ( ! empty( $parameters['sort_direction'] ) && is_array( $parameters['sort_direction'] ) ) {
206		$parameters['sort_direction'] = reset( $parameters['sort_direction'] );
207		}
208		}
209
210	2	$parameters = \GravityView_frontend::get_view_entries_parameters( $parameters, $this->view->form->ID );
211
212	2	global $post;
213
214	2	add_action( 'gravityview_before', array( \GravityView_View::getInstance(), 'render_widget_hooks' ) );
215	2	add_action( 'gravityview_after', array( \GravityView_View::getInstance(), 'render_widget_hooks' ) );
216
217	2	foreach ( array( 'header', 'body', 'footer' ) as $part ) {
218	2	\GV\Mocks\Legacy_Context::push( array_merge( array(
219	2	'view' => $this->view,
220	2	'entries' => $entries,
221	2	'request' => $request,
222	2	'fields' => $this->view->fields->by_visible( $this->view ),
223		'in_the_loop' => true,
224		), empty( $parameters ) ? array() : array(
225	2	'paging' => $parameters['paging'],
226	2	'sorting' => $parameters['sorting'],
227	2	), $post ? array(
228	2	'post' => $post,
229	2	) : array() ) );
230
231	2	\GravityView_View::getInstance()->setTemplatePartSlug( $slug );
232
233	2	\GravityView_View::getInstance()->setTemplatePartName( $part );
234
235	2	\GravityView_View::getInstance()->_include( $this->get_template_part( $slug, $part ) );
236
237	2	Mocks\Legacy_Context::pop();
238		}
239		}
240
241	2	remove_action( 'gravityview/template/after', $view_id_output );
242
243	2	return ob_get_clean();
244		}
245		}
246

gravityview / GravityView

Pull Request — master (#1442)

Legacy_Override_Template A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like