gravityview / GravityView

includes/admin/class.field.type.php

Indentation +176 added lines, -176 removed lines

@@ -10,107 +10,107 @@ 
 	 *
 	 * @var string
 	 */
-    protected $name;
+	protected $name;
 
 	/**
 	 * Field settings
 	 *
 	 * @var array
 	 */
-    protected $field;
+	protected $field;
 
 	/**
 	 * Field current value
 	 *
 	 * @var mixed
 	 */
-    protected $value;
-
-    function __construct( $name = '', $field = array(), $curr_value = NULL ) {
-
-        $this->name = $name;
-
-        $defaults = self::get_field_defaults();
-
-        // Backward compatibility
-        if( !empty( $field['choices'] ) ) {
-        	$field['options'] = $field['choices'];
-        	unset( $field['choices'] );
-        }
-
-        $this->field =  wp_parse_args( $field, $defaults );
-
-        $this->value = is_null( $curr_value ) ? $this->field['value'] : $curr_value;
-
-    }
-
-    /**
-     * Returns the default details for a field option
-     *
-     * - default    // default option value, in case nothing is defined (@deprecated)
-     * - desc       // option description
-     * - value      // the option default value
-     * - label      // the option label
-     * - left_label // In case of checkboxes, left label will appear on the left of the checkbox
-     * - id         // the field id
-     * - type       // the option type ( text, checkbox, select, ... )
-     * - options    // when type is select, define the select options ('choices' is @deprecated)
-     * - merge_tags // if the option supports merge tags feature
-     * - class      // (new) define extra classes for the field
-     * - tooltip    //
-     *
-     * @return array
-     */
-    public static function get_field_defaults() {
-        return array(
-            'desc' => '',
-            'value' => null,
-            'label' => '',
-            'left_label' => null,
-            'id' => null,
-            'type'  => 'text',
-            'options' => null,
-            'merge_tags' => true,
-            'class' => '',
-            'tooltip' => null,
-            'requires' => null
-        );
-    }
-
-
-    function get_tooltip() {
-        if( ! function_exists('gform_tooltip') ) {
-            return null;
-        }
-
-	    $article = wp_parse_args( \GV\Utils::get( $this->field, 'article', array() ), array(
-	    	'id' => '',
-	    	'type' => 'modal',
-	    	'url' => '#',
-	    ) );
-
-        return !empty( $this->field['tooltip'] ) ? ' '. $this->tooltip( $this->field['tooltip'], false, true, $article ) : null;
-    }
-
-    /**
-     * Displays the tooltip
-     *
-     * @since 2.8.1
-     *
-     * @global $__gf_tooltips
-     *
-     * @param string $name      The name of the tooltip to be displayed
-     * @param string $css_class Optional. The CSS class to apply toi the element. Defaults to empty string.
-     * @param bool   $return    Optional. If the tooltip should be returned instead of output. Defaults to false (output)
-     * @param array  $article   Optional. Details about support doc article connected to the tooltip. {
-     *   @type string $id   Unique ID of article for Beacon API
-     *   @type string $url  URL of support doc article
-     *   @type string $type Type of Beacon element to open. {@see https://developer.helpscout.com/beacon-2/web/javascript-api/#beaconarticle}
-     * }
-     *
-     * @return string
-     */
-    function tooltip( $name, $css_class = '', $return = false, $article = array() ) {
+	protected $value;
+
+	function __construct( $name = '', $field = array(), $curr_value = NULL ) {
+
+		$this->name = $name;
+
+		$defaults = self::get_field_defaults();
+
+		// Backward compatibility
+		if( !empty( $field['choices'] ) ) {
+			$field['options'] = $field['choices'];
+			unset( $field['choices'] );
+		}
+
+		$this->field =  wp_parse_args( $field, $defaults );
+
+		$this->value = is_null( $curr_value ) ? $this->field['value'] : $curr_value;
+
+	}
+
+	/**
+	 * Returns the default details for a field option
+	 *
+	 * - default    // default option value, in case nothing is defined (@deprecated)
+	 * - desc       // option description
+	 * - value      // the option default value
+	 * - label      // the option label
+	 * - left_label // In case of checkboxes, left label will appear on the left of the checkbox
+	 * - id         // the field id
+	 * - type       // the option type ( text, checkbox, select, ... )
+	 * - options    // when type is select, define the select options ('choices' is @deprecated)
+	 * - merge_tags // if the option supports merge tags feature
+	 * - class      // (new) define extra classes for the field
+	 * - tooltip    //
+	 *
+	 * @return array
+	 */
+	public static function get_field_defaults() {
+		return array(
+			'desc' => '',
+			'value' => null,
+			'label' => '',
+			'left_label' => null,
+			'id' => null,
+			'type'  => 'text',
+			'options' => null,
+			'merge_tags' => true,
+			'class' => '',
+			'tooltip' => null,
+			'requires' => null
+		);
+	}
+
+
+	function get_tooltip() {
+		if( ! function_exists('gform_tooltip') ) {
+			return null;
+		}
+
+		$article = wp_parse_args( \GV\Utils::get( $this->field, 'article', array() ), array(
+			'id' => '',
+			'type' => 'modal',
+			'url' => '#',
+		) );
+
+		return !empty( $this->field['tooltip'] ) ? ' '. $this->tooltip( $this->field['tooltip'], false, true, $article ) : null;
+	}
+
+	/**
+	 * Displays the tooltip
+	 *
+	 * @since 2.8.1
+	 *
+	 * @global $__gf_tooltips
+	 *
+	 * @param string $name      The name of the tooltip to be displayed
+	 * @param string $css_class Optional. The CSS class to apply toi the element. Defaults to empty string.
+	 * @param bool   $return    Optional. If the tooltip should be returned instead of output. Defaults to false (output)
+	 * @param array  $article   Optional. Details about support doc article connected to the tooltip. {
+	 *   @type string $id   Unique ID of article for Beacon API
+	 *   @type string $url  URL of support doc article
+	 *   @type string $type Type of Beacon element to open. {@see https://developer.helpscout.com/beacon-2/web/javascript-api/#beaconarticle}
+	 * }
+	 *
+	 * @return string
+	 */
+	function tooltip( $name, $css_class = '', $return = false, $article = array() ) {
 		global $__gf_tooltips; //declared as global to improve WPML performance
 
 		$css_class = empty( $css_class ) ? 'tooltip' : $css_class;
@@ -128,17 +128,17 @@ 
 		$tooltip_class = isset( $__gf_tooltips[ $name ] ) ? "tooltip_{$name}" : '';
 		$tooltip_class = esc_attr( $tooltip_class );
 
-	    /**
-	     * Below this line has been modified by GravityView.
-	     */
+		/**
+		 * Below this line has been modified by GravityView.
+		 */
 
 		if ( empty( $tooltip_text ) && empty( $article['id'] ) ) {
 			return '';
 		}
 
 		$url = '#';
-	    $atts = 'onclick="return false;" onkeypress="return false;"';
-	    $anchor_text = '<i class=\'fa fa-question-circle\'></i>';
+		$atts = 'onclick="return false;" onkeypress="return false;"';
+		$anchor_text = '<i class=\'fa fa-question-circle\'></i>';
 		$css_class = gravityview_sanitize_html_class( 'gf_tooltip ' . $css_class . ' ' . $tooltip_class );
 
 		$tooltip = sprintf( '<a href="%s" %s class="%s" title="%s" role="button">%s</a>',
@@ -149,11 +149,11 @@ 
 			$anchor_text
 		);
 
-	    /**
-	     * Modify the tooltip HTML before outputting
-	     * @internal
-	     * @see GravityView_Support_Port::maybe_add_article_to_tooltip()
-	     */
+		/**
+		 * Modify the tooltip HTML before outputting
+		 * @internal
+		 * @see GravityView_Support_Port::maybe_add_article_to_tooltip()
+		 */
 		$tooltip = apply_filters( 'gravityview/tooltips/tooltip', $tooltip, $article, $url, $atts, $css_class, $tooltip_text, $anchor_text );
 
 		if ( ! $return ) {
@@ -163,84 +163,84 @@ 
 		return $tooltip;
 	}
 
-    /**
-     * Build input id based on the name
-     * @return string
-     */
-    function get_field_id() {
-        if( isset( $this->field['id'] ) ) {
-            return esc_attr( $this->field['id'] );
-        }
-        return esc_attr( sanitize_html_class( $this->name ) );
-    }
-
-    /**
-     * Retrieve field label
-     * @return string
-     */
-    function get_field_label() {
-        return esc_html( trim( $this->field['label'] ) );
-    }
+	/**
+	 * Build input id based on the name
+	 * @return string
+	 */
+	function get_field_id() {
+		if( isset( $this->field['id'] ) ) {
+			return esc_attr( $this->field['id'] );
+		}
+		return esc_attr( sanitize_html_class( $this->name ) );
+	}
+
+	/**
+	 * Retrieve field label
+	 * @return string
+	 */
+	function get_field_label() {
+		return esc_html( trim( $this->field['label'] ) );
+	}
 
 	/**
 	 * Retrieve field left label
-     *
-     * @since 1.7
-     *
+	 *
+	 * @since 1.7
+	 *
 	 * @return string
 	 */
 	function get_field_left_label() {
 		return ! empty( $this->field['left_label'] ) ? esc_html( trim( $this->field['left_label'] ) ) : NULL;
 	}
 
-    /**
-     * Retrieve field label class
-     * @return string
-     */
-    function get_label_class() {
-        return 'gv-label-'. sanitize_html_class( $this->field['type'] );
-    }
-
-
-    /**
-     * Retrieve field description
-     * @return string
-     */
-    function get_field_desc() {
-        return !empty( $this->field['desc'] ) ? '<span class="howto">'. $this->field['desc'] .'</span>' : '';
-    }
-
-
-    /**
-     * Verify if field should have merge tags
-     * @return boolean
-     */
-    function show_merge_tags() {
-        // Show the merge tags if the field is a list view
-        $is_list = preg_match( '/_list-/ism', $this->name );
-        // Or is a single entry view
-        $is_single = preg_match( '/single_/ism', $this->name );
-
-        return ( $is_single || $is_list );
-    }
-
-
-
-    /**
-     * important! Override this class
-     * outputs the field option html
-     */
-    function render_option() {
-        // to replace on each field
-    }
-
-    /**
-     * important! Override this class if needed
-     * outputs the field setting html
-     */
-    function render_setting( $override_input = NULL ) {
-
-        if( !empty( $this->field['full_width'] ) ) { ?>
+	/**
+	 * Retrieve field label class
+	 * @return string
+	 */
+	function get_label_class() {
+		return 'gv-label-'. sanitize_html_class( $this->field['type'] );
+	}
+
+
+	/**
+	 * Retrieve field description
+	 * @return string
+	 */
+	function get_field_desc() {
+		return !empty( $this->field['desc'] ) ? '<span class="howto">'. $this->field['desc'] .'</span>' : '';
+	}
+
+
+	/**
+	 * Verify if field should have merge tags
+	 * @return boolean
+	 */
+	function show_merge_tags() {
+		// Show the merge tags if the field is a list view
+		$is_list = preg_match( '/_list-/ism', $this->name );
+		// Or is a single entry view
+		$is_single = preg_match( '/single_/ism', $this->name );
+
+		return ( $is_single || $is_list );
+	}
+
+
+
+	/**
+	 * important! Override this class
+	 * outputs the field option html
+	 */
+	function render_option() {
+		// to replace on each field
+	}
+
+	/**
+	 * important! Override this class if needed
+	 * outputs the field setting html
+	 */
+	function render_setting( $override_input = NULL ) {
+
+		if( !empty( $this->field['full_width'] ) ) { ?>
             <th scope="row" colspan="2">
                 <div>
                     <label for="<?php echo $this->get_field_id(); ?>">
@@ -260,14 +260,14 @@ 
             </td>
         <?php }
 
-    }
+	}
 
-    /**
-     * important! Override this class
-     * outputs the input html part
-     */
-    function render_input( $override_input ) {
-        echo '';
-    }
+	/**
+	 * important! Override this class
+	 * outputs the input html part
+	 */
+	function render_input( $override_input ) {
+		echo '';
+	}
 
 }

includes/extensions/delete-entry/class-delete-entry.php

Indentation +1 added lines, -1 removed lines

@@ -532,7 +532,7 @@
 				 * @since 1.16.4
 				 * @param  int $entry_id ID of the Gravity Forms entry
 				 * @param  array $entry Deleted entry array
-				*/
+				 */
 				do_action( 'gravityview/delete-entry/deleted', $entry_id, $entry );
 			}
 

includes/extensions/entry-notes/class-gravityview-field-notes.php

Indentation +17 added lines, -17 removed lines

@@ -270,7 +270,7 @@ 
 	 *
 	 * Verify permissions. Check expected $_POST. Parse args, then send to process_delete_notes
 	 *
-  	 * @since 1.17
+	 * @since 1.17
 	 *
 	 * @see process_delete_notes
 	 *
@@ -423,7 +423,7 @@ 
 			'subject-label' => __( 'Subject', 'gravityview' ),
 			'subject' => __( 'Email subject', 'gravityview' ),
 			'default-email-subject' => __( 'New entry note', 'gravityview' ),
-            'email-footer' => __( 'This note was sent from {url}', 'gravityview' ),
+			'email-footer' => __( 'This note was sent from {url}', 'gravityview' ),
 			'also-email' => __( 'Also email this note to', 'gravityview' ),
 			'error-add-note' => __( 'There was an error adding the note.', 'gravityview' ),
 			'error-invalid' => __( 'The request was invalid. Refresh the page and try again.', 'gravityview' ),
@@ -493,11 +493,11 @@ 
 
 		if ( $context instanceof \GV\Template_Context ) {
 
-		    ob_start();
-		    $context->template->get_template_part( 'note', 'detail', true );
-            $note_detail_html = ob_get_clean();
+			ob_start();
+			$context->template->get_template_part( 'note', 'detail', true );
+			$note_detail_html = ob_get_clean();
 
-            ob_start();
+			ob_start();
 			$context->template->get_template_part( 'note', $note_row_template, true );
 			$note_row = ob_get_clean();
 		} else {
@@ -756,7 +756,7 @@ 
 				'gv-note-to-custom' => '',
 				'gv-note-subject' => '',
 				'gv-note-content' => '',
-                'current-url' => '',
+				'current-url' => '',
 			);
 
 			$current_user  = wp_get_current_user();
@@ -808,9 +808,9 @@ 
 			$message .= $this->get_email_footer( $email_footer, $is_html, $email_data );
 
 			/**
-             * @filter `gravityview/field/notes/wpautop_email` Should the message content have paragraphs added automatically, if using HTML message format
+			 * @filter `gravityview/field/notes/wpautop_email` Should the message content have paragraphs added automatically, if using HTML message format
 			 * @since 1.18
-             * @param bool $wpautop_email True: Apply wpautop() to the email message if using; False: Leave as entered (Default: true)
+			 * @param bool $wpautop_email True: Apply wpautop() to the email message if using; False: Leave as entered (Default: true)
 			 */
 			$wpautop_email = apply_filters( 'gravityview/field/notes/wpautop_email', true );
 
@@ -830,12 +830,12 @@ 
 	}
 
 	/**
-     * Get the footer for Entry Note emails
-     *
-     * `{url}` is replaced by the URL of the page where the note form was embedded
-     *
-     * @since 1.18
-     * @see GravityView_Field_Notes::strings The default value of $message_footer is set here, with the key 'email-footer'
+	 * Get the footer for Entry Note emails
+	 *
+	 * `{url}` is replaced by the URL of the page where the note form was embedded
+	 *
+	 * @since 1.18
+	 * @see GravityView_Field_Notes::strings The default value of $message_footer is set here, with the key 'email-footer'
 	 *
 	 * @param string $email_footer The message footer value
 	 * @param bool $is_html True: Email is being sent as HTML; False: sent as text
@@ -844,10 +844,10 @@ 
 	 */
 	private function get_email_footer( $email_footer = '', $is_html = true, $email_data = array() ) {
 
-	    $output = '';
+		$output = '';
 
 		if( ! empty( $email_footer ) ) {
-		    $url = \GV\Utils::get( $email_data, 'current-url' );
+			$url = \GV\Utils::get( $email_data, 'current-url' );
 			$url = html_entity_decode( $url );
 			$url = site_url( $url );
 

includes/class-gravityview-compatibility.php

Indentation +1 added lines, -1 removed lines

@@ -240,7 +240,7 @@
 			self::$notices['wp_version'] = array(
 				'class' => 'error',
 				'message' => sprintf( __( "%sGravityView requires WordPress %s or newer.%s \n\nYou're using Version %s. Please upgrade your WordPress installation.", 'gravityview' ), '<h3>', GV_MIN_WP_VERSION, "</h3>\n\n", '<span style="font-family: Consolas, Courier, monospace;">' . $wp_version . '</span>' ),
-			    'cap' => 'update_core',
+				'cap' => 'update_core',
 				'dismiss' => 'wp_version',
 			);
 

includes/admin/field-types/type_textarea.php

Indentation +14 added lines, -14 removed lines

@@ -28,13 +28,13 @@ 
 
 		$show_mt = $this->show_merge_tags();
 
-        if( $show_mt && $this->field['merge_tags'] !== false || $this->field['merge_tags'] === 'force' ) {
-            $class .= ' merge-tag-support mt-position-right ';
+		if( $show_mt && $this->field['merge_tags'] !== false || $this->field['merge_tags'] === 'force' ) {
+			$class .= ' merge-tag-support mt-position-right ';
 
-            if( empty( $this->field['show_all_fields'] ) ) {
-            	$class .= ' mt-hide_all_fields ';
-            }
-        }
+			if( empty( $this->field['show_all_fields'] ) ) {
+				$class .= ' mt-hide_all_fields ';
+			}
+		}
 
 		$class .= rgar( $this->field, 'class' );
 		$placeholder = rgar( $this->field, 'placeholder' );
@@ -55,20 +55,20 @@ 
 
 	function codemirror( $field_id = '' ) {
 
-        // Enqueue code editor and settings for manipulating HTML.
-        $settings = wp_enqueue_code_editor( array( 'type' => 'text/html' ) );
+		// Enqueue code editor and settings for manipulating HTML.
+		$settings = wp_enqueue_code_editor( array( 'type' => 'text/html' ) );
 
-        // Bail if user disabled CodeMirror.
-        if ( false === $settings ) {
-            return;
-        }
+		// Bail if user disabled CodeMirror.
+		if ( false === $settings ) {
+			return;
+		}
 
-        ?>
+		?>
 
         <script>
 	        wp.codeEditor.initialize( "<?php echo $field_id;?>", {});
         </script>
     <?php
-    }
+	}
 
 }

