gravityview / GravityView

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 ) {
 

includes/widgets/search-widget/class-search-widget.php

Doc Comments +7 added lines, -7 removed lines

@@ -246,7 +246,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';
@@ -420,6 +420,7 @@ 
 	 * Display hidden fields to add support for sites using Default permalink structure
 	 *
 	 * @since 1.8
+	 * @param GravityView_Widget_Search $object
 	 * @return array Search fields, modified if not using permalinks
 	 */
 	public function add_no_permalink_fields( $search_fields, $object, $widget_args = array() ) {
@@ -729,7 +730,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 ) {
@@ -1428,7 +1428,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() ) {
@@ -1486,7 +1486,7 @@ 
 	 * @param array $field
 	 * @param \GV\Context $context
 	 *
-	 * @return array
+	 * @return GV\View
 	 */
 	private function get_search_filter_details( $field, $context ) {
 
@@ -1634,7 +1634,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 ) {
 
@@ -1646,7 +1646,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
@@ -1826,7 +1826,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-shortcode-gventry.php

Doc Comments -1 removed lines

@@ -18,7 +18,6 @@
 	/**
 	 * Process and output the [gventry] shortcode.
 	 *
-	 * @param array $passed_atts The attributes passed.
 	 * @param string $content The content inside the shortcode.
 	 * @param string $tag The shortcode tag.
 	 *

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

Doc Comments -1 removed lines

@@ -18,7 +18,6 @@
 	/**
 	 * Process and output the [gvfield] shortcode.
 	 *
-	 * @param array $passed_atts The attributes passed.
 	 * @param string $content The content inside the shortcode.
 	 * @param string $tag The shortcode tag.
 	 *

future/includes/class-gv-widget.php

Doc Comments +1 added lines, -1 removed lines

@@ -393,7 +393,7 @@
 	 * @internal
 	 * @since 2.0
 	 *
-	 * @return \GV\Widget|null The widget implementation from configuration or none.
+	 * @return Widget The widget implementation from configuration or none.
 	 */
 	public static function from_configuration( $configuration ) {
 		$registered_widgets = self::registered();

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

Doc Comments +2 added lines

@@ -262,6 +262,8 @@
 	/**
 	 * Process the attributes passed to the shortcode. Make sure they're valid
 	 *
+	 * @param string $content
+	 * @param string $tag
 	 * @return array Array of attributes parsed for the shortcode
 	 */
 	private function parse_atts( $atts, $content, $tag ) {

includes/extensions/entry-notes/class-gravityview-field-notes.php

Doc Comments +2 added lines, -2 removed lines

@@ -357,7 +357,7 @@ 
 	 *
 	 * @param array $file_paths List of template paths ordered
 	 *
-	 * @return array File paths with `./` and `./partials/` paths added
+	 * @return string[] File paths with `./` and `./partials/` paths added
 	 */
 	public function add_template_path( $file_paths ) {
 
@@ -549,7 +549,7 @@ 
 	 * @param array $entry
 	 * @param array $data Note details array
 	 *
-	 * @return int|WP_Error
+	 * @return integer
 	 */
 	private function add_note( $entry, $data ) {
 		global $current_user, $wpdb;

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

Doc Comments +5 added lines, -2 removed lines

@@ -64,6 +64,9 @@ 
     }
 
 
+    /**
+     * @param string $component
+     */
     private function load_components( $component ) {
 
         $dir = trailingslashit( self::$file );
@@ -183,7 +186,7 @@ 
      * "You can edit this post from the post page" fields, for example.
      *
      * @param $entry array Gravity Forms entry object
-     * @param $view_id int GravityView view id
+     * @param integer $view_id int GravityView view id
      * @param $post_id int GravityView Post ID where View may be embedded {@since 1.9.2}
      * @param string|array $field_values Parameters to pass in to the Edit Entry form to prefill data. Uses the same format as Gravity Forms "Allow field to be populated dynamically" {@since 1.9.2} {@see https://www.gravityhelp.com/documentation/article/allow-field-to-be-populated-dynamically/ }
      * @return string
@@ -286,7 +289,7 @@ 
      * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_entry for maximum security!!
      *
      * @param  array $entry Gravity Forms entry array
-     * @param \GV\View|int $view ID of the view you want to check visibility against {@since 1.9.2}. Required since 2.0
+     * @param integer $view ID of the view you want to check visibility against {@since 1.9.2}. Required since 2.0
      * @return bool
      */
     public static function check_user_cap_edit_entry( $entry, $view = 0 ) {