GravityView_Edit_Entry

Complexity

Total Complexity

27

Size/Duplication

Total Lines	288
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	2
A	getInstance()	0	8	2
A	load_components()	0	14	1
A	add_hooks()	0	14	1
A	addon_specific_hooks()	0	7	3
A	add_template_path()	0	7	1
A	get_nonce_key()	0	3	1
B	get_edit_link()	0	30	3
A	modify_field_blacklist()	0	10	3
A	get_field_blacklist()	0	22	1
C	check_user_cap_edit_entry()	0	66	9

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 19 and the first side effect is on line 15.

/**
 * The GravityView Edit Entry Extension
 *
 * Easily edit entries in GravityView.
 *
 * @package   GravityView
 * @license   GPL2+
 * @author    Katz Web Services, Inc.
 * @link      http://gravityview.co
 * @copyright Copyright 2014, Katz Web Services, Inc.
 */

if ( ! defined( 'WPINC' ) ) {
	die;
}


class GravityView_Edit_Entry {

    /**
     * @var string
     */
	static $file;

The visibility should be declared for property $file.

	static $instance;

The visibility should be declared for property $instance.

    /**
     * Component instances.
     * @var array
     */
    public $instances = array();


	function __construct() {

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

        self::$file = plugin_dir_path( __FILE__ );

        if( is_admin() ) {
            $this->load_components( 'admin' );
        }

Functions must not contain multiple empty lines in a row; found 2 empty lines

        $this->load_components( 'render' );

        // If GF User Registration Add-on exists
        $this->load_components( 'user-registration' );

        $this->add_hooks();

		// Process hooks for addons that may or may not be present
		$this->addon_specific_hooks();
	}


    static function getInstance() {

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

The function name getInstance is in camel caps, but expected get_instance instead as per the coding standard.

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

        return self::$instance;
    }


    private function load_components( $component ) {

        $dir = trailingslashit( self::$file );

        $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();

    }

    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') );

No space before closing parenthesis of array is bad style

        // Make sure this hook is run for non-admins
        add_action( 'wp_ajax_rg_delete_file', array( 'RGForms', 'delete_file') );

No space before closing parenthesis of array is bad style

        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' ) );

    }

	/**
	 * Trigger hooks that are normally run in the admin for Addons, but need to be triggered manually because we're not in the admin
	 * @return void
	 */
	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'));

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

No space before closing parenthesis of array is bad style

		}

	}

    /**
     * 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;

Array keys should NOT be surrounded by spaces if they only contain a string or an integer.

        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']  );

Expected 1 spaces before closing bracket; 2 found

        $base = gv_entry_link( $entry, $post_id );

        $url = add_query_arg( array(
            'page' => 'gf_entries', // Needed for GFForms::get_page()

40% of this comment could be valid code. Did you maybe forget this after debugging?

            'view' => 'entry', // Needed for GFForms::get_page()

40% of this comment could be valid code. Did you maybe forget this after debugging?

            'edit' => wp_create_nonce( $nonce_key )
        ), $base );

	    /**
	     * Allow passing params to dynamically populate entry with values
	     * @since 1.9.2
	     */
	    if( !empty( $field_values ) ) {

Expected 1 space after "!"; 0 found

		    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;
    }

	/**
	 * Edit mode doesn't allow certain field types.
	 * @param  array $fields  Existing blacklist fields
	 * @param  string|null $context Context
	 * @return array          If not edit context, original field blacklist. Otherwise, blacklist including post fields.
	 */
	public function modify_field_blacklist( $fields = array(), $context = NULL ) {

TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.

		if( empty( $context ) || $context !== 'edit' ) {

Found "!== '". Use Yoda Condition checks, you must

			return $fields;
		}

		$add_fields = $this->get_field_blacklist();

		return array_merge( $fields, $add_fields );
	}

	/**
	 * Returns array of field types that should not be displayed in Edit Entry
	 *
	 * @since 1.20
	 *
	 * @param array $entry Gravity Forms entry array
	 *
	 * @return array Blacklist of field types
	 */
	function get_field_blacklist( $entry = array() ) {

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

		$fields = array(
			'page',
			'payment_status',
			'payment_date',
			'payment_amount',
			'is_fulfilled',
			'transaction_id',
			'transaction_type',
		);

		/**
		 * @filter `gravityview/edit_entry/field_blacklist` Array of fields that should not be displayed in Edit Entry
		 * @since 1.20
		 * @param array $fields Blacklist field type array
		 * @param array $entry Gravity Forms entry array
		 */
		$fields = apply_filters( 'gravityview/edit_entry/field_blacklist', $fields, $entry );

		return $fields;
	}


    /**
     * 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;

        // 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.');

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            $user_can_edit = true;

        } else if( !isset( $entry['created_by'] ) ) {

Expected 1 space after "!"; 0 found

            do_action('gravityview_log_error', 'GravityView_Edit_Entry[check_user_cap_edit_entry] Entry `created_by` doesn\'t exist.');

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            $user_can_edit = false;

        } 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');

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            } 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();

            // 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.' );

Expected 1 spaces after opening bracket; 0 found

                $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'] ) ) {

                do_action('gravityview_log_debug', sprintf( 'GravityView_Edit_Entry[check_user_cap_edit_entry] User %s created the entry.', $current_user->ID ) );

Expected 1 spaces after opening bracket; 0 found

                $user_can_edit = true;

            } else if( ! is_user_logged_in() ) {

                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 );

        return (bool)$user_can_edit;

No space after closing casting parenthesis is prohibited

    }



} // end class

//add_action( 'plugins_loaded', array('GravityView_Edit_Entry', 'getInstance'), 6 );

69% of this comment could be valid code. Did you maybe forget this after debugging?

GravityView_Edit_Entry::getInstance();