gravityview / GravityView

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

Indentation +243 added lines, -243 removed lines

@@ -11,7 +11,7 @@ 
  */
 
 if ( ! defined( 'WPINC' ) ) {
-    die;
+	die;
 }
 
 /**
@@ -22,255 +22,255 @@ 
 	/**
 	 * @var GravityView_Edit_Entry
 	 */
-    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() {
 
-        /**
-	     * @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( 'GFUser' ) || empty( $entry_id ) ) {
-            return;
-        }
-
-        // support for GF User Registration 3.x
-        $gf_user_3 =  class_exists('GF_User_Registration') ? true : false;
-
-        if( $gf_user_3 ) {
-            $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 );
-
-        /**
-         * @since 1.14
-         */
-        if( $gf_user_3 ) {
-            $config = $gf_user_registration->get_single_submission_feed( $entry, $form );
-        } else {
-            $config = GFUser::get_active_config( $form, $entry );
-        }
-
-        /**
-         * @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';
-        }
-
-        /**
-         * Make sure the current display name is not changed with the update user method.
-         * @since 1.15
-         */
-        $config['meta']['displayname'] = $this->match_current_display_name( $entry['created_by'] );
-
-
-        /**
-         * @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 );
-
-
-        $feed_pos = $gf_user_3 ? 'meta/feedType' : 'meta/feed_type';
-        $is_create_feed = ( $config && rgars( $config, $feed_pos ) === 'create' );
-
-        // Only update if it's a create feed
-        if( ! $is_create_feed ) {
-            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 );
-
-        // Trigger the User Registration update user method
-        if( $gf_user_3 ) {
-            $gf_user_registration->update_user( $entry, $form, $config );
-        } else {
-            GFUser::update_user( $entry, $form, $config );
-        }
-
-
-        remove_filter( 'send_password_change_email', '__return_false', 3 );
-        remove_filter( 'send_email_change_email', '__return_false', 3 );
-
-    }
-
-    /**
-     * Calculate the user display name format
-     *
-     * @since 1.15
-     *
-     * @param int $user_id WP User ID
-     * @return string Display name format as used inside Gravity Forms User Registration
-     */
-    public function match_current_display_name( $user_id ) {
-
-        $user = get_userdata( $user_id );
-
-        $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, or it is the 'nickname' format (which Gravity Forms doesn't support)
-        //   trigger last resort method at the 'gform_user_updated' hook
-        if( false === $format || 'nickname' === $format ) {
-            $this->_user_before_update = $user;
-            $format = 'nickname';
-        }
-
-        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 void
-     */
-    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 && rgars( $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;
-        }
-
-        $user_after_update = get_userdata( $user_id );
-
-        $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 ) ) {
-            do_action('gravityview_log_error', __METHOD__ . sprintf( ' - There was an error updating user #%d details', $user_id ), $updated );
-        } else {
-            do_action('gravityview_log_debug', __METHOD__ . sprintf( ' - User #%d details restored', $user_id ) );
-        }
-
-        $this->_user_before_update = null;
-
-        unset( $updated, $restored_user, $user_after_update );
-    }
+		/**
+		 * @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( 'GFUser' ) || empty( $entry_id ) ) {
+			return;
+		}
+
+		// support for GF User Registration 3.x
+		$gf_user_3 =  class_exists('GF_User_Registration') ? true : false;
+
+		if( $gf_user_3 ) {
+			$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 );
+
+		/**
+		 * @since 1.14
+		 */
+		if( $gf_user_3 ) {
+			$config = $gf_user_registration->get_single_submission_feed( $entry, $form );
+		} else {
+			$config = GFUser::get_active_config( $form, $entry );
+		}
+
+		/**
+		 * @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';
+		}
+
+		/**
+		 * Make sure the current display name is not changed with the update user method.
+		 * @since 1.15
+		 */
+		$config['meta']['displayname'] = $this->match_current_display_name( $entry['created_by'] );
+
+
+		/**
+		 * @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 );
+
+
+		$feed_pos = $gf_user_3 ? 'meta/feedType' : 'meta/feed_type';
+		$is_create_feed = ( $config && rgars( $config, $feed_pos ) === 'create' );
+
+		// Only update if it's a create feed
+		if( ! $is_create_feed ) {
+			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 );
+
+		// Trigger the User Registration update user method
+		if( $gf_user_3 ) {
+			$gf_user_registration->update_user( $entry, $form, $config );
+		} else {
+			GFUser::update_user( $entry, $form, $config );
+		}
+
+
+		remove_filter( 'send_password_change_email', '__return_false', 3 );
+		remove_filter( 'send_email_change_email', '__return_false', 3 );
+
+	}
+
+	/**
+	 * Calculate the user display name format
+	 *
+	 * @since 1.15
+	 *
+	 * @param int $user_id WP User ID
+	 * @return string Display name format as used inside Gravity Forms User Registration
+	 */
+	public function match_current_display_name( $user_id ) {
+
+		$user = get_userdata( $user_id );
+
+		$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, or it is the 'nickname' format (which Gravity Forms doesn't support)
+		//   trigger last resort method at the 'gform_user_updated' hook
+		if( false === $format || 'nickname' === $format ) {
+			$this->_user_before_update = $user;
+			$format = 'nickname';
+		}
+
+		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 void
+	 */
+	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 && rgars( $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;
+		}
+
+		$user_after_update = get_userdata( $user_id );
+
+		$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 ) ) {
+			do_action('gravityview_log_error', __METHOD__ . sprintf( ' - There was an error updating user #%d details', $user_id ), $updated );
+		} else {
+			do_action('gravityview_log_debug', __METHOD__ . sprintf( ' - User #%d details restored', $user_id ) );
+		}
+
+		$this->_user_before_update = null;
+
+		unset( $updated, $restored_user, $user_after_update );
+	}
 
 } //end class

