Field_Template::add_id_specific_templates() - Code Metrics - Inspection of "Merge pull request #1028 from gravityview/develop" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( cd320e...b9ab02 )

by Zack
created 2018-05-14 14:44 UTC
Field_Template::add_id_specific_templates() D

↳ Parent: Field_Template
Complexity

Conditions	23
Paths	12
Size

Total Lines	130
Code Lines	58
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	59
CRAP Score	23
Importance

Changes
Metric	Value
cc	23
eloc	58
nc	12
nop	1
dl	0
loc	130
ccs	59
cts	59
cp	1
crap	23
rs	4.6303
c	0
b	0
f	0
How to fix Long Method Complexity

<?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( 'Gamajo_Template_Loader' ) ) {
	require gravityview()->plugin->dir( 'future/lib/class-gamajo-template-loader.php' );
}

/**
 * The Field Template class.
 *
 * Attached to a \GV\Field and used by a \GV\Field_Renderer.
 */
abstract class Field_Template extends Template {
	/**
	 * Prefix for filter names.
	 * @var string
	 */
	protected $filter_prefix = 'gravityview/template/fields';

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

	/**
	 * Directory name where the default templates for this plugin are found.
	 * @var string
	 */
	protected $plugin_template_directory = 'templates/fields/';

	/**
	 * @var \GV\Field The field connected to this template.
	 */
	public $field;

	/**
	 * @var \GV\View The view context.
	 */
	public $view;

	/**
	 * @var \GV\Source The source context.
	 */
	public $source;

	/**
	 * @var \GV\Entry The entry context.
	 */
	public $entry;

	/**
	 * @var \GV\Request The request context.
	 */
	public $request;

	/**
	 * @var string The template slug to be loaded (like "table", "list")
	 */
	public static $slug;

	/**
	 * Initializer.
	 *
	 * @param \GV\Field $field The field about to be rendered.
	 * @param \GV\View $view The view in this context, if applicable.
	 * @param \GV\Source $source The source (form) in this context, if applicable.
	 * @param \GV\Entry $entry The entry in this context, if applicable.
	 * @param \GV\Request $request The request in this context, if applicable.
	 */
	public function __construct( Field $field, View $view = null, Source $source = null, Entry $entry = null, Request $request = null ) {
		$this->field = $field;
		$this->view = $view;
		$this->source = $source;
		$this->entry = $entry;
		$this->request = $request;

		/** Add granular overrides. */
		add_filter( $this->filter_prefix . '_get_template_part', $this->_add_id_specific_templates_callback  = self::add_id_specific_templates( $this ), 10, 3 );
class MyClass { }

$x = new MyClass();
$x->foo = true;

		parent::__construct();
	}

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

