gravityview / GravityView

includes/class-ajax.php

Doc Comments +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
 	 * @since 1.15
 	 * @param bool|false $mixed
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	private function _exit( $mixed = NULL ) {
 
@@ -200,7 +200,7 @@ 
 	 * Import Gravity Form XML or JSON
 	 *
 	 * @param  string $xml_or_json_path Path to form XML or JSON file
-	 * @return int|bool       Imported form ID or false
+	 * @return false|string       Imported form ID or false
 	 */
 	function import_form( $xml_or_json_path = '' ) {
 

Indentation +28 added lines, -28 removed lines

@@ -136,7 +136,7 @@ 
 
 		// template areas
 		$template_areas_directory = apply_filters( 'gravityview_template_active_areas', array(), $template_id, 'directory' );
-        $template_areas_single = apply_filters( 'gravityview_template_active_areas', array(), $template_id, 'single' );
+		$template_areas_single = apply_filters( 'gravityview_template_active_areas', array(), $template_id, 'single' );
 
 		// widget areas
 		$default_widget_areas = GravityView_Plugin::get_default_widget_areas();
@@ -328,40 +328,40 @@ 
 		// load file
 		$xmlstr = file_get_contents( $form_file );
 
-        $options = array(
-            "page" => array("unserialize_as_array" => true),
-            "form"=> array("unserialize_as_array" => true),
-            "field"=> array("unserialize_as_array" => true),
-            "rule"=> array("unserialize_as_array" => true),
-            "choice"=> array("unserialize_as_array" => true),
-            "input"=> array("unserialize_as_array" => true),
-            "routing_item"=> array("unserialize_as_array" => true),
-            "creditCard"=> array("unserialize_as_array" => true),
-            "routin"=> array("unserialize_as_array" => true),
-            "confirmation" => array("unserialize_as_array" => true),
-            "notification" => array("unserialize_as_array" => true)
-        );
+		$options = array(
+			"page" => array("unserialize_as_array" => true),
+			"form"=> array("unserialize_as_array" => true),
+			"field"=> array("unserialize_as_array" => true),
+			"rule"=> array("unserialize_as_array" => true),
+			"choice"=> array("unserialize_as_array" => true),
+			"input"=> array("unserialize_as_array" => true),
+			"routing_item"=> array("unserialize_as_array" => true),
+			"creditCard"=> array("unserialize_as_array" => true),
+			"routin"=> array("unserialize_as_array" => true),
+			"confirmation" => array("unserialize_as_array" => true),
+			"notification" => array("unserialize_as_array" => true)
+		);
 
 		$xml = new RGXML($options);
-        $forms = $xml->unserialize($xmlstr);
+		$forms = $xml->unserialize($xmlstr);
 
-        if( !$forms ) {
-        	do_action( 'gravityview_log_error', '[pre_get_available_fields] Importing Form Fields for preset ['. $template_id .']. Error importing file. (File)', $form_file );
-        	return false;
-        }
+		if( !$forms ) {
+			do_action( 'gravityview_log_error', '[pre_get_available_fields] Importing Form Fields for preset ['. $template_id .']. Error importing file. (File)', $form_file );
+			return false;
+		}
 
-        if( !empty( $forms[0] ) && is_array( $forms[0] ) ) {
-        	$form = $forms[0];
-        }
+		if( !empty( $forms[0] ) && is_array( $forms[0] ) ) {
+			$form = $forms[0];
+		}
 
-        if( empty( $form ) ) {
-        	do_action( 'gravityview_log_error', '[pre_get_available_fields] $form not set.', $forms );
-        	return false;
-        }
+		if( empty( $form ) ) {
+			do_action( 'gravityview_log_error', '[pre_get_available_fields] $form not set.', $forms );
+			return false;
+		}
 
-        do_action( 'gravityview_log_debug', '[pre_get_available_fields] Importing Form Fields for preset ['. $template_id .']. (Form)', $form );
+		do_action( 'gravityview_log_debug', '[pre_get_available_fields] Importing Form Fields for preset ['. $template_id .']. (Form)', $form );
 
-        return $form;
+		return $form;
 
 	}
 

includes/class-gravityview-admin-duplicate-view.php

Doc Comments +1 added lines, -1 removed lines

@@ -195,7 +195,7 @@
 	 *
 	 * @since 1.6
 	 *
-	 * @param int $new_view_id The ID of the newly created View
+	 * @param int $new_id The ID of the newly created View
 	 * @param WP_Post $post The View that was just cloned
 	 *
 	 * @return void

includes/class-gravityview-compatibility.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 
 	/**
 	 * @since 1.12
-	 * @return bool
+	 * @return boolean|null
 	 */
 	private function add_fallback_shortcode() {
 

Indentation +1 added lines, -1 removed lines

@@ -204,7 +204,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/class-gravityview-entry-link-shortcode.php

Doc Comments +1 added lines, -2 removed lines

@@ -221,7 +221,6 @@ 
 	 *
 	 * @since 1.15
 	 *
-	 * @param string|null $content Content inside shortcode, if defined
 	 *
 	 * @return string|boolean If URL is fetched, the URL to the entry link. If not found, returns false.
 	 */
@@ -316,7 +315,7 @@ 
 	 *
 	 * @since 1.15
 	 *
-	 * @param string $href URL
+	 * @param string|null $url
 	 */
 	private function maybe_add_field_values_query_args( $url ) {
 

includes/class-gravityview-extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
 
 	/**
 	 * Add a notice to be displayed in the admin.
-	 * @param array $notice Array with `class` and `message` keys. The message is not escaped.
+	 * @param string $notice Array with `class` and `message` keys. The message is not escaped.
 	 */
 	public static function add_notice( $notice = array() ) {
 

Indentation +7 added lines, -7 removed lines

@@ -244,13 +244,13 @@
 			$this->_remote_update_url,
 			$this->_path,
 			array(
-            	'version'	=> $this->_version, // current version number
-            	'license'	=> $license['license'],
-	            'item_id'   => $this->_item_id, // The ID of the download on _remote_update_url
-            	'item_name' => $this->_title,  // name of this plugin
-            	'author' 	=> strip_tags( $this->_author )  // author of this plugin
-          	)
-        );
+				'version'	=> $this->_version, // current version number
+				'license'	=> $license['license'],
+				'item_id'   => $this->_item_id, // The ID of the download on _remote_update_url
+				'item_name' => $this->_title,  // name of this plugin
+				'author' 	=> strip_tags( $this->_author )  // author of this plugin
+		  	)
+		);
 	}
 
 	/**

includes/class-gravityview-roles-capabilities.php

Doc Comments -1 removed lines

@@ -67,7 +67,6 @@
 	 *
 	 * @since 1.15
 	 *
-	 * @param array   $allcaps An array of all the user's capabilities.
 	 * @param array   $caps    Actual capabilities for meta capability.
 	 * @param array   $args    Optional parameters passed to has_cap(), typically object ID.
 	 * @param WP_User|null $user    The user object, in WordPress 3.7.0 or higher

Indentation +1 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
 		add_filter( 'members_get_capabilities', array( 'GravityView_Roles_Capabilities', 'merge_with_all_caps' ) );
 		add_action( 'members_register_cap_groups', array( $this, 'members_register_cap_group' ), 20 );
 		add_filter( 'user_has_cap', array( $this, 'filter_user_has_cap' ), 10, 4 );
-        add_action( 'admin_init', array( $this, 'add_caps') );
+		add_action( 'admin_init', array( $this, 'add_caps') );
 	}
 
 
@@ -360,7 +360,6 @@ 
 	 * Add Gravity Forms and GravityView's "full access" caps when any other caps are checked against.
 	 *
 	 * @since 1.15
-
 	 * @param array $caps_to_check
 	 *
 	 * @return array

includes/class-gravityview-template.php

Doc Comments +8 added lines, -2 removed lines

@@ -37,6 +37,9 @@ 
 	public $active_areas;
 
 
+	/**
+	 * @param string $id
+	 */
 	function __construct( $id, $settings = array(), $field_options = array(), $areas = array() ) {
 
 		if ( empty( $id ) ) {
@@ -144,6 +147,9 @@ 
 		return $areas;
 	}
 
+	/**
+	 * @param string $context
+	 */
 	public function get_active_areas( $context ) {
 		if ( isset( $this->active_areas[ $context ] ) ) {
 			return $this->active_areas[ $context ];
@@ -156,8 +162,8 @@ 
 	/**
 	 * Assign template specific field options
 	 *
-	 * @param array $options (default: array())
-	 * @param string $template (default: '')
+	 * @param array $field_options (default: array())
+	 * @param string $template_id (default: '')
 	 * @param string $field_id key for the field
 	 * @param  string|array $context Context for the field; `directory` or `single` for example.
 	 *

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

Doc Comments -1 removed lines

@@ -170,7 +170,6 @@
 	 *
 	 * @since 1.5.1
 	 * @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`)
 	 * @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`

Indentation +4 added lines, -4 removed lines

@@ -234,7 +234,7 @@ 
 
 		self::getInstance()->set_entry( $entry );
 
-        $base = GravityView_API::directory_link( $post_id, true );
+		$base = GravityView_API::directory_link( $post_id, true );
 
 		if( empty( $base ) ) {
 			do_action( 'gravityview_log_error', __METHOD__ . ' - Post ID does not exist: '.$post_id );
@@ -244,13 +244,13 @@ 
 		// Use the slug instead of the ID for consistent security
 		$entry_slug = GravityView_API::get_entry_slug( $entry['id'], $entry );
 
-        $view_id = empty( $view_id ) ? gravityview_get_view_id() : $view_id;
+		$view_id = empty( $view_id ) ? gravityview_get_view_id() : $view_id;
 
 		$actionurl = add_query_arg( array(
 			'action'	=> 'delete',
 			'entry_id'		=> $entry_slug,
 			'gvid' => $view_id,
-            'view_id' => $view_id,
+			'view_id' => $view_id,
 		), $base );
 
 		$url = wp_nonce_url( $actionurl, 'delete_'.$entry_slug, 'delete' );
@@ -424,7 +424,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/edit-entry/class-edit-entry-admin.php

Doc Comments -1 removed lines

@@ -69,7 +69,6 @@
      * 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`)
      * @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`

Indentation +160 added lines, -160 removed lines

@@ -10,175 +10,175 @@
  */
 
 if ( ! defined( 'WPINC' ) ) {
-    die;
+	die;
 }
 
 
 class GravityView_Edit_Entry_Admin {
 
-    protected $loader;
+	protected $loader;
 
-    function __construct( GravityView_Edit_Entry $loader ) {
-        $this->loader = $loader;
-    }
+	function __construct( GravityView_Edit_Entry $loader ) {
+		$this->loader = $loader;
+	}
 
-    function load() {
-
-        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 );
+	function load() {
+
+		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 );
+		// 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_tooltips', array( $this, 'tooltips') );
-
-        // custom fields' options for zone EDIT
-        add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 5 );
-    }
-
-    /**
-     * 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 = '' ) {
-
-        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`)
-     * @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 = '' ) {
-
-        $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]
-     * @param  [type] $template_id   [description]
-     * @param  [type] $field_id      [description]
-     * @param  [type] $context       [description]
-     * @param  [type] $input_type    [description]
-     * @return [type]                [description]
-     */
-    function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
-
-        // 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(
-            '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 ) {
-
-        $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]
-     * @param  [type] $template_id   [description]
-     * @param  [type] $field_id      [description]
-     * @param  [type] $context       [description]
-     * @param  [type] $input_type    [description]
-     * @return [type]                [description]
-     */
-    function field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
-
-        // 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 );
-    }
+		// add tooltips
+		add_filter( 'gravityview_tooltips', array( $this, 'tooltips') );
+
+		// custom fields' options for zone EDIT
+		add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 5 );
+	}
+
+	/**
+	 * 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 = '' ) {
+
+		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`)
+	 * @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 = '' ) {
+
+		$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]
+	 * @param  [type] $template_id   [description]
+	 * @param  [type] $field_id      [description]
+	 * @param  [type] $context       [description]
+	 * @param  [type] $input_type    [description]
+	 * @return [type]                [description]
+	 */
+	function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
+
+		// 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(
+			'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 ) {
+
+		$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]
+	 * @param  [type] $template_id   [description]
+	 * @param  [type] $field_id      [description]
+	 * @param  [type] $context       [description]
+	 * @param  [type] $input_type    [description]
+	 * @return [type]                [description]
+	 */
+	function field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
+
+		// 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
\ No newline at end of file