gravityview / GravityView

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-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-merge-tags.php

Doc Comments +1 added lines, -1 removed lines

@@ -135,7 +135,7 @@
 	 * @param bool $url_encode Whether to URL-encode output
 	 * @param bool $esc_html Whether to apply `esc_html()` to output
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function replace_gv_merge_tags(  $text, $form = array(), $entry = array(), $url_encode = false, $esc_html = false ) {
 

Indentation +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
 		$gv_modifiers = array(
 			'maxwords:(\d+)' => 'modifier_maxwords', /** @see modifier_maxwords */
 			'wpautop' => 'modifier_wpautop', /** @see modifier_wpautop */
-		    'timestamp' => 'modifier_timestamp', /** @see modifier_timestamp */
+			'timestamp' => 'modifier_timestamp', /** @see modifier_timestamp */
 		);
 		
 		$return = $value;
@@ -253,7 +253,7 @@ 
 
 		$atts = array(
 			'format' => self::get_format_from_modifiers( $exploded, false ),
-		    'human' => in_array( 'human', $exploded ), // {date_created:human}
+			'human' => in_array( 'human', $exploded ), // {date_created:human}
 			'diff' => in_array( 'diff', $exploded ), // {date_created:diff}
 			'raw' => in_array( 'raw', $exploded ), // {date_created:raw}
 			'timestamp' => in_array( 'timestamp', $exploded ), // {date_created:timestamp}

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.
 	 *