GravityView_Change_Entry_Creator::add_select() - Code Metrics - Inspection of "Add back in helpful logging" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 3f9285...c35b1f )

by Zack

created 2017-05-18 19:03 UTC

GravityView_Change_Entry_Creator::add_select() C

↳ Parent: GravityView_Change_Entry_Creator

Complexity

Conditions	7
Paths	13

Size

Total Lines	43
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
cc	7
eloc	23
nc	13
nop	2
dl	0
loc	43
ccs	0
cts	24
cp	0
crap	56
rs	6.7272
c	0
b	0
f	0

<?php


/**
 * @since 1.2
 */
class GravityView_Change_Entry_Creator {

    function __construct() {


    	/**
    	 * @since  1.5.1
    	 */
    	add_action('gform_user_registered', array( $this, 'assign_new_user_to_lead'), 10, 4 );


    	// ONLY ADMIN FROM HERE ON.
    	if( !is_admin() ) { return; }


	    /**
         * @filter `gravityview_disable_change_entry_creator` Disable the Change Entry Creator functionality
	     * @since 1.7.4
	     * @param boolean $disable Disable the Change Entry Creator functionality. Default: false.
	     */
	    if( apply_filters('gravityview_disable_change_entry_creator', false ) ) {

		    return;
	    }

        /**
         * Use `init` to fix bbPress warning
         * @see https://bbpress.trac.wordpress.org/ticket/2309
         */
    	add_action('init', array( $this, 'load'), 100 );


    	add_action('plugins_loaded', array( $this, 'prevent_conflicts') );


    }

    /**
     * When an user is created using the User Registration add-on, assign the entry to them
     *
     * @since  1.5.1
     * @uses RGFormsModel::update_lead_property() Modify the entry `created_by` field
     * @param  int $user_id  WordPress User ID
     * @param  array $config   User registration feed configuration
     * @param  array  $entry     GF Entry array
     * @param  string $password User password
     * @return void
     */
    function assign_new_user_to_lead( $user_id, $config, $entry = array(), $password = '' ) {


    	/**
    	 * Disable assigning the new user to the entry by returning false.
    	 * @param  int $user_id  WordPress User ID
	     * @param  array $config   User registration feed configuration
	     * @param  array  $entry     GF Entry array
    	 */
    	$assign_to_lead = apply_filters( 'gravityview_assign_new_user_to_entry', true, $user_id, $config, $entry );

    	// If filter returns false, do not process
    	if( empty( $assign_to_lead ) ) {
    		return;
    	}

    	// Update the entry. The `false` prevents checking Akismet; `true` disables the user updated hook from firing
    	$result = RGFormsModel::update_lead_property( $entry['id'], 'created_by', $user_id, false, true );

    	if( empty( $result ) ) {
    		$status = __('Error', 'gravityview');

    	} else {
    		$status = __('Success', 'gravityview');

    	}

    	$note = sprintf( _x('%s: Assigned User ID #%d as the entry creator.', 'First parameter: Success or error of the action. Second: User ID number', 'gravityview'), $status, $user_id );


    	do_action( 'gravityview_log_debug', 'GravityView_Change_Entry_Creator[assign_new_user_to_lead] - '.$note );

	    /**
	     * @filter `gravityview_disable_change_entry_creator_note` Disable adding a note when changing the entry creator
	     * @since 1.21.5
	     * @param boolean $disable Disable the Change Entry Creator note. Default: false.
	     */
	    if( apply_filters('gravityview_disable_change_entry_creator_note', false ) ) {

		    return;
	    }

        GravityView_Entry_Notes::add_note( $entry['id'], -1, 'GravityView', $note, 'gravityview' );

    }

