gravityview / GravityView

includes/class-api.php

Doc Comments +4 added lines, -1 removed lines

@@ -232,7 +232,6 @@ 
 	 * @deprecated Use \GV\Field_Template::render() or the more low-level \GV\Field::get_value()
 	 *
 	 * @param array $entry
-	 * @param array $field
 	 * @return null|string
 	 */
 	public static function field_value( $entry, $field_settings, $format = 'html' ) {
@@ -851,6 +850,9 @@ 
 	return $value;
 }
 
+/**
+ * @param GV\Template_Context $context
+ */
 function gv_directory_link( $post = NULL, $add_pagination = true, $context = null ) {
 	return GravityView_API::directory_link( $post, $add_pagination, $context );
 }
@@ -1359,6 +1361,7 @@ 
  * @param  array $passed_args Associative array with field data. `field` and `form` are required.
  * @since  2.0
  * @param  \GV\Template_Context The template context.
+ * @param GV\Template_Context $context
  * @return string Field output. If empty value and hide empty is true, return empty.
  */
 function gravityview_field_output( $passed_args, $context = null ) {

includes/class-common.php

Doc Comments +5 added lines, -5 removed lines

@@ -281,7 +281,7 @@ 
 	/**
 	 * Return array of fields' id and label, for a given Form ID
 	 *
-	 * @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
@@ -1034,7 +1034,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 = '' ) {
@@ -1555,7 +1555,7 @@ 
 	 *
 	 * Do the same than parse_str without max_input_vars limitation:
 	 * Parses $string as if it were the query string passed via a URL and sets variables in the current scope.
-	 * @param $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
+	 * @param string $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
 	 * @param $result array  If the second parameter is present, variables are stored in this variable as array elements
 	 * @return bool true or false if $string is an empty string
 	 * @since  1.5.3
@@ -1791,9 +1791,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 +3 added lines, -4 removed lines

@@ -227,7 +227,7 @@ 
 	 *
 	 *
 	 *
-	 * @param null $view_id
+	 * @param string $view_id
 	 */
 	public function set_context_view_id( $view_id = null ) {
 		$multiple_views = $this->getGvOutputData() && $this->getGvOutputData()->has_multiple_views();
@@ -922,7 +922,7 @@ 
 	 *
 	 *
 	 * @uses  gravityview_get_entries()
-	 * @param array $args\n
+	 * @param array $args
 	 *   - $id - View id
 	 *   - $page_size - Page
 	 *   - $sort_field - form field id to sort
@@ -1051,7 +1051,6 @@ 
 	 * @since 1.19.5
 	 *
 	 * @param $args
-	 * @param int $form_id
 	 */
 	public static function get_search_criteria_paging( $args ) {
 
@@ -1553,7 +1552,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/connector-functions.php

Doc Comments +1 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
  * Return array of fields' id and label, for a given Form ID
  *
  * @see GVCommon::get_form_fields()
- * @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 ) {
@@ -216,7 +216,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/extensions/delete-entry/class-delete-entry-admin.php

Doc Comments -1 removed lines

@@ -67,7 +67,6 @@
 	 * @since 2.9.2 Moved here from GravityView_Delete_Entry
 	 *
 	 * @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`

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

Doc Comments +4 added lines, -4 removed lines

@@ -63,7 +63,7 @@ 
 	 *
 	 * @since 2.9.2
 	 *
-	 * @param $component
+	 * @param string $component
 	 */
 	private function load_components( $component ) {
 
@@ -423,7 +423,7 @@ 
 	 * @uses GFAPI::delete_entry()
 	 * @uses GFAPI::update_entry_property()
 	 *
-	 * @return WP_Error|string "deleted" or "trashed" if successful, WP_Error if GFAPI::delete_entry() or updating entry failed.
+	 * @return string "deleted" or "trashed" if successful, WP_Error if GFAPI::delete_entry() or updating entry failed.
 	 */
 	private function delete_or_trash_entry( $entry ) {
 
@@ -590,7 +590,7 @@ 
 	 *
 	 * @since 1.5.1
 	 * @param  array $entry Gravity Forms entry array
-	 * @return boolean|WP_Error        True: can edit form. WP_Error: nope.
+	 * @return string        True: can edit form. WP_Error: nope.
 	 */
 	function user_can_delete_entry( $entry = array(), $view_id = null ) {
 
@@ -631,7 +631,7 @@ 
 	 *
 	 * @param  array $entry Gravity Forms entry array
 	 * @param array $field Field settings (optional)
-	 * @param int|\GV\View $view Pass a View ID to check caps against. If not set, check against current View (@deprecated no longer optional)
+	 * @param integer $view Pass a View ID to check caps against. If not set, check against current View (@deprecated no longer optional)
 	 * @return bool
 	 */
 	public static function check_user_cap_delete_entry( $entry, $field = array(), $view = 0 ) {