	/**
	 * Enable granular template overrides based on current post, view, form, field types, etc.
	 *
	 * Why? See https://github.com/gravityview/GravityView/issues/1024
	 *
	 * @param \GV\Field_Template $template The template instance.
	 * @return callable The callback bound to `get_template_part`. See `\GV\Field_Template::__construct`
	 */
	public static function add_id_specific_templates( $template ) {

		$inputType  = null;
		$field_type = null;
		$field_id   = null;
		$view_id    = null;
		$form_id    = null;
		$is_view    = $template->request && $template->request->is_view();

		if ( $template->field ) {
			$inputType  = $template->field->inputType;

			$field_type = $template->field->type;

			$field_id   = $template->field->ID;
		}

		if ( $template->view ) {
			$view_id = $template->view->ID;

			$form_id = $template->view->form ? $template->view->form->ID : null;
		}

		$class = get_class( $template );

		/**
		 * Enable granular template overrides based on current post, view, form, field types, etc.
		 *
		 * The hierarchy is as follows:
		 *
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field type]-html.php
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field inputType]-html.php
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-html.php
		 * - post-[ID of post of page where view is embedded]-field-[Field type]-html.php
		 * - post-[ID of post of page where view is embedded]-field-[Field inputType]-html.php
		 * - post-[ID of post of page where view is embedded]-field-html.php
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field type].php
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field inputType].php
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field.php
		 * - post-[ID of post of page where view is embedded]-field-[Field type].php
		 * - post-[ID of post of page where view is embedded]-field-[Field inputType].php
		 * - post-[ID of post of page where view is embedded]-field.php
		 * - form-[Form ID]-field-[Field ID]-html.php
		 * - form-[Form ID]-field-[Field ID].php
		 * - form-[Form ID]-field-[Field type]-html.php
		 * - form-[Form ID]-field-[Field inputType]-html.php
		 * - form-[Form ID]-field-[Field type].php
		 * - form-[Form ID]-field-[Field inputType].php
		 * - view-[View ID]-field-[Field type]-html.php
		 * - view-[View ID]-field-[Field inputType]-html.php
		 * - view-[View ID]-field-[Field type].php
		 * - view-[View ID]-field-[Field inputType].php
		 * - field-[Field type]-html.php
		 * - field-[Field inputType]-html.php
		 * - field-[Field type].php
		 * - field-[Field inputType].php
		 * - field-html.php
		 * - field.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: `html`, `json`, `xml`
		 * @param string $name      Name of the template part.
		 *
		 * @return array $templates Modified template array, merged with existing $templates values
		 */
		return function( $templates, $slug, $name ) use ( $class, $inputType, $field_type, $view_id, $is_view, $form_id, $field_id ) {
			$specifics = array();

			list( $slug_dir, $slug_name ) = $class::split_slug( $slug, $name );

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

			if ( $is_view && $post ) {
				if ( $field_type ) {
					$specifics []= sprintf( '%spost-%d-view-%d-field-%s-%s.php', $slug_dir, $post->ID, $view_id, $field_type, $slug_name );

					$inputType && $specifics []= sprintf( '%spost-%d-view-%d-field-%s-%s.php', $slug_dir, $post->ID, $view_id, $inputType, $slug_name );

					$specifics []= sprintf( '%spost-%d-view-%d-field-%s.php', $slug_dir, $post->ID, $view_id, $field_type );

					$inputType && $specifics []= sprintf( '%spost-%d-view-%d-field-%s.php', $slug_dir, $post->ID, $view_id, $inputType );

					$specifics []= sprintf( '%spost-%d-field-%s-%s.php', $slug_dir, $post->ID, $field_type, $slug_name );

					$inputType && $specifics []= sprintf( '%spost-%d-field-%s-%s.php', $slug_dir, $post->ID, $inputType, $slug_name );

					$specifics []= sprintf( '%spost-%d-field-%s.php', $slug_dir, $post->ID, $field_type );

					$inputType &&  $specifics []= sprintf( '%spost-%d-field-%s.php', $slug_dir, $post->ID, $inputType );

				}

				$specifics []= sprintf( '%spost-%d-view-%d-field-%s.php', $slug_dir, $post->ID, $view_id, $slug_name );

				$specifics []= sprintf( '%spost-%d-view-%d-field.php', $slug_dir, $post->ID, $view_id );

				$specifics []= sprintf( '%spost-%d-field-%s.php', $slug_dir, $post->ID, $slug_name );

				$specifics []= sprintf( '%spost-%d-field.php', $slug_dir, $post->ID );

			}
			
			/** Field-specific */
			if ( $field_id && $form_id ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

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

				if ( $field_id ) {
					$specifics []= sprintf( '%sform-%d-field-%d-%s.php', $slug_dir, $form_id, $field_id, $slug_name );

					$specifics []= sprintf( '%sform-%d-field-%d.php', $slug_dir, $form_id, $field_id );

				}

				if ( $field_type ) {
					$specifics []= sprintf( '%sform-%d-field-%s-%s.php', $slug_dir, $form_id, $field_type, $slug_name );

					$inputType && $specifics []= sprintf( '%sform-%d-field-%s-%s.php', $slug_dir, $form_id, $inputType, $slug_name );

					$specifics []= sprintf( '%sform-%d-field-%s.php', $slug_dir, $form_id, $field_type );

					$inputType && $specifics []= sprintf( '%sform-%d-field-%s.php', $slug_dir, $form_id, $inputType );


					$specifics []= sprintf( '%sview-%d-field-%s-%s.php', $slug_dir, $view_id, $field_type, $slug_name );

					$inputType && $specifics []= sprintf( '%sview-%d-field-%s-%s.php', $slug_dir, $view_id, $inputType, $slug_name );

					$specifics []= sprintf( '%sview-%d-field-%s.php', $slug_dir, $view_id, $field_type );

					$inputType && $specifics []= sprintf( '%sview-%d-field-%s.php', $slug_dir, $view_id, $inputType );


					$specifics []= sprintf( '%sfield-%s-%s.php', $slug_dir, $field_type, $slug_name );

					$inputType && $specifics []= sprintf( '%sfield-%s-%s.php', $slug_dir, $inputType, $slug_name );

					$specifics []= sprintf( '%sfield-%s.php', $slug_dir, $field_type );

					$inputType && $specifics []= sprintf( '%sfield-%s.php', $slug_dir, $inputType );

				}
			}

			if ( $form_id ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				/** Generic field templates */
				$specifics []= sprintf( '%sview-%d-field-%s.php', $slug_dir, $view_id, $slug_name );

				$specifics []= sprintf( '%sform-%d-field-%s.php', $slug_dir, $form_id, $slug_name );


				$specifics []= sprintf( '%sview-%d-field.php', $slug_dir, $view_id );

				$specifics []= sprintf( '%sform-%d-field.php', $slug_dir, $form_id );

			}

			$specifics []= sprintf( '%sfield-%s.php', $slug_dir, $slug_name );

			$specifics []= sprintf( '%sfield.php', $slug_dir );




			return array_merge( $specifics, $templates );
		};
	}

