Completed
Pull Request — master (#1201)
by Ravinder
23:20
created
includes/emails/class-give-email-tags.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -477,7 +477,7 @@
 block discarded – undo
477 477
  *
478 478
  * @param int $payment_id
479 479
  *
480
- * @return int payment_id
480
+ * @return string payment_id
481 481
  */
482 482
 function give_email_tag_payment_id( $payment_id ) {
483 483
 	return give_get_payment_number( $payment_id );
Please login to merge, or discard this patch.
includes/formatting.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -225,7 +225,7 @@  discard block
 block discarded – undo
225 225
  * @param $field_args
226 226
  * @param $field
227 227
  *
228
- * @return bool
228
+ * @return false|null
229 229
  */
230 230
 function give_format_admin_multilevel_amount( $field_args, $field ) {
231 231
 
@@ -375,7 +375,7 @@  discard block
 block discarded – undo
375 375
  * @param   array  $field_args
376 376
  * @param   object $field
377 377
  *
378
- * @return mixed
378
+ * @return string
379 379
  */
380 380
 function give_sanitize_thousand_separator( $value, $field_args, $field ){
381 381
     return stripslashes( $value );
@@ -408,7 +408,7 @@  discard block
 block discarded – undo
408 408
  * @param   array  $field_args
409 409
  * @param   object $field
410 410
  *
411
- * @return  mixed
411
+ * @return  string
412 412
  */
413 413
 function give_sanitize_price_field_value( $value, $field_args, $field ){
414 414
     return give_sanitize_amount( $value );
Please login to merge, or discard this patch.
includes/admin/customers/customer-actions.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -543,7 +543,7 @@  discard block
 block discarded – undo
543 543
  * and redirect back to the donor interface for feedback
544 544
  *
545 545
  * @since  1.7
546
- * @return void|bool
546
+ * @return false|null
547 547
  */
548 548
 function give_remove_donor_email() {
549 549
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -583,7 +583,7 @@  discard block
 block discarded – undo
583 583
  * and redirect back to the donor interface for feedback
584 584
  *
585 585
  * @since  1.7
586
- * @return void|bool
586
+ * @return false|null
587 587
  */
588 588
 function give_set_donor_primary_email() {
589 589
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
Please login to merge, or discard this patch.
includes/class-give-customer.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -890,7 +890,7 @@  discard block
 block discarded – undo
890 890
 	 * @access public
891 891
 	 *
892 892
 	 * @param  string $meta_key   Metadata name. Default is empty.
893
-	 * @param  mixed  $meta_value Metadata value.
893
+	 * @param  string  $meta_value Metadata value.
894 894
 	 * @param  bool   $unique     Optional. Whether the same key should not be added. Default is false.
895 895
 	 *
896 896
 	 * @return bool               False for failure. True for success.
@@ -922,7 +922,7 @@  discard block
 block discarded – undo
922 922
 	 * @access public
923 923
 	 *
924 924
 	 * @param  string $meta_key   Metadata name. Default is empty.
925
-	 * @param  mixed  $meta_value Optional. Metadata value. Default is empty.
925
+	 * @param  string  $meta_value Optional. Metadata value. Default is empty.
926 926
 	 *
927 927
 	 * @return bool               False for failure. True for success.
928 928
 	 */
Please login to merge, or discard this patch.
includes/forms/template.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -21,7 +21,7 @@  discard block
 block discarded – undo
21 21
  *
22 22
  * @param  array  $args An array of form arguments.
23 23
  *
24
- * @return string Donation form.
24
+ * @return false|null Donation form.
25 25
  */
26 26
 function give_get_donation_form( $args = array() ) {
27 27
 
@@ -1359,7 +1359,7 @@  discard block
 block discarded – undo
1359 1359
  *
1360 1360
  * @param  int  $form_id The form ID.
1361 1361
  *
1362
- * @return void|bool
1362
+ * @return false|null
1363 1363
  */
1364 1364
 function give_terms_agreement( $form_id ) {
1365 1365
 	$form_option = get_post_meta( $form_id, '_give_terms_option', true );
@@ -1552,7 +1552,7 @@  discard block
 block discarded – undo
1552 1552
  * @param  int   $form_id The form ID.
1553 1553
  * @param  array $args    An array of form arguments.
1554 1554
  *
1555
- * @return mixed
1555
+ * @return boolean
1556 1556
  */
1557 1557
 function give_show_goal_progress( $form_id, $args ) {
1558 1558
 
Please login to merge, or discard this patch.
includes/misc-functions.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -337,7 +337,7 @@
 block discarded – undo
337 337
  *
338 338
  * @since 1.0
339 339
  * @uses  Give()->session->get()
340
- * @return mixed array | false
340
+ * @return string array | false
341 341
  */
342 342
 function give_get_purchase_session() {
343 343
 	return Give()->session->get( 'give_purchase' );
Please login to merge, or discard this patch.
includes/class-give-cli-commands.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -731,7 +731,7 @@
 block discarded – undo
731 731
 	 * @param    bool   $colon   Check if add colon between heading and message.
732 732
 	 * @param    string $color   Heading color.
733 733
 	 *
734
-	 * @return    mixed
734
+	 * @return    string
735 735
 	 */
736 736
 	private function color_message( $heading, $message = '', $colon = true, $color = 'g' ) {
737 737
 		// Add colon.
Please login to merge, or discard this patch.
includes/class-give-license-handler.php 1 patch
Doc Comments   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -219,7 +219,7 @@  discard block
 block discarded – undo
219 219
 		 * @access private
220 220
 		 * @since  1.0
221 221
 		 *
222
-		 * @return bool
222
+		 * @return false|null
223 223
 		 */
224 224
 		public function auto_updater() {
225 225
 
@@ -475,7 +475,7 @@  discard block
 block discarded – undo
475 475
 		 * @access public
476 476
 		 * @since  1.7
477 477
 		 *
478
-		 * @return bool|void
478
+		 * @return false|null
479 479
 		 */
480 480
 		public function weekly_license_check() {
481 481
 
@@ -527,7 +527,7 @@  discard block
 block discarded – undo
527 527
 		 * @access public
528 528
 		 * @since  1.7
529 529
 		 *
530
-		 * @return bool|void
530
+		 * @return false|null
531 531
 		 */
532 532
 		public function weekly_subscription_check() {
533 533
 
@@ -607,7 +607,7 @@  discard block
 block discarded – undo
607 607
 		 * @access private
608 608
 		 * @since  1.7
609 609
 		 *
610
-		 * @return bool|void
610
+		 * @return false|null
611 611
 		 */
612 612
 		private function __single_subscription_check() {
613 613
 			// Do not fire if license key is not set.
@@ -802,7 +802,7 @@  discard block
 block discarded – undo
802 802
 		 * @access private
803 803
 		 * @since  1.7
804 804
 		 *
805
-		 * @return void|bool
805
+		 * @return false|null
806 806
 		 */
807 807
 		private function __remove_license_key_from_subscriptions(){
808 808
 			$subscriptions = get_option( 'give_subscriptions', array() );
Please login to merge, or discard this patch.
includes/payments/functions.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -326,7 +326,7 @@  discard block
 block discarded – undo
326 326
  *
327 327
  * @since  1.0
328 328
  *
329
- * @param  int|bool $form_id    Form ID (default: false).
329
+ * @param  boolean $form_id    Form ID (default: false).
330 330
  * @param  int      $payment_id Payment ID.
331 331
  *
332 332
  * @return void
@@ -644,7 +644,7 @@  discard block
 block discarded – undo
644 644
  * @param  int $year      Year number. Default is null.
645 645
  * @param  int $hour      Hour number. Default is null.
646 646
  *
647
- * @return int $earnings  Earnings
647
+ * @return double $earnings  Earnings
648 648
  */
649 649
 function give_get_earnings_by_date( $day = null, $month_num, $year = null, $hour = null ) {
650 650
 
@@ -959,7 +959,7 @@  discard block
 block discarded – undo
959 959
  *
960 960
  * @param int $payment_id Payment ID.
961 961
  *
962
- * @return int $form_id Form ID.
962
+ * @return string $form_id Form ID.
963 963
  */
964 964
 function give_get_payment_form_id( $payment_id ) {
965 965
 	$payment = new Give_Payment( $payment_id );
Please login to merge, or discard this patch.