includes/extensions/edit-entry/class-edit-entry.php

Indentation +157 added lines, -157 removed lines

@@ -18,84 +18,84 @@ 
 
 class GravityView_Edit_Entry {
 
-    /**
-     * @var string
-     */
+	/**
+	 * @var string
+	 */
 	static $file;
 
 	static $instance;
 
-    /**
-     * Component instances.
-     * @var array
-     */
-    public $instances = array();
+	/**
+	 * Component instances.
+	 * @var array
+	 */
+	public $instances = array();
 
 
 	function __construct() {
 
-        self::$file = plugin_dir_path( __FILE__ );
+		self::$file = plugin_dir_path( __FILE__ );
 
-        if( is_admin() ) {
-            $this->load_components( 'admin' );
-        }
+		if( is_admin() ) {
+			$this->load_components( 'admin' );
+		}
 
 		$this->load_components( 'locking' );
 
-        $this->load_components( 'render' );
+		$this->load_components( 'render' );
 
-        // If GF User Registration Add-on exists
-        $this->load_components( 'user-registration' );
+		// If GF User Registration Add-on exists
+		$this->load_components( 'user-registration' );
 
-        $this->add_hooks();
+		$this->add_hooks();
 
 		// Process hooks for addons that may or may not be present
 		$this->addon_specific_hooks();
 	}
 
 
-    static function getInstance() {
+	static function getInstance() {
 
-        if( empty( self::$instance ) ) {
-            self::$instance = new GravityView_Edit_Entry;
-        }
+		if( empty( self::$instance ) ) {
+			self::$instance = new GravityView_Edit_Entry;
+		}
 
-        return self::$instance;
-    }
+		return self::$instance;
+	}
 
 
-    private function load_components( $component ) {
+	private function load_components( $component ) {
 
-        $dir = trailingslashit( self::$file );
+		$dir = trailingslashit( self::$file );
 
-        $filename  = $dir . 'class-edit-entry-' . $component . '.php';
-        $classname = 'GravityView_Edit_Entry_' . str_replace( ' ', '_', ucwords( str_replace( '-', ' ', $component ) ) );
+		$filename  = $dir . 'class-edit-entry-' . $component . '.php';
+		$classname = 'GravityView_Edit_Entry_' . str_replace( ' ', '_', ucwords( str_replace( '-', ' ', $component ) ) );
 
-        // Loads component and pass extension's instance so that component can
-        // talk each other.
-        require_once $filename;
-        $this->instances[ $component ] = new $classname( $this );
-        $this->instances[ $component ]->load();
+		// Loads component and pass extension's instance so that component can
+		// talk each other.
+		require_once $filename;
+		$this->instances[ $component ] = new $classname( $this );
+		$this->instances[ $component ]->load();
 
-    }
+	}
 
-    private function add_hooks() {
+	private function add_hooks() {
 
-        // Add front-end access to Gravity Forms delete file action
-        add_action( 'wp_ajax_nopriv_rg_delete_file', array( 'GFForms', 'delete_file') );
+		// Add front-end access to Gravity Forms delete file action
+		add_action( 'wp_ajax_nopriv_rg_delete_file', array( 'GFForms', 'delete_file') );
 
-        // Make sure this hook is run for non-admins
-        add_action( 'wp_ajax_rg_delete_file', array( 'GFForms', 'delete_file') );
+		// Make sure this hook is run for non-admins
+		add_action( 'wp_ajax_rg_delete_file', array( 'GFForms', 'delete_file') );
 
-        add_filter( 'gravityview_blacklist_field_types', array( $this, 'modify_field_blacklist' ), 10, 2 );
+		add_filter( 'gravityview_blacklist_field_types', array( $this, 'modify_field_blacklist' ), 10, 2 );
 
-        // add template path to check for field
-        add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) );
+		// add template path to check for field
+		add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) );
 
 		add_filter( 'gravityview/field/is_visible', array( $this, 'maybe_not_visible' ), 10, 3 );
 
 		add_filter( 'gravityview/api/reserved_query_args', array( $this, 'add_reserved_arg' ) );
