GravityView_View::render_widget_hooks() - Code Metrics - Inspection of "Version 1.16.4" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#664)

by Zack

created 2016-03-21 22:40 UTC

GravityView_View::render_widget_hooks() F

↳ Parent: GravityView_View

Complexity

Conditions	18
Paths	235

Size

Total Lines	104
Code Lines	52

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	104
rs	3.9221
cc	18
eloc	52
nc	235
nop	1

How to fix Long Method Complexity

<?php

/**
 * GravityView templating engine class
 *
 * @package   GravityView
 * @license   GPL2+
 * @author    Katz Web Services, Inc.
 * @link      http://gravityview.co
 * @copyright Copyright 2014, Katz Web Services, Inc.
 *
 * @since 1.0.0
 */

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

if( ! class_exists( 'Gamajo_Template_Loader' ) ) {
	require( GRAVITYVIEW_DIR . 'includes/lib/class-gamajo-template-loader.php' );
}

class GravityView_View extends 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';

	/**
	 * Reference to the root directory path of this plugin.
	 * @var string
	 */
	protected $plugin_directory = GRAVITYVIEW_DIR;

	/**
	 * Store templates locations that have already been located
	 * @var array
	 */
	protected $located_templates = array();

	/**
	 * The name of the template, like "list", "table", or "datatables"
	 * @var string
	 */
	protected $template_part_slug = '';

	/**
	 * The name of the file part, like "body" or "single"
	 * @var string
	 */
	protected $template_part_name = '';

	/**
	 * @var int Gravity Forms form ID
	 */
	protected $form_id = NULL;


	/**
	 * @var int View ID
	 * @todo: this needs to be public until extensions support 1.7+
	 */
	public $view_id = NULL;


	/**
	 * @var array Fields for the form
	 */
	protected $fields = array();

	/**
	 * @var string Current screen. Defaults to "directory" or "single"
	 */
	protected $context = 'directory';

	/**
	 * @var int|null If in embedded post or page, the ID of it
	 */
	protected $post_id = NULL;


	/**
	 * @var array Gravity Forms form array at ID $form_id
	 */
	protected $form = NULL;


	/**
	 * @var array Configuration for the View
	 */
	protected $atts = array();

	/**
	 * @var array Entries for the current result. Single item in array for single entry View
	 */
	protected $entries = array();

	/**
	 * @var int Total entries count for the current result.
	 */
	protected $total_entries = 0;

	/**
	 * @var string The label to display back links
	 */
	protected $back_link_label = '';

	/**
	 * @var array Array with `offset` and `page_size` keys
	 */
	protected $paging = array();

	/**
	 * @var array Array with `sort_field` and `sort_direction` keys
	 */
	protected $sorting = array();

	/**
	 * @var bool Whether to hide the results until a search is performed
	 * @since 1.5.4
	 */
	protected $hide_until_searched = false;

	/**
	 * Current entry in the loop
	 * @var array
	 */
	protected $_current_entry = array();

	/**
	 * @var array
	 */
	protected $_current_field = array();

	/**
	 * @var GravityView_View
	 */
	static $instance = NULL;