	/**
	 * Output some HTML.
	 *
	 * @todo Move to \GV\Field_HTML_Template, but call filters here?
	 *
	 * @return void
	 */
	public function render() {

		/** Retrieve the value. */
		$display_value = $value = $this->field->get_value( $this->view, $this->source, $this->entry );

		$source = $this->source;
		$source_backend = $source ? $source::$backend : null;

		/** Alter the display value according to Gravity Forms. */
		if ( $source_backend == \GV\Source::BACKEND_GRAVITYFORMS ) {
			/** Prevent any PHP warnings that may be generated. */
			ob_start();

			$display_value = \GFCommon::get_lead_field_display( $this->field->field, $value, $this->entry['currency'], false, 'html' );
<?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 ( $errors = ob_get_clean() ) {
				gravityview()->log->error( 'Errors when calling GFCommon::get_lead_field_display()', array( 'data' => $errors ) );
			}

			/** Call the Gravity Forms field value filter. */
			$display_value = apply_filters( 'gform_entry_field_value', $display_value, $this->field->field, $this->entry->as_entry(), $this->source->form );
<?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.");
        }
    }

}

			/** Replace merge tags for admin-only fields. */
			if ( ! empty( $this->field->field->adminOnly ) ) {
<?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.");
        }
    }

}
				$display_value = \GravityView_API::replace_variables( $display_value, $this->form->form, $this->entry->as_entry() );
class MyClass { }

$x = new MyClass();
$x->foo = true;
			}
		}

		$context = Template_Context::from_template( $this, compact( 'display_value', 'value' ) );

		/**
		 * Make various pieces of data available to the template
		 *  under the $gravityview scoped variable.
		 *
		 * @filter `gravityview/template/field/context`
		 * @param \GV\Template_Context $context The context for this template.
		 * @since 2.0
		 */
		$this->push_template_data( apply_filters( 'gravityview/template/field/context', $context ), 'gravityview' );

		/** Bake the template. */
		ob_start();
		$this->located_template = $this->get_template_part( static::$slug );
		$output = ob_get_clean();

		if ( empty( $output ) ) {
			/**
			 * @filter `gravityview_empty_value` What to display when a field is empty
			 * @deprecated Use the `gravityview/field/value/empty` filter instead
			 * @param string $value (empty string)
			 */
			$output = apply_filters( 'gravityview_empty_value', $output );

			/**
			 * @filter `gravityview/field/value/empty` What to display when this field is empty.
			 * @param string $value The value to display (Default: empty string)
			 * @param \GV\Template_Context The template context this is being called from.
			 */
			$output = apply_filters( 'gravityview/field/value/empty', $output, Template_Context::from_template( $this ) );

			$context = Template_Context::from_template( $this, compact( 'display_value', 'value' ) );
		}

		gravityview()->log->info( 'Field template for field #{field_id} loaded: {located_template}', array( 'field_id' => $this->field->ID, 'located_template' => $this->located_template ) );

		$this->pop_template_data( 'gravityview' );

		/** A compatibility array that's required by some of the deprecated filters. */
		$field_compat = array(
			'form' => $source_backend == \GV\Source::BACKEND_GRAVITYFORMS ? $this->source->form : null,
			'field_id' => $this->field->ID,
			'field' => $this->field->field,
<?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.");
        }
    }

}
			'field_settings' => $this->field->as_configuration(),
			'value' => $value,
			'display_value' => $display_value,
			'format' => 'html',
			'entry' => $this->entry->as_entry(),
			'field_type' => $this->field->type,