    /**
     * Disable previous functionality; use this one as the canonical.
     * @return void
     */
    function prevent_conflicts() {


    	// Plugin that was provided here:
    	// @link https://gravityview.co/support/documentation/201991205/
    	remove_action("gform_entry_info", 'gravityview_change_entry_creator_form', 10 );
<?php

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

print $doubleQuoted;
    	remove_action("gform_after_update_entry", 'gravityview_update_entry_creator', 10 );
<?php

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

print $doubleQuoted;

    	// Disable for Gravity Forms Add-ons 3.6.2 and lower
    	if( class_exists( 'KWS_GF_Change_Lead_Creator' ) ) {

    		$Old_Lead_Creator = new KWS_GF_Change_Lead_Creator;

    		// Now, no validation is required in the methods; let's hook in.
    		remove_action('admin_init', array( $Old_Lead_Creator, 'set_screen_mode' ) );


    		remove_action("gform_entry_info", array( $Old_Lead_Creator, 'add_select' ), 10 );
<?php

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

print $doubleQuoted;

    		remove_action("gform_after_update_entry", array( $Old_Lead_Creator, 'update_entry_creator' ), 10 );
<?php

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

print $doubleQuoted;
    	}

    }

    /**
     * @since  3.6.3
     * @return void
     */
    function load() {


    	// Does GF exist?
        if( !class_exists('GFCommon') ) {

            return;
        }

        // Can the user edit entries?
        if( ! GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_entries' ) ) ) {
            return;
        }

        // If screen mode isn't set, then we're in the wrong place.
        if( empty( $_REQUEST['screen_mode'] ) ) {

            return;
        }

        // Now, no validation is required in the methods; let's hook in.
        add_action('admin_init', array( &$this, 'set_screen_mode' ) );


        add_action("gform_entry_info", array( &$this, 'add_select' ), 10, 2);
<?php

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

print $doubleQuoted;

        add_action("gform_after_update_entry", array( &$this, 'update_entry_creator' ), 10, 2);
<?php

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

print $doubleQuoted;

    }

    /**
     * Allows for edit links to work with a link instead of a form (GET instead of POST)
     * @return void
     */
    function set_screen_mode() {


    	// If $_GET['screen_mode'] is set to edit, set $_POST value
        if( rgget('screen_mode') === 'edit' ) {

            $_POST["screen_mode"] = 'edit';
<?php

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

print $doubleQuoted;
        }

    }

    /**
     * When the entry creator is changed, add a note to the entry
     * @param  array $form   GF entry array
     * @param  int $entry_id Entry ID
     * @return void
     */
    function update_entry_creator($form, $entry_id) {

            global $current_user;
function myFunction($a, $b) {
    // Do something
}

        // Update the entry
        $created_by = absint( rgpost('created_by') );


        RGFormsModel::update_lead_property( $entry_id, 'created_by', $created_by );

        // If the creator has changed, let's add a note about who it used to be.
        $originally_created_by = rgpost('originally_created_by');


        // If there's no owner and there didn't used to be, keep going
        if( empty( $originally_created_by ) && empty( $created_by ) ) {
            return;
        }

        // If the values have changed
        if( absint( $originally_created_by ) !== absint( $created_by ) ) {

            $user_data = get_userdata($current_user->ID);


            $user_format = _x('%s (ID #%d)', 'The name and the ID of users who initiated changes to entry ownership', 'gravityview');


            $original_name = $created_by_name = esc_attr_x( 'No User', 'To show that the entry was unassigned from an actual user to no user.', 'gravityview');


            if( !empty( $originally_created_by ) ) {

                $originally_created_by_user_data = get_userdata($originally_created_by);

                $original_name = sprintf( $user_format, $originally_created_by_user_data->display_name, $originally_created_by_user_data->ID );
            }

            if( !empty( $created_by ) ) {

                $created_by_user_data =  get_userdata($created_by);

                $created_by_name = sprintf( $user_format, $created_by_user_data->display_name, $created_by_user_data->ID );
            }

            GravityView_Entry_Notes::add_note( $entry_id, $current_user->ID, $user_data->display_name, sprintf( __('Changed entry creator from %s to %s', 'gravityview'), $original_name, $created_by_name ), 'note' );

        }

    }