-    }
+	}
 
 	/**
 	 * Adds "edit" to the list of internal reserved query args
@@ -166,74 +166,74 @@ 
 		return false;
 	}
 
-    /**
-     * Include this extension templates path
-     * @param array $file_paths List of template paths ordered
-     */
-    public function add_template_path( $file_paths ) {
-
-        // Index 100 is the default GravityView template path.
-        $file_paths[ 110 ] = self::$file;
-
-        return $file_paths;
-    }
-
-    /**
-     *
-     * Return a well formatted nonce key according to GravityView Edit Entry protocol
-     *
-     * @param $view_id int GravityView view id
-     * @param $form_id int Gravity Forms form id
-     * @param $entry_id int Gravity Forms entry id
-     * @return string
-     */
-    public static function get_nonce_key( $view_id, $form_id, $entry_id ) {
-        return sprintf( 'edit_%d_%d_%d', $view_id, $form_id, $entry_id );
-    }
-
-
-    /**
-     * The edit entry link creates a secure link with a nonce
-     *
-     * It also mimics the URL structure Gravity Forms expects to have so that
-     * it formats the display of the edit form like it does in the backend, like
-     * "You can edit this post from the post page" fields, for example.
-     *
-     * @param $entry array Gravity Forms entry object
-     * @param $view_id int GravityView view id
-     * @param $post_id int GravityView Post ID where View may be embedded {@since 1.9.2}
-     * @param string|array $field_values Parameters to pass in to the Edit Entry form to prefill data. Uses the same format as Gravity Forms "Allow field to be populated dynamically" {@since 1.9.2} {@see https://www.gravityhelp.com/documentation/article/allow-field-to-be-populated-dynamically/ }
-     * @return string
-     */
-    public static function get_edit_link( $entry, $view_id, $post_id = null, $field_values = '' ) {
-
-        $nonce_key = self::get_nonce_key( $view_id, $entry['form_id'], $entry['id']  );
-
-        $base = gv_entry_link( $entry, $post_id ? : $view_id  );
-
-        $url = add_query_arg( array(
-            'edit' => wp_create_nonce( $nonce_key )
-        ), $base );
-
-        if( $post_id ) {
-	        $url = add_query_arg( array( 'gvid' => $view_id ), $url );
-        }
-
-	    /**
-	     * Allow passing params to dynamically populate entry with values
-	     * @since 1.9.2
-	     */
-	    if( !empty( $field_values ) ) {
-
-		    if( is_array( $field_values ) ) {
-			    // If already an array, no parse_str() needed
-			    $params = $field_values;
-		    } else {
-			    parse_str( $field_values, $params );
-		    }
-
-		    $url = add_query_arg( $params, $url );
-	    }
+	/**
+	 * Include this extension templates path
+	 * @param array $file_paths List of template paths ordered
+	 */
+	public function add_template_path( $file_paths ) {
+
+		// Index 100 is the default GravityView template path.
+		$file_paths[ 110 ] = self::$file;
+
+		return $file_paths;
+	}
+
+	/**
+	 *
+	 * Return a well formatted nonce key according to GravityView Edit Entry protocol
+	 *
+	 * @param $view_id int GravityView view id
+	 * @param $form_id int Gravity Forms form id
+	 * @param $entry_id int Gravity Forms entry id
+	 * @return string
+	 */
+	public static function get_nonce_key( $view_id, $form_id, $entry_id ) {
+		return sprintf( 'edit_%d_%d_%d', $view_id, $form_id, $entry_id );
+	}
+
+
+	/**
+	 * The edit entry link creates a secure link with a nonce
+	 *
+	 * It also mimics the URL structure Gravity Forms expects to have so that
+	 * it formats the display of the edit form like it does in the backend, like
+	 * "You can edit this post from the post page" fields, for example.
+	 *
+	 * @param $entry array Gravity Forms entry object
+	 * @param $view_id int GravityView view id
+	 * @param $post_id int GravityView Post ID where View may be embedded {@since 1.9.2}
+	 * @param string|array $field_values Parameters to pass in to the Edit Entry form to prefill data. Uses the same format as Gravity Forms "Allow field to be populated dynamically" {@since 1.9.2} {@see https://www.gravityhelp.com/documentation/article/allow-field-to-be-populated-dynamically/ }
+	 * @return string
+	 */
+	public static function get_edit_link( $entry, $view_id, $post_id = null, $field_values = '' ) {
+
+		$nonce_key = self::get_nonce_key( $view_id, $entry['form_id'], $entry['id']  );
+
+		$base = gv_entry_link( $entry, $post_id ? : $view_id  );
+
+		$url = add_query_arg( array(
+			'edit' => wp_create_nonce( $nonce_key )
+		), $base );
+
+		if( $post_id ) {
+			$url = add_query_arg( array( 'gvid' => $view_id ), $url );
+		}
+
+		/**
+		 * Allow passing params to dynamically populate entry with values
+		 * @since 1.9.2
+		 */
+		if( !empty( $field_values ) ) {
+
+			if( is_array( $field_values ) ) {
+				// If already an array, no parse_str() needed
+				$params = $field_values;
+			} else {
+				parse_str( $field_values, $params );
+			}
+
+			$url = add_query_arg( $params, $url );
+		}
 
 		/**
 		 * @filter `gravityview/edit/link` Filter the edit URL link.
@@ -242,7 +242,7 @@ 
 		 * @param \GV\View $view The View.
 		 */
 		return apply_filters( 'gravityview/edit/link', $url, $entry, \GV\View::by_id( $view_id  ) );
-    }
+	}
 
 	/**
 	 * Edit mode doesn't allow certain field types.
@@ -297,19 +297,19 @@ 
 	}
 
 
-    /**
-     * checks if user has permissions to edit a specific entry
-     *
-     * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_entry for maximum security!!
-     *
-     * @param  array $entry Gravity Forms entry array
-     * @param \GV\View|int $view ID of the view you want to check visibility against {@since 1.9.2}. Required since 2.0
-     * @return bool
-     */
-    public static function check_user_cap_edit_entry( $entry, $view = 0 ) {
+	/**
+	 * checks if user has permissions to edit a specific entry
+	 *
+	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_entry for maximum security!!
+	 *
+	 * @param  array $entry Gravity Forms entry array
+	 * @param \GV\View|int $view ID of the view you want to check visibility against {@since 1.9.2}. Required since 2.0
+	 * @return bool
+	 */
+	public static function check_user_cap_edit_entry( $entry, $view = 0 ) {
 
-        // No permission by default
-        $user_can_edit = false;
+		// No permission by default
+		$user_can_edit = false;
 
 		// get user_edit setting
 		if ( empty( $view ) ) {
@@ -327,60 +327,60 @@ 
 			$user_edit = GVCommon::get_template_setting( $view_id, 'user_edit' );
 		}
 
-        // If they can edit any entries (as defined in Gravity Forms)
-        // Or if they can edit other people's entries
-        // Then we're good.
-        if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ), $entry['id'] ) ) {
+		// If they can edit any entries (as defined in Gravity Forms)
+		// Or if they can edit other people's entries
+		// Then we're good.
+		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ), $entry['id'] ) ) {
 
-            gravityview()->log->debug( 'User has ability to edit all entries.' );
+			gravityview()->log->debug( 'User has ability to edit all entries.' );
 
-            $user_can_edit = true;
+			$user_can_edit = true;
 
-        } else if( !isset( $entry['created_by'] ) ) {
+		} else if( !isset( $entry['created_by'] ) ) {
 
-            gravityview()->log->error( 'Entry `created_by` doesn\'t exist.');
+			gravityview()->log->error( 'Entry `created_by` doesn\'t exist.');
 
-            $user_can_edit = false;
+			$user_can_edit = false;
 
-        } else {
+		} else {
 
-            $current_user = wp_get_current_user();
+			$current_user = wp_get_current_user();
 
-            // User edit is disabled
-            if( empty( $user_edit ) ) {
+			// User edit is disabled
+			if( empty( $user_edit ) ) {
 
-                gravityview()->log->debug( 'User Edit is disabled. Returning false.' );
+				gravityview()->log->debug( 'User Edit is disabled. Returning false.' );
 
-                $user_can_edit = false;
-            }
+				$user_can_edit = false;
+			}
 
-            // User edit is enabled and the logged-in user is the same as the user who created the entry. We're good.
-            else if( is_user_logged_in() && intval( $current_user->ID ) === intval( $entry['created_by'] ) ) {
+			// User edit is enabled and the logged-in user is the same as the user who created the entry. We're good.
+			else if( is_user_logged_in() && intval( $current_user->ID ) === intval( $entry['created_by'] ) ) {
 
-                gravityview()->log->debug( 'User {user_id} created the entry.', array( 'user_id', $current_user->ID ) );
+				gravityview()->log->debug( 'User {user_id} created the entry.', array( 'user_id', $current_user->ID ) );
 
-                $user_can_edit = true;
+				$user_can_edit = true;
 
-            } else if( ! is_user_logged_in() ) {
+			} else if( ! is_user_logged_in() ) {
 
-                gravityview()->log->debug( 'No user defined; edit entry requires logged in user' );
+				gravityview()->log->debug( 'No user defined; edit entry requires logged in user' );
 
-	            $user_can_edit = false; // Here just for clarity
-            }
+				$user_can_edit = false; // Here just for clarity
+			}
 
-        }
+		}
 
