ClassyTemplate::get_request_templates_list() - Code Metrics - Inspection of "Implemented template registration functionality" - anrw/classy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 75c234...bb087c )

by Andrew

created 2016-05-14 14:07 UTC

ClassyTemplate::get_request_templates_list() D

↳ Parent: ClassyTemplate

Complexity

Conditions	30
Paths	65

Size

Total Lines	181
Code Lines	84

Duplication

Lines	62
Ratio	34.25 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	30
eloc	84
c	1
b	0
f	1
nc	65
nop	1
dl	62
loc	181
rs	4.425

How to fix Long Method Complexity

<?php 

use Windwalker\Renderer\BladeRenderer;

/**
 * Template Loader
 *
 * Loads the corresponding template based on request
 */
class ClassyTemplate {
namespace YourVendor;

class YourClass { }

	/**
	 * Theme twig templates folder
	 * 
	 * @var string
	 */
	public static $theme_templates_folder = 'views';


	/**
	 * Return theme template absolute path
	 * 
	 * @param  string $template in blade path format, ex: base.header
	 * @return string full path to template file
	 */
	public static function get_theme_template_path($template) {

		$template = self::get_nested_blade_path($template);

		$template = str_replace('.', '/', $template);

		return THEME_PATH . self::$theme_templates_folder . '/' . $template . '.blade.php';			

	}

	/**
	 * Checks if template exists
	 * 
	 * @param  string $template in blade path format, ex: base.header
	 * @return boolean true/false
	 */
	public static function template_exists($template) {

		$template_path = self::get_theme_template_path($template);

		return file_exists($template_path);

	}


	/**
	 * Returns template name for render, based on type of request
	 * 
	 * @param  string $type 
	 * @return array 
	 */
	public static function get_available_template($type) {

		// Classy template?

		if ( $template = self::get_classy_template() ) {
		
			return $template;
		
		}

		// Else try to find template based on request

		$templates = self::get_request_templates_list($type);

		foreach ($templates as $template) {

			if ( self::template_exists($template) ):

				return $template;

			endif;

		}

		return false;

	}


	/**
	 * Returns list of templates to check, based on type of request
	 * 
	 * @param  string $type 
	 * @return array
	 */
	private static function get_request_templates_list($type) {

		$templates = array();


		// Home

		if ( $type == 'home' ) :

			$templates[] = 'home';
			$templates[] = 'index';


		// Single

		elseif ( $type == 'single' ) :

			$post_type = get_query_var( 'post_type' );

			$templates[] = 'single-' . $post_type;

			$templates[] = 'single';

		// Post type

		elseif ( $type == 'post_type_archive' ) :

			$post_type = get_query_var( 'post_type' );

			$templates[] = 'archive-' . $post_type;

			$templates[] = 'archive';


		// Taxonomy

		elseif ( $type == 'taxonomy' ):

			$term = get_queried_object();

			if ( ! empty( $term->slug ) ) {
				
				$taxonomy = $term->taxonomy;

				$templates[] = "taxonomy-$taxonomy-{$term->slug}";
				$templates[] = "taxonomy-$taxonomy";

			}

			$templates[] = 'taxonomy';

		// Category

		elseif ( $type == 'category' ):


			$category = get_queried_object();

			if ( ! empty( $category->slug ) ) {
				$templates[] = "category-{$category->slug}";
				$templates[] = "category-{$category->term_id}";
			}
			$templates[] = 'category';


		// Attachment

		elseif ( $type == 'attachment' ):

			$attachment = get_queried_object();

			if ( $attachment ) {

				if ( false !== strpos( $attachment->post_mime_type, '/' ) ) {
				
					list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
				
				} else {
				
					list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
				
				}

				if ( ! empty( $subtype ) ) {
					$templates[] = "{$type}-{$subtype}";
					$templates[] = "{$subtype}";
				}
				$templates[] = "{$type}";

			}
			$templates[] = 'attachment';


		// Tag

		elseif ( $type == 'tag' ):


			$tag = get_queried_object();

			if ( ! empty( $tag->slug ) ) {
				$templates[] = "tag-{$tag->slug}";
				$templates[] = "tag-{$tag->term_id}";
			}
			$templates[] = 'tag';


		// Author

		elseif ( $type == 'author' ):

			$author = get_queried_object();

			if ( $author instanceof WP_User ) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				$templates[] = "author-{$author->user_nicename}";
				$templates[] = "author-{$author->ID}";
			}
			$templates[] = 'author';


		// Front Page

		elseif ( $type == 'front-page' ):


			$id = get_queried_object_id();

			$pagename = get_query_var('pagename');

			if ( ! $pagename && $id ) {
				// If a static page is set as the front page, $pagename will not be set. Retrieve it from the queried object
				$post = get_queried_object();
				if ( $post )
					$pagename = $post->post_name;
			}

			$template = get_post_meta('theme-page-template', $id);

			if ( $template != 'index' )
				$templates[] = $template;
			if ( $pagename )
				$templates[] = "page-$pagename";
			if ( $id )
				$templates[] = "page-$id";
			$templates[] = '';

		// Page

		elseif ( $type == 'page' ):


			$id = get_queried_object_id();
			
			$template = get_post_meta('theme-page-template', $id);

			$pagename = get_query_var('pagename');

			if ( ! $pagename && $id ) {
				// If a static page is set as the front page, $pagename will not be set. Retrieve it from the queried object
				$post = get_queried_object();
				if ( $post )
					$pagename = $post->post_name;
			}

			if ( $template != 'index' )
				$templates[] = $template;
			if ( $pagename )
				$templates[] = "page-$pagename";
			if ( $id )
				$templates[] = "page-$id";
			$templates[] = 'page';