    /**
     * Output the select to change the entry creator
     * @param int $form_id GF Form ID
     * @param array $entry    GF entry array
     * @return void
     */
    function add_select($form_id, $entry ) {


        if( rgpost('screen_mode') !== 'edit' ) {

            return;
        }

        $created_by_id = rgar( $entry, 'created_by' );

        $users = GVCommon::get_users( 'change_entry_creator' );

        $is_created_by_in_users = wp_list_filter( $users, array( 'ID' => $created_by_id ) );

        // Make sure that the entry creator is included in the users list. If not, add them.
        if ( ! empty( $created_by_id ) && empty( $is_created_by_in_users ) ) {

	        if ( $created_by_user = GVCommon::get_users( 'change_entry_creator', array( 'include' => $created_by_id ) ) ) {
	            $users = array_merge( $users, $created_by_user );
	        }
	    }

        $output = '<label for="change_created_by">';
        $output .= esc_html__('Change Entry Creator:', 'gravityview');

        $output .= '</label>';

	    // If there are users who are not being shown, show a warning.
	    // TODO: Use AJAX instead of <select>
	    $count_users = count_users();
	    if( sizeof( $users ) < $count_users['total_users'] ) {
		    $output .= '<p><i class="dashicons dashicons-warning"></i> ' . sprintf( esc_html__( 'The displayed list of users has been trimmed due to the large number of users. %sLearn how to remove this limit%s.', 'gravityview' ), '<a href="https://docs.gravityview.co/article/251-i-only-see-some-users-in-the-change-entry-creator-dropdown" rel="external">', '</a>' ) . '</p>';
	    }

	    $output .= '<select name="created_by" id="change_created_by" class="widefat">';
        $output .= '<option value="' . selected( $entry['created_by'], '0', false ) . '"> &mdash; '.esc_attr_x( 'No User', 'No user assigned to the entry', 'gravityview').' &mdash; </option>';

        foreach($users as $user) {

            $output .= '<option value="'. $user->ID .'"'. selected( $entry['created_by'], $user->ID, false ).'>'.esc_attr( $user->display_name.' ('.$user->user_nicename.')' ).'</option>';
        }
        $output .= '</select>';
        $output .= '<input name="originally_created_by" value="'.esc_attr( $entry['created_by'] ).'" type="hidden" />';

	    unset( $is_created_by_in_users, $created_by_user, $users, $created_by_id, $count_users );

        echo $output;

    }

}

new GravityView_Change_Entry_Creator;


Push — develop ( 3f9285...c35b1f )

GravityView_Change_Entry_Creator::add_select() C

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-09 18:31 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 6 and the first side effect is on line 256. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			/**
4			* @since 1.2
5			*/
6			class GravityView_Change_Entry_Creator {
7
8			function __construct() {
			0 ignored issues – show Best Practice introduced 2015-12-04 01:01 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
9
10			/**
11			* @since 1.5.1
12			*/
13			add_action('gform_user_registered', array( $this, 'assign_new_user_to_lead'), 10, 4 );
			0 ignored issues – show Coding Style introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history... introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report No space before closing parenthesis of array is bad style Loading history...
14
15			// ONLY ADMIN FROM HERE ON.
16			if( !is_admin() ) { return; }
			0 ignored issues – show introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report Expected 1 space after "!"; 0 found Loading history...
17
18			/**
19			* @filter `gravityview_disable_change_entry_creator` Disable the Change Entry Creator functionality
20			* @since 1.7.4
21			* @param boolean $disable Disable the Change Entry Creator functionality. Default: false.
22			*/
23			if( apply_filters('gravityview_disable_change_entry_creator', false ) ) {
			0 ignored issues – show Coding Style introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history...
24			return;
25			}
26
27			/**
28			* Use `init` to fix bbPress warning
29			* @see https://bbpress.trac.wordpress.org/ticket/2309
30			*/
31			add_action('init', array( $this, 'load'), 100 );
			0 ignored issues – show Coding Style introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history... introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report No space before closing parenthesis of array is bad style Loading history...
32
33			add_action('plugins_loaded', array( $this, 'prevent_conflicts') );
			0 ignored issues – show Coding Style introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history... introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report No space before closing parenthesis of array is bad style Loading history...

gravityview / GravityView

Push — develop ( 3f9285...c35b1f )

GravityView_Change_Entry_Creator::add_select() C

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like