gravityview / GravityView

includes/class-common.php

Doc Comments +4 added lines, -4 removed lines

@@ -209,7 +209,7 @@ 
 	 * Return array of fields' id and label, for a given Form ID
 	 *
 	 * @access public
-	 * @param string|array $form_id (default: '') or $form object
+	 * @param string|array $form (default: '') or $form object
 	 * @param bool $add_default_properties
 	 * @param bool $include_parent_field
 	 * @return array
@@ -850,7 +850,7 @@ 
 	 *
 	 * @param array $form Gravity Forms form array
 	 * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
-	 * @param string|array $field_value Raw value of the field.
+	 * @param string $field_value Raw value of the field.
 	 * @return string
 	 */
 	public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
@@ -1503,9 +1503,9 @@ 
 	 * @param string $message            Message body (required)
 	 * @param string $from_name          Displayed name of the sender
 	 * @param string $message_format     If "html", sent text as `text/html`. Otherwise, `text/plain`. Default: "html".
-	 * @param string|array $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
+	 * @param string $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
 	 * @param array|false $entry         Gravity Forms entry array, related to the email. Default: false.
-	 * @param array|false $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
+	 * @param boolean $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
 	 */
 	public static function send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name = '', $message_format = 'html', $attachments = '', $entry = false, $notification = false ) {
 

Indentation +34 added lines, -34 removed lines

@@ -305,12 +305,12 @@ 
 						}
 
 						/**
-                         * @hack
-                         * In case of email/email confirmation, the input for email has the same id as the parent field
-                         */
+						 * @hack
+						 * In case of email/email confirmation, the input for email has the same id as the parent field
+						 */
 						if( 'email' === $field['type'] && false === strpos( $input['id'], '.' ) ) {
-                            continue;
-                        }
+							continue;
+						}
 						$fields["{$input['id']}"] = array(
 							'label' => \GV\Utils::get( $input, 'label' ),
 							'customLabel' => \GV\Utils::get( $input, 'customLabel' ),
@@ -495,7 +495,7 @@ 
 		} elseif ( 'delete' === GFForms::get( 'action' ) ) {
 			$criteria['context_view_id'] = isset( $_GET['view_id'] ) ? intval( $_GET['view_id'] ) : null;
 		} elseif( !isset( $criteria['context_view_id'] ) ) {
-            // Prevent overriding the Context View ID: Some widgets could set the context_view_id (e.g. Recent Entries widget)
+			// Prevent overriding the Context View ID: Some widgets could set the context_view_id (e.g. Recent Entries widget)
 			$criteria['context_view_id'] = null;
 		}
 
@@ -1354,7 +1354,7 @@ 
 			),
 		);
 
-        $fields = $date_created + $fields;
+		$fields = $date_created + $fields;
 
 		$blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', $blacklist, NULL );
 
@@ -1366,13 +1366,13 @@ 
 			}
 		}
 
-        /**
-         * @filter `gravityview/common/sortable_fields` Filter the sortable fields
-         * @since 1.12
-         * @param array $fields Sub-set of GF form fields that are sortable
-         * @param int $formid The Gravity Forms form ID that the fields are from
-         */
-        $fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid );
+		/**
+		 * @filter `gravityview/common/sortable_fields` Filter the sortable fields
+		 * @since 1.12
+		 * @param array $fields Sub-set of GF form fields that are sortable
+		 * @param int $formid The Gravity Forms form ID that the fields are from
+		 */
+		$fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid );
 
 		return $fields;
 	}
@@ -1664,26 +1664,26 @@ 
 	}
 
 