Spacing +26 added lines, -26 removed lines

@@ -43,8 +43,8 @@ 
 	     * @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 );
+        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 );
@@ -62,14 +62,14 @@ 
      */
     public function update_user( $form = array(), $entry_id = 0 ) {
 
-        if( !class_exists( 'GFAPI' ) || !class_exists( 'GFUser' ) || empty( $entry_id ) ) {
+        if ( ! class_exists( 'GFAPI' ) || ! class_exists( 'GFUser' ) || empty( $entry_id ) ) {
             return;
         }
 
         // support for GF User Registration 3.x
-        $gf_user_3 =  class_exists('GF_User_Registration') ? true : false;
+        $gf_user_3 = class_exists( 'GF_User_Registration' ) ? true : false;
 
-        if( $gf_user_3 ) {
+        if ( $gf_user_3 ) {
             $gf_user_registration = GF_User_Registration::get_instance();
         }
 
@@ -86,7 +86,7 @@ 
         /**
          * @since 1.14
          */
-        if( $gf_user_3 ) {
+        if ( $gf_user_3 ) {
             $config = $gf_user_registration->get_single_submission_feed( $entry, $form );
         } else {
             $config = GFUser::get_active_config( $form, $entry );
@@ -102,15 +102,15 @@ 
          */
         $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry );
 
-        if( $preserve_role ) {
-            $config['meta']['role'] = 'gfur_preserve_role';
+        if ( $preserve_role ) {
+            $config[ 'meta' ][ 'role' ] = 'gfur_preserve_role';
         }
 
         /**
          * Make sure the current display name is not changed with the update user method.
          * @since 1.15
          */
-        $config['meta']['displayname'] = $this->match_current_display_name( $entry['created_by'] );
+        $config[ 'meta' ][ 'displayname' ] = $this->match_current_display_name( $entry[ 'created_by' ] );
 
 
         /**
@@ -127,7 +127,7 @@ 
         $is_create_feed = ( $config && rgars( $config, $feed_pos ) === 'create' );
 
         // Only update if it's a create feed
-        if( ! $is_create_feed ) {
+        if ( ! $is_create_feed ) {
             return;
         }
 
@@ -136,7 +136,7 @@ 
         add_filter( 'send_email_change_email', '__return_false', 3 );
 
         // Trigger the User Registration update user method
-        if( $gf_user_3 ) {
+        if ( $gf_user_3 ) {
             $gf_user_registration->update_user( $entry, $form, $config );
         } else {
             GFUser::update_user( $entry, $form, $config );
@@ -166,7 +166,7 @@ 
 
         // In case we can't find the current display name format, or it is the 'nickname' format (which Gravity Forms doesn't support)
         //   trigger last resort method at the 'gform_user_updated' hook
-        if( false === $format || 'nickname' === $format ) {
+        if ( false === $format || 'nickname' === $format ) {
             $this->_user_before_update = $user;
             $format = 'nickname';
         }
@@ -186,18 +186,18 @@ 
     public function generate_display_names( $profileuser ) {
 
         $public_display = array();
-        $public_display['nickname']  = $profileuser->nickname;
-        $public_display['username']  = $profileuser->user_login;
+        $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->first_name ) )
+            $public_display[ 'firstname' ] = $profileuser->first_name;
 
-        if ( !empty($profileuser->last_name) )
-            $public_display['lastname'] = $profileuser->last_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;
+        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 );
@@ -227,7 +227,7 @@ 
          */
         $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true );
 
-        $is_update_feed = ( $config && rgars( $config, 'meta/feed_type') === 'update' );
+        $is_update_feed = ( $config && rgars( $config, 'meta/feed_type' ) === 'update' );
 
         /**
          * Don't restore display name:
@@ -236,7 +236,7 @@ 
          *   - 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 ) ) {
+        if ( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) {
             return;
         }
 
@@ -262,10 +262,10 @@ 
 
         $updated = wp_update_user( $restored_user );
 
-        if( is_wp_error( $updated ) ) {
-            do_action('gravityview_log_error', __METHOD__ . sprintf( ' - There was an error updating user #%d details', $user_id ), $updated );
+        if ( is_wp_error( $updated ) ) {
+            do_action( 'gravityview_log_error', __METHOD__ . sprintf( ' - There was an error updating user #%d details', $user_id ), $updated );
         } else {
-            do_action('gravityview_log_debug', __METHOD__ . sprintf( ' - User #%d details restored', $user_id ) );
+            do_action( 'gravityview_log_debug', __METHOD__ . sprintf( ' - User #%d details restored', $user_id ) );
         }
 
         $this->_user_before_update = null;

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

Indentation +164 added lines, -164 removed lines

@@ -18,80 +18,80 @@ 
 
 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( '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( 'RGForms', 'delete_file') );
+		// Add front-end access to Gravity Forms delete file action
+		add_action( 'wp_ajax_nopriv_rg_delete_file', array( 'RGForms', 'delete_file') );
 
-        // Make sure this hook is run for non-admins
-        add_action( 'wp_ajax_rg_delete_file', array( 'RGForms', 'delete_file') );
+		// Make sure this hook is run for non-admins
+		add_action( 'wp_ajax_rg_delete_file', array( 'RGForms', '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' ) );
 
-    }
+	}
 
 	/**
 	 * Trigger hooks that are normally run in the admin for Addons, but need to be triggered manually because we're not in the admin
@@ -105,75 +105,75 @@ 
 
 	}
 
-    /**
-     * 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 );
-
-        $url = add_query_arg( array(
-            'page' => 'gf_entries', // Needed for GFForms::get_page()
-            'view' => 'entry', // Needed for GFForms::get_page()
-            'edit' => wp_create_nonce( $nonce_key )
-        ), $base );
-
-	    /**
-	     * 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 );
-	    }
-
-        return $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 );
+
+		$url = add_query_arg( array(
+			'page' => 'gf_entries', // Needed for GFForms::get_page()
+			'view' => 'entry', // Needed for GFForms::get_page()
+			'edit' => wp_create_nonce( $nonce_key )
+		), $base );
+
+		/**
+		 * 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 );
+		}
+
+		return $url;
+	}
 
 
 	/**
@@ -209,81 +209,81 @@ 
 	}
 
 
-    /**
-     * 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 int $view_id ID of the view you want to check visibility against {@since 1.9.2}
-     * @return bool
-     */
-    public static function check_user_cap_edit_entry( $entry, $view_id = 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 int $view_id ID of the view you want to check visibility against {@since 1.9.2}
+	 * @return bool
+	 */
+	public static function check_user_cap_edit_entry( $entry, $view_id = 0 ) {
 
-        // No permission by default
-        $user_can_edit = false;
+		// No permission by default
+		$user_can_edit = false;
 
-        // 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'] ) ) {
 
-            do_action('gravityview_log_debug', __METHOD__ . ' - User has ability to edit all entries.');
+			do_action('gravityview_log_debug', __METHOD__ . ' - 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'] ) ) {
 
-            do_action('gravityview_log_error', 'GravityView_Edit_Entry[check_user_cap_edit_entry] Entry `created_by` doesn\'t exist.');
+			do_action('gravityview_log_error', 'GravityView_Edit_Entry[check_user_cap_edit_entry] Entry `created_by` doesn\'t exist.');
 
-            $user_can_edit = false;
+			$user_can_edit = false;
 
-        } else {
+		} else {
 
-            // get user_edit setting
-            if( empty( $view_id ) || $view_id == GravityView_View::getInstance()->getViewId() ) {
-                // if View ID not specified or is the current view
-                $user_edit = GravityView_View::getInstance()->getAtts('user_edit');
-            } else {
-                // in case is specified and not the current view
-                $user_edit = GVCommon::get_template_setting( $view_id, 'user_edit' );
-            }
+			// get user_edit setting
+			if( empty( $view_id ) || $view_id == GravityView_View::getInstance()->getViewId() ) {
+				// if View ID not specified or is the current view
+				$user_edit = GravityView_View::getInstance()->getAtts('user_edit');
+			} else {
+				// in case is specified and not the current view
+				$user_edit = GVCommon::get_template_setting( $view_id, 'user_edit' );
+			}
 
-            $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 ) ) {
 
-                do_action('gravityview_log_debug', 'GravityView_Edit_Entry[check_user_cap_edit_entry] User Edit is disabled. Returning false.' );
+				do_action('gravityview_log_debug', 'GravityView_Edit_Entry[check_user_cap_edit_entry] 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'] ) ) {
 
-                do_action('gravityview_log_debug', sprintf( 'GravityView_Edit_Entry[check_user_cap_edit_entry] User %s created the entry.', $current_user->ID ) );
+				do_action('gravityview_log_debug', sprintf( 'GravityView_Edit_Entry[check_user_cap_edit_entry] User %s created the entry.', $current_user->ID ) );
 
-                $user_can_edit = true;
+				$user_can_edit = true;
 
-            } else if( ! is_user_logged_in() ) {
+			} else if( ! is_user_logged_in() ) {
 
-                do_action( 'gravityview_log_debug', __METHOD__ . ' No user defined; edit entry requires logged in user' );
-            }
+				do_action( 'gravityview_log_debug', __METHOD__ . ' No user defined; edit entry requires logged in user' );
+			}
 
-        }
+		}
 