-        /**
-         * @filter `gravityview/edit_entry/user_can_edit_entry` Modify whether user can edit an entry.
-         * @since 1.15 Added `$entry` and `$view_id` parameters
-         * @param[in,out] boolean $user_can_edit Can the current user edit the current entry? (Default: false)
-         * @param[in] array $entry Gravity Forms entry array {@since 1.15}
-         * @param[in] int $view_id ID of the view you want to check visibility against {@since 1.15}
-         */
-        $user_can_edit = apply_filters( 'gravityview/edit_entry/user_can_edit_entry', $user_can_edit, $entry, $view_id );
+		/**
+		 * @filter `gravityview/edit_entry/user_can_edit_entry` Modify whether user can edit an entry.
+		 * @since 1.15 Added `$entry` and `$view_id` parameters
+		 * @param[in,out] boolean $user_can_edit Can the current user edit the current entry? (Default: false)
+		 * @param[in] array $entry Gravity Forms entry array {@since 1.15}
+		 * @param[in] int $view_id ID of the view you want to check visibility against {@since 1.15}
+		 */
+		$user_can_edit = apply_filters( 'gravityview/edit_entry/user_can_edit_entry', $user_can_edit, $entry, $view_id );
 
-        return (bool) $user_can_edit;
-    }
+		return (bool) $user_can_edit;
+	}
 
 
 

