gravityview / GravityView

includes/class-common.php

Doc Comments +5 added lines, -5 removed lines

@@ -270,7 +270,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
@@ -1012,7 +1012,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 = '' ) {
@@ -1515,7 +1515,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
@@ -1750,9 +1750,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/widgets/search-widget/class-search-widget.php

Doc Comments +6 added lines, -7 removed lines

@@ -249,7 +249,7 @@ 
 	/**
 	 * Add admin script to the no-conflict scripts whitelist
 	 * @param array $allowed Scripts allowed in no-conflict mode
-	 * @return array Scripts allowed in no-conflict mode, plus the search widget script
+	 * @return string[] Scripts allowed in no-conflict mode, plus the search widget script
 	 */
 	public function register_no_conflict( $allowed ) {
 		$allowed[] = 'gravityview_searchwidget_admin';
@@ -732,7 +732,6 @@ 
 	 * Dropin for the legacy flat filters when \GF_Query is available.
 	 *
 	 * @param \GF_Query $query The current query object reference
-	 * @param \GV\View $this The current view object
 	 * @param \GV\Request $request The request object
 	 */
 	public function gf_query_filter( &$query, $view, $request ) {
@@ -1414,7 +1413,7 @@ 
 	/**
 	 * Get the label for a search form field
 	 * @param  array $field      Field setting as sent by the GV configuration - has `field`, `input` (input type), and `label` keys
-	 * @param  array $form_field Form field data, as fetched by `gravityview_get_field()`
+	 * @param  GF_Field|null $form_field Form field data, as fetched by `gravityview_get_field()`
 	 * @return string             Label for the search form
 	 */
 	private static function get_field_label( $field, $form_field = array() ) {
@@ -1470,7 +1469,7 @@ 
 	 * Prepare search fields to frontend render with other details (label, field type, searched values)
 	 *
 	 * @param array $field
-	 * @return array
+	 * @return GV\View
 	 */
 	private function get_search_filter_details( $field ) {
 
@@ -1609,7 +1608,7 @@ 
 	/**
 	 * Require the datepicker script for the frontend GV script
 	 * @param array $js_dependencies Array of existing required scripts for the fe-views.js script
-	 * @return array Array required scripts, with `jquery-ui-datepicker` added
+	 * @return string[] Array required scripts, with `jquery-ui-datepicker` added
 	 */
 	public function add_datepicker_js_dependency( $js_dependencies ) {
 
@@ -1621,7 +1620,7 @@ 
 	/**
 	 * Modify the array passed to wp_localize_script()
 	 *
-	 * @param array $js_localization The data padded to the Javascript file
+	 * @param array $localizations The data padded to the Javascript file
 	 * @param array $view_data View data array with View settings
 	 *
 	 * @return array
@@ -1801,7 +1800,7 @@ 
 	 *
 	 * @param array  $get     Where to look for the operator.
 	 * @param string $key     The filter key to look for.
-	 * @param array  $allowed The allowed operators (whitelist).
+	 * @param string[]  $allowed The allowed operators (whitelist).
 	 * @param string $default The default operator.
 	 *
 	 * @return string The operator.

future/includes/class-gv-template-view-table.php

Doc Comments +3 added lines, -3 removed lines

@@ -141,8 +141,8 @@ 
      *
      * @see add_columns_sort_links
 	 * @param string $url Single-sort URL
-	 * @param array $sort_args Single sorting for rules, in [ field_id, dir ] format
-     * @param string|int $field_id ID of the current field being displayed
+	 * @param string[] $sort_args Single sorting for rules, in [ field_id, dir ] format
+     * @param string $field_id ID of the current field being displayed
      *
      * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
 	 */
@@ -346,7 +346,7 @@ 
 	 * Output a field cell.
 	 *
 	 * @param \GV\Field $field The field to be ouput.
-	 * @param \GV\Field $entry The entry this field is for.
+	 * @param Entry $entry The entry this field is for.
 	 *
 	 * @return void
 	 */

future/includes/class-gv-renderer.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 	 * @param \GV\View $view The view we're looking at.
 	 * @param string $path The path of the offending template.
 	 *
-	 * @return \Callable A closure used in the filter.
+	 * @return \Closure A closure used in the filter.
 	 */
 	public function legacy_template_warning( $view, $path ) {
 		return function() use ( $view, $path ) {

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

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
 	 * Why? See https://github.com/gravityview/GravityView/issues/1024
 	 *
 	 * @param \GV\Field_Template $template The template instance.
-	 * @return callable The callback bound to `get_template_part`. See `\GV\Field_Template::__construct`
+	 * @return \Closure The callback bound to `get_template_part`. See `\GV\Field_Template::__construct`
 	 */
 	public static function add_id_specific_templates( $template ) {