GravityView_Plugin_Hooks_Gravity_Forms_Signature

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	add_hooks()	0	9	1
A	after_edit_entry()	0	8	2
A	edit_entry_field_input()	0	18	4

<?php

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 19 and the first side effect is on line 93.

/**
 * Customization for the Gravity Forms Signature Addon
 *
 * @file      class-gravityview-plugin-hooks-gravity-forms-signature.php
 * @package   GravityView
 * @license   GPL2+
 * @author    Katz Web Services, Inc.
 * @link      http://gravityview.co
 * @copyright Copyright 2016, Katz Web Services, Inc.
 *
 * @since 1.17
 */

/**
 * @inheritDoc
 * @since 1.17
 */
class GravityView_Plugin_Hooks_Gravity_Forms_Signature extends GravityView_Plugin_and_Theme_Hooks {

	/**
	 * @type string Class that should be exist in a plugin or theme. Used to check whether plugin is active.
	 * @since 1.17
	 */
	protected $class_name = 'GFSignature';

	protected function add_hooks() {

		// Remove $_POST values so GF doesn't change output HTML laout
		add_action( 'gravityview/edit_entry/after_update', array( $this, 'after_edit_entry' ), 10, 2 );

		// Set the priority to 5 so it processes before the Signature field input is generated
		// This way, we can modify the $_POST value before the Signature Addon uses it.
		add_filter( 'gform_field_input', array( $this, 'edit_entry_field_input' ), 5, 5 );
	}

	/**
	 * We need to remove the $value used by Gravity Forms so it instead checks for the $_POST field values
	 *
	 * In ~line 541, this code would be used if we didn't override in this method:
	 *
	 * `if (RG_CURRENT_VIEW == "entry" && $value){`
	 *
	 * We don't want that code (with the download/delete icons). So unsetting the $_POST here forces using the "sign again" code instead.
	 *
	 * @see GFSignature::signature_input
	 *
	 * @param array $form GF form array
	 * @param int $entry_id Entry ID being edited
	 */
	function after_edit_entry( $form, $entry_id ) {

The parameter $entry_id is not used and could be removed.

It is generally recommended to explicitly declare the visibility for methods.

		$signature_fields = GFAPI::get_fields_by_type( $form, 'signature' );

		foreach ( $signature_fields as $field ) {
			unset( $_POST["input_{$field->id}"] );

Detected access of super global var $_POST, probably need manual inspection.

Array keys should be surrounded by spaces unless they contain a string or an integer.

		}
	}

	/**
	 * The Signature Addon only displays the output in the editable form if it thinks it's in the Admin or a form has been submitted
	 *
	 * @since 1.17
	 *
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
	 * @param GF_Field $field
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
	 * @param int $form_id Form ID
	 *
	 * @return string Empty string forces Gravity Forms to use the $_POST values
	 */
	function edit_entry_field_input( $field_content = '', $field, $value = '', $lead_id = 0, $form_id = 0 ) {

It is generally recommended to explicitly declare the visibility for methods.

		$context = function_exists('gravityview_get_context') ? gravityview_get_context() : '';

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		if( 'signature' !== $field->type || 'edit' !== $context ) {
			return $field_content;
		}

		// We need to fetch a fresh version of the entry, since the saved entry hasn't refreshed in GV yet.
		$entry = GravityView_View::getInstance()->getCurrentEntry();
		$entry = GFAPI::get_entry( $entry['id'] );
		$entry_value = rgar( $entry, $field->id );

		$_POST["input_{$field->id}"] = $entry_value; // Used when Edit Entry form *is* submitted

Array keys should be surrounded by spaces unless they contain a string or an integer.

		$_POST["input_{$form_id}_{$field->id}_signature_filename"] = $entry_value; // Used when Edit Entry form *is not* submitted

Array keys should be surrounded by spaces unless they contain a string or an integer.

		return ''; // Return empty string to force using $_POST values instead
	}
}

new GravityView_Plugin_Hooks_Gravity_Forms_Signature;