includes/extensions/edit-entry/class-edit-entry-user-registration.php

Indentation +262 added lines, -262 removed lines

@@ -11,7 +11,7 @@ 
  */
 
 if ( ! defined( 'WPINC' ) ) {
-    die;
+	die;
 }
 
 /**
@@ -22,109 +22,109 @@ 
 	/**
 	 * @var GravityView_Edit_Entry $loader
 	 */
-    protected $loader;
+	protected $loader;
 
-    /**
-     * @var WP_User|null Temporary storage used by restore_user_details()
-     */
-    private $_user_before_update = null;
+	/**
+	 * @var WP_User|null Temporary storage used by restore_user_details()
+	 */
+	private $_user_before_update = null;
 
-    function __construct( GravityView_Edit_Entry $loader ) {
-        $this->loader = $loader;
-    }
+	function __construct( GravityView_Edit_Entry $loader ) {
+		$this->loader = $loader;
+	}
 
 	/**
 	 * @since 1.11
 	 */
 	public function load() {
 		add_action( 'wp', array( $this, 'add_hooks' ), 10 );
-    }
+	}
 
 	/**
 	 * Add hooks to trigger updating the user
 	 *
 	 * @since 1.18
 	 */
-    public function add_hooks() {
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated?
-	     * @since 1.11
-	     * @param boolean $boolean Whether to trigger update on user registration (default: true)
-	     */
-	    if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) {
-
-	    	add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 );
-
-		    // last resort in case the current user display name don't match any of the defaults
-		    add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 );
-	    }
-    }
-
-    /**
-     * Update the WordPress user profile based on the GF User Registration create feed
-     *
-     * @since 1.11
-     *
-     * @param array $form Gravity Forms form array
-     * @param string $entry_id Gravity Forms entry ID
-     * @return void
-     */
-    public function update_user( $form = array(), $entry_id = 0 ) {
-
-        if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) {
-	        gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' );
-	        return;
-        } elseif( empty( $entry_id ) ) {
-        	gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) );
-	        return;
-        }
-
-        $gf_user_registration = GF_User_Registration::get_instance();
-
-        $entry = GFAPI::get_entry( $entry_id );
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on
-	     * @since 1.11
-	     * @param array $entry Gravity Forms entry
-	     * @param array $form Gravity Forms form
-	     */
-        $entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form );
-
-	    $config = $this->get_feed_configuration( $entry, $form );
-
-        // Make sure the feed is active
-	    if ( ! \GV\Utils::get( $config, 'is_active', false ) ) {
+	public function add_hooks() {
+
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated?
+		 * @since 1.11
+		 * @param boolean $boolean Whether to trigger update on user registration (default: true)
+		 */
+		if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) {
+
+			add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 );
+
+			// last resort in case the current user display name don't match any of the defaults
+			add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 );
+		}
+	}
+
+	/**
+	 * Update the WordPress user profile based on the GF User Registration create feed
+	 *
+	 * @since 1.11
+	 *
+	 * @param array $form Gravity Forms form array
+	 * @param string $entry_id Gravity Forms entry ID
+	 * @return void
+	 */
+	public function update_user( $form = array(), $entry_id = 0 ) {
+
+		if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) {
+			gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' );
 			return;
-	    }
+		} elseif( empty( $entry_id ) ) {
+			gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) );
+			return;
+		}
+
+		$gf_user_registration = GF_User_Registration::get_instance();
+
+		$entry = GFAPI::get_entry( $entry_id );
 
-	    // If an Update feed, make sure the conditions are met.
-	    if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) {
-	    	if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) {
-			    return;
-		    }
-	    }
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on
+		 * @since 1.11
+		 * @param array $entry Gravity Forms entry
+		 * @param array $form Gravity Forms form
+		 */
+		$entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form );
 
-	    // Do not update user if the user hasn't been registered (happens when manual activation is enabled in User Registration feed)
-	    $username = \GV\Utils::get( $config, 'meta/username', null );
-	    if ( ! isset( $entry[ $username ] ) || ! get_user_by( 'login', $entry[ $username ] ) ) {
-		    return;
-	    }
+		$config = $this->get_feed_configuration( $entry, $form );
+
+		// Make sure the feed is active
+		if ( ! \GV\Utils::get( $config, 'is_active', false ) ) {
+			return;
+		}
+
+		// If an Update feed, make sure the conditions are met.
+		if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) {
+			if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) {
+				return;
+			}
+		}
+
+		// Do not update user if the user hasn't been registered (happens when manual activation is enabled in User Registration feed)
+		$username = \GV\Utils::get( $config, 'meta/username', null );
+		if ( ! isset( $entry[ $username ] ) || ! get_user_by( 'login', $entry[ $username ] ) ) {
+			return;
+		}
 
-        // The priority is set to 3 so that default priority (10) will still override it
-        add_filter( 'send_password_change_email', '__return_false', 3 );
-        add_filter( 'send_email_change_email', '__return_false', 3 );
+		// The priority is set to 3 so that default priority (10) will still override it
+		add_filter( 'send_password_change_email', '__return_false', 3 );
+		add_filter( 'send_email_change_email', '__return_false', 3 );
 
-        // Trigger the User Registration update user method
-        $gf_user_registration->update_user( $entry, $form, $config );
+		// Trigger the User Registration update user method
+		$gf_user_registration->update_user( $entry, $form, $config );
 
-        remove_filter( 'send_password_change_email', '__return_false', 3 );
-        remove_filter( 'send_email_change_email', '__return_false', 3 );
+		remove_filter( 'send_password_change_email', '__return_false', 3 );
+		remove_filter( 'send_email_change_email', '__return_false', 3 );
 