class A {
    var $property;
}

	/**
	 * Construct the view object
	 * @param  array       $atts Associative array to set the data of
	 */
	function __construct( $atts = array() ) {


		$atts = wp_parse_args( $atts, array(
			'form_id' => NULL,

			'view_id' => NULL,

			'fields'  => NULL,

			'context' => NULL,

			'post_id' => NULL,

			'form'    => NULL,

			'atts'	  => NULL,

		) );

		foreach ($atts as $key => $value) {

			if( is_null( $value ) ) {
				continue;
			}
			$this->{$key} = $value;
		}



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



		// widget logic
		add_action( 'gravityview_before', array( $this, 'render_widget_hooks' ) );
		add_action( 'gravityview_after', array( $this, 'render_widget_hooks' ) );

		/**
		 * Clear the current entry after the loop is done
		 * @since 1.7.3
		 */
		add_action( 'gravityview_footer', array( $this, 'clearCurrentEntry' ), 500 );

		self::$instance = &$this;
	}

	/**
	 * @param null $passed_post
	 *
	 * @return GravityView_View
	 */
	static function getInstance( $passed_post = NULL ) {


		if( empty( self::$instance ) ) {
			self::$instance = new self( $passed_post );
		}

		return self::$instance;
	}

	/**
	 * @param string|null $key The key to a specific attribute of the current field
	 * @return array|mixed|null If $key is set and attribute exists at $key, return that. If not set, return NULL. Otherwise, return current field array
	 */
	public function getCurrentField( $key = NULL ) {


		if( !empty( $key ) ) {

			if( isset( $this->_current_field[ $key ] ) ) {
				return $this->_current_field[ $key ];
			}
			return NULL;

		}

		return $this->_current_field;
	}

	public function setCurrentFieldSetting( $key, $value ) {


		if( !empty( $this->_current_field ) ) {

			$this->_current_field['field_settings'][ $key ] = $value;
		}

	}

	public function getCurrentFieldSetting( $key ) {

		$settings = $this->getCurrentField('field_settings');


		if( $settings && !empty( $settings[ $key ] ) ) {

			return $settings[ $key ];
		}

		return NULL;

	}

	/**
	 * @param array $passed_field
	 */
	public function setCurrentField( $passed_field ) {


		$existing_field = $this->getCurrentField();

		$set_field = wp_parse_args( $passed_field, $existing_field );

		$this->_current_field = $set_field;

		/**
		 * Backward compatibility
		 * @deprecated 1.6.2
		 */
		$this->field_data = $set_field;
	}

	/**
	 * @param string|null $key The key to a specific field in the fields array
	 * @return array|mixed|null If $key is set and field exists at $key, return that. If not set, return NULL. Otherwise, return array of fields.
	 */
	public function getAtts( $key = NULL ) {


		if( !empty( $key ) ) {

			if( isset( $this->atts[ $key ] ) ) {
				return $this->atts[ $key ];
			}
			return NULL;

		}

		return $this->atts;
	}

	/**
	 * @param array $atts
	 */
	public function setAtts( $atts ) {

		$this->atts = $atts;
	}

	/**
	 * @return array
	 */
	public function getForm() {

		return $this->form;
	}

	/**
	 * @param array $form
	 */
	public function setForm( $form ) {

		$this->form = $form;
	}

	/**
	 * @return int|null
	 */
	public function getPostId() {

		return $this->post_id;
	}

	/**
	 * @param int|null $post_id
	 */
	public function setPostId( $post_id ) {

		$this->post_id = $post_id;
	}

	/**
	 * @return string
	 */
	public function getContext() {

		return $this->context;
	}

	/**
	 * @param string $context
	 */
	public function setContext( $context ) {

		$this->context = $context;
	}

	/**
	 * @param string|null $key The key to a specific field in the fields array
	 * @return array|mixed|null If $key is set and field exists at $key, return that. If not set, return NULL. Otherwise, return array of fields.
	 */
	public function getFields( $key = null ) {


		$fields = empty( $this->fields ) ? NULL : $this->fields;


		if( $fields && !empty( $key ) ) {

			$fields = isset( $fields[ $key ] ) ? $fields[ $key ] : NULL;

		}

		return $fields;
	}

	/**
	 * @param array $fields
	 */
	public function setFields( $fields ) {

		$this->fields = $fields;
	}

	/**
	 * @param string $key The key to a specific field in the fields array
	 * @return array|mixed|null If $key is set and field exists at $key, return that. If not set, return NULL. Otherwise, return array of fields.
	 */
	public function getField( $key ) {


		if( !empty( $key ) ) {

			if( isset( $this->fields[ $key ] ) ) {
				return $this->fields[ $key ];
			}
		}

		return NULL;

	}

	/**
	 * @param string $key The key to a specific field in the fields array
	 * @param mixed $value The value to set for the field
	 */
	public function setField( $key, $value ) {

		$this->fields[ $key ] = $value;
	}

	/**
	 * @return int
	 */
	public function getViewId() {

		return absint( $this->view_id );
	}

	/**
	 * @param int $view_id
	 */
	public function setViewId( $view_id ) {

		$this->view_id = intval( $view_id );
	}

	/**
	 * @return int
	 */
	public function getFormId() {

		return $this->form_id;
	}

	/**
	 * @param int $form_id
	 */
	public function setFormId( $form_id ) {

		$this->form_id = $form_id;
	}

	/**
	 * @return array
	 */
	public function getEntries() {

		return $this->entries;
	}

	/**
	 * @param array $entries
	 */
	public function setEntries( $entries ) {

		$this->entries = $entries;
	}

	/**
	 * @return int
	 */
	public function getTotalEntries() {

		return (int)$this->total_entries;

	}

	/**
	 * @param int $total_entries
	 */
	public function setTotalEntries( $total_entries ) {

		$this->total_entries = intval( $total_entries );
	}

	/**
	 * @return array
	 */
	public function getPaging() {

		return $this->paging;
	}

	/**
	 * @param array $paging
	 */
	public function setPaging( $paging ) {

		$this->paging = $paging;
	}

	/**
	 * Get an array with pagination information
	 *
	 * @since 1.13
	 * 
	 * @return array {
	 *  @type int $first The starting entry number (counter, not ID)
	 *  @type int $last The last displayed entry number (counter, not ID)
	 *  @type int $total The total number of entries
	 * }
	 */
	public function getPaginationCounts() {


		$paging = $this->getPaging();
		$offset = $paging['offset'];
		$page_size = $paging['page_size'];
		$total = $this->getTotalEntries();

		if ( empty( $total ) ) {
			do_action( 'gravityview_log_debug', __METHOD__ . ': No entries. Returning empty array.' );

			return array();
		}

		$first = empty( $offset ) ? 1 : $offset + 1;

		// If the page size + starting entry is larger than total, the total is the max.
		$last = ( $offset + $page_size > $total ) ? $total : $offset + $page_size;

		/**
		 * @filter `gravityview_pagination_counts` Modify the displayed pagination numbers
		 * @since 1.13
		 * @param array $counts Array with $first, $last, $total numbers in that order
		 */
		list( $first, $last, $total ) = apply_filters( 'gravityview_pagination_counts', array( $first, $last, $total ) );

		return array( 'first' => (int) $first, 'last' => (int) $last, 'total' => (int) $total );
	}

	/**
	 * @return array
	 */
	public function getSorting() {

		return $this->sorting;
	}

	/**
	 * @param array $sorting
	 */
	public function setSorting( $sorting ) {

		$this->sorting = $sorting;
	}

	/**
	 * @return string
	 */
	public function getBackLinkLabel() {


		$back_link_label = GravityView_API::replace_variables( $this->back_link_label, $this->getForm(), $this->getCurrentEntry() );

		$back_link_label = do_shortcode( $back_link_label );

		return $back_link_label;
	}

	/**
	 * @param string $back_link_label
	 */
	public function setBackLinkLabel( $back_link_label ) {

		$this->back_link_label = $back_link_label;
	}

	/**
	 * @return boolean
	 */
	public function isHideUntilSearched() {

		return $this->hide_until_searched;
	}

	/**
	 * @param boolean $hide_until_searched
	 */
	public function setHideUntilSearched( $hide_until_searched ) {

		$this->hide_until_searched = $hide_until_searched;
	}

	/**
	 * @return string
	 */
	public function getTemplatePartSlug() {

		return $this->template_part_slug;
	}

	/**
	 * @param string $template_part_slug
	 */
	public function setTemplatePartSlug( $template_part_slug ) {

		$this->template_part_slug = $template_part_slug;
	}

	/**
	 * @return string
	 */
	public function getTemplatePartName() {

		return $this->template_part_name;
	}

	/**
	 * @param string $template_part_name
	 */
	public function setTemplatePartName( $template_part_name ) {

		$this->template_part_name = $template_part_name;
	}

	/**
	 * Return the current entry. If in the loop, the current entry. If single entry, the currently viewed entry.
	 * @return array
	 */
	public function getCurrentEntry() {


		if( in_array( $this->getContext(), array( 'edit', 'single') ) ) {

			$entries = $this->getEntries();
			$entry = $entries[0];
		} else {
			$entry = $this->_current_entry;
		}

		/** @since 1.16 Fixes DataTables empty entry issue */
		if ( empty( $entry ) && ! empty( $this->_current_field['entry'] ) ) {
			$entry = $this->_current_field['entry'];
		}

		return $entry;
	}

	/**
	 * @param array $current_entry
	 * @return void
	 */
	public function setCurrentEntry( $current_entry ) {

		$this->_current_entry = $current_entry;
	}

	/**
	 * Clear the current entry after all entries in the loop have been displayed.
	 *
	 * @since 1.7.3
	 * @return void
	 */
	public function clearCurrentEntry() {

		$this->_current_entry = NULL;

	}

	/**
	 * Render an output zone, as configured in the Admin
	 *
	 * @since 1.16.4 Added $echo parameter
	 *
	 * @param string $zone The zone name, like 'footer-left'
	 * @param array $atts
	 * @param bool $echo Whether to print the output
	 *
	 * @return string|null
	 */
	public function renderZone( $zone = '', $atts = array(), $echo = true ) {


		if( empty( $zone ) ) {
			do_action('gravityview_log_error', 'GravityView_View[renderZone] No zone defined.');

			return NULL;

		}

		$defaults = array(
			'slug' => $this->getTemplatePartSlug(),
			'context' => $this->getContext(),
			'entry' => $this->getCurrentEntry(),
			'form' => $this->getForm(),
			'hide_empty' => $this->getAtts('hide_empty'),

		);

		$final_atts = wp_parse_args( $atts, $defaults );

		$output = '';

		$final_atts['zone_id'] = "{$final_atts['context']}_{$final_atts['slug']}-{$zone}";

		$fields = $this->getField( $final_atts['zone_id'] );

		// Backward compatibility
		if( 'table' === $this->getTemplatePartSlug() ) {
			/**
			 * Modify the fields displayed in the table
			 * @var array
			 */
			$fields = apply_filters("gravityview_table_cells", $fields, $this );
<?php

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

print $doubleQuoted;
		}

		if( empty( $fields ) ) {
			return NULL;

		}

		$field_output = '';
		foreach ( $fields as $field ) {
			$final_atts['field'] = $field;

			$field_output .= gravityview_field_output( $final_atts );
		}

		/**
		 * If a zone has no field output, choose whether to show wrapper
		 * False by default to keep backward compatibility
		 * @since 1.7.6
		 * @param boolean $hide_empty_zone Default: false
		 */
		if( empty( $field_output ) && apply_filters( 'gravityview/render/hide-empty-zone', false ) ) {
			return NULL;

		}

		if( !empty( $final_atts['wrapper_class'] ) ) {

			$output .= '<div class="'.gravityview_sanitize_html_class( $final_atts['wrapper_class'] ).'">';
		}

		$output .= $field_output;

		if( !empty( $final_atts['wrapper_class'] ) ) {

			$output .= '</div>';
		}

		if( $echo ) {
			echo $output;

		}

		return $output;
	}

	/**
	 * In order to improve lookup times, we store located templates in a local array.
	 *
	 * This improves performance by up to 1/2 second on a 250 entry View with 7 columns showing
	 *
	 * @inheritdoc
	 * @see Gamajo_Template_Loader::locate_template()
	 * @return null|string NULL: Template not found; String: path to template
	 */
	function locate_template( $template_names, $load = false, $require_once = true ) {


		if( is_string( $template_names ) && isset( $this->located_templates[ $template_names ] ) ) {

			$located = $this->located_templates[ $template_names ];

		} else {

			// Set $load to always false so we handle it here.
			$located = parent::locate_template( $template_names, false, $require_once );

			if( is_string( $template_names ) ) {
				$this->located_templates[ $template_names ] = $located;
			}
		}

		if ( $load && $located ) {
			load_template( $located, $require_once );
		}

		return $located;
	}

	/**
	 * Magic Method: Instead of throwing an error when a variable isn't set, return null.
	 * @param  string      $name Key for the data retrieval.
	 * @return mixed|null    The stored data.
	 */
	public function __get( $name ) {
		if( isset( $this->{$name} ) ) {
			return $this->{$name};
		} else {
			return NULL;

		}
	}

	/**
	 * 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
	 */
	function add_id_specific_templates( $templates, $slug, $name ) {


		$additional = array();

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

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

		if( $this->getPostId() ) {
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

			// page-19-table-body.php
			$additional[] = sprintf( 'page-%d-%s-%s.php', $this->getPostId(), $slug, $name );
		}

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

		do_action( 'gravityview_log_debug', '[add_id_specific_templates] List of Template Files', $templates );

		return $templates;
	}

	// Load the template
	public function render( $slug, $name, $require_once = true ) {

		$this->setTemplatePartSlug( $slug );

		$this->setTemplatePartName( $name );

		$template_file = $this->get_template_part( $slug, $name, false );

		do_action( 'gravityview_log_debug', '[render] Rendering Template File', $template_file );

		if( !empty( $template_file) ) {


			if ( $require_once ) {
				require_once( $template_file );
			} else {
				require( $template_file );
			}


		}
	}

	/**
	 *
	 * @param $view_id
	 */
	public function render_widget_hooks( $view_id ) {

		if( empty( $view_id ) || 'single' == gravityview_get_context() ) {
			do_action( 'gravityview_log_debug', __METHOD__ . ' - Not rendering widgets; single entry' );
			return;
		}

		$view_data = gravityview_get_current_view_data( $view_id );

		// get View widget configuration
		$widgets = (array)$view_data['widgets'];


		switch( current_filter() ) {
			default:
			case 'gravityview_before':
				$zone = 'header';
				break;
			case 'gravityview_after':
				$zone = 'footer';
				break;
		}

		/**
		 * Filter widgets not in the current zone
		 * @since 1.16
		 */
		foreach( $widgets as $key => $widget ) {
			// The widget isn't in the current zone
			if( false === strpos( $key, $zone ) ) {
				unset( $widgets[ $key ] );
			}
		}

		/**
		 * Prevent output if no widgets to show.
		 * @since 1.16
		 */
		if ( empty( $widgets ) ) {
			do_action( 'gravityview_log_debug', sprintf( 'No widgets for View #%s', $view_id ) );
			return;
		}

		// Prevent being called twice
		if( did_action( $zone.'_'.$view_id.'_widgets' ) ) {
			do_action( 'gravityview_log_debug', sprintf( '%s - Not rendering %s; already rendered', __METHOD__ , $zone.'_'.$view_id.'_widgets' ) );
			return;
		}

		$rows = GravityView_Plugin::get_default_widget_areas();

		// TODO: Move to sep. method, use an action instead
		wp_enqueue_style( 'gravityview_default_style' );

		$default_css_class = 'gv-grid gv-widgets-' . $zone;

		if( 0 === GravityView_View::getInstance()->getTotalEntries() ) {
			$default_css_class .= ' gv-widgets-no-results';
		}

		/**
		 * @filter `gravityview/widgets/wrapper_css_class` The CSS class applied to the widget container `<div>`.
		 * @since 1.16.2
		 * @param string $css_class Default: `gv-grid gv-widgets-{zone}` where `{zone}` is replaced by the current `$zone` value. If the View has no results, adds ` gv-widgets-no-results`
		 * @param string $zone Current widget zone, either `header` or `footer`
		 * @param array $widgets Array of widget configurations for the current zone, as set by `gravityview_get_current_view_data()['widgets']`
		 */
		$css_class = apply_filters('gravityview/widgets/wrapper_css_class', $default_css_class, $zone, $widgets );


		$css_class = gravityview_sanitize_html_class( $css_class );

		// TODO Convert to partials
		?>
		<div class="<?php echo $css_class; ?>">

			<?php
			foreach( $rows as $row ) {
				foreach( $row as $col => $areas ) {
					$column = ($col == '2-2') ? '1-2 gv-right' : $col.' gv-left';
				?>
					<div class="gv-grid-col-<?php echo esc_attr( $column ); ?>">
						<?php
						if( !empty( $areas ) ) {

							foreach( $areas as $area ) {
								if( !empty( $widgets[ $zone .'_'. $area['areaid'] ] ) ) {

									foreach( $widgets[ $zone .'_'. $area['areaid'] ] as $widget ) {
										do_action( "gravityview_render_widget_{$widget['id']}", $widget );
									}
								}
							}
						} ?>
					</div>
				<?php } // $row ?>
			<?php } // $rows ?>
		</div>

		<?php

		/**
		 * Prevent widgets from being called twice.
		 * Checking for loop_start prevents themes and plugins that pre-process shortcodes from triggering the action before displaying. Like, ahem, the Divi theme and WordPress SEO plugin
		 */
		if( did_action( 'loop_start' ) ) {
			do_action( $zone.'_'.$view_id.'_widgets' );
		}
	}

}



1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-09 18:31 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 23 and the first side effect is on line 16. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* GravityView templating engine class
4			*
5			* @package GravityView
6			* @license GPL2+
7			* @author Katz Web Services, Inc.
8			* @link http://gravityview.co
9			* @copyright Copyright 2014, Katz Web Services, Inc.
10			*
11			* @since 1.0.0
12			*/
13
14			/** If this file is called directly, abort. */
15			if ( ! defined( 'ABSPATH' ) ) {
16			die;
17			}
18
19			if( ! class_exists( 'Gamajo_Template_Loader' ) ) {
20			require( GRAVITYVIEW_DIR . 'includes/lib/class-gamajo-template-loader.php' );
21			}
22
23			class GravityView_View extends Gamajo_Template_Loader {
24
25			/**
26			* Prefix for filter names.
27			* @var string
28			*/
29			protected $filter_prefix = 'gravityview';
30
31			/**
32			* Directory name where custom templates for this plugin should be found in the theme.
33			* @var string
34			*/
35			protected $theme_template_directory = 'gravityview';
36
37			/**
38			* Reference to the root directory path of this plugin.
39			* @var string

gravityview / GravityView

Pull Request — master (#664)

GravityView_View::render_widget_hooks() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like