Extension::getName() - Code Metrics - Inspection of "Implemented new hierarchy handling for WP 4.7+." - Rarst/meadow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (55ca36)

by Andrey

created 2016-12-10 20:11 UTC

Extension::getName() A

↳ Parent: Extension::getFunctions()

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Rarst\Meadow;

/**
 * Meadow extension for Twig with WordPress specific functionality.
 */
class Extension extends \Twig_Extension implements \Twig_Extension_GlobalsInterface {

	public function getFunctions() {

		$options = array(
			'needs_environment' => true,
			'needs_context'     => true,
			'is_safe'           => array( 'all' )
		);

		$functions = array();

		foreach ( array( 'get_header', 'get_footer', 'get_sidebar', 'get_template_part', 'get_search_form', 'comments_template' ) as $function ) {
			$functions[] = new \Twig_SimpleFunction( $function, array( $this, $function ), $options );
		}

		return $functions;
	}

	public function getGlobals() {

		global $wp_query;
function myFunction($a, $b) {
    // Do something
}

		return compact( 'wp_query' );
	}

	public function getTokenParsers(  ) {

		return array(
			new Loop_Token_Parser(),
			new Comments_Token_Parser(),
		);
	}

	public function get_header( \Twig_Environment $env, $context, $name = null ) {

		return $this->get_template( $env, $context, 'header', $name );
	}

	public function get_templates( $slug, $name = null ) {

		$templates = array();

		if ( ! empty( $name ) )
			$templates[] = "{$slug}-{$name}.twig";

		$templates[] = "{$slug}.twig";

		return $templates;
	}

	public function get_footer( \Twig_Environment $env, $context, $name = null ) {

		return $this->get_template( $env, $context, 'footer', $name );
	}

	public function get_sidebar( \Twig_Environment $env, $context, $name = null ) {

		return $this->get_template( $env, $context, 'sidebar', $name );
	}

	public function get_template_part( \Twig_Environment $env, $context, $slug, $name = null ) {


		try {
			$return = twig_include( $env, $context, $this->get_templates( $slug, $name ) );
			do_action( "get_template_part_{$slug}", $slug, $name );
		} catch ( \Twig_Error_Loader $e ) {
			ob_start();
			get_template_part( $slug, $name );
			$return = ob_get_clean();
		}

		return $return;
	}

	/**
	 * Skips rendering in native function in favor of Plugin->get_search_form() in filter
	 *
	 * @return string
	 */
	public function get_search_form() {

		return apply_filters( 'get_search_form', true );
	}

	protected function get_template( \Twig_Environment $env, $context, $type, $name = null ) {


		try {
			$return = twig_include( $env, $context, $this->get_templates( $type, $name ) );
			do_action( 'get_' . $type, $name );
		} catch ( \Twig_Error_Loader $e ) {
			ob_start();
			call_user_func( 'get_' . $type, $name );
			$return = ob_get_clean();
		}

		return $return;
	}

	public function comments_template( \Twig_Environment $env, $context, $file = 'comments.twig', $separate_comments = false ) {

		try {
			$env->loadTemplate( $file );
		} catch ( \Twig_Error_Loader $e ) {
			ob_start();
			comments_template( '/comments.php', $separate_comments );

			return ob_get_clean();
		}

		add_filter( 'comments_template', array( $this, 'return_blank_template' ) );
		comments_template( '/comments.php', $separate_comments );
		remove_filter( 'comments_template', array( $this, 'return_blank_template' ) );

		return twig_include( $env, $context, $file );
	}

	public function return_blank_template() {

		return __DIR__ . '/blank.php';
	}
}

1		<?php
2
3		namespace Rarst\Meadow;
4
5		/**
6		* Meadow extension for Twig with WordPress specific functionality.
7		*/
8		class Extension extends \Twig_Extension implements \Twig_Extension_GlobalsInterface {
9
10		public function getFunctions() {
11
12		$options = array(
13		'needs_environment' => true,
14		'needs_context' => true,
15		'is_safe' => array( 'all' )
16		);
17
18		$functions = array();
19
20		foreach ( array( 'get_header', 'get_footer', 'get_sidebar', 'get_template_part', 'get_search_form', 'comments_template' ) as $function ) {
21		$functions[] = new \Twig_SimpleFunction( $function, array( $this, $function ), $options );
22		}
23
24		return $functions;
25		}
26
27		public function getGlobals() {
28
29		global $wp_query;
		1 ignored issue – show Compatibility Best Practice introduced 2016-12-09 20:49 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
30
31		return compact( 'wp_query' );
32		}
33
34		public function getTokenParsers( ) {
35
36		return array(
37		new Loop_Token_Parser(),
38		new Comments_Token_Parser(),
39		);
40		}
41
42		public function get_header( \Twig_Environment $env, $context, $name = null ) {
43
44		return $this->get_template( $env, $context, 'header', $name );
45		}
46
47		public function get_templates( $slug, $name = null ) {
48
49		$templates = array();
50
51		if ( ! empty( $name ) )
52		$templates[] = "{$slug}-{$name}.twig";
53
54		$templates[] = "{$slug}.twig";
55
56		return $templates;
57		}
58
59		public function get_footer( \Twig_Environment $env, $context, $name = null ) {
60
61		return $this->get_template( $env, $context, 'footer', $name );
62		}
63
64		public function get_sidebar( \Twig_Environment $env, $context, $name = null ) {
65
66		return $this->get_template( $env, $context, 'sidebar', $name );
67		}
68
69	View Code Duplication	public function get_template_part( \Twig_Environment $env, $context, $slug, $name = null ) {
		1 ignored issue – show Duplication introduced 2016-12-09 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
70
71		try {
72		$return = twig_include( $env, $context, $this->get_templates( $slug, $name ) );
73		do_action( "get_template_part_{$slug}", $slug, $name );
74		} catch ( \Twig_Error_Loader $e ) {
75		ob_start();
76		get_template_part( $slug, $name );
77		$return = ob_get_clean();
78		}
79
80		return $return;
81		}
82
83		/**
84		* Skips rendering in native function in favor of Plugin->get_search_form() in filter
85		*
86		* @return string
87		*/
88		public function get_search_form() {
89
90		return apply_filters( 'get_search_form', true );
91		}
92
93	View Code Duplication	protected function get_template( \Twig_Environment $env, $context, $type, $name = null ) {
		1 ignored issue – show Duplication introduced 2016-12-09 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94
95		try {
96		$return = twig_include( $env, $context, $this->get_templates( $type, $name ) );
97		do_action( 'get_' . $type, $name );
98		} catch ( \Twig_Error_Loader $e ) {
99		ob_start();
100		call_user_func( 'get_' . $type, $name );
101		$return = ob_get_clean();
102		}
103
104		return $return;
105		}
106
107		public function comments_template( \Twig_Environment $env, $context, $file = 'comments.twig', $separate_comments = false ) {
108
109		try {
110		$env->loadTemplate( $file );
111		} catch ( \Twig_Error_Loader $e ) {
112		ob_start();
113		comments_template( '/comments.php', $separate_comments );
114
115		return ob_get_clean();
116		}
117
118		add_filter( 'comments_template', array( $this, 'return_blank_template' ) );
119		comments_template( '/comments.php', $separate_comments );
120		remove_filter( 'comments_template', array( $this, 'return_blank_template' ) );
121
122		return twig_include( $env, $context, $file );
123		}
124
125		public function return_blank_template() {
126
127		return __DIR__ . '/blank.php';
128		}
129		}

Rarst / meadow

Branch — master (55ca36)

Extension::getName() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like