ravinderk / Give

includes/login-register.php

Doc Comments +2 added lines, -2 removed lines

@@ -174,7 +174,7 @@ 
  * @param string $user_login Username
  * @param string $user_pass  Password
  *
- * @return bool
+ * @return false|null
  */
 function give_log_user_in( $user_id, $user_login, $user_pass ) {
 
@@ -215,7 +215,7 @@ 
  *
  * @param array $data Data sent from the register form
  *
- * @return bool
+ * @return false|null
  */
 function give_process_register_form( $data ) {
 

includes/actions.php

Doc Comments -1 removed lines

@@ -217,7 +217,6 @@
 /**
  * Set Donation Amount for Multi Level Donation Forms
  *
- * @param int    $form_id
  * @param object $form
  *
  * @since 1.8.9

includes/payments/class-payment-stats.php

Doc Comments +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
 	 * @param  $end_date   string|bool  The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
 	 * @param  $status     string|array The sale status(es) to count. Only valid when retrieving global stats
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_sales( $form_id = 0, $start_date = false, $end_date = false, $status = 'publish' ) {
 
@@ -83,7 +83,7 @@ 
 	 * @param  $end_date    string|bool The end date for which we'd like to filter the donations stats. If false, method will use the default end date of `this_month`.
 	 * @param  $gateway_id  string|bool The gateway to get earnings for such as 'paypal' or 'stripe'.
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_earnings( $form_id = 0, $start_date = false, $end_date = false, $gateway_id = false ) {
 		$this->setup_dates( $start_date, $end_date );
@@ -168,7 +168,7 @@ 
 	 * @param  $end_date    string|bool The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
 	 * @param  $gateway_id  string|bool The gateway to get earnings for such as 'paypal' or 'stripe'
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_earnings_cache_key( $form_id = 0, $start_date = false, $end_date = false, $gateway_id = false ) {
 

includes/payments/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -681,7 +681,7 @@ 
  * @param  int $year      Year number. Default is null.
  * @param  int $hour      Hour number. Default is null.
  *
- * @return int $earnings  Earnings
+ * @return double $earnings  Earnings
  */
 function give_get_earnings_by_date( $day = null, $month_num, $year = null, $hour = null ) {
 
@@ -970,7 +970,7 @@ 
  *
  * @param int $payment_id Payment ID.
  *
- * @return array $user_info User Info Meta Values.
+ * @return string $user_info User Info Meta Values.
  */
 function give_get_payment_meta_user_info( $payment_id ) {
 	$payment = new Give_Payment( $payment_id );
@@ -987,7 +987,7 @@ 
  *
  * @param int $payment_id Payment ID.
  *
- * @return int $form_id Form ID.
+ * @return string $form_id Form ID.
  */
 function give_get_payment_form_id( $payment_id ) {
 	$payment = new Give_Payment( $payment_id );

includes/admin/reports/class-donor-reports-table.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
 	 *
 	 * @access public
 	 * @since  1.0
-	 * @return mixed string If search is present, false otherwise
+	 * @return string|false string If search is present, false otherwise
 	 */
 	public function get_search() {
 		return ! empty( $_GET['s'] ) ? urldecode( trim( $_GET['s'] ) ) : false;

includes/formatting.php

Doc Comments +1 added lines, -1 removed lines

@@ -283,7 +283,7 @@
  * @since 1.0
  *
  * @param int|float|string $amount   Formatted or sanitized price
- * @param int|bool         $dp       number of decimals
+ * @param boolean         $dp       number of decimals
  * @param bool             $sanitize Whether or not sanitize number
  *
  * @return string $amount Newly formatted amount or Price Not Available

includes/forms/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -155,7 +155,7 @@ 
  *
  * Used to redirect a user back to the donation form if there are errors present.
  *
- * @param array $args
+ * @param string $args
  *
  * @access public
  * @since  1.0
@@ -441,7 +441,7 @@ 
  *
  * @param int $form_id Give Form ID
  *
- * @return int $earnings Earnings for a certain form
+ * @return double $earnings Earnings for a certain form
  */
 function give_get_form_earnings_stats( $form_id = 0 ) {
 	$give_form = new Give_Donate_Form( $form_id );
@@ -708,7 +708,7 @@ 
  *
  * @param int $form_id ID number of the form to retrieve the minimum price for
  *
- * @return mixed string|int Minimum price of the form
+ * @return string string|int Minimum price of the form
  */
 function give_get_form_minimum_price( $form_id = 0 ) {
 

give.php

Doc Comments +1 added lines, -1 removed lines

@@ -521,7 +521,7 @@
  * Example: <?php $give = Give(); ?>
  *
  * @since 1.0
- * @return object|Give
+ * @return Give
  */
 function Give() {
 	return Give::instance();

includes/admin/tools/data/class-give-tools-delete-test-donors.php

Doc Comments +4 added lines, -1 removed lines

@@ -216,7 +216,7 @@ 
 	 * Return the calculated completion percentage.
 	 *
 	 * @since 1.8.12
-	 * @return int
+	 * @return double
 	 */
 	public function get_percentage_complete() {
 		return ceil( ( 100 * $this->step_completed ) / $this->total_step );
@@ -353,6 +353,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $page
+	 */
 	public function get_delete_ids( $donation_ids, $page ) {
 		$index            = $page --;
 		$count            = count( $donation_ids );