Completed
Pull Request — master (#605)
by Zack
05:22
created
includes/class-settings.php 1 patch
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -301,6 +301,7 @@
 block discarded – undo
301 301
 	 * Make protected public
302 302
 	 * @inheritDoc
303 303
 	 * @access public
304
+	 * @param string $setting_name
304 305
 	 */
305 306
 	public function get_app_setting( $setting_name ) {
306 307
 
Please login to merge, or discard this patch.
includes/connector-functions.php 1 patch
Doc Comments   +3 added lines, -5 removed lines patch added patch discarded remove patch
@@ -41,7 +41,6 @@  discard block
 block discarded – undo
41 41
  *
42 42
  * @see GVCommon::get_forms()
43 43
  * @access public
44
- * @param mixed $form_id
45 44
  * @return array (id, title)
46 45
  */
47 46
 function gravityview_get_forms() {
@@ -53,7 +52,7 @@  discard block
 block discarded – undo
53 52
  *
54 53
  * @see GVCommon::get_form_fields()
55 54
  * @access public
56
- * @param string|array $form_id (default: '') or $form object
55
+ * @param string|array $form (default: '') or $form object
57 56
  * @return array
58 57
  */
59 58
 function gravityview_get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {
@@ -91,6 +90,7 @@  discard block
 block discarded – undo
91 90
  * @param int|array $form_ids The ID of the form or an array IDs of the Forms. Zero for all forms.
92 91
  * @param mixed $passed_criteria (default: null)
93 92
  * @param mixed &$total (default: null)
93
+ * @param integer $total
94 94
  * @return mixed False: Error fetching entries. Array: Multi-dimensional array of Gravity Forms entry arrays
95 95
  */
96 96
 function gravityview_get_entries( $form_ids = null, $passed_criteria = null, &$total = null ) {
@@ -103,7 +103,6 @@  discard block
 block discarded – undo
103 103
  * 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()`
104 104
  *
105 105
  * @access public
106
- * @param mixed $entry_id
107 106
  * @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.
108 107
  * @param boolean $check_entry_display Check whether the entry is visible for the current View configuration. Default: true {@since 1.14}
109 108
  * @return array|boolean
@@ -177,7 +176,7 @@  discard block
 block discarded – undo
177 176
  *
178 177
  * @param int $view_id ID of the View you want the form of
179 178
  *
180
- * @return int
179
+ * @return string
181 180
  */
182 181
 function gravityview_get_form_id( $view_id ) {
183 182
 	return GVCommon::get_meta_form_id( $view_id );
@@ -188,7 +187,6 @@  discard block
 block discarded – undo
188 187
  *
189 188
  * @see GravityView_Template::template_id
190 189
  *
191
- * @param int $view_id The ID of the View to get the layout of
192 190
  *
193 191
  * @return string GravityView_Template::template_id value. Empty string if not.
194 192
  */
Please login to merge, or discard this patch.
includes/extensions/delete-entry/class-delete-entry.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -170,7 +170,6 @@
 block discarded – undo
170 170
 	 *
171 171
 	 * @since 1.5.1
172 172
 	 * @param  array 	   $visibility_caps        Array of capabilities to display in field dropdown.
173
-	 * @param  string      $field_type  Type of field options to render (`field` or `widget`)
174 173
 	 * @param  string      $template_id Table slug
175 174
 	 * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
176 175
 	 * @param  string      $context     What context are we in? Example: `single` or `directory`
Please login to merge, or discard this patch.
includes/extensions/edit-entry/class-edit-entry-admin.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -69,7 +69,6 @@
 block discarded – undo
69 69
      * Change wording for the Edit context to read Entry Creator
70 70
      *
71 71
      * @param  array 	   $visibility_caps        Array of capabilities to display in field dropdown.
72
-     * @param  string      $field_type  Type of field options to render (`field` or `widget`)
73 72
      * @param  string      $template_id Table slug
74 73
      * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
75 74
      * @param  string      $context     What context are we in? Example: `single` or `directory`
Please login to merge, or discard this patch.
includes/extensions/edit-entry/class-edit-entry-render.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -1249,7 +1249,7 @@
 block discarded – undo
1249 1249
     /**
1250 1250
      * Override GF Form field properties with the ones defined on the View
1251 1251
      * @param  GF_Field $field GF Form field object
1252
-     * @param  array $setting  GV field options
1252
+     * @param  array $field_setting  GV field options
1253 1253
      * @since  1.5
1254 1254
      * @return array
1255 1255
      */
Please login to merge, or discard this patch.
includes/extensions/edit-entry/class-edit-entry-user-registration.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -57,7 +57,7 @@
 block discarded – undo
57 57
      * @since 1.11
58 58
      *
59 59
      * @param array $form Gravity Forms form array
60
-     * @param string $entry_id Gravity Forms entry ID
60
+     * @param integer $entry_id Gravity Forms entry ID
61 61
      * @return void
62 62
      */
63 63
     public function update_user( $form = array(), $entry_id = 0 ) {
Please login to merge, or discard this patch.
includes/extensions/edit-entry/class-edit-entry.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,6 +65,9 @@  discard block
 block discarded – undo
65 65
     }
66 66
 
67 67
 
68
+    /**
69
+     * @param string $component
70
+     */
68 71
     private function load_components( $component ) {
69 72
 
70 73
         $dir = trailingslashit( self::$file );
@@ -141,7 +144,7 @@  discard block
 block discarded – undo
141 144
      * "You can edit this post from the post page" fields, for example.
142 145
      *
143 146
      * @param $entry array Gravity Forms entry object
144
-     * @param $view_id int GravityView view id
147
+     * @param integer $view_id int GravityView view id
145 148
      * @param $post_id int GravityView Post ID where View may be embedded {@since 1.9.2}
146 149
      * @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/ }
147 150
      * @return string
Please login to merge, or discard this patch.
includes/lib/EDD_SL_Plugin_Updater.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -68,7 +68,7 @@
 block discarded – undo
68 68
 	 * @uses api_request()
69 69
 	 *
70 70
 	 * @param array   $_transient_data Update array build by WordPress.
71
-	 * @return array Modified update array with custom plugin data.
71
+	 * @return stdClass Modified update array with custom plugin data.
72 72
 	 */
73 73
 	function check_update( $_transient_data ) {
74 74
 
Please login to merge, or discard this patch.
includes/lib/xml-parsers/parsers.php 1 patch
Doc Comments   +22 added lines patch added patch discarded remove patch
@@ -10,6 +10,10 @@  discard block
 block discarded – undo
10 10
  * WordPress Importer class for managing parsing of WXR files.
11 11
  */
12 12
 class WXR_Parser {
13
+
14
+	/**
15
+	 * @param string $file
16
+	 */
13 17
 	function parse( $file ) {
14 18
 		// Attempt to use proper XML parsers first
15 19
 		if ( extension_loaded( 'simplexml' ) ) {
@@ -479,6 +483,9 @@  discard block
 block discarded – undo
479 483
 		);
480 484
 	}
481 485
 
486
+	/**
487
+	 * @param string $tag
488
+	 */
482 489
 	function get_tag( $string, $tag ) {
483 490
 		preg_match( "|<$tag.*?>(.*?)</$tag>|is", $string, $return );
484 491
 		if ( isset( $return[1] ) ) {
@@ -500,6 +507,9 @@  discard block
 block discarded – undo
500 507
 		return $return;
501 508
 	}
502 509
 
510
+	/**
511
+	 * @param string $c
512
+	 */
503 513
 	function process_category( $c ) {
504 514
 		return array(
505 515
 			'term_id' => $this->get_tag( $c, 'wp:term_id' ),
@@ -510,6 +520,9 @@  discard block
 block discarded – undo
510 520
 		);
511 521
 	}
512 522
 
523
+	/**
524
+	 * @param string $t
525
+	 */
513 526
 	function process_tag( $t ) {
514 527
 		return array(
515 528
 			'term_id' => $this->get_tag( $t, 'wp:term_id' ),
@@ -519,6 +532,9 @@  discard block
 block discarded – undo
519 532
 		);
520 533
 	}
521 534
 
535
+	/**
536
+	 * @param string $t
537
+	 */
522 538
 	function process_term( $t ) {
523 539
 		return array(
524 540
 			'term_id' => $this->get_tag( $t, 'wp:term_id' ),
@@ -530,6 +546,9 @@  discard block
 block discarded – undo
530 546
 		);
531 547
 	}
532 548
 
549
+	/**
550
+	 * @param string $a
551
+	 */
533 552
 	function process_author( $a ) {
534 553
 		return array(
535 554
 			'author_id' => $this->get_tag( $a, 'wp:author_id' ),
@@ -541,6 +560,9 @@  discard block
 block discarded – undo
541 560
 		);
542 561
 	}
543 562
 
563
+	/**
564
+	 * @param string $post
565
+	 */
544 566
 	function process_post( $post ) {
545 567
 		$post_id        = $this->get_tag( $post, 'wp:post_id' );
546 568
 		$post_title     = $this->get_tag( $post, 'title' );
Please login to merge, or discard this patch.