ravinderk / Give

includes/database/class-give-db-donors.php

Doc Comments +1 added lines, -1 removed lines

@@ -399,7 +399,7 @@
 	 * @access public
 	 *
 	 * @param  string $field ID or email. Default is 'id'.
-	 * @param  mixed  $value The Customer ID or email to search. Default is 0.
+	 * @param  integer  $value The Customer ID or email to search. Default is 0.
 	 *
 	 * @return mixed         Upon success, an object of the donor. Upon failure, NULL
 	 */

includes/forms/functions.php

Doc Comments +4 added lines, -4 removed lines

@@ -296,7 +296,7 @@ 
  * @since  1.0
  * @since  1.8.16 Add security check
  *
- * @return bool
+ * @return false|null
  */
 function give_listen_for_failed_payments() {
 	$payment_id = ! empty( $_GET['payment-id'] ) ? absint( $_GET['payment-id'] ) : 0;
@@ -1326,7 +1326,7 @@ 
  * @since 2.2.0
  *
  * @param array|integer   $price_or_level_id Price level data.
- * @param boolean|integer $form_id           Donation Form ID.
+ * @param integer $form_id           Donation Form ID.
  *
  * @return boolean
  */
@@ -1430,7 +1430,7 @@ 
  *
  * @since 2.2.0
  *
- * @return object
+ * @return Give_Donor
  */
 function give_get_name_with_title_prefixes( $donor ) {
 
@@ -1475,7 +1475,7 @@ 
  *
  * @since 2.2.0
  *
- * @return array
+ * @return string|boolean
  */
 function give_get_default_title_prefixes() {
 	/**

includes/forms/template.php

Doc Comments +7 added lines, -8 removed lines

@@ -19,7 +19,7 @@ 
  *
  * @param array $args An array of form arguments.
  *
- * @return string Donation form.
+ * @return false|null Donation form.
  * @since 1.0
  */
 function give_get_donation_form( $args = [] ) {
@@ -1744,7 +1744,7 @@ 
  *
  * @param int $form_id The form ID.
  *
- * @return bool
+ * @return false|null
  * @since  1.0
  */
 function give_terms_agreement( $form_id ) {
@@ -1952,7 +1952,7 @@ 
  * @param int   $form_id The form ID.
  * @param array $args    An array of form arguments.
  *
- * @return mixed
+ * @return boolean
  * @since        1.6   Add template for Give Goals Shortcode.
  *               More info is on https://github.com/impress-org/give/issues/411
  *
@@ -1987,7 +1987,7 @@ 
  * @param int $total      Total amount based on shortcode parameter.
  * @param int $total_goal Total Goal amount passed by Admin.
  *
- * @return mixed
+ * @return boolean
  * @since  2.1
  */
 function give_show_goal_totals_progress( $total, $total_goal ) {
@@ -2016,7 +2016,7 @@ 
 /**
  * Get form content position.
  *
- * @param  $form_id
+ * @param  integer $form_id
  * @param  $args
  *
  * @return mixed|string
@@ -2053,7 +2053,7 @@ 
  * @param int   $form_id The form ID.
  * @param array $args    An array of form arguments.
  *
- * @return void|bool
+ * @return false|null
  * @since  1.0
  */
 function give_form_content( $form_id, $args ) {
@@ -2372,7 +2372,7 @@ 
  * @param int   $id    ID of the form.
  * @param array $args  Additional args.
  *
- * @return array
+ * @return string[]
  * @since 2.1
  */
 function add_class_for_form_grid( $class, $id, $args ) {
@@ -2390,7 +2390,6 @@ 
 /**
  * Add hidden field to Form Grid page
  *
- * @param int              $form_id The form ID.
  * @param array            $args    An array of form arguments.
  * @param Give_Donate_Form $form    Form object.
  *

includes/gateways/paypal/paypal-standard.php

Doc Comments +1 added lines, -1 removed lines

@@ -598,7 +598,7 @@
  * @param int   $payment_id   Payment ID
  * @param array $payment_data Array of payment data.
  *
- * @return mixed|string
+ * @return string
  */
 function give_build_paypal_url( $payment_id, $payment_data ) {
 	// Only send to PayPal if the pending payment is created successfully.

includes/gateways/stripe/includes/class-give-stripe-gateway.php

Doc Comments +1 added lines, -1 removed lines

@@ -480,7 +480,7 @@
 		 *
 		 * @param float $amount Donation amount.
 		 *
-		 * @return mixed
+		 * @return integer
 		 */
 		public function format_amount( $amount ) {
 			return Money::of( $amount, give_get_currency() )->getMinorAmount();

includes/gateways/stripe/includes/give-stripe-helpers.php

Doc Comments +4 added lines, -4 removed lines

@@ -604,7 +604,7 @@ 
  *
  * @since 2.5.0
  *
- * @return int
+ * @return double
  */
 function give_stripe_get_application_fee_amount( $amount ) {
 	return round( $amount * give_stripe_get_application_fee_percentage() / 100, 0 );
@@ -1039,7 +1039,7 @@ 
  * @since  2.5.0
  * @since 2.9.2  Return amount in cent only if currency is not zero-decimal currency.
  *
- * @return string
+ * @return integer
  */
 function give_stripe_dollars_to_cents( $dollars ) {
 	return Money::of( $dollars, give_get_currency() )->getMinorAmount();
@@ -1054,7 +1054,7 @@ 
  *
  * @since 2.5.4
  *
- * @return mixed
+ * @return integer|null
  */
 function give_stripe_format_amount( $amount ) {
 
@@ -1375,7 +1375,7 @@ 
  *
  * @since 2.7.0
  *
- * @return array
+ * @return string
  */
 function give_stripe_get_default_account( $form_id = 0 ) {
 

src/API/Endpoints/Reports/AverageDonation.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
 	}
 
 
+	/**
+	 * @param string $intervalStr
+	 */
 	public function get_data( $start, $end, $intervalStr ) {
 
 		$tooltips = [];

src/API/Endpoints/Reports/Income.php

Doc Comments +3 added lines

@@ -45,6 +45,9 @@
 		return $data;
 	}
 
+	/**
+	 * @param string $intervalStr
+	 */
 	public function get_data( $start, $end, $intervalStr ) {
 
 		$tooltips = [];

src/API/Endpoints/Reports/IncomeBreakdown.php

Doc Comments +3 added lines

@@ -41,6 +41,9 @@
 		return $data;
 	}
 
+	/**
+	 * @param string $intervalStr
+	 */
 	public function get_data( $start, $end, $intervalStr ) {
 
 		$data = [];