<?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.");
        }
    }

}
			'field_path' => $this->located_template,
		);

		$pre_link_compat_callback = function( $output, $context ) use ( $field_compat ) {
			$field = $context->field;

			/**
			 * @filter `gravityview_field_entry_value_{$field_type}_pre_link` Modify the field value output for a field type before Show As Link setting is applied. Example: `gravityview_field_entry_value_number_pre_link`
			 * @since 1.16
			 * @param string $output HTML value output
			 * @param array  $entry The GF entry array
			 * @param array  $field_settings Settings for the particular GV field
			 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
			 *
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
			 */
			$output = apply_filters( "gravityview_field_entry_value_{$field->type}_pre_link", $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			$output = apply_filters( 'gravityview_field_entry_value_pre_link', $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			/**
			 * Link to the single entry by wrapping the output in an anchor tag
			 *
			 * Fields can override this by modifying the field data variable inside the field. See /templates/fields/post_image.php for an example.
			 */
			if ( ! empty( $field->show_as_link ) && ! \gv_empty( $output, false, false ) ) {
				$link_atts = empty( $field->new_window ) ? array() : array( 'target' => '_blank' );

				$permalink = $context->entry->get_permalink( $context->view, $context->request );
				$output = \gravityview_get_link( $permalink, $output, $link_atts );
				
				/**
				 * @filter `gravityview_field_entry_link` Modify the link HTML
				 * @param string $link HTML output of the link
				 * @param string $href URL of the link
				 * @param array  $entry The GF entry array
				 * @param array $field_settings Settings for the particular GV field
				 * @deprecated Use `gravityview/template/field/entry_link`
				 */
				$output = apply_filters( 'gravityview_field_entry_link', $output, $permalink, $context->entry->as_entry(), $field->as_configuration() );

				/**
				 * @filter `gravityview/template/field/entry_link` Modify the link HTML
				 * @since 2.0
				 * @param string $link HTML output of the link
				 * @param string $href URL of the link
				 * @param \GV\Template_Context $context The context
				 */
				$output = apply_filters( 'gravityview/template/field/entry_link', $output, $permalink, $context );
			}

			return $output;
		};

		$post_link_compat_callback = function( $output, $context ) use ( $field_compat ) {
			$field = $context->field;

			/**
			 * @filter `gravityview_field_entry_value_{$field_type}` Modify the field value output for a field type. Example: `gravityview_field_entry_value_number`
			 * @since 1.6
			 * @param string $output HTML value output
			 * @param array  $entry The GF entry array
			 * @param  array $field_settings Settings for the particular GV field
			 * @param array $field Current field being displayed
			 *
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
			 */
			$output = apply_filters( "gravityview_field_entry_value_{$field->type}", $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			/**
			 * @filter `gravityview_field_entry_value` Modify the field value output for all field types
			 * @param string $output HTML value output
			 * @param array  $entry The GF entry array
			 * @param  array $field_settings Settings for the particular GV field
			 * @param array $field_data  {@since 1.6}
			 *
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
			 */
			$output = apply_filters( 'gravityview_field_entry_value', $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			/**
			 * @filter `gravityview/template/field/{$field_type}/output` Modify the field output for a field type.
			 *
			 * @since 2.0
			 *
			 * @param string $output The current output.
			 * @param \GV\Template_Context The template context this is being called from.
			 */
			return apply_filters( "gravityview/template/field/{$field->type}/output", $output, $context );
		};

		/**
		 * Okay, what's this whole pre/post_link compat deal, huh?
		 *
		 * Well, the `gravityview_field_entry_value_{$field_type}_pre_link` filter
		 *  is expected to be applied before the value is turned into an entry link.
		 *
		 * And then `gravityview_field_entry_value_{$field_type}` and `gravityview_field_entry_value`
		 *  are called afterwards.
		 *
		 * So we're going to use filter priorities to make sure this happens inline with
		 *  our new filters, in the correct sequence. Pre-link called with priority 5 and
		 *  post-link called with priority 9. Then everything else.
		 *
		 * If a new code wants to alter the value before it is hyperlinked (hyperlinkified?),
		 *  it should hook into a priority between -inf. and 8. Afterwards: 10 to +inf.
		 */
		add_filter( 'gravityview/template/field/output', $pre_link_compat_callback, 5, 2 );
		add_filter( 'gravityview/template/field/output', $post_link_compat_callback, 9, 2 );

		/**
		 * @filter `gravityview/template/field/output` Modify the field output for a field.
		 *
		 * @since 2.0
		 *
		 * @param string $output The current output.
		 * @param \GV\Template_Context The template this is being called from.
		 */
		echo apply_filters( "gravityview/template/field/output", $output, $context );
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

		remove_filter( 'gravityview/template/field/output', $pre_link_compat_callback, 5 );
		remove_filter( 'gravityview/template/field/output', $post_link_compat_callback, 9 );
	}
}

/** Load implementations. */
require gravityview()->plugin->dir( 'future/includes/class-gv-template-field-html.php' );

Push — master ( cd320e...b9ab02 )

Field_Template::add_id_specific_templates() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

gravityview / GravityView

Push — master ( cd320e...b9ab02 )

Field_Template::add_id_specific_templates() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like