		// Default

		else:

			$templates[] = $type;

		endif;


		return $templates;

	}

	/**
	 * Checks if this is classy custom template
	 * 
	 * @return boolean
	 */
	public static function is_classy_template() {

		return self::get_classy_template() ? true : false;
	}

	/**
	 * Returns classy template name or boolean if this is not classy template
	 * 
	 * @return mixed
	 */
	public static function get_classy_template() {

		$template_slug = get_page_template_slug();

		preg_match('/classy\-(.*)/', $template_slug, $matches);

		if ( $matches && isset($matches[1]) ) return $matches[1];


		return false;

	}


	/**
	 * Returns current page template slug
	 * 
	 * @return string
	 */
	public static function get_current_page() {

		if ( is_404() && $template = self::get_available_template('404') ) :
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

		elseif ( is_search() && $template = self::get_available_template('search') ) :


		elseif ( is_front_page() && $template = self::get_available_template('front-page') ) :


		elseif ( is_home() && $template = self::get_available_template('home') ) :


		elseif ( is_post_type_archive() && $template = self::get_available_template('post_type_archive') ) :


		elseif ( is_tax() && $template = self::get_available_template('taxonomy') ) :


		elseif ( is_attachment() && $template = self::get_available_template('attachment') ) :


		elseif ( is_single() && $template = self::get_available_template('single') ) :


		elseif ( is_page() && $template = self::get_available_template('page') ) :


		elseif ( is_singular() && $template = self::get_available_template('singular') ) :


		elseif ( is_category() && $template = self::get_available_template('category') ) :


		elseif ( is_tag() && $template = self::get_available_template('tag') ) :


		elseif ( is_author() && $template = self::get_available_template('author') ) :


		elseif ( is_date() && $template = self::get_available_template('date') ) :


		elseif ( is_archive() && $template = self::get_available_template('archive') ) :


		elseif ( is_paged() && $template = self::get_available_template('paged') ) :


		else :
		
			$template = 'index';

		endif;


		return $template;

	}

	/**
	 * Modifies template path to nested that we use for our template structuring
	 * 
	 * @param  string $template ex: single
	 * @return string           single.single (it will look at "single" folder and will find "single.blade.php" template)
	 */
	public static function get_nested_blade_path($template) {

		if (preg_match('/\./', $template)) {

			return $template;	

		} else {

			return $template . '.' . $template;
			
		}

	}


	/**
	 * Returns available template, based on page argument
	 * 
	 * @return string
	 */
	public static function get_blade_template($page = null) {

		if (!$page) {
			$page = self::get_current_page();
		}

		$template = self::get_available_template($page);

		if ($template) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false

			return self::get_nested_blade_path($template);
			
		}

		return false;

	}

	/**
	 * Performs template render. 
	 * If there is $template attribute presented, it will render requested template. 
	 * If it's not it will try to find necessary template based on $wp_query
	 * 
	 * @param  string|null $template template path in blade format, ex: single, base.default, single.partials.slider and etc
	 * @param  array|null  $data     Additional params
	 * @return void                
	 */
	public static function render($template = null, $data = null) {

		$views = THEME_PATH . self::$theme_templates_folder;
		$cache = WP_CONTENT_DIR . '/templatecache';
		$common_scope = ClassyScope::get_common_scope();

		if ($template !== null && is_string($template)) {

			if ($data && is_array($data)) {

				$scope = array_merge($common_scope, $data);

			} else {

				$scope = $common_scope;

			}

		} else {

			$current_page = self::get_current_page();

			$template = self::get_blade_template($current_page);

			$scope = ClassyScope::get_scope($current_page);

		}

		$renderer = new BladeRenderer($views, array('cache_path' => $cache));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		echo $renderer->render($template, $scope);


	}
	
	/**
	 * Returns list of theme page templates
	 * 
	 * @return array
	 */
	public static function get_page_templates_list() {

		$templates = array();
		
	    $files = (array) glob( THEME_PATH . '/' . self::$theme_templates_folder . '/*/*.blade.php' );

		foreach ( $files as $filename ) {
			
			if ( !empty($filename) ) {

				if ( ! preg_match( '/\{\{\-\-\s*Template Name:(.*)\s*\-\-\}\}/mi', file_get_contents( $filename ), $header ) ) continue;

				$template_name = trim($header[1]);

				preg_match('/\/([^\/]*)\.blade.php$/is', $filename, $filename_match);

				$template_file = 'classy-' . $filename_match[1];

				$templates[$template_file] = $template_name;
				
			}

		}

		return $templates;

	}

}

Push — master ( 75c234...bb087c )

ClassyTemplate::get_request_templates_list() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			use Windwalker\Renderer\BladeRenderer;
4
5			/**
6			* Template Loader
7			*
8			* Loads the corresponding template based on request
9			*/
10			class ClassyTemplate {
			0 ignored issues – show Coding Style Compatibility introduced 2016-05-13 06:15 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
11
12			/**
13			* Theme twig templates folder
14			*
15			* @var string
16			*/
17			public static $theme_templates_folder = 'views';
18
19
20			/**
21			* Return theme template absolute path
22			*
23			* @param string $template in blade path format, ex: base.header
24			* @return string full path to template file
25			*/
26			public static function get_theme_template_path($template) {
27
28			$template = self::get_nested_blade_path($template);
29
30			$template = str_replace('.', '/', $template);
31
32			return THEME_PATH . self::$theme_templates_folder . '/' . $template . '.blade.php';
33
34			}
35
36			/**
37			* Checks if template exists
38			*
39			* @param string $template in blade path format, ex: base.header

anrw / classy

Push — master ( 75c234...bb087c )

ClassyTemplate::get_request_templates_list() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like