-        // Prevent double-triggering by removing the hook
-	    remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 );
-    }
+		// Prevent double-triggering by removing the hook
+		remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 );
+	}
 
 	/**
 	 * Get the User Registration feed configuration for the entry & form
@@ -139,184 +139,184 @@ 
 	 *
 	 * @return array
 	 */
-    public function get_feed_configuration( $entry, $form ) {
-
-	    $gf_user_registration = GF_User_Registration::get_instance();
-
-	    $config = $gf_user_registration->get_single_submission_feed( $entry, $form );
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed
-	     * @since 1.15
-	     * @param[in,out] boolean $preserve_role Preserve current user role Default: true
-	     * @param[in] array $config Gravity Forms User Registration feed configuration for the form
-	     * @param[in] array $form Gravity Forms form array
-	     * @param[in] array $entry Gravity Forms entry being edited
-	     */
-	    $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry );
-
-	    if( $preserve_role ) {
-		    $config['meta']['role'] = 'gfur_preserve_role';
-	    }
-
-	    $displayname = $this->match_current_display_name( $entry['created_by'] );
-
-	    /**
-	     * Make sure the current display name is not changed with the update user method.
-	     * @since 1.15
-	     */
-	    $config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname'];
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration
-	     * @since 1.14
-	     * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form
-	     * @param[in] array $form Gravity Forms form array
-	     * @param[in] array $entry Gravity Forms entry being edited
-	     */
-	    $config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry );
-
-	    return $config;
-    }
-
-    /**
-     * Calculate the user display name format
-     *
-     * @since 1.15
-     * @since 1.20 Returns false if user not found at $user_id
-     *
-     * @param int $user_id WP User ID
-     * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found.
-     */
-    public function match_current_display_name( $user_id ) {
-
-        $user = get_userdata( $user_id );
-
-        if( ! $user ) {
-        	return false;
-        }
-
-        $names = $this->generate_display_names( $user );
-
-        $format = array_search( $user->display_name, $names, true );
-
-        /**
-         * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook
-         * @see restore_display_name
-         */
-        if( false === $format ) {
-            $this->_user_before_update = $user;
-        }
-
-        return $format;
-    }
-
-    /**
-     * Generate an array of all the user display names possibilities
-     *
-     * @since 1.15
-     *
-     * @param object $profileuser WP_User object
-     * @return array List all the possible display names for a certain User object
-     */
-    public function generate_display_names( $profileuser ) {
-
-        $public_display = array();
-        $public_display['nickname']  = $profileuser->nickname;
-        $public_display['username']  = $profileuser->user_login;
-
-        if ( !empty($profileuser->first_name) ) {
-	        $public_display['firstname'] = $profileuser->first_name;
-        }
-
-        if ( !empty($profileuser->last_name) ) {
-	        $public_display['lastname'] = $profileuser->last_name;
-        }
-
-        if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) {
-            $public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name;
-            $public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name;
-        }
-
-        $public_display = array_map( 'trim', $public_display );
-        $public_display = array_unique( $public_display );
-
-        return $public_display;
-    }
-
-
-    /**
-     * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon
-     *
-     * @see GFUser::update_user()
-     * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon
-     * @param array $config Gravity Forms User Registration Addon form feed configuration
-     * @param array $entry The Gravity Forms entry that was just updated
-     * @param string $password User password
-     * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process
-     */
-    public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) {
-
-        /**
-         * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry.
-         * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed
-         * @since 1.14.4
-         * @param boolean $restore_display_name Restore Display Name? Default: true
-         */
-        $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true );
-
-        $is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' );
-
-        /**
-         * Don't restore display name:
-         *   - either disabled,
-         *   - or it is an Update feed (we only care about Create feed)
-         *   - or we don't need as we found the correct format before updating user.
-         * @since 1.14.4
-         */
-        if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) {
-            return null;
-        }
-
-        $user_after_update = get_userdata( $user_id );
-
-        // User not found
-	    if ( ! $user_after_update ) {
-	    	gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) );
-		    return false;
-	    }
-
-        $restored_user = $user_after_update;
-
-	    // Restore previous display_name
-        $restored_user->display_name = $this->_user_before_update->display_name;
-
-	    // Don't have WP update the password.
-	    unset( $restored_user->data->user_pass, $restored_user->user_pass );
-
-        /**
-         * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView
-         * @since 1.14
-         * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user()
-         * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration
-         * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration
-         * @param array   $entry The Gravity Forms entry that was just updated
-         */
-        $restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry );
-
-        $updated = wp_update_user( $restored_user );
-
-        if( is_wp_error( $updated ) ) {
-            gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) );
-        } else {
-            gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) );
-        }
-
-        $this->_user_before_update = null;
-
-        unset( $restored_user, $user_after_update );
-
-        return $updated;
-    }
+	public function get_feed_configuration( $entry, $form ) {
+
+		$gf_user_registration = GF_User_Registration::get_instance();
+
+		$config = $gf_user_registration->get_single_submission_feed( $entry, $form );
+
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed
+		 * @since 1.15
+		 * @param[in,out] boolean $preserve_role Preserve current user role Default: true
+		 * @param[in] array $config Gravity Forms User Registration feed configuration for the form
+		 * @param[in] array $form Gravity Forms form array
+		 * @param[in] array $entry Gravity Forms entry being edited
+		 */
+		$preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry );
+
+		if( $preserve_role ) {
+			$config['meta']['role'] = 'gfur_preserve_role';
+		}
+
+		$displayname = $this->match_current_display_name( $entry['created_by'] );
+
+		/**
+		 * Make sure the current display name is not changed with the update user method.
+		 * @since 1.15
+		 */
+		$config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname'];
+
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration
+		 * @since 1.14
+		 * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form
+		 * @param[in] array $form Gravity Forms form array
+		 * @param[in] array $entry Gravity Forms entry being edited
+		 */
+		$config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry );
+
+		return $config;
+	}
+
+	/**
+	 * Calculate the user display name format
+	 *
+	 * @since 1.15
+	 * @since 1.20 Returns false if user not found at $user_id
+	 *
+	 * @param int $user_id WP User ID
+	 * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found.
+	 */
+	public function match_current_display_name( $user_id ) {
+
+		$user = get_userdata( $user_id );
+
+		if( ! $user ) {
+			return false;
+		}
+
+		$names = $this->generate_display_names( $user );
+
+		$format = array_search( $user->display_name, $names, true );
+
+		/**
+		 * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook
+		 * @see restore_display_name
+		 */
+		if( false === $format ) {
+			$this->_user_before_update = $user;
+		}
+
+		return $format;
+	}
+
+	/**
+	 * Generate an array of all the user display names possibilities
+	 *
+	 * @since 1.15
+	 *
+	 * @param object $profileuser WP_User object
+	 * @return array List all the possible display names for a certain User object
+	 */
+	public function generate_display_names( $profileuser ) {
+
+		$public_display = array();
+		$public_display['nickname']  = $profileuser->nickname;
+		$public_display['username']  = $profileuser->user_login;
+
+		if ( !empty($profileuser->first_name) ) {
+			$public_display['firstname'] = $profileuser->first_name;
+		}
+
+		if ( !empty($profileuser->last_name) ) {
+			$public_display['lastname'] = $profileuser->last_name;
+		}
+
+		if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) {
+			$public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name;
+			$public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name;
+		}
+
+		$public_display = array_map( 'trim', $public_display );
+		$public_display = array_unique( $public_display );
+
+		return $public_display;
+	}
+
+
+	/**
+	 * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon
+	 *
+	 * @see GFUser::update_user()
+	 * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon
+	 * @param array $config Gravity Forms User Registration Addon form feed configuration
+	 * @param array $entry The Gravity Forms entry that was just updated
+	 * @param string $password User password
+	 * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process
+	 */
+	public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) {
+
+		/**
+		 * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry.
+		 * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed
+		 * @since 1.14.4
+		 * @param boolean $restore_display_name Restore Display Name? Default: true
+		 */
+		$restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true );
+
+		$is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' );
+
+		/**
+		 * Don't restore display name:
+		 *   - either disabled,
+		 *   - or it is an Update feed (we only care about Create feed)
+		 *   - or we don't need as we found the correct format before updating user.
+		 * @since 1.14.4
+		 */
+		if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) {
+			return null;
+		}
+
+		$user_after_update = get_userdata( $user_id );
+
+		// User not found
+		if ( ! $user_after_update ) {
+			gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) );
+			return false;
+		}
+
+		$restored_user = $user_after_update;
+
+		// Restore previous display_name
+		$restored_user->display_name = $this->_user_before_update->display_name;
+
+		// Don't have WP update the password.
+		unset( $restored_user->data->user_pass, $restored_user->user_pass );
+
+		/**
+		 * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView
+		 * @since 1.14
+		 * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user()
+		 * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration
+		 * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration
+		 * @param array   $entry The Gravity Forms entry that was just updated
+		 */
+		$restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry );
+
+		$updated = wp_update_user( $restored_user );
+
+		if( is_wp_error( $updated ) ) {
+			gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) );
+		} else {
+			gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) );
+		}
+
+		$this->_user_before_update = null;
+
+		unset( $restored_user, $user_after_update );
+
+		return $updated;
+	}
 
 } //end class

