GravityView_Edit_Entry_Admin

Complexity

Total Complexity

12

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	load()	0	24	2
A	view_settings_metabox()	0	12	1
A	add_default_field()	0	14	2
A	modify_visibility_caps()	0	15	2
A	edit_link_field_options()	0	18	1
A	tooltips()	0	11	1
A	field_options()	0	33	2

<?php
/**
 * GravityView Edit Entry - Admin logic
 *
 * @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_Admin {

    protected $loader;

    function __construct( GravityView_Edit_Entry $loader ) {

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

        $this->loader = $loader;
    }

    function load() {

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

        if( !is_admin() ) {
            return;
        }

        // Add Edit Link as a default field, outside those set in the Gravity Form form
        add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 );

        // For the Edit Entry Link, you don't want visible to all users.
        add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 );

        // Modify the field options based on the name of the field type
        add_filter( 'gravityview_template_edit_link_options', array( $this, 'edit_link_field_options' ), 10, 5 );

        // add tooltips
        add_filter( 'gravityview/metaboxes/tooltips', array( $this, 'tooltips') );

        // custom fields' options for zone EDIT
        add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 6 );

        // Add Edit Entry settings to View Settings
        add_action( 'gravityview/metaboxes/edit_entry', array( $this, 'view_settings_metabox' ) );
    }

	/**
	 * Render Edit Entry View metabox settings
	 *
	 * @since 2.9
	 *
	 * @param $current_settings
	 *
	 * @return void
	 */
	public function view_settings_metabox( $current_settings ) {

		GravityView_Render_Settings::render_setting_row( 'edit_locking', $current_settings );

		GravityView_Render_Settings::render_setting_row( 'user_edit', $current_settings );

		GravityView_Render_Settings::render_setting_row( 'unapprove_edit', $current_settings );

		GravityView_Render_Settings::render_setting_row( 'edit_redirect', $current_settings );

		GravityView_Render_Settings::render_setting_row( 'edit_redirect_url', $current_settings );
	}

    /**
     * Add Edit Link as a default field, outside those set in the Gravity Form form
     * @param array $entry_default_fields Existing fields
     * @param  string|array $form form_ID or form object
     * @param  string $zone   Either 'single', 'directory', 'header', 'footer'
     */
    function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) {

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

        if( $zone !== 'edit' ) {

            $entry_default_fields['edit_link'] = array(
                'label' => __('Edit Entry', 'gravityview'),
                'type' => 'edit_link',
                'desc'	=> __('A link to edit the entry. Visible based on View settings.', 'gravityview'),
            );

        }

        return $entry_default_fields;
    }

    /**
     * Change wording for the Edit context to read Entry Creator
     *
     * @param  array 	   $visibility_caps        Array of capabilities to display in field dropdown.
     * @param  string      $field_type  Type of field options to render (`field` or `widget`)

There is no parameter named $field_type. Was it maybe removed?

     * @param  string      $template_id Table slug
     * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
     * @param  string      $context     What context are we in? Example: `single` or `directory`
     * @param  string      $input_type  (textarea, list, select, etc.)
     * @return array                   Array of field options with `label`, `value`, `type`, `default` keys
     */
    function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) {

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

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

        $caps = $visibility_caps;

        // If we're configuring fields in the edit context, we want a limited selection
        if( $context === 'edit' ) {

            // Remove other built-in caps.
            unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['delete_others_posts'] );

            $caps['read'] = _x('Entry Creator','User capability', 'gravityview');
        }

        return $caps;
    }

    /**
     * Add "Edit Link Text" setting to the edit_link field settings
     * @param  [type] $field_options [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $template_id   [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $field_id      [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $context       [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $input_type    [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @return [type]                [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) {

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

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

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

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

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

        // Always a link, never a filter
        unset( $field_options['show_as_link'], $field_options['search_filter'] );

        // Edit Entry link should only appear to visitors capable of editing entries
        unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] );

        $add_option['edit_link'] = array(

$add_option was never initialized. Although not strictly required by PHP, it is generally a good practice to add $add_option = array(); before regardless.

            'type' => 'text',
            'label' => __( 'Edit Link Text', 'gravityview' ),
            'desc' => NULL,
            'value' => __('Edit Entry', 'gravityview'),
            'merge_tags' => true,
        );

        return array_merge( $add_option, $field_options );
    }

    /**
     * Add tooltips
     * @param  array $tooltips Existing tooltips
     * @return array           Modified tooltips
     */
    function tooltips( $tooltips ) {

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

        $return = $tooltips;

        $return['allow_edit_cap'] = array(
            'title' => __('Limiting Edit Access', 'gravityview'),
            'value' => __('Change this setting if you don\'t want the user who created the entry to be able to edit this field.', 'gravityview'),
        );

        return $return;
    }

    /**
     * Manipulate the fields' options for the EDIT ENTRY screen
     * @param  [type] $field_options [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $template_id   [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $field_id      [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $context       [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param  [type] $input_type    [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @return [type]                [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
	public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) {

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

        // We only want to modify the settings for the edit context
        if( 'edit' !== $context ) {

            /**
             * @since 1.8.4
             */
            $field_options['new_window'] = array(
                'type' => 'checkbox',
                'label' => __( 'Open link in a new tab or window?', 'gravityview' ),
                'value' => false,
            );

            return $field_options;
        }

        //  Entry field is only for logged in users
        unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] );

        $add_options = array(
            'allow_edit_cap' => array(
                'type' => 'select',
                'label' => __( 'Make field editable to:', 'gravityview' ),
                'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ),
                'tooltip' => 'allow_edit_cap',
                'class' => 'widefat',
                'value' => 'read', // Default: entry creator
            ),
        );

        return array_merge( $field_options, $add_options );
    }


} // end class