-    /**
-     * Display updated/error notice
-     *
-     * @since 1.19.2 Added $cap and $object_id parameters
-     *
-     * @param string $notice text/HTML of notice
-     * @param string $class CSS class for notice (`updated` or `error`)
-     * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps.
-     *
-     * @return string
-     */
-    public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) {
-
-    	// If $cap is defined, only show notice if user has capability
-    	if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) {
-    		return '';
-	    }
-
-        return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
-    }
+	/**
+	 * Display updated/error notice
+	 *
+	 * @since 1.19.2 Added $cap and $object_id parameters
+	 *
+	 * @param string $notice text/HTML of notice
+	 * @param string $class CSS class for notice (`updated` or `error`)
+	 * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps.
+	 *
+	 * @return string
+	 */
+	public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) {
+
+		// If $cap is defined, only show notice if user has capability
+		if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) {
+			return '';
+		}
+
+		return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
+	}
 
 	/**
 	 * Inspired on \GFCommon::encode_shortcodes, reverse the encoding by replacing the ascii characters by the shortcode brackets

future/_mocks.php

Doc Comments +4 added lines

@@ -10,6 +10,7 @@ 
  * @internal
  * @since 2.0
  *
+ * @param \GravityView_View_Data $_this
  * @return array|false The old array data, or false on error.
  */
 function GravityView_View_Data_add_view( $view_id, $atts, $_this ) {
@@ -62,6 +63,8 @@ 
  * @internal
  * @since 2.0
  *
+ * @param integer $form_id
+ * @param integer $count
  * @return array The old associative array data as returned by
  *  \GravityView_frontend::get_view_entries(), the paging parameters
  *  and a total count of all entries.
@@ -155,6 +158,7 @@ 
  * @internal
  * @since 2.0
  *
+ * @param string $format
  * @return null|string The value of a field in an entry.
  */
 function GravityView_API_field_value( $entry, $field_settings, $format ) {

future/includes/class-gv-entry-gravityforms.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 	 *
 	 * @param array $entry The array ID.
 	 *
-	 * @return \GV\Entry|null An instance of this entry or null if not found.
+	 * @return null|GF_Entry An instance of this entry or null if not found.
 	 */
 	public static function from_entry( $entry ) {
 		if ( empty( $entry['id'] ) ) {

future/includes/class-gv-extension.php

Doc Comments +2 added lines, -2 removed lines

@@ -207,7 +207,7 @@ 
 	 * - Checks PHP version numbers
 	 * - Sets self::$is_compatible[__CLASS__] to boolean value
 	 *
-	 * @return boolean Is the extension supported?
+	 * @return boolean|null Is the extension supported?
 	 */
 	protected function is_extension_supported() {
 
@@ -329,7 +329,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.
 	 *
 	 * @return void
 	 */

future/includes/class-gv-field-gravityforms.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
 	 * @param \GV\GF_Form $form The Gravity Form form.
 	 * @param int $field_id The Gravity Form field ID for the $form.
 	 *
-	 * @return \GV\Field|null The requested field or null if not found.
+	 * @return null|GF_Field The requested field or null if not found.
 	 */
 	public static function by_id( $form, $field_id ) {
 

future/includes/class-gv-form-gravityforms.php

Doc Comments +1 added lines, -3 removed lines

@@ -132,10 +132,8 @@
 	/**
 	 * Get a \GV\Field by Form and Field ID for this data source.
 	 *
-	 * @param \GV\GF_Form $form The Gravity Form form ID.
-	 * @param int $field_id The Gravity Form field ID for the $form_id.
 	 *
-	 * @return \GV\Field|null The requested field or null if not found.
+	 * @return null|GF_Field The requested field or null if not found.
 	 */
 	public static function get_field( /** varargs */ ) {
 		$args = func_get_args();

future/includes/class-gv-license-handler.php

Doc Comments +4 added lines, -2 removed lines

@@ -350,7 +350,7 @@ 
 	 * Generate the status message box HTML based on the current status
 	 *
 	 * @since 1.7.4
-	 * @param $message
+	 * @param string $message
 	 * @param string $class
 	 *
 	 * @return string
@@ -470,6 +470,9 @@ 
 		$this->settings->update( $settings );
 	}
 
+	/**
+	 * @param boolean $echo
+	 */
 	public function settings_edd_license_activation( $field, $echo ) {
 		$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
 
@@ -569,7 +572,6 @@ 
 	 * Check the GravityView license information
 	 *
 	 * @since 1.19.3
-	 * @param bool $force Whether to force checking license, even if AJAX
 	 *
 	 * @return void
 	 */

Indentation +10 added lines, -10 removed lines

@@ -96,7 +96,7 @@ 
 			'author'    => self::author,
 			'language'  => get_locale(),
 			'url'       => home_url(),
-		    'beta'      => $this->settings->get( 'beta' ),
+			'beta'      => $this->settings->get( 'beta' ),
 		);
 
 		if ( ! empty( $action ) ) {
@@ -463,7 +463,7 @@ 
 	private function license_call_update_settings( $license_data, $data ) {
 		$settings = array();
 
-        $settings['license_key'] = $license_data->license_key = trim( $data['license'] );
+		$settings['license_key'] = $license_data->license_key = trim( $data['license'] );
 		$settings['license_key_status'] = $license_data->license;
 		$settings['license_key_response'] = (array)$license_data;
 
@@ -597,14 +597,14 @@ 
 			// Call the custom API.
 			$response = wp_remote_post( self::url, array(
 				'timeout'   => 15,
-			    'sslverify' => false,
-			    'body'      =>  array(
-				    'edd_action' => 'check_license',
-				    'license'    => trim( $this->settings->get( 'license_key' ) ),
-				    'item_name'  => self::name,
-				    'url'        => home_url(),
-				    'site_data'  => $this->get_site_data(),
-			    ),
+				'sslverify' => false,
+				'body'      =>  array(
+					'edd_action' => 'check_license',
+					'license'    => trim( $this->settings->get( 'license_key' ) ),
+					'item_name'  => self::name,
+					'url'        => home_url(),
+					'site_data'  => $this->get_site_data(),
+				),
 			));
 
 			// make sure the response came back okay

future/includes/class-gv-settings.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
 	 * Set an setting.
 	 *
 	 * @param mixed $key The key in this setting to retrieve.
-	 * @param mixed $default A default in case the key is not set. 
+	 * @param false|null $default A default in case the key is not set. 
 	 *
 	 * @api
 	 * @since 2.0

future/includes/class-gv-shortcode-gravityview.php

Doc Comments -1 removed lines

@@ -174,7 +174,6 @@
 	 * @param \GV\View $view The View.
 	 * @param \GV\Entry_Collection $entries The calculated entries.
 	 * @param array $atts The shortcode attributes (with defaults).
-	 * @param array $view_atts A quirky compatibility parameter where we get the unaltered view atts.
 	 *
 	 * @return string The output.
 	 */