includes/admin/class.render.settings.php

Indentation +1 added lines, -1 removed lines

@@ -284,7 +284,7 @@
 					<div class="gv-field-detail gv-field-detail--field">
 						<span class="gv-field-detail--label">' . esc_html__( 'Field ID', 'gravityview' ) .'</span><span class="gv-field-detail--value">#{{field_id}}</span>
 					</div>';
-			    }
+				}
 
 				$item_details .= '
 					<div class="gv-field-detail gv-field-detail--type">

includes/class-admin-views.php

Indentation +73 added lines, -73 removed lines

@@ -46,7 +46,7 @@ 
 		// Enqueue code editor and settings for manipulating HTML.
 		add_action('admin_enqueue_scripts', function() {
 
-		    $settings = wp_enqueue_code_editor( array( 'type' => 'text/html' ) );
+			$settings = wp_enqueue_code_editor( array( 'type' => 'text/html' ) );
 		});
 
 		// @todo check if this hook is needed..
@@ -68,28 +68,28 @@ 
 	}
 
 	/**
-     * When on the Add/Edit View screen, suggest most popular articles related to that
-     *
+	 * When on the Add/Edit View screen, suggest most popular articles related to that
+	 *
 	 * @param array $localization_data Data to be passed to the Support Port JS
 	 *
 	 * @return array
 	 */
 	function suggest_support_articles( $localization_data = array() ) {
 
-	    if( ! gravityview()->request->is_view() ) {
-	        return $localization_data;
-        }
+		if( ! gravityview()->request->is_view() ) {
+			return $localization_data;
+		}
 
 		$localization_data['suggest'] = array(
-            '57ef23539033602e61d4a560',
-            '54c67bb9e4b0512429885513',
-            '54c67bb9e4b0512429885512',
-            '54c67bbbe4b07997ea3f3f6b',
-            '54d1a33ae4b086c0c0964ce9',
-            '57ef253c9033602e61d4a563',
-            '552355bfe4b0221aadf2572b',
-            '54c67bcde4b051242988553e',
-        );
+			'57ef23539033602e61d4a560',
+			'54c67bb9e4b0512429885513',
+			'54c67bb9e4b0512429885512',
+			'54c67bbbe4b07997ea3f3f6b',
+			'54d1a33ae4b086c0c0964ce9',
+			'57ef253c9033602e61d4a563',
+			'552355bfe4b0221aadf2572b',
+			'54c67bcde4b051242988553e',
+		);
 
 		return $localization_data;
 	}
