gravityview / GravityView

includes/admin/metaboxes/class-gravityview-admin-metaboxes.php

Doc Comments +1 added lines, -2 removed lines

@@ -214,7 +214,7 @@ 
 	/**
 	 * Generate the script tags necessary for the Gravity Forms Merge Tag picker to work.
 	 *
-	 * @param  mixed      $curr_form Form ID
+	 * @param  string      $curr_form Form ID
 	 * @return null|string     Merge tags html; NULL if $curr_form isn't defined.
 	 */
 	public static function render_merge_tags_scripts( $curr_form ) {
@@ -290,7 +290,6 @@ 
 	 * Render shortcode hint in the Publish metabox
 	 *
 	 * @access public
-	 * @param object $post
 	 * @return void
 	 */
 	function render_shortcode_hint() {

Indentation +5 added lines, -5 removed lines

@@ -14,7 +14,7 @@ 
 
 		if( !GravityView_Compatibility::is_valid() ) { return; }
 
-        self::$metaboxes_dir = GRAVITYVIEW_DIR . 'includes/admin/metaboxes/';
+		self::$metaboxes_dir = GRAVITYVIEW_DIR . 'includes/admin/metaboxes/';
 
 		include_once self::$metaboxes_dir . 'class-gravityview-metabox-tab.php';
 
@@ -228,13 +228,13 @@ 
 		$get_id_backup = isset($_GET['id']) ? $_GET['id'] : NULL;
 
 		if( isset( $form['id'] ) ) {
-		    $form_script = 'var form = ' . GFCommon::json_encode($form) . ';';
+			$form_script = 'var form = ' . GFCommon::json_encode($form) . ';';
 
-		    // The `gf_vars()` method needs a $_GET[id] variable set with the form ID.
-		    $_GET['id'] = $form['id'];
+			// The `gf_vars()` method needs a $_GET[id] variable set with the form ID.
+			$_GET['id'] = $form['id'];
 
 		} else {
-		    $form_script = 'var form = new Form();';
+			$form_script = 'var form = new Form();';
 		}
 
 		$output = '<script type="text/javascript" data-gv-merge-tags="1">' . $form_script . "\n" . GFCommon::gf_vars(false) . '</script>';

includes/admin/metaboxes/class-gravityview-metabox-tab.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	 * @param string $icon_class_name Icon class used in vertical tabs. Supports non-dashicon. If dashicons, no need for `dashicons ` prefix
 	 * @param string $callback Function to render the metabox, if $file is not defined.
 	 * @param null $callback_args Arguments passed to the callback
-	 * @return void
+	 * @return GravityView_Metabox_Tab
 	 */
 	function __construct( $id, $title = '', $file = '', $icon_class_name = '', $callback = '', $callback_args = null  ) {
 

includes/class-admin-add-shortcode.php

Doc Comments -1 removed lines

@@ -144,7 +144,6 @@
 	 * Enqueue scripts and styles
 	 *
 	 * @access public
-	 * @param mixed $hook
 	 * @return void
 	 */
 	function add_scripts_and_styles() {

Indentation +10 added lines, -10 removed lines

@@ -1,15 +1,15 @@
 <?php
 /**
- * Adds a button to add the View shortcode into the post content
- *
- * @package   GravityView
- * @license   GPL2+
- * @author    Katz Web Services, Inc.
- * @link      http://gravityview.co
- * @copyright Copyright 2014, Katz Web Services, Inc.
- *
- * @since 1.0.0
- */
+	 * Adds a button to add the View shortcode into the post content
+	 *
+	 * @package   GravityView
+	 * @license   GPL2+
+	 * @author    Katz Web Services, Inc.
+	 * @link      http://gravityview.co
+	 * @copyright Copyright 2014, Katz Web Services, Inc.
+	 *
+	 * @since 1.0.0
+	 */
 
 /** If this file is called directly, abort. */
 if ( ! defined( 'ABSPATH' ) ) {

includes/class-admin-approve-entries.php

Doc Comments +3 added lines, -4 removed lines

@@ -170,7 +170,7 @@ 
 	 *
 	 * @uses  GravityView_frontend::get_search_criteria() Convert the $_POST search request into a properly formatted request.
 	 * @access public
-	 * @return void|boolean
+	 * @return null|false
 	 */
 	public function process_bulk_action() {
 		if ( ! class_exists( 'RGForms' ) ) {
@@ -252,7 +252,7 @@ 
 	 * @param array|boolean $entries If array, array of entry IDs that are to be updated. If true: update all entries.
 	 * @param int $approved Approved status. If `0`: unapproved, if not empty, `Approved`
 	 * @param int $form_id The Gravity Forms Form ID
-	 * @return boolean|void
+	 * @return false|null
 	 */
 	private static function update_bulk( $entries, $approved, $form_id ) {
 
@@ -284,7 +284,6 @@ 
 	 *
 	 * @access public
 	 * @static
-	 * @param int $lead_id (default: 0)
 	 * @param int $approved (default: 0)
 	 * @param int $form_id (default: 0)
 	 * @param int $approvedcolumn (default: 0)
@@ -470,7 +469,7 @@ 
 	 * @access public
 	 * @static
 	 * @param mixed $form GF Form or Form ID
-	 * @return false|null|string Returns the input ID of the approved field. Returns NULL if no approved fields were found. Returns false if $form_id wasn't set.
+	 * @return integer Returns the input ID of the approved field. Returns NULL if no approved fields were found. Returns false if $form_id wasn't set.
 	 */
 	static public function get_approved_column( $form ) {
 

Indentation +22 added lines, -22 removed lines

@@ -321,7 +321,7 @@ 
 
 			if( class_exists( 'GravityView_Entry_Notes' ) ){
 				global $current_user;
-      			get_currentuserinfo();
+	  			get_currentuserinfo();
 				GravityView_Entry_Notes::add_note( $entry_id, $current_user->ID, $current_user->display_name, $note );
 			}
 
@@ -356,12 +356,12 @@ 
 
 		$approvedcolumn = self::get_approved_column( $form['id'] );
 
-        /**
-         * If the form doesn't contain the approve field, don't assume anything.
-         */
-        if( empty( $approvedcolumn ) ) {
-            return;
-        }
+		/**
+		 * If the form doesn't contain the approve field, don't assume anything.
+		 */
+		if( empty( $approvedcolumn ) ) {
+			return;
+		}
 
 		$entry = GFAPI::get_entry( $entry_id );
 
@@ -474,17 +474,17 @@ 
 	 */
 	static public function get_approved_column( $form ) {
 
-        if( empty( $form ) ) {
-            return null;
-        }
+		if( empty( $form ) ) {
+			return null;
+		}
 
-        if( !is_array( $form ) ) {
-            $form = GVCommon::get_form( $form );
-        }
+		if( !is_array( $form ) ) {
+			$form = GVCommon::get_form( $form );
+		}
 
 		foreach( $form['fields'] as $key => $field ) {
 
-            $field = (array) $field;
+			$field = (array) $field;
 
 			if( !empty( $field['gravityview_approved'] ) ) {
 				if( !empty($field['inputs'][0]['id']) ) {
@@ -492,14 +492,14 @@ 
 				}
 			}
 
-            // Note: This is just for backward compatibility from GF Directory plugin and old GV versions - when using i18n it may not work..
-            if( 'checkbox' == $field['type'] && isset( $field['inputs'] ) && is_array( $field['inputs'] ) ) {
-                foreach ( $field['inputs'] as $key2 => $input ) {
-                    if ( strtolower( $input['label'] ) == 'approved' ) {
-                        return $input['id'];
-                    }
-                }
-            }
+			// Note: This is just for backward compatibility from GF Directory plugin and old GV versions - when using i18n it may not work..
+			if( 'checkbox' == $field['type'] && isset( $field['inputs'] ) && is_array( $field['inputs'] ) ) {
+				foreach ( $field['inputs'] as $key2 => $input ) {
+					if ( strtolower( $input['label'] ) == 'approved' ) {
+						return $input['id'];
+					}
+				}
+			}
 		}
 
 		return null;

includes/class-admin-views.php

Doc Comments +7 added lines, -2 removed lines

@@ -326,7 +326,7 @@ 
 
 	/**
 	 * Get HTML links relating to a connected form, like Edit, Entries, Settings, Preview
-	 * @param  array|int $form_id Gravity Forms forms array, or the form ID
+	 * @param  array|int $form Gravity Forms forms array, or the form ID
 	 * @param  boolean $include_form_link Whether to include the bold name of the form in the output
 	 * @return string          HTML links
 	 */
@@ -547,7 +547,7 @@ 
 	 * $blacklist_field_types - contains the field types which are not proper to be shown in a directory.
 	 *
 	 * @access public
-	 * @param int $form_id Gravity Forms Form ID (default: '')
+	 * @param int $form Gravity Forms Form ID (default: '')
 	 * @param string $context (default: 'single')
 	 * @return void
 	 */
@@ -592,6 +592,10 @@ 
 		$this->render_additional_fields( $form, $context );
 	}
 
+	/**
+	 * @param string $form
+	 * @param string $context
+	 */
 	function render_additional_fields( $form, $context ) {
 
 		/**
@@ -790,6 +794,7 @@ 
 	 * @param  string $zone   Either 'single', 'directory', 'header', 'footer'
 	 * @param  array $rows    The layout structure: rows, columns and areas
 	 * @param  array $values  Saved objects
+	 * @param string $template_id
 	 * @return void
 	 */
 	function render_active_areas( $template_id, $type, $zone, $rows, $values ) {

Indentation +20 added lines, -20 removed lines

@@ -110,7 +110,7 @@ 
 	 * Start using GravityView_Render_Settings::render_setting_row
 	 */
 	public static function render_setting_row( $key = '', $current_settings = array(), $override_input = null, $name = 'template_settings[%s]', $id = 'gravityview_se_%s' ) {
-        _deprecated_function( 'GravityView_Admin_Views::render_setting_row', '1.1.7', 'GravityView_Render_Settings::render_setting_row' );
+		_deprecated_function( 'GravityView_Admin_Views::render_setting_row', '1.1.7', 'GravityView_Render_Settings::render_setting_row' );
 		GravityView_Render_Settings::render_setting_row( $key, $current_settings, $override_input, $name , $id );
 	}
 
@@ -688,22 +688,22 @@ 
 				/**
 				 * @since 1.7.2
 				 */
-			    'other_entries' => array(
-				    'label'	=> __('Other Entries', 'gravityview'),
-				    'type'	=> 'other_entries',
-				    'desc'	=> __('Display other entries created by the entry creator.', 'gravityview'),
-			    ),
-	        );
+				'other_entries' => array(
+					'label'	=> __('Other Entries', 'gravityview'),
+					'type'	=> 'other_entries',
+					'desc'	=> __('Display other entries created by the entry creator.', 'gravityview'),
+				),
+			);
 
 
 			if( 'single' !== $zone) {
 
-	        	$entry_default_fields['entry_link'] = array(
-	        		'label' => __('Link to Entry', 'gravityview'),
-	        		'desc'	=> __('A dedicated link to the single entry with customizable text.', 'gravityview'),
-	        		'type' => 'entry_link',
-	        	);
-	        }
+				$entry_default_fields['entry_link'] = array(
+					'label' => __('Link to Entry', 'gravityview'),
+					'desc'	=> __('A dedicated link to the single entry with customizable text.', 'gravityview'),
+					'type' => 'entry_link',
+				);
+			}
 
 		} // if not zone directory or single
 
@@ -714,7 +714,7 @@ 
 		 * @param  string|array $form form_ID or form object
 		 * @param  string $zone   Either 'single', 'directory', 'header', 'footer'
 		 */
-        return apply_filters( 'gravityview_entry_default_fields', $entry_default_fields, $form, $zone);
+		return apply_filters( 'gravityview_entry_default_fields', $entry_default_fields, $form, $zone);
 	}
 
 	/**
@@ -1028,15 +1028,15 @@ 
 		GFForms::register_scripts();
 
 		$scripts = array(
-		    'sack',
-		    'gform_gravityforms',
-		    'gform_forms',
-		    'gform_form_admin',
-		    'jquery-ui-autocomplete'
+			'sack',
+			'gform_gravityforms',
+			'gform_forms',
+			'gform_form_admin',
+			'jquery-ui-autocomplete'
 		);
 
 		if ( wp_is_mobile() )
-		    $scripts[] = 'jquery-touch-punch';
+			$scripts[] = 'jquery-touch-punch';
 
 		foreach ($scripts as $script) {
 			wp_enqueue_script( $script );

includes/class-admin.php

Doc Comments +4 added lines, -1 removed lines

@@ -311,7 +311,7 @@ 
 	 * Remove any style or script non-registered in the no conflict mode
 	 * @todo  Move this to GravityView_Admin_Views
 	 * @param  WP_Dependencies $wp_objects        Object of WP_Styles or WP_Scripts
-	 * @param  array $required_objects   List of registered script/style handles
+	 * @param  string[] $required_objects   List of registered script/style handles
 	 * @param  string $type              Either 'styles' or 'scripts'
 	 * @return void
 	 */
@@ -472,6 +472,9 @@ 
 
 new GravityView_Admin;
 
+/**
+ * @param string $page
+ */
 function gravityview_is_admin_page($hook = '', $page = NULL) {
 	return GravityView_Admin::is_admin_page( $hook, $page );
 }

Indentation +59 added lines, -60 removed lines

@@ -215,39 +215,39 @@ 
 		}
 
 		$wp_allowed_scripts = array(
-            'common',
-            'admin-bar',
-            'autosave',
-            'post',
+			'common',
+			'admin-bar',
+			'autosave',
+			'post',
 			'inline-edit-post',
-            'utils',
-            'svg-painter',
-            'wp-auth-check',
-            'heartbeat',
+			'utils',
+			'svg-painter',
+			'wp-auth-check',
+			'heartbeat',
 			'media-editor',
 			'media-upload',
-            'thickbox',
+			'thickbox',
 			'wp-color-picker',
 
-            // Settings
+			// Settings
 			'gv-admin-edd-license',
 
-            // Common
-            'select2-js',
-            'qtip-js',
+			// Common
+			'select2-js',
+			'qtip-js',
 
-            // jQuery
+			// jQuery
 			'jquery',
-            'jquery-ui-core',
-            'jquery-ui-sortable',
-            'jquery-ui-datepicker',
-            'jquery-ui-dialog',
-            'jquery-ui-slider',
+			'jquery-ui-core',
+			'jquery-ui-sortable',
+			'jquery-ui-datepicker',
+			'jquery-ui-dialog',
+			'jquery-ui-slider',
 			'jquery-ui-dialog',
 			'jquery-ui-tabs',
 			'jquery-ui-draggable',
 			'jquery-ui-droppable',
-            'jquery-ui-accordion',
+			'jquery-ui-accordion',
 		);
 
 		$this->remove_conflicts( $wp_scripts, $wp_allowed_scripts, 'scripts' );
@@ -281,23 +281,23 @@ 
 			return;
 		}
 
-        $wp_allowed_styles = array(
-	        'admin-bar',
-        	'colors',
-	        'ie',
-	        'wp-auth-check',
-	        'media-views',
+		$wp_allowed_styles = array(
+			'admin-bar',
+			'colors',
+			'ie',
+			'wp-auth-check',
+			'media-views',
 			'thickbox',
 			'dashicons',
-	        'wp-jquery-ui-dialog',
-	        'jquery-ui-sortable',
+			'wp-jquery-ui-dialog',
+			'jquery-ui-sortable',
 
-            // Settings
-	        'gravityview_settings',
+			// Settings
+			'gravityview_settings',
 
-	        // @todo qTip styles not loading for some reason!
-	        'jquery-qtip.js',
-	    );
+			// @todo qTip styles not loading for some reason!
+			'jquery-qtip.js',
+		);
 
 		$this->remove_conflicts( $wp_styles, $wp_allowed_styles, 'styles' );
 
@@ -317,32 +317,32 @@ 
 	 */
 	private function remove_conflicts( &$wp_objects, $required_objects, $type = 'scripts' ) {
 
-        /**
-         * @filter `gravityview_noconflict_{$type}` Modify the list of no conflict scripts or styles\n
-         * Filter is `gravityview_noconflict_scripts` or `gravityview_noconflict_styles`
-         * @param array $required_objects
-         */
-        $required_objects = apply_filters( "gravityview_noconflict_{$type}", $required_objects );
-
-        //reset queue
-        $queue = array();
-        foreach( $wp_objects->queue as $object ) {
-	        if( in_array( $object, $required_objects ) || preg_match('/gravityview|gf_|gravityforms/ism', $object ) ) {
-                $queue[] = $object;
-            }
-        }
-        $wp_objects->queue = $queue;
-
-        $required_objects = $this->add_script_dependencies( $wp_objects->registered, $required_objects );
-
-        //unregistering scripts
-        $registered = array();
-        foreach( $wp_objects->registered as $handle => $script_registration ){
-            if( in_array( $handle, $required_objects ) ){
-                $registered[ $handle ] = $script_registration;
-            }
-        }
-        $wp_objects->registered = $registered;
+		/**
+		 * @filter `gravityview_noconflict_{$type}` Modify the list of no conflict scripts or styles\n
+		 * Filter is `gravityview_noconflict_scripts` or `gravityview_noconflict_styles`
+		 * @param array $required_objects
+		 */
+		$required_objects = apply_filters( "gravityview_noconflict_{$type}", $required_objects );
+
+		//reset queue
+		$queue = array();
+		foreach( $wp_objects->queue as $object ) {
+			if( in_array( $object, $required_objects ) || preg_match('/gravityview|gf_|gravityforms/ism', $object ) ) {
+				$queue[] = $object;
+			}
+		}
+		$wp_objects->queue = $queue;
+
+		$required_objects = $this->add_script_dependencies( $wp_objects->registered, $required_objects );
+
+		//unregistering scripts
+		$registered = array();
+		foreach( $wp_objects->registered as $handle => $script_registration ){
+			if( in_array( $handle, $required_objects ) ){
+				$registered[ $handle ] = $script_registration;
+			}
+		}
+		$wp_objects->registered = $registered;
 	}
 
 	/**
@@ -405,7 +405,6 @@ 
 	 *
 	 * @deprecated since 1.12
 	 * @see GravityView_Compatibility::get_plugin_status()
-
 	 * @return boolean|string True: plugin is active; False: plugin file doesn't exist at path; 'inactive' it's inactive
 	 */
 	static function get_plugin_status( $location = '' ) {

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-data.php

Doc Comments +5 added lines, -2 removed lines

@@ -113,6 +113,9 @@ 
 		return ( sizeof( $ids ) === 1 ) ? $ids[0] : $ids;
 	}
 
+	/**
+	 * @return GravityView_View_Data
+	 */
 	public static function getInstance( $passed_post = NULL ) {
 
 		if( empty( self::$instance ) ) {
@@ -152,7 +155,7 @@ 
 	 * within the WordPress database.
 	 *
 	 * @see http://tommcfarlin.com/wordpress-post-exists-by-id/ Fastest check available
-	 * @param    int    $id    The ID of the post to check
+	 * @param integer $view_id
 	 * @return   bool          True if the post exists; otherwise, false.
 	 * @since    1.0.0
 	 */
@@ -299,7 +302,7 @@ 
 	 *
 	 * @access public
 	 * @param array $properties
-	 * @return void|boolean (field should be hidden) or false (field should be presented)
+	 * @return boolean (field should be hidden) or false (field should be presented)
 	 */
 	private function hide_field_check_conditions( $properties ) {
 

includes/class-debug-bar.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 
 	/**
 	 * Should the panel be shown? If there are notices or warnings, yes.
-	 * @return boolean true: show panel; false: hide panel
+	 * @return boolean|null true: show panel; false: hide panel
 	 */
 	function set_visible( $visible = '' ) {
 		$this->_visible = ( count( $this->get_notices() ) || count( $this->get_warnings() ) );