-        /**
-         * @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;
+	}
 
 
 

Spacing +21 added lines, -21 removed lines

@@ -36,7 +36,7 @@ 
 
         self::$file = plugin_dir_path( __FILE__ );
 
-        if( is_admin() ) {
+        if ( is_admin() ) {
             $this->load_components( 'admin' );
         }
 
@@ -55,7 +55,7 @@ 
 
     static function getInstance() {
 
-        if( empty( self::$instance ) ) {
+        if ( empty( self::$instance ) ) {
             self::$instance = new GravityView_Edit_Entry;
         }
 
@@ -81,10 +81,10 @@ 
     private function add_hooks() {
 
         // Add front-end access to Gravity Forms delete file action
-        add_action( 'wp_ajax_nopriv_rg_delete_file', array( 'RGForms', 'delete_file') );
+        add_action( 'wp_ajax_nopriv_rg_delete_file', array( 'RGForms', 'delete_file' ) );
 
         // Make sure this hook is run for non-admins
-        add_action( 'wp_ajax_rg_delete_file', array( 'RGForms', 'delete_file') );
+        add_action( 'wp_ajax_rg_delete_file', array( 'RGForms', 'delete_file' ) );
 
         add_filter( 'gravityview_blacklist_field_types', array( $this, 'modify_field_blacklist' ), 10, 2 );
 
@@ -99,8 +99,8 @@ 
 	 */
 	private function addon_specific_hooks() {
 
-		if( class_exists( 'GFSignature' ) && is_callable( array( 'GFSignature', 'get_instance' ) ) ) {
-			add_filter('gform_admin_pre_render', array( GFSignature::get_instance(), 'edit_lead_script'));
+		if ( class_exists( 'GFSignature' ) && is_callable( array( 'GFSignature', 'get_instance' ) ) ) {
+			add_filter( 'gform_admin_pre_render', array( GFSignature::get_instance(), 'edit_lead_script' ) );
 		}
 
 	}
@@ -146,7 +146,7 @@ 
      */
     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']  );
+        $nonce_key = self::get_nonce_key( $view_id, $entry[ 'form_id' ], $entry[ 'id' ] );
 
         $base = gv_entry_link( $entry, $post_id );
 
@@ -160,9 +160,9 @@ 
 	     * Allow passing params to dynamically populate entry with values
 	     * @since 1.9.2
 	     */
-	    if( !empty( $field_values ) ) {
+	    if ( ! empty( $field_values ) ) {
 
-		    if( is_array( $field_values ) ) {
+		    if ( is_array( $field_values ) ) {
 			    // If already an array, no parse_str() needed
 			    $params = $field_values;
 		    } else {
@@ -184,7 +184,7 @@ 
 	 */
 	public function modify_field_blacklist( $fields = array(), $context = NULL ) {
 
-		if( empty( $context ) || $context !== 'edit' ) {
+		if ( empty( $context ) || $context !== 'edit' ) {
 			return $fields;
 		}
 
@@ -226,24 +226,24 @@ 
         // 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 ( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ), $entry[ 'id' ] ) ) {
 
-            do_action('gravityview_log_debug', __METHOD__ . ' - User has ability to edit all entries.');
+            do_action( 'gravityview_log_debug', __METHOD__ . ' - User has ability to edit all entries.' );
 
             $user_can_edit = true;
 
-        } else if( !isset( $entry['created_by'] ) ) {
+        } else if ( ! isset( $entry[ 'created_by' ] ) ) {
 
-            do_action('gravityview_log_error', 'GravityView_Edit_Entry[check_user_cap_edit_entry] Entry `created_by` doesn\'t exist.');
+            do_action( 'gravityview_log_error', 'GravityView_Edit_Entry[check_user_cap_edit_entry] Entry `created_by` doesn\'t exist.' );
 
             $user_can_edit = false;
 
         } else {
 
             // get user_edit setting
-            if( empty( $view_id ) || $view_id == GravityView_View::getInstance()->getViewId() ) {
+            if ( empty( $view_id ) || $view_id == GravityView_View::getInstance()->getViewId() ) {
                 // if View ID not specified or is the current view
-                $user_edit = GravityView_View::getInstance()->getAtts('user_edit');
+                $user_edit = GravityView_View::getInstance()->getAtts( 'user_edit' );
             } else {
                 // in case is specified and not the current view
                 $user_edit = GVCommon::get_template_setting( $view_id, 'user_edit' );
@@ -252,21 +252,21 @@ 
             $current_user = wp_get_current_user();
 
             // User edit is disabled
-            if( empty( $user_edit ) ) {
+            if ( empty( $user_edit ) ) {
 
-                do_action('gravityview_log_debug', 'GravityView_Edit_Entry[check_user_cap_edit_entry] User Edit is disabled. Returning false.' );
+                do_action( 'gravityview_log_debug', 'GravityView_Edit_Entry[check_user_cap_edit_entry] User Edit is disabled. Returning 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'] ) ) {
+            else if ( is_user_logged_in() && intval( $current_user->ID ) === intval( $entry[ 'created_by' ] ) ) {
 
-                do_action('gravityview_log_debug', sprintf( 'GravityView_Edit_Entry[check_user_cap_edit_entry] User %s created the entry.', $current_user->ID ) );
+                do_action( 'gravityview_log_debug', sprintf( 'GravityView_Edit_Entry[check_user_cap_edit_entry] User %s created the entry.', $current_user->ID ) );
 
                 $user_can_edit = true;
 
-            } else if( ! is_user_logged_in() ) {
+            } else if ( ! is_user_logged_in() ) {
 
                 do_action( 'gravityview_log_debug', __METHOD__ . ' No user defined; edit entry requires logged in user' );
             }