gravityview / GravityView

includes/connector-functions.php

Doc Comments +2 added lines, -3 removed lines

@@ -56,7 +56,7 @@ 
  *
  * @see GVCommon::get_form_fields()
  * @access public
- * @param string|array $form_id (default: '') or $form object
+ * @param string|array $form (default: '') or $form object
  * @return array
  */
 function gravityview_get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {
@@ -94,6 +94,7 @@ 
  * @param int|array $form_ids The ID of the form or an array IDs of the Forms. Zero for all forms.
  * @param mixed $passed_criteria (default: null)
  * @param mixed &$total (default: null)
+ * @param integer $total
  * @return mixed False: Error fetching entries. Array: Multi-dimensional array of Gravity Forms entry arrays
  */
 function gravityview_get_entries( $form_ids = null, $passed_criteria = null, &$total = null ) {
@@ -106,7 +107,6 @@ 
  * Since 1.4, supports custom entry slugs. The way that GravityView fetches an entry based on the custom slug is by searching `gravityview_unique_id` meta. The `$entry_slug` is fetched by getting the current query var set by `is_single_entry()`
  *
  * @access public
- * @param mixed $entry_id
  * @param boolean $force_allow_ids Force the get_entry() method to allow passed entry IDs, even if the `gravityview_custom_entry_slug_allow_id` filter returns false.
  * @param boolean $check_entry_display Check whether the entry is visible for the current View configuration. Default: true {@since 1.14}
  * @return array|boolean
@@ -193,7 +193,6 @@ 
  *
  * @see GravityView_Template::template_id
  *
- * @param int $view_id The ID of the View to get the layout of
  *
  * @return string GravityView_Template::template_id value. Empty string if not.
  */

includes/class-admin-approve-entries.php

Doc Comments +2 added lines, -2 removed lines

@@ -265,7 +265,7 @@ 
 	 *
 	 * @uses  GravityView_frontend::get_search_criteria() Convert the $_POST search request into a properly formatted request.
 	 * @access public
-	 * @return void|boolean
+	 * @return false|null
 	 */
 	public function process_bulk_action() {
 
@@ -362,7 +362,7 @@ 
      * @since 1.18 Moved to GravityView_Entry_Approval::get_approved_column
      * @see GravityView_Entry_Approval::get_approved_column
      *
-	 * @param mixed $form GF Form or Form ID
+	 * @param integer $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.
 	 */
 	static public function get_approved_column( $form ) {

includes/fields/class-gravityview-field-is-approved.php

Doc Comments -1 removed lines

@@ -59,7 +59,6 @@
 	 *
 	 * @param string $output HTML value output
 	 * @param array  $entry The GF entry array
-	 * @param array  $field_settings Settings for the particular GV field
 	 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
 	 *
 	 * @return string The field setting label for the current status. Uses defaults, if not configured.

includes/class-gravityview-entry-approval.php

Doc Comments +2 added lines, -2 removed lines

@@ -371,7 +371,7 @@ 
 	 * @param  int $entry_id ID of the Gravity Forms entry
 	 * @param  string $status String whether entry is approved or not. `0` for not approved, `Approved` for approved.
 	 * @param int $form_id ID of the form of the entry being updated. Improves query performance.
-	 * @param string $approvedcolumn Gravity Forms Field ID
+	 * @param integer $approvedcolumn Gravity Forms Field ID
 	 *
 	 * @return true|WP_Error
 	 */
@@ -422,7 +422,7 @@ 
 	 *
 	 * When approving a field via the entry meta, we
 	 *
-	 * @param array|int $form Form ID or form array
+	 * @param integer $form Form ID or form array
 	 * @param string $approved_column Approved column field ID
 	 *
 	 * @return string|null

includes/class-common.php

Doc Comments +5 added lines, -4 removed lines

@@ -217,7 +217,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
@@ -882,7 +882,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 = '' ) {
@@ -1514,6 +1514,7 @@ 
      * @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.
+     * @param integer $object_id
      *
      * @return string
      */
@@ -1557,9 +1558,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 ) {
 

includes/class-frontend-views.php

Doc Comments +5 added lines, -6 removed lines

@@ -153,7 +153,7 @@ 
 
 	/**
 	 * Sets the single entry ID and also the entry
-	 * @param bool|int|string $single_entry
+	 * @param boolean|string $single_entry
 	 */
 	public function setSingleEntry( $single_entry ) {
 
@@ -170,7 +170,7 @@ 
 
 	/**
 	 * Set the current entry
-	 * @param array|int $entry Entry array or entry slug or ID
+	 * @param boolean|string $entry Entry array or entry slug or ID
 	 */
 	public function setEntry( $entry ) {
 
@@ -228,7 +228,7 @@ 
 	 *
 	 *
 	 *
-	 * @param null $view_id
+	 * @param string $view_id
 	 */
 	public function set_context_view_id( $view_id = null ) {
 
@@ -558,7 +558,6 @@ 
 	 *
 	 * @since 1.19.2
 	 *
-	 * @param string $context The current context that has no configuration
 	 *
 	 * @return void
 	 */
@@ -1091,7 +1090,7 @@ 
 	 *
 	 * @uses  gravityview_get_entries()
 	 * @access public
-	 * @param array $args\n
+	 * @param array $args
 	 *   - $id - View id
 	 *   - $page_size - Page
 	 *   - $sort_field - form field id to sort
@@ -1551,7 +1550,7 @@ 
 	/**
 	 * Checks if field (column) is sortable
 	 *
-	 * @param string $field Field settings
+	 * @param string $field_id Field settings
 	 * @param array $form Gravity Forms form array
 	 *
 	 * @since 1.7

includes/class-gv-license-handler.php

Doc Comments +4 added lines, -2 removed lines

@@ -86,7 +86,6 @@ 
 	 *
 	 * @since 1.19.3
 	 *
-	 * @param bool $force Whether to force checking license, even if AJAX
 	 *
 	 * @return void
 	 */
@@ -272,6 +271,9 @@ 
 		return $implode ? implode( $implode, $extensions ) : $extensions;
 	}
 
+	/**
+	 * @param boolean $echo
+	 */
 	function settings_edd_license_activation( $field, $echo ) {
 
 		$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
@@ -464,7 +466,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