@@ -235,11 +235,11 @@ 
 
 		if( 'form_list' === GFForms::get_page() ) {
 			$priority = 790;
-        }
+		}
 
 		if( empty( $connected_views ) ) {
 
-		    $menu_items['gravityview'] = array(
+			$menu_items['gravityview'] = array(
 				'label'          => esc_attr__( 'Create a View', 'gravityview' ),
 				'icon'           => '<i class="fa fa-lg gv-icon-astronaut-head gv-icon"></i>', // Only appears in GF pre-2.5
 				'title'          => esc_attr__( 'Create a View using this form as a data source', 'gravityview' ),
@@ -271,13 +271,13 @@ 
 		// If there were no items added, then let's create the parent menu
 		if( $sub_menu_items ) {
 
-		    $sub_menu_items[] = array(
-			    'label' => esc_attr__( 'Create a View', 'gravityview' ),
-			    'icon' => '<span class="dashicons dashicons-plus"></span>',
-			    'title' => esc_attr__( 'Create a View using this form as a data source', 'gravityview' ),
-			    'url'   => admin_url( 'post-new.php?post_type=gravityview&form_id=' . $id ),
-			    'capabilities'   => array( 'edit_gravityviews' ),
-            );
+			$sub_menu_items[] = array(
+				'label' => esc_attr__( 'Create a View', 'gravityview' ),
+				'icon' => '<span class="dashicons dashicons-plus"></span>',
+				'title' => esc_attr__( 'Create a View using this form as a data source', 'gravityview' ),
+				'url'   => admin_url( 'post-new.php?post_type=gravityview&form_id=' . $id ),
+				'capabilities'   => array( 'edit_gravityviews' ),
+			);
 
 			// Make sure Gravity Forms uses the submenu; if there's only one item, it uses a link instead of a dropdown
 			$sub_menu_items[] = array(
@@ -659,16 +659,16 @@ 
 	/**
 	 * Render html for displaying available fields based on a Form ID
 	 *
-     * @see GravityView_Ajax::get_available_fields_html() Triggers `gravityview_render_available_fields` action
+	 * @see GravityView_Ajax::get_available_fields_html() Triggers `gravityview_render_available_fields` action
 	 *
 	 * @param int $form Gravity Forms Form ID (default: '')
 	 * @param string $context (default: 'single')
-     *
+	 *
 	 * @return void
 	 */
 	function render_available_fields( $form = 0, $context = 'single' ) {
 
-	    // Determine if form is a preset and convert it to an array with fields
+		// Determine if form is a preset and convert it to an array with fields
 		$form = ( is_string( $form ) && preg_match( '/^preset_/', $form ) ) ? GravityView_Ajax::pre_get_form_fields( $form ) : $form;
 
 		/**
@@ -680,7 +680,7 @@ 
 
 		if ( ! is_array( $blacklist_field_types ) ) {
 
-		    gravityview()->log->error( '$blacklist_field_types is not an array', array( 'data' => print_r( $blacklist_field_types, true ) ) );
+			gravityview()->log->error( '$blacklist_field_types is not an array', array( 'data' => print_r( $blacklist_field_types, true ) ) );
 
 			$blacklist_field_types = array();
 		}
@@ -936,9 +936,9 @@ 
 
 				$joined_forms = gravityview_get_joined_forms( $post->ID );
 
-                foreach ( $joined_forms as $form ) {
-                    $available_items[ $form->ID ] = $this->get_available_fields( $form->ID, $zone );
-                }
+				foreach ( $joined_forms as $form ) {
+					$available_items[ $form->ID ] = $this->get_available_fields( $form->ID, $zone );
+				}
 			} else {
 				$available_items[ $form ] = \GV\Widget::registered();
 			}
@@ -977,9 +977,9 @@ 
 
 										if ( $form_id ) {
 											$original_item = isset( $available_items[ $form_id ] [ $field['id'] ] ) ? $available_items[ $form_id ] [ $field['id'] ] : false ;
-                                        } else {
+										} else {
 											$original_item = isset( $available_items[ $field['id'] ] ) ? $available_items[ $field['id'] ] : false ;
-                                        }
+										}
 
 										if ( !$original_item ) {
 											gravityview()->log->error( 'An item was not available when rendering the output; maybe it was added by a plugin that is now de-activated.', array(' data' => array('available_items' => $available_items, 'field' => $field ) ) );
@@ -1229,7 +1229,7 @@ 
 		}
 
 		// Add the GV font (with the Astronaut)
-        wp_enqueue_style( 'gravityview_global', plugins_url('assets/css/admin-global.css', GRAVITYVIEW_FILE), array(), \GV\Plugin::$version );
+		wp_enqueue_style( 'gravityview_global', plugins_url('assets/css/admin-global.css', GRAVITYVIEW_FILE), array(), \GV\Plugin::$version );
 		wp_register_style( 'gravityview_views_styles', plugins_url( 'assets/css/admin-views.css', GRAVITYVIEW_FILE ), array( 'dashicons', 'wp-jquery-ui-dialog' ), \GV\Plugin::$version );
 
 		wp_register_script( 'gravityview-jquery-cookie', plugins_url('assets/lib/jquery.cookie/jquery.cookie.min.js', GRAVITYVIEW_FILE), array( 'jquery' ), \GV\Plugin::$version, true );
@@ -1237,43 +1237,43 @@ 
 		if( GFForms::get_page() === 'form_list' ) {
 			wp_enqueue_style( 'gravityview_views_styles' );
 			return;
-        }
+		}
 
 		// Don't process any scripts below here if it's not a GravityView page.
 		if( ! gravityview()->request->is_admin( $hook, 'single' ) && ! $is_widgets_page ) {
-		    return;
+			return;
 		}
 
-        wp_enqueue_script( 'jquery-ui-datepicker' );
-        wp_enqueue_style( 'gravityview_views_datepicker', plugins_url('assets/css/admin-datepicker.css', GRAVITYVIEW_FILE), \GV\Plugin::$version );
-
-        // Enqueue scripts
-        wp_enqueue_script( 'gravityview_views_scripts', plugins_url( 'assets/js/admin-views' . $script_debug . '.js', GRAVITYVIEW_FILE ), array( 'jquery-ui-tabs', 'jquery-ui-draggable', 'jquery-ui-droppable', 'jquery-ui-sortable', 'jquery-ui-tooltip', 'jquery-ui-dialog', 'gravityview-jquery-cookie', 'jquery-ui-datepicker', 'underscore' ), \GV\Plugin::$version );
-
-        wp_localize_script('gravityview_views_scripts', 'gvGlobals', array(
-            'cookiepath' => COOKIEPATH,
-            'admin_cookiepath' => ADMIN_COOKIE_PATH,
-            'passed_form_id' => (bool) \GV\Utils::_GET( 'form_id' ),
-            'nonce' => wp_create_nonce( 'gravityview_ajaxviews' ),
-            'label_viewname' => __( 'Enter View name here', 'gravityview' ),
-            'label_reorder_search_fields' => __( 'Reorder Search Fields', 'gravityview' ),
-            'label_add_search_field' => __( 'Add Search Field', 'gravityview' ),
-            'label_remove_search_field' => __( 'Remove Search Field', 'gravityview' ),
-            'label_close' => __( 'Close', 'gravityview' ),
-            'label_cancel' => __( 'Cancel', 'gravityview' ),
-            'label_continue' => __( 'Continue', 'gravityview' ),
-            'label_ok' => __( 'Ok', 'gravityview' ),
-            'label_publisherror' => __( 'Error while creating the View for you. Check the settings or contact GravityView support.', 'gravityview' ),
-            'loading_text' => esc_html__( 'Loading&hellip;', 'gravityview' ),
-            'loading_error' => esc_html__( 'There was an error loading dynamic content.', 'gravityview' ),
-            'field_loaderror' => __( 'Error while adding the field. Please try again or contact GravityView support.', 'gravityview' ),
-            'remove_all_fields' => __( 'Would you like to remove all fields in this zone?', 'gravityview' ),
-        ));
+		wp_enqueue_script( 'jquery-ui-datepicker' );
+		wp_enqueue_style( 'gravityview_views_datepicker', plugins_url('assets/css/admin-datepicker.css', GRAVITYVIEW_FILE), \GV\Plugin::$version );
+
+		// Enqueue scripts
+		wp_enqueue_script( 'gravityview_views_scripts', plugins_url( 'assets/js/admin-views' . $script_debug . '.js', GRAVITYVIEW_FILE ), array( 'jquery-ui-tabs', 'jquery-ui-draggable', 'jquery-ui-droppable', 'jquery-ui-sortable', 'jquery-ui-tooltip', 'jquery-ui-dialog', 'gravityview-jquery-cookie', 'jquery-ui-datepicker', 'underscore' ), \GV\Plugin::$version );
+
+		wp_localize_script('gravityview_views_scripts', 'gvGlobals', array(
+			'cookiepath' => COOKIEPATH,
+			'admin_cookiepath' => ADMIN_COOKIE_PATH,
+			'passed_form_id' => (bool) \GV\Utils::_GET( 'form_id' ),
+			'nonce' => wp_create_nonce( 'gravityview_ajaxviews' ),
+			'label_viewname' => __( 'Enter View name here', 'gravityview' ),
+			'label_reorder_search_fields' => __( 'Reorder Search Fields', 'gravityview' ),
+			'label_add_search_field' => __( 'Add Search Field', 'gravityview' ),
+			'label_remove_search_field' => __( 'Remove Search Field', 'gravityview' ),
+			'label_close' => __( 'Close', 'gravityview' ),
+			'label_cancel' => __( 'Cancel', 'gravityview' ),
+			'label_continue' => __( 'Continue', 'gravityview' ),
+			'label_ok' => __( 'Ok', 'gravityview' ),
+			'label_publisherror' => __( 'Error while creating the View for you. Check the settings or contact GravityView support.', 'gravityview' ),
+			'loading_text' => esc_html__( 'Loading&hellip;', 'gravityview' ),
+			'loading_error' => esc_html__( 'There was an error loading dynamic content.', 'gravityview' ),
+			'field_loaderror' => __( 'Error while adding the field. Please try again or contact GravityView support.', 'gravityview' ),
+			'remove_all_fields' => __( 'Would you like to remove all fields in this zone?', 'gravityview' ),
+		));
 
 		wp_enqueue_style( 'gravityview_views_styles' );
 
-        // Enqueue scripts needed for merge tags
-        self::enqueue_gravity_forms_scripts();
+		// Enqueue scripts needed for merge tags
+		self::enqueue_gravity_forms_scripts();
 
 		// 2.5 changed how Merge Tags are enqueued
 		if ( is_callable( array( 'GFCommon', 'output_hooks_javascript') ) ) {
@@ -1283,24 +1283,24 @@ 
 
 	/**
 	 * Enqueue Gravity Forms scripts, needed for Merge Tags
-     *
-     * @since 1.0.5-beta
-     *
-     * @return void
+	 *
+	 * @since 1.0.5-beta
+	 *
+	 * @return void
 	 */
 	static function enqueue_gravity_forms_scripts() {
 		GFForms::register_scripts();
 
 		$scripts = array(
-		    'sack',
-		    'gform_gravityforms',
-		    'gform_forms',
-		    'gform_form_admin',
-		    'jquery-ui-autocomplete'
+			'sack',
+			'gform_gravityforms',
+			'gform_forms',
+			'gform_form_admin',
+			'jquery-ui-autocomplete'
 		);
 
 		if ( wp_is_mobile() ) {
-		    $scripts[] = 'jquery-touch-punch';
+			$scripts[] = 'jquery-touch-punch';
 		}
 
 		wp_enqueue_script( $scripts );